@zyphr-dev/node-sdk 0.1.42 → 0.1.43
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 +1763 -321
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2122 -643
- package/dist/index.d.ts +2122 -643
- package/dist/index.js +1582 -316
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +35 -1
- package/src/src/apis/AuthUserDirectoryApi.ts +54 -36
- package/src/src/apis/DomainsApi.ts +7 -6
- package/src/src/apis/InboxApi.ts +78 -54
- package/src/src/apis/TemplatesApi.ts +10 -6
- package/src/src/apis/WaaSDeliveriesApi.ts +17 -12
- package/src/src/apis/WaaSEndpointsApi.ts +50 -30
- package/src/src/apis/WaaSEventTypesApi.ts +17 -12
- package/src/src/models/CloseWaaSEndpointCircuit200Response.ts +88 -0
- package/src/src/models/CloseWaaSEndpointCircuit200ResponseData.ts +76 -0
- package/src/src/models/GetEndUserById200Response.ts +88 -0
- package/src/src/models/GetEndUserClaims200Response.ts +88 -0
- package/src/src/models/GetEndUserClaims200ResponseData.ts +65 -0
- package/src/src/models/GetSubscriberInboxPreferences200Response.ts +73 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseData.ts +88 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.ts +88 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.ts +97 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobal.ts +73 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.ts +94 -0
- package/src/src/models/GetSubscriberNotification200Response.ts +73 -0
- package/src/src/models/GetSubscriberUnreadCount200Response.ts +73 -0
- package/src/src/models/GetWaaSDelivery200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointCircuit200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointCircuit200ResponseData.ts +123 -0
- package/src/src/models/GetWaaSEndpointMetrics200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseData.ts +99 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseDataHealth.ts +87 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseDataWindowsValue.ts +126 -0
- package/src/src/models/InviteEndUser200Response.ts +88 -0
- package/src/src/models/InviteEndUser200ResponseData.ts +81 -0
- package/src/src/models/ListEndUsers200Response.ts +88 -0
- package/src/src/models/{ListWorkflowExecutions200ResponseMeta.ts → ListEndUsers200ResponseMeta.ts} +15 -15
- package/src/src/models/ListWorkflowExecutions200Response.ts +11 -11
- package/src/src/models/MarkAllSubscriberNotificationsRead200Response.ts +73 -0
- package/src/src/models/RotateWaaSEndpointSecret200Response.ts +88 -0
- package/src/src/models/RotateWaaSEndpointSecret200ResponseData.ts +66 -0
- package/src/src/models/SendTemplateTestEmail202Response.ts +90 -0
- package/src/src/models/SendTemplateTestEmail202ResponseData.ts +120 -0
- package/src/src/models/SendTemplateTestEmail202ResponseMeta.ts +66 -0
- package/src/src/models/SmsListResponse.ts +10 -10
- package/src/src/models/UpdateSubscriberPreferences200Response.ts +73 -0
- package/src/src/models/UpdateSubscriberPreferences200ResponseData.ts +81 -0
- package/src/src/models/UpdateSubscriberPreferences200ResponseDataPreferencesInner.ts +102 -0
- package/src/src/models/UpdateWaaSEndpoint200Response.ts +88 -0
- package/src/src/models/UpdateWaaSEventType200Response.ts +88 -0
- package/src/src/models/index.ts +35 -1
|
@@ -0,0 +1,73 @@
|
|
|
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 { UpdateSubscriberPreferences200ResponseData } from './UpdateSubscriberPreferences200ResponseData';
|
|
17
|
+
import {
|
|
18
|
+
UpdateSubscriberPreferences200ResponseDataFromJSON,
|
|
19
|
+
UpdateSubscriberPreferences200ResponseDataFromJSONTyped,
|
|
20
|
+
UpdateSubscriberPreferences200ResponseDataToJSON,
|
|
21
|
+
UpdateSubscriberPreferences200ResponseDataToJSONTyped,
|
|
22
|
+
} from './UpdateSubscriberPreferences200ResponseData';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface UpdateSubscriberPreferences200Response
|
|
28
|
+
*/
|
|
29
|
+
export interface UpdateSubscriberPreferences200Response {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {UpdateSubscriberPreferences200ResponseData}
|
|
33
|
+
* @memberof UpdateSubscriberPreferences200Response
|
|
34
|
+
*/
|
|
35
|
+
data?: UpdateSubscriberPreferences200ResponseData;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the UpdateSubscriberPreferences200Response interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfUpdateSubscriberPreferences200Response(value: object): value is UpdateSubscriberPreferences200Response {
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function UpdateSubscriberPreferences200ResponseFromJSON(json: any): UpdateSubscriberPreferences200Response {
|
|
46
|
+
return UpdateSubscriberPreferences200ResponseFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function UpdateSubscriberPreferences200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriberPreferences200Response {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'data': json['data'] == null ? undefined : UpdateSubscriberPreferences200ResponseDataFromJSON(json['data']),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function UpdateSubscriberPreferences200ResponseToJSON(json: any): UpdateSubscriberPreferences200Response {
|
|
60
|
+
return UpdateSubscriberPreferences200ResponseToJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function UpdateSubscriberPreferences200ResponseToJSONTyped(value?: UpdateSubscriberPreferences200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'data': UpdateSubscriberPreferences200ResponseDataToJSON(value['data']),
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
@@ -0,0 +1,81 @@
|
|
|
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 { UpdateSubscriberPreferences200ResponseDataPreferencesInner } from './UpdateSubscriberPreferences200ResponseDataPreferencesInner';
|
|
17
|
+
import {
|
|
18
|
+
UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSON,
|
|
19
|
+
UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSONTyped,
|
|
20
|
+
UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSON,
|
|
21
|
+
UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSONTyped,
|
|
22
|
+
} from './UpdateSubscriberPreferences200ResponseDataPreferencesInner';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface UpdateSubscriberPreferences200ResponseData
|
|
28
|
+
*/
|
|
29
|
+
export interface UpdateSubscriberPreferences200ResponseData {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof UpdateSubscriberPreferences200ResponseData
|
|
34
|
+
*/
|
|
35
|
+
updated?: number;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {Array<UpdateSubscriberPreferences200ResponseDataPreferencesInner>}
|
|
39
|
+
* @memberof UpdateSubscriberPreferences200ResponseData
|
|
40
|
+
*/
|
|
41
|
+
preferences?: Array<UpdateSubscriberPreferences200ResponseDataPreferencesInner>;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the UpdateSubscriberPreferences200ResponseData interface.
|
|
46
|
+
*/
|
|
47
|
+
export function instanceOfUpdateSubscriberPreferences200ResponseData(value: object): value is UpdateSubscriberPreferences200ResponseData {
|
|
48
|
+
return true;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function UpdateSubscriberPreferences200ResponseDataFromJSON(json: any): UpdateSubscriberPreferences200ResponseData {
|
|
52
|
+
return UpdateSubscriberPreferences200ResponseDataFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function UpdateSubscriberPreferences200ResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriberPreferences200ResponseData {
|
|
56
|
+
if (json == null) {
|
|
57
|
+
return json;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
|
|
61
|
+
'updated': json['updated'] == null ? undefined : json['updated'],
|
|
62
|
+
'preferences': json['preferences'] == null ? undefined : ((json['preferences'] as Array<any>).map(UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSON)),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function UpdateSubscriberPreferences200ResponseDataToJSON(json: any): UpdateSubscriberPreferences200ResponseData {
|
|
67
|
+
return UpdateSubscriberPreferences200ResponseDataToJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function UpdateSubscriberPreferences200ResponseDataToJSONTyped(value?: UpdateSubscriberPreferences200ResponseData | null, ignoreDiscriminator: boolean = false): any {
|
|
71
|
+
if (value == null) {
|
|
72
|
+
return value;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return {
|
|
76
|
+
|
|
77
|
+
'updated': value['updated'],
|
|
78
|
+
'preferences': value['preferences'] == null ? undefined : ((value['preferences'] as Array<any>).map(UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSON)),
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
@@ -0,0 +1,102 @@
|
|
|
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
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface UpdateSubscriberPreferences200ResponseDataPreferencesInner
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateSubscriberPreferences200ResponseDataPreferencesInner {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof UpdateSubscriberPreferences200ResponseDataPreferencesInner
|
|
26
|
+
*/
|
|
27
|
+
categoryId?: string | null;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof UpdateSubscriberPreferences200ResponseDataPreferencesInner
|
|
32
|
+
*/
|
|
33
|
+
channel?: UpdateSubscriberPreferences200ResponseDataPreferencesInnerChannelEnum;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof UpdateSubscriberPreferences200ResponseDataPreferencesInner
|
|
38
|
+
*/
|
|
39
|
+
enabled?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof UpdateSubscriberPreferences200ResponseDataPreferencesInner
|
|
44
|
+
*/
|
|
45
|
+
source?: string;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export const UpdateSubscriberPreferences200ResponseDataPreferencesInnerChannelEnum = {
|
|
53
|
+
EMAIL: 'email',
|
|
54
|
+
PUSH: 'push',
|
|
55
|
+
SMS: 'sms',
|
|
56
|
+
IN_APP: 'in_app'
|
|
57
|
+
} as const;
|
|
58
|
+
export type UpdateSubscriberPreferences200ResponseDataPreferencesInnerChannelEnum = typeof UpdateSubscriberPreferences200ResponseDataPreferencesInnerChannelEnum[keyof typeof UpdateSubscriberPreferences200ResponseDataPreferencesInnerChannelEnum];
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Check if a given object implements the UpdateSubscriberPreferences200ResponseDataPreferencesInner interface.
|
|
63
|
+
*/
|
|
64
|
+
export function instanceOfUpdateSubscriberPreferences200ResponseDataPreferencesInner(value: object): value is UpdateSubscriberPreferences200ResponseDataPreferencesInner {
|
|
65
|
+
return true;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSON(json: any): UpdateSubscriberPreferences200ResponseDataPreferencesInner {
|
|
69
|
+
return UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSONTyped(json, false);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function UpdateSubscriberPreferences200ResponseDataPreferencesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriberPreferences200ResponseDataPreferencesInner {
|
|
73
|
+
if (json == null) {
|
|
74
|
+
return json;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'categoryId': json['category_id'] == null ? undefined : json['category_id'],
|
|
79
|
+
'channel': json['channel'] == null ? undefined : json['channel'],
|
|
80
|
+
'enabled': json['enabled'] == null ? undefined : json['enabled'],
|
|
81
|
+
'source': json['source'] == null ? undefined : json['source'],
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export function UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSON(json: any): UpdateSubscriberPreferences200ResponseDataPreferencesInner {
|
|
86
|
+
return UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSONTyped(json, false);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export function UpdateSubscriberPreferences200ResponseDataPreferencesInnerToJSONTyped(value?: UpdateSubscriberPreferences200ResponseDataPreferencesInner | null, ignoreDiscriminator: boolean = false): any {
|
|
90
|
+
if (value == null) {
|
|
91
|
+
return value;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
return {
|
|
95
|
+
|
|
96
|
+
'category_id': value['categoryId'],
|
|
97
|
+
'channel': value['channel'],
|
|
98
|
+
'enabled': value['enabled'],
|
|
99
|
+
'source': value['source'],
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
|
|
@@ -0,0 +1,88 @@
|
|
|
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 { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
|
|
17
|
+
import {
|
|
18
|
+
GetDomain200ResponseMetaFromJSON,
|
|
19
|
+
GetDomain200ResponseMetaFromJSONTyped,
|
|
20
|
+
GetDomain200ResponseMetaToJSON,
|
|
21
|
+
GetDomain200ResponseMetaToJSONTyped,
|
|
22
|
+
} from './GetDomain200ResponseMeta';
|
|
23
|
+
import type { WaaSEndpoint } from './WaaSEndpoint';
|
|
24
|
+
import {
|
|
25
|
+
WaaSEndpointFromJSON,
|
|
26
|
+
WaaSEndpointFromJSONTyped,
|
|
27
|
+
WaaSEndpointToJSON,
|
|
28
|
+
WaaSEndpointToJSONTyped,
|
|
29
|
+
} from './WaaSEndpoint';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface UpdateWaaSEndpoint200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface UpdateWaaSEndpoint200Response {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {WaaSEndpoint}
|
|
40
|
+
* @memberof UpdateWaaSEndpoint200Response
|
|
41
|
+
*/
|
|
42
|
+
data?: WaaSEndpoint;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {GetDomain200ResponseMeta}
|
|
46
|
+
* @memberof UpdateWaaSEndpoint200Response
|
|
47
|
+
*/
|
|
48
|
+
meta?: GetDomain200ResponseMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the UpdateWaaSEndpoint200Response interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfUpdateWaaSEndpoint200Response(value: object): value is UpdateWaaSEndpoint200Response {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function UpdateWaaSEndpoint200ResponseFromJSON(json: any): UpdateWaaSEndpoint200Response {
|
|
59
|
+
return UpdateWaaSEndpoint200ResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function UpdateWaaSEndpoint200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateWaaSEndpoint200Response {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : WaaSEndpointFromJSON(json['data']),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : GetDomain200ResponseMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function UpdateWaaSEndpoint200ResponseToJSON(json: any): UpdateWaaSEndpoint200Response {
|
|
74
|
+
return UpdateWaaSEndpoint200ResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function UpdateWaaSEndpoint200ResponseToJSONTyped(value?: UpdateWaaSEndpoint200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': WaaSEndpointToJSON(value['data']),
|
|
85
|
+
'meta': GetDomain200ResponseMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -0,0 +1,88 @@
|
|
|
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 { WaaSEventType } from './WaaSEventType';
|
|
17
|
+
import {
|
|
18
|
+
WaaSEventTypeFromJSON,
|
|
19
|
+
WaaSEventTypeFromJSONTyped,
|
|
20
|
+
WaaSEventTypeToJSON,
|
|
21
|
+
WaaSEventTypeToJSONTyped,
|
|
22
|
+
} from './WaaSEventType';
|
|
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 UpdateWaaSEventType200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface UpdateWaaSEventType200Response {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {WaaSEventType}
|
|
40
|
+
* @memberof UpdateWaaSEventType200Response
|
|
41
|
+
*/
|
|
42
|
+
data?: WaaSEventType;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {GetDomain200ResponseMeta}
|
|
46
|
+
* @memberof UpdateWaaSEventType200Response
|
|
47
|
+
*/
|
|
48
|
+
meta?: GetDomain200ResponseMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the UpdateWaaSEventType200Response interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfUpdateWaaSEventType200Response(value: object): value is UpdateWaaSEventType200Response {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function UpdateWaaSEventType200ResponseFromJSON(json: any): UpdateWaaSEventType200Response {
|
|
59
|
+
return UpdateWaaSEventType200ResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function UpdateWaaSEventType200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateWaaSEventType200Response {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : WaaSEventTypeFromJSON(json['data']),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : GetDomain200ResponseMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function UpdateWaaSEventType200ResponseToJSON(json: any): UpdateWaaSEventType200Response {
|
|
74
|
+
return UpdateWaaSEventType200ResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function UpdateWaaSEventType200ResponseToJSONTyped(value?: UpdateWaaSEventType200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': WaaSEventTypeToJSON(value['data']),
|
|
85
|
+
'meta': GetDomain200ResponseMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
package/src/src/models/index.ts
CHANGED
|
@@ -45,6 +45,8 @@ export * from './BulkUpsertAuthEmailTemplatesResponse';
|
|
|
45
45
|
export * from './Category';
|
|
46
46
|
export * from './CategoryListResponse';
|
|
47
47
|
export * from './CategoryResponse';
|
|
48
|
+
export * from './CloseWaaSEndpointCircuit200Response';
|
|
49
|
+
export * from './CloseWaaSEndpointCircuit200ResponseData';
|
|
48
50
|
export * from './ConfirmEmailVerificationRequest';
|
|
49
51
|
export * from './ConfirmEmailVerificationResponse';
|
|
50
52
|
export * from './ConfirmEmailVerificationResponseData';
|
|
@@ -121,7 +123,25 @@ export * from './GenerateSubscriberTokenRequest';
|
|
|
121
123
|
export * from './GenerateWaaSPortalToken201Response';
|
|
122
124
|
export * from './GetDomain200Response';
|
|
123
125
|
export * from './GetDomain200ResponseMeta';
|
|
126
|
+
export * from './GetEndUserById200Response';
|
|
127
|
+
export * from './GetEndUserClaims200Response';
|
|
128
|
+
export * from './GetEndUserClaims200ResponseData';
|
|
129
|
+
export * from './GetSubscriberInboxPreferences200Response';
|
|
130
|
+
export * from './GetSubscriberInboxPreferences200ResponseData';
|
|
131
|
+
export * from './GetSubscriberInboxPreferences200ResponseDataCategoriesInner';
|
|
132
|
+
export * from './GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory';
|
|
133
|
+
export * from './GetSubscriberInboxPreferences200ResponseDataGlobal';
|
|
134
|
+
export * from './GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner';
|
|
135
|
+
export * from './GetSubscriberNotification200Response';
|
|
136
|
+
export * from './GetSubscriberUnreadCount200Response';
|
|
137
|
+
export * from './GetWaaSDelivery200Response';
|
|
124
138
|
export * from './GetWaaSEndpoint200Response';
|
|
139
|
+
export * from './GetWaaSEndpointCircuit200Response';
|
|
140
|
+
export * from './GetWaaSEndpointCircuit200ResponseData';
|
|
141
|
+
export * from './GetWaaSEndpointMetrics200Response';
|
|
142
|
+
export * from './GetWaaSEndpointMetrics200ResponseData';
|
|
143
|
+
export * from './GetWaaSEndpointMetrics200ResponseDataHealth';
|
|
144
|
+
export * from './GetWaaSEndpointMetrics200ResponseDataWindowsValue';
|
|
125
145
|
export * from './GetWaaSUsage200Response';
|
|
126
146
|
export * from './InAppNotification';
|
|
127
147
|
export * from './InboundAttachmentUrlResponse';
|
|
@@ -135,13 +155,16 @@ export * from './InboundEmailResponse';
|
|
|
135
155
|
export * from './InboxListMeta';
|
|
136
156
|
export * from './InboxListResponse';
|
|
137
157
|
export * from './InboxNotificationResponse';
|
|
158
|
+
export * from './InviteEndUser200Response';
|
|
159
|
+
export * from './InviteEndUser200ResponseData';
|
|
138
160
|
export * from './InviteEndUserRequest';
|
|
161
|
+
export * from './ListEndUsers200Response';
|
|
162
|
+
export * from './ListEndUsers200ResponseMeta';
|
|
139
163
|
export * from './ListWaaSApplications200Response';
|
|
140
164
|
export * from './ListWaaSEndpointDeliveries200Response';
|
|
141
165
|
export * from './ListWaaSEndpoints200Response';
|
|
142
166
|
export * from './ListWaaSEventTypes200Response';
|
|
143
167
|
export * from './ListWorkflowExecutions200Response';
|
|
144
|
-
export * from './ListWorkflowExecutions200ResponseMeta';
|
|
145
168
|
export * from './ListWorkflows200Response';
|
|
146
169
|
export * from './ListWorkflows200ResponseMeta';
|
|
147
170
|
export * from './LoginRequest';
|
|
@@ -152,6 +175,7 @@ export * from './MagicLinkVerifyResponseData';
|
|
|
152
175
|
export * from './MarkAllInboxReadRequest';
|
|
153
176
|
export * from './MarkAllReadData';
|
|
154
177
|
export * from './MarkAllReadResponse';
|
|
178
|
+
export * from './MarkAllSubscriberNotificationsRead200Response';
|
|
155
179
|
export * from './MarkAllSubscriberNotificationsReadRequest';
|
|
156
180
|
export * from './MarkInboxReadRequest';
|
|
157
181
|
export * from './MfaBackupCodesResponse';
|
|
@@ -248,6 +272,8 @@ export * from './ResubscribeResponse';
|
|
|
248
272
|
export * from './RevokeAllSessionsResponse';
|
|
249
273
|
export * from './RevokeAllSessionsResponseData';
|
|
250
274
|
export * from './RevokeSessionRequest';
|
|
275
|
+
export * from './RotateWaaSEndpointSecret200Response';
|
|
276
|
+
export * from './RotateWaaSEndpointSecret200ResponseData';
|
|
251
277
|
export * from './SendBatchEmailRequest';
|
|
252
278
|
export * from './SendBatchEmailResponse';
|
|
253
279
|
export * from './SendBatchEmailResult';
|
|
@@ -280,6 +306,9 @@ export * from './SendSlackMessageResult';
|
|
|
280
306
|
export * from './SendSmsData';
|
|
281
307
|
export * from './SendSmsRequest';
|
|
282
308
|
export * from './SendSmsResponse';
|
|
309
|
+
export * from './SendTemplateTestEmail202Response';
|
|
310
|
+
export * from './SendTemplateTestEmail202ResponseData';
|
|
311
|
+
export * from './SendTemplateTestEmail202ResponseMeta';
|
|
283
312
|
export * from './SendTemplateTestEmailRequest';
|
|
284
313
|
export * from './SendTestSmsData';
|
|
285
314
|
export * from './SendTestSmsRequest';
|
|
@@ -357,13 +386,18 @@ export * from './UpdateEndUserByApplicationRequest';
|
|
|
357
386
|
export * from './UpdateEndUserRequest';
|
|
358
387
|
export * from './UpdateOrganizationMemberRoleRequest';
|
|
359
388
|
export * from './UpdateOrganizationRequest';
|
|
389
|
+
export * from './UpdateSubscriberPreferences200Response';
|
|
390
|
+
export * from './UpdateSubscriberPreferences200ResponseData';
|
|
391
|
+
export * from './UpdateSubscriberPreferences200ResponseDataPreferencesInner';
|
|
360
392
|
export * from './UpdateSubscriberPreferencesRequest';
|
|
361
393
|
export * from './UpdateSubscriberPreferencesRequestPreferencesInner';
|
|
362
394
|
export * from './UpdateSubscriberRequest';
|
|
363
395
|
export * from './UpdateTemplateRequest';
|
|
364
396
|
export * from './UpdateTopicRequest';
|
|
365
397
|
export * from './UpdateWaaSApplicationRequest';
|
|
398
|
+
export * from './UpdateWaaSEndpoint200Response';
|
|
366
399
|
export * from './UpdateWaaSEndpointRequest';
|
|
400
|
+
export * from './UpdateWaaSEventType200Response';
|
|
367
401
|
export * from './UpdateWaaSEventTypeRequest';
|
|
368
402
|
export * from './UpdateWebhookRequest';
|
|
369
403
|
export * from './UpdateWorkflowRequest';
|