@zyphr-dev/node-sdk 0.1.53 → 0.1.55
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 +121 -162
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +125 -185
- package/dist/index.d.ts +125 -185
- package/dist/index.js +116 -147
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +1 -3
- package/src/client.ts +11 -0
- package/src/src/apis/AuthApplicationApi.ts +63 -0
- package/src/src/apis/AuthEmailVerificationApi.ts +20 -17
- package/src/src/apis/EmailsApi.ts +4 -4
- package/src/src/apis/SMSApi.ts +50 -4
- package/src/src/apis/WebhooksApi.ts +0 -50
- package/src/src/models/ConfirmEmailVerificationResponseData.ts +8 -0
- package/src/src/models/{WebhookRegion.ts → ResendEmailVerificationRequest.ts} +15 -31
- package/src/src/models/SendEmailVerificationRequest.ts +1 -1
- package/src/src/models/WebhookDelivery.ts +0 -8
- package/src/src/models/WebhookDeliveryDetail.ts +0 -8
- package/src/src/models/index.ts +1 -3
- package/src/src/models/WebhookRegionsResponse.ts +0 -88
- package/src/src/models/WebhookRegionsResponseData.ts +0 -81
|
@@ -111,12 +111,6 @@ export interface WebhookDelivery {
|
|
|
111
111
|
* @memberof WebhookDelivery
|
|
112
112
|
*/
|
|
113
113
|
completedAt?: Date | null;
|
|
114
|
-
/**
|
|
115
|
-
*
|
|
116
|
-
* @type {string}
|
|
117
|
-
* @memberof WebhookDelivery
|
|
118
|
-
*/
|
|
119
|
-
deliveryRegion?: string | null;
|
|
120
114
|
/**
|
|
121
115
|
*
|
|
122
116
|
* @type {Date}
|
|
@@ -170,7 +164,6 @@ export function WebhookDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
170
164
|
'firstAttemptedAt': json['first_attempted_at'] == null ? undefined : (new Date(json['first_attempted_at'])),
|
|
171
165
|
'lastAttemptedAt': json['last_attempted_at'] == null ? undefined : (new Date(json['last_attempted_at'])),
|
|
172
166
|
'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
|
|
173
|
-
'deliveryRegion': json['delivery_region'] == null ? undefined : json['delivery_region'],
|
|
174
167
|
'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
|
|
175
168
|
};
|
|
176
169
|
}
|
|
@@ -200,7 +193,6 @@ export function WebhookDeliveryToJSONTyped(value?: WebhookDelivery | null, ignor
|
|
|
200
193
|
'first_attempted_at': value['firstAttemptedAt'] == null ? undefined : ((value['firstAttemptedAt'] as any).toISOString()),
|
|
201
194
|
'last_attempted_at': value['lastAttemptedAt'] == null ? undefined : ((value['lastAttemptedAt'] as any).toISOString()),
|
|
202
195
|
'completed_at': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
|
|
203
|
-
'delivery_region': value['deliveryRegion'],
|
|
204
196
|
'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
|
|
205
197
|
};
|
|
206
198
|
}
|
|
@@ -111,12 +111,6 @@ export interface WebhookDeliveryDetail {
|
|
|
111
111
|
* @memberof WebhookDeliveryDetail
|
|
112
112
|
*/
|
|
113
113
|
completedAt?: Date | null;
|
|
114
|
-
/**
|
|
115
|
-
*
|
|
116
|
-
* @type {string}
|
|
117
|
-
* @memberof WebhookDeliveryDetail
|
|
118
|
-
*/
|
|
119
|
-
deliveryRegion?: string | null;
|
|
120
114
|
/**
|
|
121
115
|
*
|
|
122
116
|
* @type {Date}
|
|
@@ -194,7 +188,6 @@ export function WebhookDeliveryDetailFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
194
188
|
'firstAttemptedAt': json['first_attempted_at'] == null ? undefined : (new Date(json['first_attempted_at'])),
|
|
195
189
|
'lastAttemptedAt': json['last_attempted_at'] == null ? undefined : (new Date(json['last_attempted_at'])),
|
|
196
190
|
'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
|
|
197
|
-
'deliveryRegion': json['delivery_region'] == null ? undefined : json['delivery_region'],
|
|
198
191
|
'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
|
|
199
192
|
'payload': json['payload'] == null ? undefined : json['payload'],
|
|
200
193
|
'lastResponseBody': json['last_response_body'] == null ? undefined : json['last_response_body'],
|
|
@@ -228,7 +221,6 @@ export function WebhookDeliveryDetailToJSONTyped(value?: WebhookDeliveryDetail |
|
|
|
228
221
|
'first_attempted_at': value['firstAttemptedAt'] == null ? undefined : ((value['firstAttemptedAt'] as any).toISOString()),
|
|
229
222
|
'last_attempted_at': value['lastAttemptedAt'] == null ? undefined : ((value['lastAttemptedAt'] as any).toISOString()),
|
|
230
223
|
'completed_at': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
|
|
231
|
-
'delivery_region': value['deliveryRegion'],
|
|
232
224
|
'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
|
|
233
225
|
'payload': value['payload'],
|
|
234
226
|
'last_response_body': value['lastResponseBody'],
|
package/src/src/models/index.ts
CHANGED
|
@@ -277,6 +277,7 @@ export * from './RenderTemplateRequest';
|
|
|
277
277
|
export * from './ReorderWorkflowStepsRequest';
|
|
278
278
|
export * from './ReplayWebhookEventsRequest';
|
|
279
279
|
export * from './RequestMeta';
|
|
280
|
+
export * from './ResendEmailVerificationRequest';
|
|
280
281
|
export * from './ResetPasswordRequest';
|
|
281
282
|
export * from './ResetPasswordResponse';
|
|
282
283
|
export * from './ResubscribeRequest';
|
|
@@ -481,9 +482,6 @@ export * from './WebhookIpsResponseData';
|
|
|
481
482
|
export * from './WebhookJobResponse';
|
|
482
483
|
export * from './WebhookListResponse';
|
|
483
484
|
export * from './WebhookMetricsResponse';
|
|
484
|
-
export * from './WebhookRegion';
|
|
485
|
-
export * from './WebhookRegionsResponse';
|
|
486
|
-
export * from './WebhookRegionsResponseData';
|
|
487
485
|
export * from './WebhookReplayResponse';
|
|
488
486
|
export * from './WebhookResponse';
|
|
489
487
|
export * from './WebhookSecretRotateResponse';
|
|
@@ -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 ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## 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 { WebhookRegionsResponseData } from './WebhookRegionsResponseData';
|
|
17
|
-
import {
|
|
18
|
-
WebhookRegionsResponseDataFromJSON,
|
|
19
|
-
WebhookRegionsResponseDataFromJSONTyped,
|
|
20
|
-
WebhookRegionsResponseDataToJSON,
|
|
21
|
-
WebhookRegionsResponseDataToJSONTyped,
|
|
22
|
-
} from './WebhookRegionsResponseData';
|
|
23
|
-
import type { RequestMeta } from './RequestMeta';
|
|
24
|
-
import {
|
|
25
|
-
RequestMetaFromJSON,
|
|
26
|
-
RequestMetaFromJSONTyped,
|
|
27
|
-
RequestMetaToJSON,
|
|
28
|
-
RequestMetaToJSONTyped,
|
|
29
|
-
} from './RequestMeta';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
* @interface WebhookRegionsResponse
|
|
35
|
-
*/
|
|
36
|
-
export interface WebhookRegionsResponse {
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {WebhookRegionsResponseData}
|
|
40
|
-
* @memberof WebhookRegionsResponse
|
|
41
|
-
*/
|
|
42
|
-
data?: WebhookRegionsResponseData;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {RequestMeta}
|
|
46
|
-
* @memberof WebhookRegionsResponse
|
|
47
|
-
*/
|
|
48
|
-
meta?: RequestMeta;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* Check if a given object implements the WebhookRegionsResponse interface.
|
|
53
|
-
*/
|
|
54
|
-
export function instanceOfWebhookRegionsResponse(value: object): value is WebhookRegionsResponse {
|
|
55
|
-
return true;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
export function WebhookRegionsResponseFromJSON(json: any): WebhookRegionsResponse {
|
|
59
|
-
return WebhookRegionsResponseFromJSONTyped(json, false);
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export function WebhookRegionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookRegionsResponse {
|
|
63
|
-
if (json == null) {
|
|
64
|
-
return json;
|
|
65
|
-
}
|
|
66
|
-
return {
|
|
67
|
-
|
|
68
|
-
'data': json['data'] == null ? undefined : WebhookRegionsResponseDataFromJSON(json['data']),
|
|
69
|
-
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
|
-
};
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export function WebhookRegionsResponseToJSON(json: any): WebhookRegionsResponse {
|
|
74
|
-
return WebhookRegionsResponseToJSONTyped(json, false);
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
export function WebhookRegionsResponseToJSONTyped(value?: WebhookRegionsResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
-
if (value == null) {
|
|
79
|
-
return value;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
return {
|
|
83
|
-
|
|
84
|
-
'data': WebhookRegionsResponseDataToJSON(value['data']),
|
|
85
|
-
'meta': RequestMetaToJSON(value['meta']),
|
|
86
|
-
};
|
|
87
|
-
}
|
|
88
|
-
|
|
@@ -1,81 +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 ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## 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 { WebhookRegion } from './WebhookRegion';
|
|
17
|
-
import {
|
|
18
|
-
WebhookRegionFromJSON,
|
|
19
|
-
WebhookRegionFromJSONTyped,
|
|
20
|
-
WebhookRegionToJSON,
|
|
21
|
-
WebhookRegionToJSONTyped,
|
|
22
|
-
} from './WebhookRegion';
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @export
|
|
27
|
-
* @interface WebhookRegionsResponseData
|
|
28
|
-
*/
|
|
29
|
-
export interface WebhookRegionsResponseData {
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {Array<WebhookRegion>}
|
|
33
|
-
* @memberof WebhookRegionsResponseData
|
|
34
|
-
*/
|
|
35
|
-
regions?: Array<WebhookRegion>;
|
|
36
|
-
/**
|
|
37
|
-
* Default delivery region
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof WebhookRegionsResponseData
|
|
40
|
-
*/
|
|
41
|
-
defaultRegion?: string;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Check if a given object implements the WebhookRegionsResponseData interface.
|
|
46
|
-
*/
|
|
47
|
-
export function instanceOfWebhookRegionsResponseData(value: object): value is WebhookRegionsResponseData {
|
|
48
|
-
return true;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
export function WebhookRegionsResponseDataFromJSON(json: any): WebhookRegionsResponseData {
|
|
52
|
-
return WebhookRegionsResponseDataFromJSONTyped(json, false);
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
export function WebhookRegionsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookRegionsResponseData {
|
|
56
|
-
if (json == null) {
|
|
57
|
-
return json;
|
|
58
|
-
}
|
|
59
|
-
return {
|
|
60
|
-
|
|
61
|
-
'regions': json['regions'] == null ? undefined : ((json['regions'] as Array<any>).map(WebhookRegionFromJSON)),
|
|
62
|
-
'defaultRegion': json['default_region'] == null ? undefined : json['default_region'],
|
|
63
|
-
};
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export function WebhookRegionsResponseDataToJSON(json: any): WebhookRegionsResponseData {
|
|
67
|
-
return WebhookRegionsResponseDataToJSONTyped(json, false);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
export function WebhookRegionsResponseDataToJSONTyped(value?: WebhookRegionsResponseData | null, ignoreDiscriminator: boolean = false): any {
|
|
71
|
-
if (value == null) {
|
|
72
|
-
return value;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
return {
|
|
76
|
-
|
|
77
|
-
'regions': value['regions'] == null ? undefined : ((value['regions'] as Array<any>).map(WebhookRegionToJSON)),
|
|
78
|
-
'default_region': value['defaultRegion'],
|
|
79
|
-
};
|
|
80
|
-
}
|
|
81
|
-
|