@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
|
@@ -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 ## 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 { AuthEmailTemplateDeleteResponseData } from './AuthEmailTemplateDeleteResponseData';
|
|
17
|
+
import {
|
|
18
|
+
AuthEmailTemplateDeleteResponseDataFromJSON,
|
|
19
|
+
AuthEmailTemplateDeleteResponseDataFromJSONTyped,
|
|
20
|
+
AuthEmailTemplateDeleteResponseDataToJSON,
|
|
21
|
+
AuthEmailTemplateDeleteResponseDataToJSONTyped,
|
|
22
|
+
} from './AuthEmailTemplateDeleteResponseData';
|
|
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 AuthEmailTemplateDeleteResponse
|
|
35
|
+
*/
|
|
36
|
+
export interface AuthEmailTemplateDeleteResponse {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {AuthEmailTemplateDeleteResponseData}
|
|
40
|
+
* @memberof AuthEmailTemplateDeleteResponse
|
|
41
|
+
*/
|
|
42
|
+
data?: AuthEmailTemplateDeleteResponseData;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {RequestMeta}
|
|
46
|
+
* @memberof AuthEmailTemplateDeleteResponse
|
|
47
|
+
*/
|
|
48
|
+
meta?: RequestMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the AuthEmailTemplateDeleteResponse interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfAuthEmailTemplateDeleteResponse(value: object): value is AuthEmailTemplateDeleteResponse {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function AuthEmailTemplateDeleteResponseFromJSON(json: any): AuthEmailTemplateDeleteResponse {
|
|
59
|
+
return AuthEmailTemplateDeleteResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function AuthEmailTemplateDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplateDeleteResponse {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : AuthEmailTemplateDeleteResponseDataFromJSON(json['data']),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function AuthEmailTemplateDeleteResponseToJSON(json: any): AuthEmailTemplateDeleteResponse {
|
|
74
|
+
return AuthEmailTemplateDeleteResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function AuthEmailTemplateDeleteResponseToJSONTyped(value?: AuthEmailTemplateDeleteResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': AuthEmailTemplateDeleteResponseDataToJSON(value['data']),
|
|
85
|
+
'meta': RequestMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -16,29 +16,29 @@ import { mapValues } from '../runtime';
|
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
|
19
|
-
* @interface
|
|
19
|
+
* @interface AuthEmailTemplateDeleteResponseData
|
|
20
20
|
*/
|
|
21
|
-
export interface
|
|
21
|
+
export interface AuthEmailTemplateDeleteResponseData {
|
|
22
22
|
/**
|
|
23
23
|
*
|
|
24
24
|
* @type {boolean}
|
|
25
|
-
* @memberof
|
|
25
|
+
* @memberof AuthEmailTemplateDeleteResponseData
|
|
26
26
|
*/
|
|
27
27
|
success?: boolean;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* Check if a given object implements the
|
|
31
|
+
* Check if a given object implements the AuthEmailTemplateDeleteResponseData interface.
|
|
32
32
|
*/
|
|
33
|
-
export function
|
|
33
|
+
export function instanceOfAuthEmailTemplateDeleteResponseData(value: object): value is AuthEmailTemplateDeleteResponseData {
|
|
34
34
|
return true;
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
export function
|
|
38
|
-
return
|
|
37
|
+
export function AuthEmailTemplateDeleteResponseDataFromJSON(json: any): AuthEmailTemplateDeleteResponseData {
|
|
38
|
+
return AuthEmailTemplateDeleteResponseDataFromJSONTyped(json, false);
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
-
export function
|
|
41
|
+
export function AuthEmailTemplateDeleteResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplateDeleteResponseData {
|
|
42
42
|
if (json == null) {
|
|
43
43
|
return json;
|
|
44
44
|
}
|
|
@@ -48,11 +48,11 @@ export function SuccessResultDataFromJSONTyped(json: any, ignoreDiscriminator: b
|
|
|
48
48
|
};
|
|
49
49
|
}
|
|
50
50
|
|
|
51
|
-
export function
|
|
52
|
-
return
|
|
51
|
+
export function AuthEmailTemplateDeleteResponseDataToJSON(json: any): AuthEmailTemplateDeleteResponseData {
|
|
52
|
+
return AuthEmailTemplateDeleteResponseDataToJSONTyped(json, false);
|
|
53
53
|
}
|
|
54
54
|
|
|
55
|
-
export function
|
|
55
|
+
export function AuthEmailTemplateDeleteResponseDataToJSONTyped(value?: AuthEmailTemplateDeleteResponseData | null, ignoreDiscriminator: boolean = false): any {
|
|
56
56
|
if (value == null) {
|
|
57
57
|
return value;
|
|
58
58
|
}
|
|
@@ -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 ## 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 { RequestMeta } from './RequestMeta';
|
|
17
|
+
import {
|
|
18
|
+
RequestMetaFromJSON,
|
|
19
|
+
RequestMetaFromJSONTyped,
|
|
20
|
+
RequestMetaToJSON,
|
|
21
|
+
RequestMetaToJSONTyped,
|
|
22
|
+
} from './RequestMeta';
|
|
23
|
+
import type { AuthEmailTemplate } from './AuthEmailTemplate';
|
|
24
|
+
import {
|
|
25
|
+
AuthEmailTemplateFromJSON,
|
|
26
|
+
AuthEmailTemplateFromJSONTyped,
|
|
27
|
+
AuthEmailTemplateToJSON,
|
|
28
|
+
AuthEmailTemplateToJSONTyped,
|
|
29
|
+
} from './AuthEmailTemplate';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface AuthEmailTemplateListResponse
|
|
35
|
+
*/
|
|
36
|
+
export interface AuthEmailTemplateListResponse {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {Array<AuthEmailTemplate>}
|
|
40
|
+
* @memberof AuthEmailTemplateListResponse
|
|
41
|
+
*/
|
|
42
|
+
data?: Array<AuthEmailTemplate>;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {RequestMeta}
|
|
46
|
+
* @memberof AuthEmailTemplateListResponse
|
|
47
|
+
*/
|
|
48
|
+
meta?: RequestMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the AuthEmailTemplateListResponse interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfAuthEmailTemplateListResponse(value: object): value is AuthEmailTemplateListResponse {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function AuthEmailTemplateListResponseFromJSON(json: any): AuthEmailTemplateListResponse {
|
|
59
|
+
return AuthEmailTemplateListResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function AuthEmailTemplateListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplateListResponse {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(AuthEmailTemplateFromJSON)),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function AuthEmailTemplateListResponseToJSON(json: any): AuthEmailTemplateListResponse {
|
|
74
|
+
return AuthEmailTemplateListResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function AuthEmailTemplateListResponseToJSONTyped(value?: AuthEmailTemplateListResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(AuthEmailTemplateToJSON)),
|
|
85
|
+
'meta': RequestMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -0,0 +1,108 @@
|
|
|
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
|
+
* In-flight editor values. When provided, the preview is rendered against
|
|
18
|
+
* these instead of the persisted template. Useful for live-preview while
|
|
19
|
+
* editing.
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
* @interface AuthEmailTemplatePreviewDraft
|
|
23
|
+
*/
|
|
24
|
+
export interface AuthEmailTemplatePreviewDraft {
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
29
|
+
*/
|
|
30
|
+
subject?: string | null;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
35
|
+
*/
|
|
36
|
+
html?: string | null;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
41
|
+
*/
|
|
42
|
+
text?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
47
|
+
*/
|
|
48
|
+
mjmlSource?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
53
|
+
*/
|
|
54
|
+
fromName?: string | null;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof AuthEmailTemplatePreviewDraft
|
|
59
|
+
*/
|
|
60
|
+
replyTo?: string | null;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the AuthEmailTemplatePreviewDraft interface.
|
|
65
|
+
*/
|
|
66
|
+
export function instanceOfAuthEmailTemplatePreviewDraft(value: object): value is AuthEmailTemplatePreviewDraft {
|
|
67
|
+
return true;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function AuthEmailTemplatePreviewDraftFromJSON(json: any): AuthEmailTemplatePreviewDraft {
|
|
71
|
+
return AuthEmailTemplatePreviewDraftFromJSONTyped(json, false);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export function AuthEmailTemplatePreviewDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplatePreviewDraft {
|
|
75
|
+
if (json == null) {
|
|
76
|
+
return json;
|
|
77
|
+
}
|
|
78
|
+
return {
|
|
79
|
+
|
|
80
|
+
'subject': json['subject'] == null ? undefined : json['subject'],
|
|
81
|
+
'html': json['html'] == null ? undefined : json['html'],
|
|
82
|
+
'text': json['text'] == null ? undefined : json['text'],
|
|
83
|
+
'mjmlSource': json['mjml_source'] == null ? undefined : json['mjml_source'],
|
|
84
|
+
'fromName': json['from_name'] == null ? undefined : json['from_name'],
|
|
85
|
+
'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export function AuthEmailTemplatePreviewDraftToJSON(json: any): AuthEmailTemplatePreviewDraft {
|
|
90
|
+
return AuthEmailTemplatePreviewDraftToJSONTyped(json, false);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export function AuthEmailTemplatePreviewDraftToJSONTyped(value?: AuthEmailTemplatePreviewDraft | null, ignoreDiscriminator: boolean = false): any {
|
|
94
|
+
if (value == null) {
|
|
95
|
+
return value;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
return {
|
|
99
|
+
|
|
100
|
+
'subject': value['subject'],
|
|
101
|
+
'html': value['html'],
|
|
102
|
+
'text': value['text'],
|
|
103
|
+
'mjml_source': value['mjmlSource'],
|
|
104
|
+
'from_name': value['fromName'],
|
|
105
|
+
'reply_to': value['replyTo'],
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
@@ -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 ## 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 { AuthEmailTemplatePreviewDraft } from './AuthEmailTemplatePreviewDraft';
|
|
17
|
+
import {
|
|
18
|
+
AuthEmailTemplatePreviewDraftFromJSON,
|
|
19
|
+
AuthEmailTemplatePreviewDraftFromJSONTyped,
|
|
20
|
+
AuthEmailTemplatePreviewDraftToJSON,
|
|
21
|
+
AuthEmailTemplatePreviewDraftToJSONTyped,
|
|
22
|
+
} from './AuthEmailTemplatePreviewDraft';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface AuthEmailTemplatePreviewRequest
|
|
28
|
+
*/
|
|
29
|
+
export interface AuthEmailTemplatePreviewRequest {
|
|
30
|
+
/**
|
|
31
|
+
* Variables to interpolate. If omitted, sample values are used.
|
|
32
|
+
* @type {{ [key: string]: any; }}
|
|
33
|
+
* @memberof AuthEmailTemplatePreviewRequest
|
|
34
|
+
*/
|
|
35
|
+
variables?: { [key: string]: any; };
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {AuthEmailTemplatePreviewDraft}
|
|
39
|
+
* @memberof AuthEmailTemplatePreviewRequest
|
|
40
|
+
*/
|
|
41
|
+
draft?: AuthEmailTemplatePreviewDraft;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the AuthEmailTemplatePreviewRequest interface.
|
|
46
|
+
*/
|
|
47
|
+
export function instanceOfAuthEmailTemplatePreviewRequest(value: object): value is AuthEmailTemplatePreviewRequest {
|
|
48
|
+
return true;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function AuthEmailTemplatePreviewRequestFromJSON(json: any): AuthEmailTemplatePreviewRequest {
|
|
52
|
+
return AuthEmailTemplatePreviewRequestFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function AuthEmailTemplatePreviewRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplatePreviewRequest {
|
|
56
|
+
if (json == null) {
|
|
57
|
+
return json;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
|
|
61
|
+
'variables': json['variables'] == null ? undefined : json['variables'],
|
|
62
|
+
'draft': json['draft'] == null ? undefined : AuthEmailTemplatePreviewDraftFromJSON(json['draft']),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function AuthEmailTemplatePreviewRequestToJSON(json: any): AuthEmailTemplatePreviewRequest {
|
|
67
|
+
return AuthEmailTemplatePreviewRequestToJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function AuthEmailTemplatePreviewRequestToJSONTyped(value?: AuthEmailTemplatePreviewRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
71
|
+
if (value == null) {
|
|
72
|
+
return value;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return {
|
|
76
|
+
|
|
77
|
+
'variables': value['variables'],
|
|
78
|
+
'draft': AuthEmailTemplatePreviewDraftToJSON(value['draft']),
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
@@ -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 ## 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 { AuthEmailTemplatePreviewResult } from './AuthEmailTemplatePreviewResult';
|
|
17
|
+
import {
|
|
18
|
+
AuthEmailTemplatePreviewResultFromJSON,
|
|
19
|
+
AuthEmailTemplatePreviewResultFromJSONTyped,
|
|
20
|
+
AuthEmailTemplatePreviewResultToJSON,
|
|
21
|
+
AuthEmailTemplatePreviewResultToJSONTyped,
|
|
22
|
+
} from './AuthEmailTemplatePreviewResult';
|
|
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 AuthEmailTemplatePreviewResponse
|
|
35
|
+
*/
|
|
36
|
+
export interface AuthEmailTemplatePreviewResponse {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {AuthEmailTemplatePreviewResult}
|
|
40
|
+
* @memberof AuthEmailTemplatePreviewResponse
|
|
41
|
+
*/
|
|
42
|
+
data?: AuthEmailTemplatePreviewResult;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {RequestMeta}
|
|
46
|
+
* @memberof AuthEmailTemplatePreviewResponse
|
|
47
|
+
*/
|
|
48
|
+
meta?: RequestMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the AuthEmailTemplatePreviewResponse interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfAuthEmailTemplatePreviewResponse(value: object): value is AuthEmailTemplatePreviewResponse {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function AuthEmailTemplatePreviewResponseFromJSON(json: any): AuthEmailTemplatePreviewResponse {
|
|
59
|
+
return AuthEmailTemplatePreviewResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function AuthEmailTemplatePreviewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplatePreviewResponse {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : AuthEmailTemplatePreviewResultFromJSON(json['data']),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function AuthEmailTemplatePreviewResponseToJSON(json: any): AuthEmailTemplatePreviewResponse {
|
|
74
|
+
return AuthEmailTemplatePreviewResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function AuthEmailTemplatePreviewResponseToJSONTyped(value?: AuthEmailTemplatePreviewResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': AuthEmailTemplatePreviewResultToJSON(value['data']),
|
|
85
|
+
'meta': RequestMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -0,0 +1,97 @@
|
|
|
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 AuthEmailTemplatePreviewResult
|
|
20
|
+
*/
|
|
21
|
+
export interface AuthEmailTemplatePreviewResult {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AuthEmailTemplatePreviewResult
|
|
26
|
+
*/
|
|
27
|
+
subject?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AuthEmailTemplatePreviewResult
|
|
32
|
+
*/
|
|
33
|
+
html?: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof AuthEmailTemplatePreviewResult
|
|
38
|
+
*/
|
|
39
|
+
text?: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AuthEmailTemplatePreviewResult
|
|
44
|
+
*/
|
|
45
|
+
fromName?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof AuthEmailTemplatePreviewResult
|
|
50
|
+
*/
|
|
51
|
+
replyTo?: string | null;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the AuthEmailTemplatePreviewResult interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfAuthEmailTemplatePreviewResult(value: object): value is AuthEmailTemplatePreviewResult {
|
|
58
|
+
return true;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export function AuthEmailTemplatePreviewResultFromJSON(json: any): AuthEmailTemplatePreviewResult {
|
|
62
|
+
return AuthEmailTemplatePreviewResultFromJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function AuthEmailTemplatePreviewResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplatePreviewResult {
|
|
66
|
+
if (json == null) {
|
|
67
|
+
return json;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'subject': json['subject'] == null ? undefined : json['subject'],
|
|
72
|
+
'html': json['html'] == null ? undefined : json['html'],
|
|
73
|
+
'text': json['text'] == null ? undefined : json['text'],
|
|
74
|
+
'fromName': json['from_name'] == null ? undefined : json['from_name'],
|
|
75
|
+
'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function AuthEmailTemplatePreviewResultToJSON(json: any): AuthEmailTemplatePreviewResult {
|
|
80
|
+
return AuthEmailTemplatePreviewResultToJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function AuthEmailTemplatePreviewResultToJSONTyped(value?: AuthEmailTemplatePreviewResult | null, ignoreDiscriminator: boolean = false): any {
|
|
84
|
+
if (value == null) {
|
|
85
|
+
return value;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
return {
|
|
89
|
+
|
|
90
|
+
'subject': value['subject'],
|
|
91
|
+
'html': value['html'],
|
|
92
|
+
'text': value['text'],
|
|
93
|
+
'from_name': value['fromName'],
|
|
94
|
+
'reply_to': value['replyTo'],
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
|