@zyphr-dev/node-sdk 0.1.28 → 0.1.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +4 -487
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -487
- package/dist/index.d.ts +2 -487
- package/dist/index.js +4 -445
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +0 -8
- package/src/client.ts +3 -0
- package/src/src/apis/DomainsApi.ts +2 -250
- package/src/src/models/index.ts +0 -8
- package/src/src/models/DeleteDomainResponse.ts +0 -90
- package/src/src/models/DeleteDomainResponseData.ts +0 -75
- package/src/src/models/GetDomain200Response.ts +0 -88
- package/src/src/models/GetDomain200ResponseMeta.ts +0 -65
- package/src/src/models/VerificationStatusResponse.ts +0 -90
- package/src/src/models/VerificationStatusResponseData.ts +0 -148
- package/src/src/models/VerifyDomainResponse.ts +0 -90
- package/src/src/models/VerifyDomainResponseData.ts +0 -103
package/package.json
CHANGED
|
@@ -104,8 +104,6 @@ src/models/CreateWaaSEndpointResponse.ts
|
|
|
104
104
|
src/models/CreateWaaSEventType201Response.ts
|
|
105
105
|
src/models/CreateWaaSEventTypeRequest.ts
|
|
106
106
|
src/models/CreateWebhookRequest.ts
|
|
107
|
-
src/models/DeleteDomainResponse.ts
|
|
108
|
-
src/models/DeleteDomainResponseData.ts
|
|
109
107
|
src/models/DeleteResult.ts
|
|
110
108
|
src/models/DeleteResultData.ts
|
|
111
109
|
src/models/Device.ts
|
|
@@ -144,8 +142,6 @@ src/models/GenerateSubscriberToken200Response.ts
|
|
|
144
142
|
src/models/GenerateSubscriberToken200ResponseData.ts
|
|
145
143
|
src/models/GenerateSubscriberTokenRequest.ts
|
|
146
144
|
src/models/GenerateWaaSPortalToken201Response.ts
|
|
147
|
-
src/models/GetDomain200Response.ts
|
|
148
|
-
src/models/GetDomain200ResponseMeta.ts
|
|
149
145
|
src/models/GetWaaSEndpoint200Response.ts
|
|
150
146
|
src/models/GetWaaSUsage200Response.ts
|
|
151
147
|
src/models/InAppNotification.ts
|
|
@@ -358,10 +354,6 @@ src/models/UserDevicesDeleteResponseData.ts
|
|
|
358
354
|
src/models/ValidateResetTokenRequest.ts
|
|
359
355
|
src/models/ValidateResetTokenResponse.ts
|
|
360
356
|
src/models/ValidateResetTokenResponseData.ts
|
|
361
|
-
src/models/VerificationStatusResponse.ts
|
|
362
|
-
src/models/VerificationStatusResponseData.ts
|
|
363
|
-
src/models/VerifyDomainResponse.ts
|
|
364
|
-
src/models/VerifyDomainResponseData.ts
|
|
365
357
|
src/models/VerifySmsConfigData.ts
|
|
366
358
|
src/models/VerifySmsConfigResponse.ts
|
|
367
359
|
src/models/WaaSApplication.ts
|
package/src/client.ts
CHANGED
|
@@ -28,6 +28,7 @@ import {
|
|
|
28
28
|
AuthUserProfileApi,
|
|
29
29
|
AuthWebAuthnApi,
|
|
30
30
|
DevicesApi,
|
|
31
|
+
DomainsApi,
|
|
31
32
|
EmailsApi,
|
|
32
33
|
InboxApi,
|
|
33
34
|
PushApi,
|
|
@@ -81,6 +82,7 @@ export class Zyphr {
|
|
|
81
82
|
readonly webhooks: WebhooksApi;
|
|
82
83
|
readonly topics: TopicsApi;
|
|
83
84
|
readonly devices: DevicesApi;
|
|
85
|
+
readonly domains: DomainsApi;
|
|
84
86
|
|
|
85
87
|
readonly waas: {
|
|
86
88
|
readonly applications: WaaSApplicationsApi;
|
|
@@ -130,6 +132,7 @@ export class Zyphr {
|
|
|
130
132
|
this.webhooks = new WebhooksApi(config);
|
|
131
133
|
this.topics = new TopicsApi(config);
|
|
132
134
|
this.devices = new DevicesApi(config);
|
|
135
|
+
this.domains = new DomainsApi(config);
|
|
133
136
|
|
|
134
137
|
this.waas = {
|
|
135
138
|
applications: new WaaSApplicationsApi(config),
|
|
@@ -18,11 +18,7 @@ import type {
|
|
|
18
18
|
AddDomain200Response,
|
|
19
19
|
AddDomainRequest,
|
|
20
20
|
ApiError,
|
|
21
|
-
DeleteDomainResponse,
|
|
22
21
|
DomainListResponse,
|
|
23
|
-
GetDomain200Response,
|
|
24
|
-
VerificationStatusResponse,
|
|
25
|
-
VerifyDomainResponse,
|
|
26
22
|
} from '../models/index';
|
|
27
23
|
import {
|
|
28
24
|
AddDomain200ResponseFromJSON,
|
|
@@ -31,38 +27,14 @@ import {
|
|
|
31
27
|
AddDomainRequestToJSON,
|
|
32
28
|
ApiErrorFromJSON,
|
|
33
29
|
ApiErrorToJSON,
|
|
34
|
-
DeleteDomainResponseFromJSON,
|
|
35
|
-
DeleteDomainResponseToJSON,
|
|
36
30
|
DomainListResponseFromJSON,
|
|
37
31
|
DomainListResponseToJSON,
|
|
38
|
-
GetDomain200ResponseFromJSON,
|
|
39
|
-
GetDomain200ResponseToJSON,
|
|
40
|
-
VerificationStatusResponseFromJSON,
|
|
41
|
-
VerificationStatusResponseToJSON,
|
|
42
|
-
VerifyDomainResponseFromJSON,
|
|
43
|
-
VerifyDomainResponseToJSON,
|
|
44
32
|
} from '../models/index';
|
|
45
33
|
|
|
46
34
|
export interface DomainsApiAddDomainOperationRequest {
|
|
47
35
|
addDomainRequest: AddDomainRequest;
|
|
48
36
|
}
|
|
49
37
|
|
|
50
|
-
export interface DomainsApiDeleteDomainRequest {
|
|
51
|
-
id: string;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
export interface DomainsApiGetDomainRequest {
|
|
55
|
-
id: string;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
export interface DomainsApiGetDomainVerificationStatusRequest {
|
|
59
|
-
id: string;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export interface DomainsApiVerifyDomainRequest {
|
|
63
|
-
id: string;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
38
|
/**
|
|
67
39
|
* DomainsApi - interface
|
|
68
40
|
*
|
|
@@ -86,54 +58,6 @@ export interface DomainsApiInterface {
|
|
|
86
58
|
*/
|
|
87
59
|
addDomain(addDomainRequest: AddDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddDomain200Response>;
|
|
88
60
|
|
|
89
|
-
/**
|
|
90
|
-
* Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
|
|
91
|
-
* @summary Remove a sending domain
|
|
92
|
-
* @param {string} id
|
|
93
|
-
* @param {*} [options] Override http request option.
|
|
94
|
-
* @throws {RequiredError}
|
|
95
|
-
* @memberof DomainsApiInterface
|
|
96
|
-
*/
|
|
97
|
-
deleteDomainRaw(requestParameters: DomainsApiDeleteDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteDomainResponse>>;
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
|
|
101
|
-
* Remove a sending domain
|
|
102
|
-
*/
|
|
103
|
-
deleteDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteDomainResponse>;
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* Retrieve a single sending domain by ID, including DNS records and verification counters.
|
|
107
|
-
* @summary Get a sending domain
|
|
108
|
-
* @param {string} id
|
|
109
|
-
* @param {*} [options] Override http request option.
|
|
110
|
-
* @throws {RequiredError}
|
|
111
|
-
* @memberof DomainsApiInterface
|
|
112
|
-
*/
|
|
113
|
-
getDomainRaw(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDomain200Response>>;
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Retrieve a single sending domain by ID, including DNS records and verification counters.
|
|
117
|
-
* Get a sending domain
|
|
118
|
-
*/
|
|
119
|
-
getDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDomain200Response>;
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
|
|
123
|
-
* @summary Get domain verification status
|
|
124
|
-
* @param {string} id Domain ID
|
|
125
|
-
* @param {*} [options] Override http request option.
|
|
126
|
-
* @throws {RequiredError}
|
|
127
|
-
* @memberof DomainsApiInterface
|
|
128
|
-
*/
|
|
129
|
-
getDomainVerificationStatusRaw(requestParameters: DomainsApiGetDomainVerificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerificationStatusResponse>>;
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
|
|
133
|
-
* Get domain verification status
|
|
134
|
-
*/
|
|
135
|
-
getDomainVerificationStatus(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationStatusResponse>;
|
|
136
|
-
|
|
137
61
|
/**
|
|
138
62
|
* List sending domains on the current project, with verification status and DNS records.
|
|
139
63
|
* @summary List sending domains
|
|
@@ -149,22 +73,6 @@ export interface DomainsApiInterface {
|
|
|
149
73
|
*/
|
|
150
74
|
listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainListResponse>;
|
|
151
75
|
|
|
152
|
-
/**
|
|
153
|
-
* Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
|
|
154
|
-
* @summary Trigger domain verification
|
|
155
|
-
* @param {string} id
|
|
156
|
-
* @param {*} [options] Override http request option.
|
|
157
|
-
* @throws {RequiredError}
|
|
158
|
-
* @memberof DomainsApiInterface
|
|
159
|
-
*/
|
|
160
|
-
verifyDomainRaw(requestParameters: DomainsApiVerifyDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerifyDomainResponse>>;
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
|
|
164
|
-
* Trigger domain verification
|
|
165
|
-
*/
|
|
166
|
-
verifyDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifyDomainResponse>;
|
|
167
|
-
|
|
168
76
|
}
|
|
169
77
|
|
|
170
78
|
/**
|
|
@@ -195,7 +103,7 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
|
|
|
195
103
|
}
|
|
196
104
|
|
|
197
105
|
const response = await this.request({
|
|
198
|
-
path: `/
|
|
106
|
+
path: `/domains`,
|
|
199
107
|
method: 'POST',
|
|
200
108
|
headers: headerParameters,
|
|
201
109
|
query: queryParameters,
|
|
@@ -214,123 +122,6 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
|
|
|
214
122
|
return await response.value();
|
|
215
123
|
}
|
|
216
124
|
|
|
217
|
-
/**
|
|
218
|
-
* Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
|
|
219
|
-
* Remove a sending domain
|
|
220
|
-
*/
|
|
221
|
-
async deleteDomainRaw(requestParameters: DomainsApiDeleteDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteDomainResponse>> {
|
|
222
|
-
if (requestParameters['id'] == null) {
|
|
223
|
-
throw new runtime.RequiredError(
|
|
224
|
-
'id',
|
|
225
|
-
'Required parameter "id" was null or undefined when calling deleteDomain().'
|
|
226
|
-
);
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
const queryParameters: any = {};
|
|
230
|
-
|
|
231
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
232
|
-
|
|
233
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
234
|
-
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
const response = await this.request({
|
|
238
|
-
path: `/v1/domains/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
|
|
239
|
-
method: 'DELETE',
|
|
240
|
-
headers: headerParameters,
|
|
241
|
-
query: queryParameters,
|
|
242
|
-
}, initOverrides);
|
|
243
|
-
|
|
244
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => DeleteDomainResponseFromJSON(jsonValue));
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
/**
|
|
248
|
-
* Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
|
|
249
|
-
* Remove a sending domain
|
|
250
|
-
*/
|
|
251
|
-
async deleteDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteDomainResponse> {
|
|
252
|
-
const response = await this.deleteDomainRaw({ id: id }, initOverrides);
|
|
253
|
-
return await response.value();
|
|
254
|
-
}
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* Retrieve a single sending domain by ID, including DNS records and verification counters.
|
|
258
|
-
* Get a sending domain
|
|
259
|
-
*/
|
|
260
|
-
async getDomainRaw(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDomain200Response>> {
|
|
261
|
-
if (requestParameters['id'] == null) {
|
|
262
|
-
throw new runtime.RequiredError(
|
|
263
|
-
'id',
|
|
264
|
-
'Required parameter "id" was null or undefined when calling getDomain().'
|
|
265
|
-
);
|
|
266
|
-
}
|
|
267
|
-
|
|
268
|
-
const queryParameters: any = {};
|
|
269
|
-
|
|
270
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
271
|
-
|
|
272
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
273
|
-
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
const response = await this.request({
|
|
277
|
-
path: `/v1/domains/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
|
|
278
|
-
method: 'GET',
|
|
279
|
-
headers: headerParameters,
|
|
280
|
-
query: queryParameters,
|
|
281
|
-
}, initOverrides);
|
|
282
|
-
|
|
283
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => GetDomain200ResponseFromJSON(jsonValue));
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
/**
|
|
287
|
-
* Retrieve a single sending domain by ID, including DNS records and verification counters.
|
|
288
|
-
* Get a sending domain
|
|
289
|
-
*/
|
|
290
|
-
async getDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDomain200Response> {
|
|
291
|
-
const response = await this.getDomainRaw({ id: id }, initOverrides);
|
|
292
|
-
return await response.value();
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
/**
|
|
296
|
-
* Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
|
|
297
|
-
* Get domain verification status
|
|
298
|
-
*/
|
|
299
|
-
async getDomainVerificationStatusRaw(requestParameters: DomainsApiGetDomainVerificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerificationStatusResponse>> {
|
|
300
|
-
if (requestParameters['id'] == null) {
|
|
301
|
-
throw new runtime.RequiredError(
|
|
302
|
-
'id',
|
|
303
|
-
'Required parameter "id" was null or undefined when calling getDomainVerificationStatus().'
|
|
304
|
-
);
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
const queryParameters: any = {};
|
|
308
|
-
|
|
309
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
310
|
-
|
|
311
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
312
|
-
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
const response = await this.request({
|
|
316
|
-
path: `/v1/domains/{id}/verification-status`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
|
|
317
|
-
method: 'GET',
|
|
318
|
-
headers: headerParameters,
|
|
319
|
-
query: queryParameters,
|
|
320
|
-
}, initOverrides);
|
|
321
|
-
|
|
322
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => VerificationStatusResponseFromJSON(jsonValue));
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
/**
|
|
326
|
-
* Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
|
|
327
|
-
* Get domain verification status
|
|
328
|
-
*/
|
|
329
|
-
async getDomainVerificationStatus(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationStatusResponse> {
|
|
330
|
-
const response = await this.getDomainVerificationStatusRaw({ id: id }, initOverrides);
|
|
331
|
-
return await response.value();
|
|
332
|
-
}
|
|
333
|
-
|
|
334
125
|
/**
|
|
335
126
|
* List sending domains on the current project, with verification status and DNS records.
|
|
336
127
|
* List sending domains
|
|
@@ -345,7 +136,7 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
|
|
|
345
136
|
}
|
|
346
137
|
|
|
347
138
|
const response = await this.request({
|
|
348
|
-
path: `/
|
|
139
|
+
path: `/domains`,
|
|
349
140
|
method: 'GET',
|
|
350
141
|
headers: headerParameters,
|
|
351
142
|
query: queryParameters,
|
|
@@ -363,43 +154,4 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
|
|
|
363
154
|
return await response.value();
|
|
364
155
|
}
|
|
365
156
|
|
|
366
|
-
/**
|
|
367
|
-
* Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
|
|
368
|
-
* Trigger domain verification
|
|
369
|
-
*/
|
|
370
|
-
async verifyDomainRaw(requestParameters: DomainsApiVerifyDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerifyDomainResponse>> {
|
|
371
|
-
if (requestParameters['id'] == null) {
|
|
372
|
-
throw new runtime.RequiredError(
|
|
373
|
-
'id',
|
|
374
|
-
'Required parameter "id" was null or undefined when calling verifyDomain().'
|
|
375
|
-
);
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
const queryParameters: any = {};
|
|
379
|
-
|
|
380
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
381
|
-
|
|
382
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
383
|
-
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
const response = await this.request({
|
|
387
|
-
path: `/v1/domains/{id}/verify`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
|
|
388
|
-
method: 'POST',
|
|
389
|
-
headers: headerParameters,
|
|
390
|
-
query: queryParameters,
|
|
391
|
-
}, initOverrides);
|
|
392
|
-
|
|
393
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => VerifyDomainResponseFromJSON(jsonValue));
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
* Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
|
|
398
|
-
* Trigger domain verification
|
|
399
|
-
*/
|
|
400
|
-
async verifyDomain(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifyDomainResponse> {
|
|
401
|
-
const response = await this.verifyDomainRaw({ id: id }, initOverrides);
|
|
402
|
-
return await response.value();
|
|
403
|
-
}
|
|
404
|
-
|
|
405
157
|
}
|
package/src/src/models/index.ts
CHANGED
|
@@ -69,8 +69,6 @@ export * from './CreateWaaSEndpointResponse';
|
|
|
69
69
|
export * from './CreateWaaSEventType201Response';
|
|
70
70
|
export * from './CreateWaaSEventTypeRequest';
|
|
71
71
|
export * from './CreateWebhookRequest';
|
|
72
|
-
export * from './DeleteDomainResponse';
|
|
73
|
-
export * from './DeleteDomainResponseData';
|
|
74
72
|
export * from './DeleteResult';
|
|
75
73
|
export * from './DeleteResultData';
|
|
76
74
|
export * from './Device';
|
|
@@ -109,8 +107,6 @@ export * from './GenerateSubscriberToken200Response';
|
|
|
109
107
|
export * from './GenerateSubscriberToken200ResponseData';
|
|
110
108
|
export * from './GenerateSubscriberTokenRequest';
|
|
111
109
|
export * from './GenerateWaaSPortalToken201Response';
|
|
112
|
-
export * from './GetDomain200Response';
|
|
113
|
-
export * from './GetDomain200ResponseMeta';
|
|
114
110
|
export * from './GetWaaSEndpoint200Response';
|
|
115
111
|
export * from './GetWaaSUsage200Response';
|
|
116
112
|
export * from './InAppNotification';
|
|
@@ -323,10 +319,6 @@ export * from './UserDevicesDeleteResponseData';
|
|
|
323
319
|
export * from './ValidateResetTokenRequest';
|
|
324
320
|
export * from './ValidateResetTokenResponse';
|
|
325
321
|
export * from './ValidateResetTokenResponseData';
|
|
326
|
-
export * from './VerificationStatusResponse';
|
|
327
|
-
export * from './VerificationStatusResponseData';
|
|
328
|
-
export * from './VerifyDomainResponse';
|
|
329
|
-
export * from './VerifyDomainResponseData';
|
|
330
322
|
export * from './VerifySmsConfigData';
|
|
331
323
|
export * from './VerifySmsConfigResponse';
|
|
332
324
|
export * from './WaaSApplication';
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: support@zyphr.dev
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
import { mapValues } from '../runtime';
|
|
16
|
-
import type { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
|
|
17
|
-
import {
|
|
18
|
-
GetDomain200ResponseMetaFromJSON,
|
|
19
|
-
GetDomain200ResponseMetaFromJSONTyped,
|
|
20
|
-
GetDomain200ResponseMetaToJSON,
|
|
21
|
-
GetDomain200ResponseMetaToJSONTyped,
|
|
22
|
-
} from './GetDomain200ResponseMeta';
|
|
23
|
-
import type { DeleteDomainResponseData } from './DeleteDomainResponseData';
|
|
24
|
-
import {
|
|
25
|
-
DeleteDomainResponseDataFromJSON,
|
|
26
|
-
DeleteDomainResponseDataFromJSONTyped,
|
|
27
|
-
DeleteDomainResponseDataToJSON,
|
|
28
|
-
DeleteDomainResponseDataToJSONTyped,
|
|
29
|
-
} from './DeleteDomainResponseData';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
* @interface DeleteDomainResponse
|
|
35
|
-
*/
|
|
36
|
-
export interface DeleteDomainResponse {
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {DeleteDomainResponseData}
|
|
40
|
-
* @memberof DeleteDomainResponse
|
|
41
|
-
*/
|
|
42
|
-
data: DeleteDomainResponseData;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {GetDomain200ResponseMeta}
|
|
46
|
-
* @memberof DeleteDomainResponse
|
|
47
|
-
*/
|
|
48
|
-
meta: GetDomain200ResponseMeta;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* Check if a given object implements the DeleteDomainResponse interface.
|
|
53
|
-
*/
|
|
54
|
-
export function instanceOfDeleteDomainResponse(value: object): value is DeleteDomainResponse {
|
|
55
|
-
if (!('data' in value) || value['data'] === undefined) return false;
|
|
56
|
-
if (!('meta' in value) || value['meta'] === undefined) return false;
|
|
57
|
-
return true;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
export function DeleteDomainResponseFromJSON(json: any): DeleteDomainResponse {
|
|
61
|
-
return DeleteDomainResponseFromJSONTyped(json, false);
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export function DeleteDomainResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteDomainResponse {
|
|
65
|
-
if (json == null) {
|
|
66
|
-
return json;
|
|
67
|
-
}
|
|
68
|
-
return {
|
|
69
|
-
|
|
70
|
-
'data': DeleteDomainResponseDataFromJSON(json['data']),
|
|
71
|
-
'meta': GetDomain200ResponseMetaFromJSON(json['meta']),
|
|
72
|
-
};
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
export function DeleteDomainResponseToJSON(json: any): DeleteDomainResponse {
|
|
76
|
-
return DeleteDomainResponseToJSONTyped(json, false);
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
export function DeleteDomainResponseToJSONTyped(value?: DeleteDomainResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
80
|
-
if (value == null) {
|
|
81
|
-
return value;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
return {
|
|
85
|
-
|
|
86
|
-
'data': DeleteDomainResponseDataToJSON(value['data']),
|
|
87
|
-
'meta': GetDomain200ResponseMetaToJSON(value['meta']),
|
|
88
|
-
};
|
|
89
|
-
}
|
|
90
|
-
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: support@zyphr.dev
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
import { mapValues } from '../runtime';
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @export
|
|
19
|
-
* @interface DeleteDomainResponseData
|
|
20
|
-
*/
|
|
21
|
-
export interface DeleteDomainResponseData {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof DeleteDomainResponseData
|
|
26
|
-
*/
|
|
27
|
-
id: string;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {boolean}
|
|
31
|
-
* @memberof DeleteDomainResponseData
|
|
32
|
-
*/
|
|
33
|
-
deleted: boolean;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Check if a given object implements the DeleteDomainResponseData interface.
|
|
38
|
-
*/
|
|
39
|
-
export function instanceOfDeleteDomainResponseData(value: object): value is DeleteDomainResponseData {
|
|
40
|
-
if (!('id' in value) || value['id'] === undefined) return false;
|
|
41
|
-
if (!('deleted' in value) || value['deleted'] === undefined) return false;
|
|
42
|
-
return true;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export function DeleteDomainResponseDataFromJSON(json: any): DeleteDomainResponseData {
|
|
46
|
-
return DeleteDomainResponseDataFromJSONTyped(json, false);
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
export function DeleteDomainResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteDomainResponseData {
|
|
50
|
-
if (json == null) {
|
|
51
|
-
return json;
|
|
52
|
-
}
|
|
53
|
-
return {
|
|
54
|
-
|
|
55
|
-
'id': json['id'],
|
|
56
|
-
'deleted': json['deleted'],
|
|
57
|
-
};
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
export function DeleteDomainResponseDataToJSON(json: any): DeleteDomainResponseData {
|
|
61
|
-
return DeleteDomainResponseDataToJSONTyped(json, false);
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export function DeleteDomainResponseDataToJSONTyped(value?: DeleteDomainResponseData | null, ignoreDiscriminator: boolean = false): any {
|
|
65
|
-
if (value == null) {
|
|
66
|
-
return value;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
return {
|
|
70
|
-
|
|
71
|
-
'id': value['id'],
|
|
72
|
-
'deleted': value['deleted'],
|
|
73
|
-
};
|
|
74
|
-
}
|
|
75
|
-
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: support@zyphr.dev
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
import { mapValues } from '../runtime';
|
|
16
|
-
import type { DomainResponse } from './DomainResponse';
|
|
17
|
-
import {
|
|
18
|
-
DomainResponseFromJSON,
|
|
19
|
-
DomainResponseFromJSONTyped,
|
|
20
|
-
DomainResponseToJSON,
|
|
21
|
-
DomainResponseToJSONTyped,
|
|
22
|
-
} from './DomainResponse';
|
|
23
|
-
import type { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
|
|
24
|
-
import {
|
|
25
|
-
GetDomain200ResponseMetaFromJSON,
|
|
26
|
-
GetDomain200ResponseMetaFromJSONTyped,
|
|
27
|
-
GetDomain200ResponseMetaToJSON,
|
|
28
|
-
GetDomain200ResponseMetaToJSONTyped,
|
|
29
|
-
} from './GetDomain200ResponseMeta';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
* @interface GetDomain200Response
|
|
35
|
-
*/
|
|
36
|
-
export interface GetDomain200Response {
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {DomainResponse}
|
|
40
|
-
* @memberof GetDomain200Response
|
|
41
|
-
*/
|
|
42
|
-
data?: DomainResponse;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {GetDomain200ResponseMeta}
|
|
46
|
-
* @memberof GetDomain200Response
|
|
47
|
-
*/
|
|
48
|
-
meta?: GetDomain200ResponseMeta;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* Check if a given object implements the GetDomain200Response interface.
|
|
53
|
-
*/
|
|
54
|
-
export function instanceOfGetDomain200Response(value: object): value is GetDomain200Response {
|
|
55
|
-
return true;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
export function GetDomain200ResponseFromJSON(json: any): GetDomain200Response {
|
|
59
|
-
return GetDomain200ResponseFromJSONTyped(json, false);
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export function GetDomain200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDomain200Response {
|
|
63
|
-
if (json == null) {
|
|
64
|
-
return json;
|
|
65
|
-
}
|
|
66
|
-
return {
|
|
67
|
-
|
|
68
|
-
'data': json['data'] == null ? undefined : DomainResponseFromJSON(json['data']),
|
|
69
|
-
'meta': json['meta'] == null ? undefined : GetDomain200ResponseMetaFromJSON(json['meta']),
|
|
70
|
-
};
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export function GetDomain200ResponseToJSON(json: any): GetDomain200Response {
|
|
74
|
-
return GetDomain200ResponseToJSONTyped(json, false);
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
export function GetDomain200ResponseToJSONTyped(value?: GetDomain200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
-
if (value == null) {
|
|
79
|
-
return value;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
return {
|
|
83
|
-
|
|
84
|
-
'data': DomainResponseToJSON(value['data']),
|
|
85
|
-
'meta': GetDomain200ResponseMetaToJSON(value['meta']),
|
|
86
|
-
};
|
|
87
|
-
}
|
|
88
|
-
|