SDK regeneration (#8)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
ssoready · Aug 13, 2024 · a170e91 · a170e91
1 parent 98ec75c
commit a170e91
Show file tree

Hide file tree

Showing 31 changed files with 1,063 additions and 305 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ssoready",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "private": false,
     "repository": "https://github.com/ssoready/ssoready-typescript",
     "license": "MIT",

diff --git a/reference.md b/reference.md
@@ -6,7 +6,7 @@
 
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
 
 <dl>
 
@@ -16,16 +16,61 @@
 
 <dd>
 
-Exchange a SAML access code for details about a SAML login.
+```ts
+await ssoReady.saml.redeemSamlAccessCode({
+    samlAccessCode: "saml_access_code_...",
+});
+```
+
+</dd>
+
+</dl>
 
 </dd>
 
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `SSOReady.RedeemSamlAccessCodeRequest`**
+
 </dd>
 
 </dl>
 
+<dl>
+
+<dd>
+
+**requestOptions: `Saml.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>ssoReady.saml.<a href="./src/api/resources/saml/client/Client.ts">getSamlRedirectUrl</a>({ ...params }) -> SSOReady.GetSamlRedirectUrlResponse</code> </summary>
+
+<dl>
+
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -37,8 +82,8 @@ Exchange a SAML access code for details about a SAML login.
 <dd>
 
 ```ts
-await ssoReady.saml.redeemSamlAccessCode({
-    samlAccessCode: "saml_access_code_...",
+await ssoReady.saml.getSamlRedirectUrl({
+    organizationExternalId: "my_custom_external_id",
 });
 ```
 
@@ -60,7 +105,7 @@ await ssoReady.saml.redeemSamlAccessCode({
 
 <dd>
 
-**request: `SSOReady.RedeemSamlAccessCodeRequest`**
+**request: `SSOReady.GetSamlRedirectUrlRequest`**
 
 </dd>
 
@@ -85,13 +130,15 @@ await ssoReady.saml.redeemSamlAccessCode({
 </dl>
 </details>
 
-<details><summary> <code>ssoReady.saml.<a href="./src/api/resources/saml/client/Client.ts">getSamlRedirectUrl</a>({ ...params }) -> SSOReady.GetSamlRedirectUrlResponse</code> </summary>
+## Scim
+
+<details><summary> <code>ssoReady.scim.<a href="./src/api/resources/scim/client/Client.ts">listScimGroups</a>({ ...params }) -> SSOReady.ListScimGroupsResponse</code> </summary>
 
 <dl>
 
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
 
 <dl>
 
@@ -101,16 +148,61 @@ await ssoReady.saml.redeemSamlAccessCode({
 
 <dd>
 
-Get a URL to initiate a SAML login.
+```ts
+await ssoReady.scim.listScimGroups({
+    organizationExternalId: "my_custom_external_id",
+});
+```
+
+</dd>
+
+</dl>
 
 </dd>
 
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `SSOReady.ScimListScimGroupsRequest`**
+
 </dd>
 
 </dl>
 
+<dl>
+
+<dd>
+
+**requestOptions: `Scim.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>ssoReady.scim.<a href="./src/api/resources/scim/client/Client.ts">getScimGroup</a>(id) -> SSOReady.GetScimGroupResponse</code> </summary>
+
+<dl>
+
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -122,7 +214,70 @@ Get a URL to initiate a SAML login.
 <dd>
 
 ```ts
-await ssoReady.saml.getSamlRedirectUrl({
+await ssoReady.scim.getScimGroup("scim_group_...");
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**id: `string`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `Scim.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>ssoReady.scim.<a href="./src/api/resources/scim/client/Client.ts">listScimUsers</a>({ ...params }) -> SSOReady.ListScimUsersResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await ssoReady.scim.listScimUsers({
     organizationExternalId: "my_custom_external_id",
 });
 ```
@@ -145,7 +300,7 @@ await ssoReady.saml.getSamlRedirectUrl({
 
 <dd>
 
-**request: `SSOReady.GetSamlRedirectUrlRequest`**
+**request: `SSOReady.ScimListScimUsersRequest`**
 
 </dd>
 
@@ -155,7 +310,70 @@ await ssoReady.saml.getSamlRedirectUrl({
 
 <dd>
 
-**requestOptions: `Saml.RequestOptions`**
+**requestOptions: `Scim.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>ssoReady.scim.<a href="./src/api/resources/scim/client/Client.ts">getScimUser</a>(id) -> SSOReady.GetScimUserResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await ssoReady.scim.getScimUser("scim_user_...");
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**id: `string`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `Scim.RequestOptions`**
 
 </dd>
 

diff --git a/src/Client.ts b/src/Client.ts
@@ -5,6 +5,7 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Saml } from "./api/resources/saml/client/Client";
+import { Scim } from "./api/resources/scim/client/Client";
 
 export declare namespace SSOReadyClient {
     interface Options {
@@ -27,4 +28,10 @@ export class SSOReadyClient {
     public get saml(): Saml {
         return (this._saml ??= new Saml(this._options));
     }
+
+    protected _scim: Scim | undefined;
+
+    public get scim(): Scim {
+        return (this._scim ??= new Scim(this._options));
+    }
 }
diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts
@@ -1,2 +1,4 @@
 export * as saml from "./saml";
+export * as scim from "./scim";
 export * from "./saml/client/requests";
+export * from "./scim/client/requests";
diff --git a/src/api/resources/saml/client/Client.ts b/src/api/resources/saml/client/Client.ts
@@ -26,8 +26,6 @@ export class Saml {
     constructor(protected readonly _options: Saml.Options = {}) {}
 
     /**
-     * Exchange a SAML access code for details about a SAML login.
-     *
      * @param {SSOReady.RedeemSamlAccessCodeRequest} request
      * @param {Saml.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -50,7 +48,7 @@ export class Saml {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "ssoready",
-                "X-Fern-SDK-Version": "1.0.0",
+                "X-Fern-SDK-Version": "1.0.1",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -94,8 +92,6 @@ export class Saml {
     }
 
     /**
-     * Get a URL to initiate a SAML login.
-     *
      * @param {SSOReady.GetSamlRedirectUrlRequest} request
      * @param {Saml.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -118,7 +114,7 @@ export class Saml {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "ssoready",
-                "X-Fern-SDK-Version": "1.0.0",
+                "X-Fern-SDK-Version": "1.0.1",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },