Skip to content

Commit 1b2a5aa

Browse files
fern-api[bot]developerkunal
fern-api[bot]
and
developerkunal
authored
feat: Add organization discovery domains support (#1225)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Kunal Dawar <[email protected]>
1 parent 36456f8 commit 1b2a5aa

15 files changed

+1619
-0
lines changed

‎reference.md‎

Lines changed: 385 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18939,6 +18939,391 @@ await client.organizations.clientGrants.delete("id", "grant_id");
1893918939
</dl>
1894018940
</details>
1894118941

18942+
## Organizations DiscoveryDomains
18943+
18944+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">list</a>(id, { ...params }) -> core.Page<Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent></code></summary>
18945+
<dl>
18946+
<dd>
18947+
18948+
#### 📝 Description
18949+
18950+
<dl>
18951+
<dd>
18952+
18953+
<dl>
18954+
<dd>
18955+
18956+
Retrieve list of all organization discovery domains associated with the specified organization.
18957+
18958+
</dd>
18959+
</dl>
18960+
</dd>
18961+
</dl>
18962+
18963+
#### 🔌 Usage
18964+
18965+
<dl>
18966+
<dd>
18967+
18968+
<dl>
18969+
<dd>
18970+
18971+
```typescript
18972+
const pageableResponse = await client.organizations.discoveryDomains.list("id", {
18973+
from: "from",
18974+
take: 1,
18975+
});
18976+
for await (const item of pageableResponse) {
18977+
console.log(item);
18978+
}
18979+
18980+
// Or you can manually iterate page-by-page
18981+
let page = await client.organizations.discoveryDomains.list("id", {
18982+
from: "from",
18983+
take: 1,
18984+
});
18985+
while (page.hasNextPage()) {
18986+
page = page.getNextPage();
18987+
}
18988+
18989+
// You can also access the underlying response
18990+
const response = page.response;
18991+
```
18992+
18993+
</dd>
18994+
</dl>
18995+
</dd>
18996+
</dl>
18997+
18998+
#### ⚙️ Parameters
18999+
19000+
<dl>
19001+
<dd>
19002+
19003+
<dl>
19004+
<dd>
19005+
19006+
**id:** `string` — ID of the organization.
19007+
19008+
</dd>
19009+
</dl>
19010+
19011+
<dl>
19012+
<dd>
19013+
19014+
**request:** `Management.ListOrganizationDiscoveryDomainsRequestParameters`
19015+
19016+
</dd>
19017+
</dl>
19018+
19019+
<dl>
19020+
<dd>
19021+
19022+
**requestOptions:** `DiscoveryDomains.RequestOptions`
19023+
19024+
</dd>
19025+
</dl>
19026+
</dd>
19027+
</dl>
19028+
19029+
</dd>
19030+
</dl>
19031+
</details>
19032+
19033+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateOrganizationDiscoveryDomainResponseContent</code></summary>
19034+
<dl>
19035+
<dd>
19036+
19037+
#### 📝 Description
19038+
19039+
<dl>
19040+
<dd>
19041+
19042+
<dl>
19043+
<dd>
19044+
19045+
Update the verification status for an organization discovery domain. The <code>status</code> field must be either <code>pending</code> or <code>verified</code>.
19046+
19047+
</dd>
19048+
</dl>
19049+
</dd>
19050+
</dl>
19051+
19052+
#### 🔌 Usage
19053+
19054+
<dl>
19055+
<dd>
19056+
19057+
<dl>
19058+
<dd>
19059+
19060+
```typescript
19061+
await client.organizations.discoveryDomains.create("id", {
19062+
domain: "domain",
19063+
});
19064+
```
19065+
19066+
</dd>
19067+
</dl>
19068+
</dd>
19069+
</dl>
19070+
19071+
#### ⚙️ Parameters
19072+
19073+
<dl>
19074+
<dd>
19075+
19076+
<dl>
19077+
<dd>
19078+
19079+
**id:** `string` — ID of the organization.
19080+
19081+
</dd>
19082+
</dl>
19083+
19084+
<dl>
19085+
<dd>
19086+
19087+
**request:** `Management.CreateOrganizationDiscoveryDomainRequestContent`
19088+
19089+
</dd>
19090+
</dl>
19091+
19092+
<dl>
19093+
<dd>
19094+
19095+
**requestOptions:** `DiscoveryDomains.RequestOptions`
19096+
19097+
</dd>
19098+
</dl>
19099+
</dd>
19100+
</dl>
19101+
19102+
</dd>
19103+
</dl>
19104+
</details>
19105+
19106+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">get</a>(id, discoveryDomainId) -> Management.GetOrganizationDiscoveryDomainResponseContent</code></summary>
19107+
<dl>
19108+
<dd>
19109+
19110+
#### 📝 Description
19111+
19112+
<dl>
19113+
<dd>
19114+
19115+
<dl>
19116+
<dd>
19117+
19118+
Retrieve details about a single organization discovery domain specified by ID.
19119+
19120+
</dd>
19121+
</dl>
19122+
</dd>
19123+
</dl>
19124+
19125+
#### 🔌 Usage
19126+
19127+
<dl>
19128+
<dd>
19129+
19130+
<dl>
19131+
<dd>
19132+
19133+
```typescript
19134+
await client.organizations.discoveryDomains.get("id", "discovery_domain_id");
19135+
```
19136+
19137+
</dd>
19138+
</dl>
19139+
</dd>
19140+
</dl>
19141+
19142+
#### ⚙️ Parameters
19143+
19144+
<dl>
19145+
<dd>
19146+
19147+
<dl>
19148+
<dd>
19149+
19150+
**id:** `string` — ID of the organization.
19151+
19152+
</dd>
19153+
</dl>
19154+
19155+
<dl>
19156+
<dd>
19157+
19158+
**discoveryDomainId:** `string` — ID of the discovery domain.
19159+
19160+
</dd>
19161+
</dl>
19162+
19163+
<dl>
19164+
<dd>
19165+
19166+
**requestOptions:** `DiscoveryDomains.RequestOptions`
19167+
19168+
</dd>
19169+
</dl>
19170+
</dd>
19171+
</dl>
19172+
19173+
</dd>
19174+
</dl>
19175+
</details>
19176+
19177+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">delete</a>(id, discoveryDomainId) -> void</code></summary>
19178+
<dl>
19179+
<dd>
19180+
19181+
#### 📝 Description
19182+
19183+
<dl>
19184+
<dd>
19185+
19186+
<dl>
19187+
<dd>
19188+
19189+
Remove a discovery domain from an organization. This action cannot be undone.
19190+
19191+
</dd>
19192+
</dl>
19193+
</dd>
19194+
</dl>
19195+
19196+
#### 🔌 Usage
19197+
19198+
<dl>
19199+
<dd>
19200+
19201+
<dl>
19202+
<dd>
19203+
19204+
```typescript
19205+
await client.organizations.discoveryDomains.delete("id", "discovery_domain_id");
19206+
```
19207+
19208+
</dd>
19209+
</dl>
19210+
</dd>
19211+
</dl>
19212+
19213+
#### ⚙️ Parameters
19214+
19215+
<dl>
19216+
<dd>
19217+
19218+
<dl>
19219+
<dd>
19220+
19221+
**id:** `string` — ID of the organization.
19222+
19223+
</dd>
19224+
</dl>
19225+
19226+
<dl>
19227+
<dd>
19228+
19229+
**discoveryDomainId:** `string` — ID of the discovery domain.
19230+
19231+
</dd>
19232+
</dl>
19233+
19234+
<dl>
19235+
<dd>
19236+
19237+
**requestOptions:** `DiscoveryDomains.RequestOptions`
19238+
19239+
</dd>
19240+
</dl>
19241+
</dd>
19242+
</dl>
19243+
19244+
</dd>
19245+
</dl>
19246+
</details>
19247+
19248+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">update</a>(id, discoveryDomainId, { ...params }) -> Management.UpdateOrganizationDiscoveryDomainResponseContent</code></summary>
19249+
<dl>
19250+
<dd>
19251+
19252+
#### 📝 Description
19253+
19254+
<dl>
19255+
<dd>
19256+
19257+
<dl>
19258+
<dd>
19259+
19260+
Update the verification status for an organization discovery domain. The <code>status</code> field must be either <code>pending</code> or <code>verified</code>.
19261+
19262+
</dd>
19263+
</dl>
19264+
</dd>
19265+
</dl>
19266+
19267+
#### 🔌 Usage
19268+
19269+
<dl>
19270+
<dd>
19271+
19272+
<dl>
19273+
<dd>
19274+
19275+
```typescript
19276+
await client.organizations.discoveryDomains.update("id", "discovery_domain_id");
19277+
```
19278+
19279+
</dd>
19280+
</dl>
19281+
</dd>
19282+
</dl>
19283+
19284+
#### ⚙️ Parameters
19285+
19286+
<dl>
19287+
<dd>
19288+
19289+
<dl>
19290+
<dd>
19291+
19292+
**id:** `string` — ID of the organization.
19293+
19294+
</dd>
19295+
</dl>
19296+
19297+
<dl>
19298+
<dd>
19299+
19300+
**discoveryDomainId:** `string` — ID of the discovery domain to update.
19301+
19302+
</dd>
19303+
</dl>
19304+
19305+
<dl>
19306+
<dd>
19307+
19308+
**request:** `Management.UpdateOrganizationDiscoveryDomainRequestContent`
19309+
19310+
</dd>
19311+
</dl>
19312+
19313+
<dl>
19314+
<dd>
19315+
19316+
**requestOptions:** `DiscoveryDomains.RequestOptions`
19317+
19318+
</dd>
19319+
</dl>
19320+
</dd>
19321+
</dl>
19322+
19323+
</dd>
19324+
</dl>
19325+
</details>
19326+
1894219327
## Organizations EnabledConnections
1894319328

1894419329
<details><summary><code>client.organizations.enabledConnections.<a href="/src/management/api/resources/organizations/resources/enabledConnections/client/Client.ts">list</a>(id, { ...params }) -> core.Page<Management.OrganizationConnection, Management.ListOrganizationConnectionsOffsetPaginatedResponseContent></code></summary>

0 commit comments

Comments
 (0)