@zyphr-dev/node-sdk 0.1.19 → 0.1.21
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 +1964 -190
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3178 -1137
- package/dist/index.d.ts +3178 -1137
- package/dist/index.js +1811 -185
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +31 -1
- package/src/client.ts +3 -0
- package/src/src/apis/AuthEmailTemplatesApi.ts +734 -0
- package/src/src/apis/SlackApi.ts +264 -0
- package/src/src/apis/index.ts +2 -0
- package/src/src/models/AuthEmailTemplate.ts +181 -0
- package/src/src/models/AuthEmailTemplateDefault.ts +107 -0
- package/src/src/models/AuthEmailTemplateDefaultResponse.ts +88 -0
- package/src/src/models/AuthEmailTemplateDeleteResponse.ts +88 -0
- package/src/src/models/{SuccessResultData.ts → AuthEmailTemplateDeleteResponseData.ts} +11 -11
- package/src/src/models/AuthEmailTemplateListResponse.ts +88 -0
- package/src/src/models/AuthEmailTemplatePreviewDraft.ts +108 -0
- package/src/src/models/AuthEmailTemplatePreviewRequest.ts +81 -0
- package/src/src/models/AuthEmailTemplatePreviewResponse.ts +88 -0
- package/src/src/models/AuthEmailTemplatePreviewResult.ts +97 -0
- package/src/src/models/AuthEmailTemplateResponse.ts +88 -0
- package/src/src/models/AuthEmailTemplateTestRequest.ts +74 -0
- package/src/src/models/AuthEmailTemplateTestResponse.ts +88 -0
- package/src/src/models/AuthEmailTemplateTestResult.ts +73 -0
- package/src/src/models/AuthEmailTemplateVersion.ts +157 -0
- package/src/src/models/AuthEmailTemplateVersionsResponse.ts +88 -0
- package/src/src/models/AuthEmailType.ts +54 -0
- package/src/src/models/BulkUpsertAuthEmailTemplatesRequest.ts +91 -0
- package/src/src/models/BulkUpsertAuthEmailTemplatesResponse.ts +88 -0
- package/src/src/models/ResubscribeResponse.ts +10 -10
- package/src/src/models/SendSlackMessageRequest.ts +156 -0
- package/src/src/models/SendSlackMessageResponse.ts +88 -0
- package/src/src/models/SendSlackMessageResult.ts +115 -0
- package/src/src/models/SlackMessage.ts +203 -0
- package/src/src/models/SlackMessageListResponse.ts +88 -0
- package/src/src/models/SlackMessageListResponseMeta.ts +89 -0
- package/src/src/models/SlackMessageResponse.ts +88 -0
- package/src/src/models/SlackMessageStatus.ts +56 -0
- package/src/src/models/SlackMessageSummary.ts +155 -0
- package/src/src/models/SuccessResult.ts +10 -10
- package/src/src/models/UpsertAuthEmailTemplateRequest.ts +143 -0
- package/src/src/models/index.ts +29 -1
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
-
import type {
|
|
16
|
+
import type { AuthEmailTemplateDeleteResponseData } from './AuthEmailTemplateDeleteResponseData';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
} from './
|
|
18
|
+
AuthEmailTemplateDeleteResponseDataFromJSON,
|
|
19
|
+
AuthEmailTemplateDeleteResponseDataFromJSONTyped,
|
|
20
|
+
AuthEmailTemplateDeleteResponseDataToJSON,
|
|
21
|
+
AuthEmailTemplateDeleteResponseDataToJSONTyped,
|
|
22
|
+
} from './AuthEmailTemplateDeleteResponseData';
|
|
23
23
|
import type { RequestMeta } from './RequestMeta';
|
|
24
24
|
import {
|
|
25
25
|
RequestMetaFromJSON,
|
|
@@ -36,10 +36,10 @@ import {
|
|
|
36
36
|
export interface SuccessResult {
|
|
37
37
|
/**
|
|
38
38
|
*
|
|
39
|
-
* @type {
|
|
39
|
+
* @type {AuthEmailTemplateDeleteResponseData}
|
|
40
40
|
* @memberof SuccessResult
|
|
41
41
|
*/
|
|
42
|
-
data?:
|
|
42
|
+
data?: AuthEmailTemplateDeleteResponseData;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
45
|
* @type {RequestMeta}
|
|
@@ -65,7 +65,7 @@ export function SuccessResultFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
65
65
|
}
|
|
66
66
|
return {
|
|
67
67
|
|
|
68
|
-
'data': json['data'] == null ? undefined :
|
|
68
|
+
'data': json['data'] == null ? undefined : AuthEmailTemplateDeleteResponseDataFromJSON(json['data']),
|
|
69
69
|
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
70
|
};
|
|
71
71
|
}
|
|
@@ -81,7 +81,7 @@ export function SuccessResultToJSONTyped(value?: SuccessResult | null, ignoreDis
|
|
|
81
81
|
|
|
82
82
|
return {
|
|
83
83
|
|
|
84
|
-
'data':
|
|
84
|
+
'data': AuthEmailTemplateDeleteResponseDataToJSON(value['data']),
|
|
85
85
|
'meta': RequestMetaToJSON(value['meta']),
|
|
86
86
|
};
|
|
87
87
|
}
|
|
@@ -0,0 +1,143 @@
|
|
|
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
|
+
* Subject is required. Provide one of `html`, `mjml_source`, or `design_json`.
|
|
18
|
+
* MJML sources are compiled to HTML on save.
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface UpsertAuthEmailTemplateRequest
|
|
22
|
+
*/
|
|
23
|
+
export interface UpsertAuthEmailTemplateRequest {
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
28
|
+
*/
|
|
29
|
+
subject?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
34
|
+
*/
|
|
35
|
+
html?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
40
|
+
*/
|
|
41
|
+
text?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
46
|
+
*/
|
|
47
|
+
mjmlSource?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {{ [key: string]: any; }}
|
|
51
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
52
|
+
*/
|
|
53
|
+
designJson?: { [key: string]: any; } | null;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
58
|
+
*/
|
|
59
|
+
editorType?: UpsertAuthEmailTemplateRequestEditorTypeEnum | null;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
64
|
+
*/
|
|
65
|
+
fromName?: string | null;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
70
|
+
*/
|
|
71
|
+
replyTo?: string | null;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {boolean}
|
|
75
|
+
* @memberof UpsertAuthEmailTemplateRequest
|
|
76
|
+
*/
|
|
77
|
+
isEnabled?: boolean;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
export const UpsertAuthEmailTemplateRequestEditorTypeEnum = {
|
|
85
|
+
CODE: 'code',
|
|
86
|
+
MJML: 'mjml',
|
|
87
|
+
DESIGN: 'design'
|
|
88
|
+
} as const;
|
|
89
|
+
export type UpsertAuthEmailTemplateRequestEditorTypeEnum = typeof UpsertAuthEmailTemplateRequestEditorTypeEnum[keyof typeof UpsertAuthEmailTemplateRequestEditorTypeEnum];
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Check if a given object implements the UpsertAuthEmailTemplateRequest interface.
|
|
94
|
+
*/
|
|
95
|
+
export function instanceOfUpsertAuthEmailTemplateRequest(value: object): value is UpsertAuthEmailTemplateRequest {
|
|
96
|
+
return true;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export function UpsertAuthEmailTemplateRequestFromJSON(json: any): UpsertAuthEmailTemplateRequest {
|
|
100
|
+
return UpsertAuthEmailTemplateRequestFromJSONTyped(json, false);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export function UpsertAuthEmailTemplateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertAuthEmailTemplateRequest {
|
|
104
|
+
if (json == null) {
|
|
105
|
+
return json;
|
|
106
|
+
}
|
|
107
|
+
return {
|
|
108
|
+
|
|
109
|
+
'subject': json['subject'] == null ? undefined : json['subject'],
|
|
110
|
+
'html': json['html'] == null ? undefined : json['html'],
|
|
111
|
+
'text': json['text'] == null ? undefined : json['text'],
|
|
112
|
+
'mjmlSource': json['mjml_source'] == null ? undefined : json['mjml_source'],
|
|
113
|
+
'designJson': json['design_json'] == null ? undefined : json['design_json'],
|
|
114
|
+
'editorType': json['editor_type'] == null ? undefined : json['editor_type'],
|
|
115
|
+
'fromName': json['from_name'] == null ? undefined : json['from_name'],
|
|
116
|
+
'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
|
|
117
|
+
'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export function UpsertAuthEmailTemplateRequestToJSON(json: any): UpsertAuthEmailTemplateRequest {
|
|
122
|
+
return UpsertAuthEmailTemplateRequestToJSONTyped(json, false);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export function UpsertAuthEmailTemplateRequestToJSONTyped(value?: UpsertAuthEmailTemplateRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
126
|
+
if (value == null) {
|
|
127
|
+
return value;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
return {
|
|
131
|
+
|
|
132
|
+
'subject': value['subject'],
|
|
133
|
+
'html': value['html'],
|
|
134
|
+
'text': value['text'],
|
|
135
|
+
'mjml_source': value['mjmlSource'],
|
|
136
|
+
'design_json': value['designJson'],
|
|
137
|
+
'editor_type': value['editorType'],
|
|
138
|
+
'from_name': value['fromName'],
|
|
139
|
+
'reply_to': value['replyTo'],
|
|
140
|
+
'is_enabled': value['isEnabled'],
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
|
package/src/src/models/index.ts
CHANGED
|
@@ -4,6 +4,23 @@ export * from './AddTopicSubscribersRequest';
|
|
|
4
4
|
export * from './ApiError';
|
|
5
5
|
export * from './ApiErrorError';
|
|
6
6
|
export * from './ApiErrorMeta';
|
|
7
|
+
export * from './AuthEmailTemplate';
|
|
8
|
+
export * from './AuthEmailTemplateDefault';
|
|
9
|
+
export * from './AuthEmailTemplateDefaultResponse';
|
|
10
|
+
export * from './AuthEmailTemplateDeleteResponse';
|
|
11
|
+
export * from './AuthEmailTemplateDeleteResponseData';
|
|
12
|
+
export * from './AuthEmailTemplateListResponse';
|
|
13
|
+
export * from './AuthEmailTemplatePreviewDraft';
|
|
14
|
+
export * from './AuthEmailTemplatePreviewRequest';
|
|
15
|
+
export * from './AuthEmailTemplatePreviewResponse';
|
|
16
|
+
export * from './AuthEmailTemplatePreviewResult';
|
|
17
|
+
export * from './AuthEmailTemplateResponse';
|
|
18
|
+
export * from './AuthEmailTemplateTestRequest';
|
|
19
|
+
export * from './AuthEmailTemplateTestResponse';
|
|
20
|
+
export * from './AuthEmailTemplateTestResult';
|
|
21
|
+
export * from './AuthEmailTemplateVersion';
|
|
22
|
+
export * from './AuthEmailTemplateVersionsResponse';
|
|
23
|
+
export * from './AuthEmailType';
|
|
7
24
|
export * from './AuthLoginResponse';
|
|
8
25
|
export * from './AuthLoginResult';
|
|
9
26
|
export * from './AuthLoginResultMfaChallenge';
|
|
@@ -16,6 +33,8 @@ export * from './AuthUserResponse';
|
|
|
16
33
|
export * from './AuthUserResponseData';
|
|
17
34
|
export * from './BatchPublishWaaSEvents201Response';
|
|
18
35
|
export * from './BulkRetryWebhookDeliveriesRequest';
|
|
36
|
+
export * from './BulkUpsertAuthEmailTemplatesRequest';
|
|
37
|
+
export * from './BulkUpsertAuthEmailTemplatesResponse';
|
|
19
38
|
export * from './Category';
|
|
20
39
|
export * from './CategoryListResponse';
|
|
21
40
|
export * from './CategoryResponse';
|
|
@@ -201,6 +220,9 @@ export * from './SendPushResponseData';
|
|
|
201
220
|
export * from './SendPushToTopicData';
|
|
202
221
|
export * from './SendPushToTopicRequest';
|
|
203
222
|
export * from './SendPushToTopicResponse';
|
|
223
|
+
export * from './SendSlackMessageRequest';
|
|
224
|
+
export * from './SendSlackMessageResponse';
|
|
225
|
+
export * from './SendSlackMessageResult';
|
|
204
226
|
export * from './SendSmsData';
|
|
205
227
|
export * from './SendSmsRequest';
|
|
206
228
|
export * from './SendSmsResponse';
|
|
@@ -213,6 +235,12 @@ export * from './SessionListResponseData';
|
|
|
213
235
|
export * from './SessionListResponseDataSessionInfo';
|
|
214
236
|
export * from './SetPreferencesRequest';
|
|
215
237
|
export * from './SetPreferencesRequestPreferencesInner';
|
|
238
|
+
export * from './SlackMessage';
|
|
239
|
+
export * from './SlackMessageListResponse';
|
|
240
|
+
export * from './SlackMessageListResponseMeta';
|
|
241
|
+
export * from './SlackMessageResponse';
|
|
242
|
+
export * from './SlackMessageStatus';
|
|
243
|
+
export * from './SlackMessageSummary';
|
|
216
244
|
export * from './SmsBatchResultMessage';
|
|
217
245
|
export * from './SmsBatchResultSummary';
|
|
218
246
|
export * from './SmsConfig';
|
|
@@ -230,7 +258,6 @@ export * from './SubscriberListResponse';
|
|
|
230
258
|
export * from './SubscriberPreference';
|
|
231
259
|
export * from './SubscriberResponse';
|
|
232
260
|
export * from './SuccessResult';
|
|
233
|
-
export * from './SuccessResultData';
|
|
234
261
|
export * from './Template';
|
|
235
262
|
export * from './TemplateListResponse';
|
|
236
263
|
export * from './TemplateRenderResponse';
|
|
@@ -268,6 +295,7 @@ export * from './UpdateWaaSApplicationRequest';
|
|
|
268
295
|
export * from './UpdateWaaSEndpointRequest';
|
|
269
296
|
export * from './UpdateWaaSEventTypeRequest';
|
|
270
297
|
export * from './UpdateWebhookRequest';
|
|
298
|
+
export * from './UpsertAuthEmailTemplateRequest';
|
|
271
299
|
export * from './UpsertSmsConfigRequest';
|
|
272
300
|
export * from './UserDevicesDeleteResponse';
|
|
273
301
|
export * from './UserDevicesDeleteResponseData';
|