ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.117.0

ding-live · Nov 9, 2023 · 6067e0e · 6067e0e
1 parent 16ee11e
commit 6067e0e
Show file tree

Hide file tree

Showing 69 changed files with 107 additions and 100 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
diff --git a/.gitattributes b/.gitattributes
diff --git a/README.md b/README.md
@@ -21,9 +21,11 @@ yarn add @ding-live/ding
 ## SDK Example Usage
 
 <!-- Start SDK Example Usage -->
-## Send a code
+### Send a code
+
 Send an OTP code to a user's phone number.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 import { DeviceType } from "@ding-live/ding/dist/models/components";
@@ -33,8 +35,8 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
         apiKey: "YOUR_API_KEY",
     });
 
-    const res = await sdk.otp.createAutentication({
-        customerUuid: "eae192ab-9e1e-4b21-b5b1-bfcb79a32fcc",
+    const res = await sdk.otp.send({
+        customerUuid: "82779012-9667-4917-8532-b94017ce3f0f",
         phoneNumber: "+1234567890",
     });
 
@@ -45,10 +47,11 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
 
 ```
 
+### Check a code
 
-## Check a code
 Check that a code entered by a user is valid.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 
@@ -70,10 +73,11 @@ import { Ding } from "@ding-live/ding";
 
 ```
 
+### Retry an authentication
 
-## Retry an authentication
 Retry an authentication if a user has not received the code.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 
@@ -102,8 +106,8 @@ import { Ding } from "@ding-live/ding";
 ### [otp](docs/sdks/otp/README.md)
 
 * [check](docs/sdks/otp/README.md#check) - Check an authentication code
-* [createAutentication](docs/sdks/otp/README.md#createautentication) - Create an authentication
 * [retry](docs/sdks/otp/README.md#retry) - Retry an authentication
+* [send](docs/sdks/otp/README.md#send) - Create an authentication
 
 ### [lookup](docs/sdks/lookup/README.md)
 
@@ -115,7 +119,7 @@ import { Ding } from "@ding-live/ding";
 <!-- End Dev Containers -->
 
 <!-- Start Error Handling -->
-# Error Handling
+## Error Handling
 
 Handling errors in this SDK should largely match your expectations.  All operations return a response object or throw an error.  If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
 
@@ -124,9 +128,7 @@ Handling errors in this SDK should largely match your expectations.  All operati
 | errors.ErrorResponse | 400                  | application/json     |
 | errors.SDKError      | 400-600              | */*                  |
 
-
-## Check a code
-Check that a code entered by a user is valid.
+Example
 
 ```typescript
 import { Ding } from "@ding-live/ding";
@@ -158,11 +160,10 @@ import { Ding } from "@ding-live/ding";
 <!-- End Error Handling -->
 
 <!-- Start Custom HTTP Client -->
-# Custom HTTP Client
+## Custom HTTP Client
 
 The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
 
-
 For example, you could specify a header for every request that your sdk makes as follows:
 
 ```typescript
@@ -173,15 +174,14 @@ const httpClient = axios.create({
     headers: {'x-custom-header': 'someValue'}
 })
 
-
 const sdk = new Ding({defaultClient: httpClient});
 ```
 <!-- End Custom HTTP Client -->
 
 <!-- Start Authentication -->
-# Authentication
+## Authentication
 
-## Per-Client Security Schemes
+### Per-Client Security Schemes
 
 This SDK supports the following security scheme globally:
 
@@ -190,9 +190,6 @@ This SDK supports the following security scheme globally:
 | `apiKey` | apiKey   | API key  |
 
 To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
-## Check a code
-Check that a code entered by a user is valid.
-
 ```typescript
 import { Ding } from "@ding-live/ding";
 
@@ -218,19 +215,16 @@ import { Ding } from "@ding-live/ding";
 
 
 <!-- Start Server Selection -->
-# Server Selection
+## Server Selection
 
-## Select Server by Name
+### Select Server by Name
 
 You can override the default server globally by passing a server name to the `server: string` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
 
 | Name | Server | Variables |
 | ----- | ------ | --------- |
 | `production` | `https://api.ding.live/v1` | None |
-
-For example:
-## Check a code
-Check that a code entered by a user is valid.
+#### Example
 
 ```typescript
 import { Ding } from "@ding-live/ding";
@@ -255,12 +249,9 @@ import { Ding } from "@ding-live/ding";
 ```
 
 
-## Override Server URL Per-Client
+### Override Server URL Per-Client
 
 The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
-## Check a code
-Check that a code entered by a user is valid.
-
 ```typescript
 import { Ding } from "@ding-live/ding";
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -16,4 +16,14 @@ Based on:
 ### Generated
 - [typescript v0.2.0] .
 ### Releases
-- [NPM v0.2.0] https://www.npmjs.com/package/@ding-live/ding/v/0.2.0 - .
+- [NPM v0.2.0] https://www.npmjs.com/package/@ding-live/ding/v/0.2.0 - .
+
+## 2023-11-09 12:57:00
+### Changes
+Based on:
+- OpenAPI Doc 1.0.0 
+- Speakeasy CLI 1.117.0 (2.186.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.1] .
+### Releases
+- [NPM v0.2.1] https://www.npmjs.com/package/@ding-live/ding/v/0.2.1 - .
diff --git a/USAGE.md b/USAGE.md
@@ -1,8 +1,9 @@
 <!-- Start SDK Example Usage -->
+### Send a code
 
-## Send a code
 Send an OTP code to a user's phone number.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 import { DeviceType } from "@ding-live/ding/dist/models/components";
@@ -12,8 +13,8 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
         apiKey: "YOUR_API_KEY",
     });
 
-    const res = await sdk.otp.createAutentication({
-        customerUuid: "eae192ab-9e1e-4b21-b5b1-bfcb79a32fcc",
+    const res = await sdk.otp.send({
+        customerUuid: "82779012-9667-4917-8532-b94017ce3f0f",
         phoneNumber: "+1234567890",
     });
 
@@ -24,10 +25,11 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
 
 ```
 
+### Check a code
 
-## Check a code
 Check that a code entered by a user is valid.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 
@@ -49,10 +51,11 @@ import { Ding } from "@ding-live/ding";
 
 ```
 
+### Retry an authentication
 
-## Retry an authentication
 Retry an authentication if a user has not received the code.
 
+
 ```typescript
 import { Ding } from "@ding-live/ding";
 

diff --git a/docs/models/components/createauthenticationrequest.md b/docs/models/components/createauthenticationrequest.md
diff --git a/docs/models/components/createauthenticationresponse.md b/docs/models/components/createauthenticationresponse.md
diff --git a/docs/models/components/createcheckrequest.md b/docs/models/components/createcheckrequest.md
diff --git a/docs/models/components/createcheckresponse.md b/docs/models/components/createcheckresponse.md
diff --git a/docs/models/components/createcheckresponsestatus.md b/docs/models/components/createcheckresponsestatus.md
diff --git a/docs/models/components/devicetype.md b/docs/models/components/devicetype.md
diff --git a/docs/models/components/linetype.md b/docs/models/components/linetype.md
diff --git a/docs/models/components/lookuprequest.md b/docs/models/components/lookuprequest.md
diff --git a/docs/models/components/lookupresponse.md b/docs/models/components/lookupresponse.md
diff --git a/docs/models/components/retryauthenticationrequest.md b/docs/models/components/retryauthenticationrequest.md
diff --git a/docs/models/components/retryauthenticationresponse.md b/docs/models/components/retryauthenticationresponse.md
diff --git a/docs/models/components/retryauthenticationresponsestatus.md b/docs/models/components/retryauthenticationresponsestatus.md
diff --git a/docs/models/components/security.md b/docs/models/components/security.md
diff --git a/docs/models/components/status.md b/docs/models/components/status.md
diff --git a/docs/models/errors/code.md b/docs/models/errors/code.md
diff --git a/docs/models/errors/errorresponse.md b/docs/models/errors/errorresponse.md
diff --git a/docs/models/operations/checkresponse.md b/docs/models/operations/checkresponse.md
diff --git a/docs/models/operations/createautenticationresponse.md b/docs/models/operations/createautenticationresponse.md
diff --git a/docs/models/operations/lookuprequest.md b/docs/models/operations/lookuprequest.md
diff --git a/docs/models/operations/lookupresponse.md b/docs/models/operations/lookupresponse.md
diff --git a/docs/models/operations/retryresponse.md b/docs/models/operations/retryresponse.md
diff --git a/docs/sdks/ding/README.md b/docs/sdks/ding/README.md
diff --git a/docs/sdks/lookup/README.md b/docs/sdks/lookup/README.md
diff --git a/docs/sdks/otp/README.md b/docs/sdks/otp/README.md
@@ -8,8 +8,8 @@ Send OTP codes to your users using their phone numbers.
 ### Available Operations
 
 * [check](#check) - Check an authentication code
-* [createAutentication](#createautentication) - Create an authentication
 * [retry](#retry) - Retry an authentication
+* [send](#send) - Create an authentication
 
 ## check
 
@@ -55,24 +55,23 @@ import { Ding } from "@ding-live/ding";
 | errors.ErrorResponse | 400                  | application/json     |
 | errors.SDKError      | 400-600              | */*                  |
 
-## createAutentication
+## retry
 
-Create an authentication
+Retry an authentication
 
 ### Example Usage
 
 ```typescript
 import { Ding } from "@ding-live/ding";
-import { DeviceType } from "@ding-live/ding/dist/models/components";
 
 (async() => {
   const sdk = new Ding({
     apiKey: "YOUR_API_KEY",
   });
 
-  const res = await sdk.otp.createAutentication({
-    customerUuid: "eae192ab-9e1e-4b21-b5b1-bfcb79a32fcc",
-    phoneNumber: "+1234567890",
+  const res = await sdk.otp.retry({
+    authenticationUuid: "a74ee547-564d-487a-91df-37fb25413a91",
+    customerUuid: "3c8b3a46-881e-4cdd-93a6-f7f238bf020a",
   });
 
   if (res.statusCode == 200) {
@@ -83,39 +82,40 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
 
 ### Parameters
 
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [components.CreateAuthenticationRequest](../../models/components/createauthenticationrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
+| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `request`                                                                                      | [components.RetryAuthenticationRequest](../../models/components/retryauthenticationrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
+| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
 
 
 ### Response
 
-**Promise<[operations.CreateAutenticationResponse](../../models/operations/createautenticationresponse.md)>**
+**Promise<[operations.RetryResponse](../../models/operations/retryresponse.md)>**
 ### Errors
 
 | Error Object         | Status Code          | Content Type         |
 | -------------------- | -------------------- | -------------------- |
 | errors.ErrorResponse | 400                  | application/json     |
 | errors.SDKError      | 400-600              | */*                  |
 
-## retry
+## send
 
-Retry an authentication
+Create an authentication
 
 ### Example Usage
 
 ```typescript
 import { Ding } from "@ding-live/ding";
+import { DeviceType } from "@ding-live/ding/dist/models/components";
 
 (async() => {
   const sdk = new Ding({
     apiKey: "YOUR_API_KEY",
   });
 
-  const res = await sdk.otp.retry({
-    authenticationUuid: "a74ee547-564d-487a-91df-37fb25413a91",
-    customerUuid: "3c8b3a46-881e-4cdd-93a6-f7f238bf020a",
+  const res = await sdk.otp.send({
+    customerUuid: "82779012-9667-4917-8532-b94017ce3f0f",
+    phoneNumber: "+1234567890",
   });
 
   if (res.statusCode == 200) {
@@ -126,15 +126,15 @@ import { Ding } from "@ding-live/ding";
 
 ### Parameters
 
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [components.RetryAuthenticationRequest](../../models/components/retryauthenticationrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
-| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
+| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `request`                                                                                        | [components.CreateAuthenticationRequest](../../models/components/createauthenticationrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
+| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
 
 
 ### Response
 
-**Promise<[operations.RetryResponse](../../models/operations/retryresponse.md)>**
+**Promise<[operations.CreateAutenticationResponse](../../models/operations/createautenticationresponse.md)>**
 ### Errors
 
 | Error Object         | Status Code          | Content Type         |

diff --git a/files.gen b/files.gen
@@ -21,15 +21,15 @@ src/types/index.ts
 src/types/rfcdate.ts
 tsconfig.json
 src/models/operations/check.ts
-src/models/operations/createautentication.ts
 src/models/operations/retry.ts
+src/models/operations/createautentication.ts
 src/models/operations/lookup.ts
 src/models/components/createcheckresponse.ts
 src/models/components/createcheckrequest.ts
-src/models/components/createauthenticationresponse.ts
-src/models/components/createauthenticationrequest.ts
 src/models/components/retryauthenticationresponse.ts
 src/models/components/retryauthenticationrequest.ts
+src/models/components/createauthenticationresponse.ts
+src/models/components/createauthenticationrequest.ts
 src/models/components/lookupresponse.ts
 src/models/components/lookuprequest.ts
 src/models/components/security.ts
@@ -39,20 +39,20 @@ src/models/operations/index.ts
 src/models/components/index.ts
 USAGE.md
 docs/models/operations/checkresponse.md
-docs/models/operations/createautenticationresponse.md
 docs/models/operations/retryresponse.md
+docs/models/operations/createautenticationresponse.md
 docs/models/operations/lookuprequest.md
 docs/models/operations/lookupresponse.md
 docs/models/components/createcheckresponsestatus.md
 docs/models/components/createcheckresponse.md
 docs/models/components/createcheckrequest.md
+docs/models/components/retryauthenticationresponsestatus.md
+docs/models/components/retryauthenticationresponse.md
+docs/models/components/retryauthenticationrequest.md
 docs/models/components/status.md
 docs/models/components/createauthenticationresponse.md
 docs/models/components/devicetype.md
 docs/models/components/createauthenticationrequest.md
-docs/models/components/retryauthenticationresponsestatus.md
-docs/models/components/retryauthenticationresponse.md
-docs/models/components/retryauthenticationrequest.md
 docs/models/components/linetype.md
 docs/models/components/lookupresponse.md
 docs/models/components/lookuprequest.md