Skip to content

Commit c7ce988

Browse files
fern-api[bot]fern-api[bot]
authored
Feat: Added Organization Connections and type updates (#1315)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 30c295c commit c7ce988

11 files changed

Lines changed: 1557 additions & 71 deletions

File tree

‎reference.md‎

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22030,6 +22030,320 @@ await client.organizations.clientGrants.delete("id", "grant_id");
2203022030
</dl>
2203122031
</details>
2203222032

22033+
## Organizations Connections
22034+
22035+
<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationAllConnectionPost, Management.ListOrganizationAllConnectionsOffsetPaginatedResponseContent&gt;</code></summary>
22036+
<dl>
22037+
<dd>
22038+
22039+
#### 🔌 Usage
22040+
22041+
<dl>
22042+
<dd>
22043+
22044+
<dl>
22045+
<dd>
22046+
22047+
```typescript
22048+
const pageableResponse = await client.organizations.connections.list("id", {
22049+
page: 1,
22050+
per_page: 1,
22051+
include_totals: true,
22052+
is_enabled: true,
22053+
});
22054+
for await (const item of pageableResponse) {
22055+
console.log(item);
22056+
}
22057+
22058+
// Or you can manually iterate page-by-page
22059+
let page = await client.organizations.connections.list("id", {
22060+
page: 1,
22061+
per_page: 1,
22062+
include_totals: true,
22063+
is_enabled: true,
22064+
});
22065+
while (page.hasNextPage()) {
22066+
page = page.getNextPage();
22067+
}
22068+
22069+
// You can also access the underlying response
22070+
const response = page.response;
22071+
```
22072+
22073+
</dd>
22074+
</dl>
22075+
</dd>
22076+
</dl>
22077+
22078+
#### ⚙️ Parameters
22079+
22080+
<dl>
22081+
<dd>
22082+
22083+
<dl>
22084+
<dd>
22085+
22086+
**id:** `string` — Organization identifier.
22087+
22088+
</dd>
22089+
</dl>
22090+
22091+
<dl>
22092+
<dd>
22093+
22094+
**request:** `Management.ListOrganizationAllConnectionsRequestParameters`
22095+
22096+
</dd>
22097+
</dl>
22098+
22099+
<dl>
22100+
<dd>
22101+
22102+
**requestOptions:** `ConnectionsClient.RequestOptions`
22103+
22104+
</dd>
22105+
</dl>
22106+
</dd>
22107+
</dl>
22108+
22109+
</dd>
22110+
</dl>
22111+
</details>
22112+
22113+
<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateOrganizationAllConnectionResponseContent</code></summary>
22114+
<dl>
22115+
<dd>
22116+
22117+
#### 🔌 Usage
22118+
22119+
<dl>
22120+
<dd>
22121+
22122+
<dl>
22123+
<dd>
22124+
22125+
```typescript
22126+
await client.organizations.connections.create("id", {
22127+
connection_id: "connection_id",
22128+
});
22129+
```
22130+
22131+
</dd>
22132+
</dl>
22133+
</dd>
22134+
</dl>
22135+
22136+
#### ⚙️ Parameters
22137+
22138+
<dl>
22139+
<dd>
22140+
22141+
<dl>
22142+
<dd>
22143+
22144+
**id:** `string` — Organization identifier.
22145+
22146+
</dd>
22147+
</dl>
22148+
22149+
<dl>
22150+
<dd>
22151+
22152+
**request:** `Management.CreateOrganizationAllConnectionRequestParameters`
22153+
22154+
</dd>
22155+
</dl>
22156+
22157+
<dl>
22158+
<dd>
22159+
22160+
**requestOptions:** `ConnectionsClient.RequestOptions`
22161+
22162+
</dd>
22163+
</dl>
22164+
</dd>
22165+
</dl>
22166+
22167+
</dd>
22168+
</dl>
22169+
</details>
22170+
22171+
<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">get</a>(id, connection_id) -> Management.GetOrganizationAllConnectionResponseContent</code></summary>
22172+
<dl>
22173+
<dd>
22174+
22175+
#### 🔌 Usage
22176+
22177+
<dl>
22178+
<dd>
22179+
22180+
<dl>
22181+
<dd>
22182+
22183+
```typescript
22184+
await client.organizations.connections.get("id", "connection_id");
22185+
```
22186+
22187+
</dd>
22188+
</dl>
22189+
</dd>
22190+
</dl>
22191+
22192+
#### ⚙️ Parameters
22193+
22194+
<dl>
22195+
<dd>
22196+
22197+
<dl>
22198+
<dd>
22199+
22200+
**id:** `string` — Organization identifier.
22201+
22202+
</dd>
22203+
</dl>
22204+
22205+
<dl>
22206+
<dd>
22207+
22208+
**connection_id:** `string` — Connection identifier.
22209+
22210+
</dd>
22211+
</dl>
22212+
22213+
<dl>
22214+
<dd>
22215+
22216+
**requestOptions:** `ConnectionsClient.RequestOptions`
22217+
22218+
</dd>
22219+
</dl>
22220+
</dd>
22221+
</dl>
22222+
22223+
</dd>
22224+
</dl>
22225+
</details>
22226+
22227+
<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">delete</a>(id, connection_id) -> void</code></summary>
22228+
<dl>
22229+
<dd>
22230+
22231+
#### 🔌 Usage
22232+
22233+
<dl>
22234+
<dd>
22235+
22236+
<dl>
22237+
<dd>
22238+
22239+
```typescript
22240+
await client.organizations.connections.delete("id", "connection_id");
22241+
```
22242+
22243+
</dd>
22244+
</dl>
22245+
</dd>
22246+
</dl>
22247+
22248+
#### ⚙️ Parameters
22249+
22250+
<dl>
22251+
<dd>
22252+
22253+
<dl>
22254+
<dd>
22255+
22256+
**id:** `string` — Organization identifier.
22257+
22258+
</dd>
22259+
</dl>
22260+
22261+
<dl>
22262+
<dd>
22263+
22264+
**connection_id:** `string` — Connection identifier.
22265+
22266+
</dd>
22267+
</dl>
22268+
22269+
<dl>
22270+
<dd>
22271+
22272+
**requestOptions:** `ConnectionsClient.RequestOptions`
22273+
22274+
</dd>
22275+
</dl>
22276+
</dd>
22277+
</dl>
22278+
22279+
</dd>
22280+
</dl>
22281+
</details>
22282+
22283+
<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">update</a>(id, connection_id, { ...params }) -> Management.UpdateOrganizationAllConnectionResponseContent</code></summary>
22284+
<dl>
22285+
<dd>
22286+
22287+
#### 🔌 Usage
22288+
22289+
<dl>
22290+
<dd>
22291+
22292+
<dl>
22293+
<dd>
22294+
22295+
```typescript
22296+
await client.organizations.connections.update("id", "connection_id");
22297+
```
22298+
22299+
</dd>
22300+
</dl>
22301+
</dd>
22302+
</dl>
22303+
22304+
#### ⚙️ Parameters
22305+
22306+
<dl>
22307+
<dd>
22308+
22309+
<dl>
22310+
<dd>
22311+
22312+
**id:** `string` — Organization identifier.
22313+
22314+
</dd>
22315+
</dl>
22316+
22317+
<dl>
22318+
<dd>
22319+
22320+
**connection_id:** `string` — Connection identifier.
22321+
22322+
</dd>
22323+
</dl>
22324+
22325+
<dl>
22326+
<dd>
22327+
22328+
**request:** `Management.UpdateOrganizationConnectionRequestParameters`
22329+
22330+
</dd>
22331+
</dl>
22332+
22333+
<dl>
22334+
<dd>
22335+
22336+
**requestOptions:** `ConnectionsClient.RequestOptions`
22337+
22338+
</dd>
22339+
</dl>
22340+
</dd>
22341+
</dl>
22342+
22343+
</dd>
22344+
</dl>
22345+
</details>
22346+
2203322347
## Organizations DiscoveryDomains
2203422348

2203522349
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent&gt;</code></summary>

‎src/management/api/requests/requests.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3070,6 +3070,66 @@ export interface AssociateOrganizationClientGrantRequestContent {
30703070
grant_id: string;
30713071
}
30723072

3073+
/**
3074+
* @example
3075+
* {
3076+
* page: 1,
3077+
* per_page: 1,
3078+
* include_totals: true,
3079+
* is_enabled: true
3080+
* }
3081+
*/
3082+
export interface ListOrganizationAllConnectionsRequestParameters {
3083+
/** Page index of the results to return. First page is 0. */
3084+
page?: number | null;
3085+
/** Number of results per page. Defaults to 50. */
3086+
per_page?: number | null;
3087+
/** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
3088+
include_totals?: boolean | null;
3089+
/** Filter connections by enabled status. */
3090+
is_enabled?: boolean | null;
3091+
}
3092+
3093+
/**
3094+
* @example
3095+
* {
3096+
* connection_id: "connection_id"
3097+
* }
3098+
*/
3099+
export interface CreateOrganizationAllConnectionRequestParameters {
3100+
/** Name of the connection in the scope of this organization. */
3101+
organization_connection_name?: string;
3102+
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
3103+
assign_membership_on_login?: boolean;
3104+
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
3105+
show_as_button?: boolean;
3106+
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
3107+
is_signup_enabled?: boolean;
3108+
organization_access_level?: Management.OrganizationAccessLevelEnum;
3109+
/** Whether the connection is enabled for the organization. */
3110+
is_enabled?: boolean;
3111+
/** Connection identifier. */
3112+
connection_id: string;
3113+
}
3114+
3115+
/**
3116+
* @example
3117+
* {}
3118+
*/
3119+
export interface UpdateOrganizationConnectionRequestParameters {
3120+
/** Name of the connection in the scope of this organization. */
3121+
organization_connection_name?: string | null;
3122+
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
3123+
assign_membership_on_login?: boolean;
3124+
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
3125+
show_as_button?: boolean;
3126+
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
3127+
is_signup_enabled?: boolean;
3128+
organization_access_level?: Management.OrganizationAccessLevelEnumWithNull | null;
3129+
/** Whether the connection is enabled for the organization. */
3130+
is_enabled?: boolean | null;
3131+
}
3132+
30733133
/**
30743134
* @example
30753135
* {

0 commit comments

Comments
 (0)