The Ding Typescript library provides convenient access to the Ding API from applications written in JS or TS.
npm add @ding-live/ding
yarn add @ding-live/ding
Send an OTP code to a user's phone number.
import { Ding } from "@ding-live/ding";
import { DeviceType } from "@ding-live/ding/dist/models/components";
async function run() {
const sdk = new Ding({
apiKey: "YOUR_API_KEY",
});
const res = await sdk.otp.createAuthentication({
customerUuid: "c9f826e0-deca-41ec-871f-ecd6e8efeb46",
phoneNumber: "+1234567890",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Check that a code entered by a user is valid.
import { Ding } from "@ding-live/ding";
async function run() {
const sdk = new Ding({
apiKey: "YOUR_API_KEY",
});
const res = await sdk.otp.check({
authenticationUuid: "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
checkCode: "123456",
customerUuid: "8f1196d5-806e-4b71-9b24-5f96ec052808",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Perform a retry if a user has not received the code.
import { Ding } from "@ding-live/ding";
async function run() {
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",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
- check - Check a code
- createAuthentication - Send a code
- feedback - Send feedback
- retry - Perform a retry
- lookup - Perform a phone number lookup
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.
Error Object | Status Code | Content Type |
---|---|---|
errors.ErrorResponse | 400 | application/json |
errors.SDKError | 4xx-5xx | / |
Example
import { Ding } from "@ding-live/ding";
async function run() {
const sdk = new Ding({
apiKey: "YOUR_API_KEY",
});
let res;
try {
res = await sdk.otp.check({
authenticationUuid: "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
checkCode: "123456",
customerUuid: "8f1196d5-806e-4b71-9b24-5f96ec052808",
});
} catch (err) {
if (err instanceof errors.ErrorResponse) {
console.error(err); // handle exception
throw err;
} else if (err instanceof errors.SDKError) {
console.error(err); // handle exception
throw err;
}
}
if (res.statusCode == 200) {
// handle response
}
}
run();
The Typescript SDK makes API calls using the axios 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:
import { @ding-live/ding } from "Ding";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new Ding({defaultClient: httpClient});
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
apiKey |
apiKey | API key |
To authenticate with the API the apiKey
parameter must be set when initializing the SDK client instance. For example:
import { Ding } from "@ding-live/ding";
async function run() {
const sdk = new Ding({
apiKey: "YOUR_API_KEY",
});
const res = await sdk.otp.check({
authenticationUuid: "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
checkCode: "123456",
customerUuid: "8f1196d5-806e-4b71-9b24-5f96ec052808",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
You can override the default server globally by passing a server index to the serverIdx: number
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 indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.ding.live/v1 |
None |
import { Ding } from "@ding-live/ding";
async function run() {
const sdk = new Ding({
serverIdx: 0,
apiKey: "YOUR_API_KEY",
});
const res = await sdk.otp.check({
authenticationUuid: "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
checkCode: "123456",
customerUuid: "8f1196d5-806e-4b71-9b24-5f96ec052808",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
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:
import { Ding } from "@ding-live/ding";
async function run() {
const sdk = new Ding({
serverURL: "https://api.ding.live/v1",
apiKey: "YOUR_API_KEY",
});
const res = await sdk.otp.check({
authenticationUuid: "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
checkCode: "123456",
customerUuid: "8f1196d5-806e-4b71-9b24-5f96ec052808",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!