Skip to content

Commit 6067e0e

Browse files
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.117.0
1 parent 16ee11e commit 6067e0e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+107
-100
lines changed

.eslintrc.yml

100755100644
File mode changed.

.gitattributes

100755100644
File mode changed.

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ yarn add @ding-live/ding
2121
## SDK Example Usage
2222

2323
<!-- Start SDK Example Usage -->
24-
## Send a code
24+
### Send a code
25+
2526
Send an OTP code to a user's phone number.
2627

28+
2729
```typescript
2830
import { Ding } from "@ding-live/ding";
2931
import { DeviceType } from "@ding-live/ding/dist/models/components";
@@ -33,8 +35,8 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
3335
apiKey: "YOUR_API_KEY",
3436
});
3537

36-
const res = await sdk.otp.createAutentication({
37-
customerUuid: "eae192ab-9e1e-4b21-b5b1-bfcb79a32fcc",
38+
const res = await sdk.otp.send({
39+
customerUuid: "82779012-9667-4917-8532-b94017ce3f0f",
3840
phoneNumber: "+1234567890",
3941
});
4042

@@ -45,10 +47,11 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
4547

4648
```
4749

50+
### Check a code
4851

49-
## Check a code
5052
Check that a code entered by a user is valid.
5153

54+
5255
```typescript
5356
import { Ding } from "@ding-live/ding";
5457

@@ -70,10 +73,11 @@ import { Ding } from "@ding-live/ding";
7073

7174
```
7275

76+
### Retry an authentication
7377

74-
## Retry an authentication
7578
Retry an authentication if a user has not received the code.
7679

80+
7781
```typescript
7882
import { Ding } from "@ding-live/ding";
7983

@@ -102,8 +106,8 @@ import { Ding } from "@ding-live/ding";
102106
### [otp](docs/sdks/otp/README.md)
103107

104108
* [check](docs/sdks/otp/README.md#check) - Check an authentication code
105-
* [createAutentication](docs/sdks/otp/README.md#createautentication) - Create an authentication
106109
* [retry](docs/sdks/otp/README.md#retry) - Retry an authentication
110+
* [send](docs/sdks/otp/README.md#send) - Create an authentication
107111

108112
### [lookup](docs/sdks/lookup/README.md)
109113

@@ -115,7 +119,7 @@ import { Ding } from "@ding-live/ding";
115119
<!-- End Dev Containers -->
116120

117121
<!-- Start Error Handling -->
118-
# Error Handling
122+
## Error Handling
119123

120124
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.
121125

@@ -124,9 +128,7 @@ Handling errors in this SDK should largely match your expectations. All operati
124128
| errors.ErrorResponse | 400 | application/json |
125129
| errors.SDKError | 400-600 | */* |
126130

127-
128-
## Check a code
129-
Check that a code entered by a user is valid.
131+
Example
130132

131133
```typescript
132134
import { Ding } from "@ding-live/ding";
@@ -158,11 +160,10 @@ import { Ding } from "@ding-live/ding";
158160
<!-- End Error Handling -->
159161
160162
<!-- Start Custom HTTP Client -->
161-
# Custom HTTP Client
163+
## Custom HTTP Client
162164
163165
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.
164166
165-
166167
For example, you could specify a header for every request that your sdk makes as follows:
167168
168169
```typescript
@@ -173,15 +174,14 @@ const httpClient = axios.create({
173174
headers: {'x-custom-header': 'someValue'}
174175
})
175176

176-
177177
const sdk = new Ding({defaultClient: httpClient});
178178
```
179179
<!-- End Custom HTTP Client -->
180180
181181
<!-- Start Authentication -->
182-
# Authentication
182+
## Authentication
183183
184-
## Per-Client Security Schemes
184+
### Per-Client Security Schemes
185185
186186
This SDK supports the following security scheme globally:
187187
@@ -190,9 +190,6 @@ This SDK supports the following security scheme globally:
190190
| `apiKey` | apiKey | API key |
191191
192192
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
193-
## Check a code
194-
Check that a code entered by a user is valid.
195-
196193
```typescript
197194
import { Ding } from "@ding-live/ding";
198195

@@ -218,19 +215,16 @@ import { Ding } from "@ding-live/ding";
218215
219216
220217
<!-- Start Server Selection -->
221-
# Server Selection
218+
## Server Selection
222219
223-
## Select Server by Name
220+
### Select Server by Name
224221
225222
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:
226223
227224
| Name | Server | Variables |
228225
| ----- | ------ | --------- |
229226
| `production` | `https://api.ding.live/v1` | None |
230-
231-
For example:
232-
## Check a code
233-
Check that a code entered by a user is valid.
227+
#### Example
234228

235229
```typescript
236230
import { Ding } from "@ding-live/ding";
@@ -255,12 +249,9 @@ import { Ding } from "@ding-live/ding";
255249
```
256250

257251

258-
## Override Server URL Per-Client
252+
### Override Server URL Per-Client
259253

260254
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:
261-
## Check a code
262-
Check that a code entered by a user is valid.
263-
264255
```typescript
265256
import { Ding } from "@ding-live/ding";
266257

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,14 @@ Based on:
1616
### Generated
1717
- [typescript v0.2.0] .
1818
### Releases
19-
- [NPM v0.2.0] https://www.npmjs.com/package/@ding-live/ding/v/0.2.0 - .
19+
- [NPM v0.2.0] https://www.npmjs.com/package/@ding-live/ding/v/0.2.0 - .
20+
21+
## 2023-11-09 12:57:00
22+
### Changes
23+
Based on:
24+
- OpenAPI Doc 1.0.0
25+
- Speakeasy CLI 1.117.0 (2.186.4) https://github.com/speakeasy-api/speakeasy
26+
### Generated
27+
- [typescript v0.2.1] .
28+
### Releases
29+
- [NPM v0.2.1] https://www.npmjs.com/package/@ding-live/ding/v/0.2.1 - .

USAGE.md

100755100644
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
<!-- Start SDK Example Usage -->
2+
### Send a code
23

3-
## Send a code
44
Send an OTP code to a user's phone number.
55

6+
67
```typescript
78
import { Ding } from "@ding-live/ding";
89
import { DeviceType } from "@ding-live/ding/dist/models/components";
@@ -12,8 +13,8 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
1213
apiKey: "YOUR_API_KEY",
1314
});
1415

15-
const res = await sdk.otp.createAutentication({
16-
customerUuid: "eae192ab-9e1e-4b21-b5b1-bfcb79a32fcc",
16+
const res = await sdk.otp.send({
17+
customerUuid: "82779012-9667-4917-8532-b94017ce3f0f",
1718
phoneNumber: "+1234567890",
1819
});
1920

@@ -24,10 +25,11 @@ import { DeviceType } from "@ding-live/ding/dist/models/components";
2425

2526
```
2627

28+
### Check a code
2729

28-
## Check a code
2930
Check that a code entered by a user is valid.
3031

32+
3133
```typescript
3234
import { Ding } from "@ding-live/ding";
3335

@@ -49,10 +51,11 @@ import { Ding } from "@ding-live/ding";
4951

5052
```
5153

54+
### Retry an authentication
5255

53-
## Retry an authentication
5456
Retry an authentication if a user has not received the code.
5557

58+
5659
```typescript
5760
import { Ding } from "@ding-live/ding";
5861

docs/models/components/createauthenticationrequest.md

100755100644
File mode changed.

docs/models/components/createauthenticationresponse.md

100755100644
File mode changed.

docs/models/components/createcheckrequest.md

100755100644
File mode changed.

docs/models/components/createcheckresponse.md

100755100644
File mode changed.

docs/models/components/createcheckresponsestatus.md

100755100644
File mode changed.

0 commit comments

Comments
 (0)