@zyphr-dev/node-sdk 0.1.39 → 0.1.41
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 +2315 -1220
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1724 -622
- package/dist/index.d.ts +1724 -622
- package/dist/index.js +2195 -1203
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +24 -4
- package/src/src/apis/AuthRegistrationApi.ts +4 -4
- package/src/src/apis/WorkflowsApi.ts +912 -0
- package/src/src/apis/index.ts +1 -1
- package/src/src/models/AddWorkflowStep201Response.ts +88 -0
- package/src/src/models/AddWorkflowStepRequest.ts +136 -0
- package/src/src/models/CreateWorkflow201Response.ts +88 -0
- package/src/src/models/CreateWorkflowRequest.ts +98 -0
- package/src/src/models/DeleteWorkflow200Response.ts +88 -0
- package/src/src/models/{TopicDeleteResponseData.ts → DeleteWorkflow200ResponseData.ts} +12 -12
- package/src/src/models/DeleteWorkflowStep200Response.ts +88 -0
- package/src/src/models/DeleteWorkflowStep200ResponseData.ts +81 -0
- package/src/src/models/ListWorkflowExecutions200Response.ts +88 -0
- package/src/src/models/{SmsListResponseMeta.ts → ListWorkflowExecutions200ResponseMeta.ts} +15 -15
- package/src/src/models/ListWorkflows200Response.ts +88 -0
- package/src/src/models/ListWorkflows200ResponseMeta.ts +121 -0
- package/src/src/models/ReorderWorkflowStepsRequest.ts +66 -0
- package/src/src/models/SignInWithGameCenterRequest.ts +1 -1
- package/src/src/models/SmsListResponse.ts +10 -10
- package/src/src/models/TopicDeleteResponse.ts +10 -10
- package/src/src/models/TriggerWorkflow202Response.ts +88 -0
- package/src/src/models/TriggerWorkflow202ResponseData.ts +81 -0
- package/src/src/models/TriggerWorkflowRequest.ts +90 -0
- package/src/src/models/UpdateWorkflowRequest.ts +89 -0
- package/src/src/models/UpdateWorkflowStatusRequest.ts +76 -0
- package/src/src/models/UpdateWorkflowStepRequest.ts +73 -0
- package/src/src/models/Workflow.ts +187 -0
- package/src/src/models/WorkflowStatus.ts +55 -0
- package/src/src/models/WorkflowStep.ts +176 -0
- package/src/src/models/WorkflowStepType.ts +60 -0
- package/src/src/models/index.ts +23 -3
- package/src/src/apis/MuseApi.ts +0 -531
- package/src/src/models/V1MuseSubjectsSuggestPostRequest.ts +0 -105
|
@@ -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
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface DeleteWorkflowStep200ResponseData
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteWorkflowStep200ResponseData {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof DeleteWorkflowStep200ResponseData
|
|
26
|
+
*/
|
|
27
|
+
workflowKey?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof DeleteWorkflowStep200ResponseData
|
|
32
|
+
*/
|
|
33
|
+
stepKey?: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof DeleteWorkflowStep200ResponseData
|
|
38
|
+
*/
|
|
39
|
+
deleted?: boolean;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Check if a given object implements the DeleteWorkflowStep200ResponseData interface.
|
|
44
|
+
*/
|
|
45
|
+
export function instanceOfDeleteWorkflowStep200ResponseData(value: object): value is DeleteWorkflowStep200ResponseData {
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function DeleteWorkflowStep200ResponseDataFromJSON(json: any): DeleteWorkflowStep200ResponseData {
|
|
50
|
+
return DeleteWorkflowStep200ResponseDataFromJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export function DeleteWorkflowStep200ResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteWorkflowStep200ResponseData {
|
|
54
|
+
if (json == null) {
|
|
55
|
+
return json;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
|
|
59
|
+
'workflowKey': json['workflow_key'] == null ? undefined : json['workflow_key'],
|
|
60
|
+
'stepKey': json['step_key'] == null ? undefined : json['step_key'],
|
|
61
|
+
'deleted': json['deleted'] == null ? undefined : json['deleted'],
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function DeleteWorkflowStep200ResponseDataToJSON(json: any): DeleteWorkflowStep200ResponseData {
|
|
66
|
+
return DeleteWorkflowStep200ResponseDataToJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function DeleteWorkflowStep200ResponseDataToJSONTyped(value?: DeleteWorkflowStep200ResponseData | null, ignoreDiscriminator: boolean = false): any {
|
|
70
|
+
if (value == null) {
|
|
71
|
+
return value;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return {
|
|
75
|
+
|
|
76
|
+
'workflow_key': value['workflowKey'],
|
|
77
|
+
'step_key': value['stepKey'],
|
|
78
|
+
'deleted': value['deleted'],
|
|
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 ## 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 { ListWorkflowExecutions200ResponseMeta } from './ListWorkflowExecutions200ResponseMeta';
|
|
17
|
+
import {
|
|
18
|
+
ListWorkflowExecutions200ResponseMetaFromJSON,
|
|
19
|
+
ListWorkflowExecutions200ResponseMetaFromJSONTyped,
|
|
20
|
+
ListWorkflowExecutions200ResponseMetaToJSON,
|
|
21
|
+
ListWorkflowExecutions200ResponseMetaToJSONTyped,
|
|
22
|
+
} from './ListWorkflowExecutions200ResponseMeta';
|
|
23
|
+
import type { WorkflowExecution } from './WorkflowExecution';
|
|
24
|
+
import {
|
|
25
|
+
WorkflowExecutionFromJSON,
|
|
26
|
+
WorkflowExecutionFromJSONTyped,
|
|
27
|
+
WorkflowExecutionToJSON,
|
|
28
|
+
WorkflowExecutionToJSONTyped,
|
|
29
|
+
} from './WorkflowExecution';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface ListWorkflowExecutions200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface ListWorkflowExecutions200Response {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {Array<WorkflowExecution>}
|
|
40
|
+
* @memberof ListWorkflowExecutions200Response
|
|
41
|
+
*/
|
|
42
|
+
data?: Array<WorkflowExecution>;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {ListWorkflowExecutions200ResponseMeta}
|
|
46
|
+
* @memberof ListWorkflowExecutions200Response
|
|
47
|
+
*/
|
|
48
|
+
meta?: ListWorkflowExecutions200ResponseMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the ListWorkflowExecutions200Response interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfListWorkflowExecutions200Response(value: object): value is ListWorkflowExecutions200Response {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function ListWorkflowExecutions200ResponseFromJSON(json: any): ListWorkflowExecutions200Response {
|
|
59
|
+
return ListWorkflowExecutions200ResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function ListWorkflowExecutions200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListWorkflowExecutions200Response {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(WorkflowExecutionFromJSON)),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : ListWorkflowExecutions200ResponseMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function ListWorkflowExecutions200ResponseToJSON(json: any): ListWorkflowExecutions200Response {
|
|
74
|
+
return ListWorkflowExecutions200ResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function ListWorkflowExecutions200ResponseToJSONTyped(value?: ListWorkflowExecutions200Response | 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(WorkflowExecutionToJSON)),
|
|
85
|
+
'meta': ListWorkflowExecutions200ResponseMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -16,53 +16,53 @@ import { mapValues } from '../runtime';
|
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
|
19
|
-
* @interface
|
|
19
|
+
* @interface ListWorkflowExecutions200ResponseMeta
|
|
20
20
|
*/
|
|
21
|
-
export interface
|
|
21
|
+
export interface ListWorkflowExecutions200ResponseMeta {
|
|
22
22
|
/**
|
|
23
23
|
*
|
|
24
24
|
* @type {string}
|
|
25
|
-
* @memberof
|
|
25
|
+
* @memberof ListWorkflowExecutions200ResponseMeta
|
|
26
26
|
*/
|
|
27
27
|
requestId?: string;
|
|
28
28
|
/**
|
|
29
29
|
*
|
|
30
30
|
* @type {number}
|
|
31
|
-
* @memberof
|
|
31
|
+
* @memberof ListWorkflowExecutions200ResponseMeta
|
|
32
32
|
*/
|
|
33
33
|
page?: number;
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
36
36
|
* @type {number}
|
|
37
|
-
* @memberof
|
|
37
|
+
* @memberof ListWorkflowExecutions200ResponseMeta
|
|
38
38
|
*/
|
|
39
39
|
perPage?: number;
|
|
40
40
|
/**
|
|
41
41
|
*
|
|
42
42
|
* @type {number}
|
|
43
|
-
* @memberof
|
|
43
|
+
* @memberof ListWorkflowExecutions200ResponseMeta
|
|
44
44
|
*/
|
|
45
45
|
total?: number;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @type {number}
|
|
49
|
-
* @memberof
|
|
49
|
+
* @memberof ListWorkflowExecutions200ResponseMeta
|
|
50
50
|
*/
|
|
51
51
|
totalPages?: number;
|
|
52
52
|
}
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* Check if a given object implements the
|
|
55
|
+
* Check if a given object implements the ListWorkflowExecutions200ResponseMeta interface.
|
|
56
56
|
*/
|
|
57
|
-
export function
|
|
57
|
+
export function instanceOfListWorkflowExecutions200ResponseMeta(value: object): value is ListWorkflowExecutions200ResponseMeta {
|
|
58
58
|
return true;
|
|
59
59
|
}
|
|
60
60
|
|
|
61
|
-
export function
|
|
62
|
-
return
|
|
61
|
+
export function ListWorkflowExecutions200ResponseMetaFromJSON(json: any): ListWorkflowExecutions200ResponseMeta {
|
|
62
|
+
return ListWorkflowExecutions200ResponseMetaFromJSONTyped(json, false);
|
|
63
63
|
}
|
|
64
64
|
|
|
65
|
-
export function
|
|
65
|
+
export function ListWorkflowExecutions200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListWorkflowExecutions200ResponseMeta {
|
|
66
66
|
if (json == null) {
|
|
67
67
|
return json;
|
|
68
68
|
}
|
|
@@ -76,11 +76,11 @@ export function SmsListResponseMetaFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
76
76
|
};
|
|
77
77
|
}
|
|
78
78
|
|
|
79
|
-
export function
|
|
80
|
-
return
|
|
79
|
+
export function ListWorkflowExecutions200ResponseMetaToJSON(json: any): ListWorkflowExecutions200ResponseMeta {
|
|
80
|
+
return ListWorkflowExecutions200ResponseMetaToJSONTyped(json, false);
|
|
81
81
|
}
|
|
82
82
|
|
|
83
|
-
export function
|
|
83
|
+
export function ListWorkflowExecutions200ResponseMetaToJSONTyped(value?: ListWorkflowExecutions200ResponseMeta | null, ignoreDiscriminator: boolean = false): any {
|
|
84
84
|
if (value == null) {
|
|
85
85
|
return value;
|
|
86
86
|
}
|
|
@@ -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 { ListWorkflows200ResponseMeta } from './ListWorkflows200ResponseMeta';
|
|
17
|
+
import {
|
|
18
|
+
ListWorkflows200ResponseMetaFromJSON,
|
|
19
|
+
ListWorkflows200ResponseMetaFromJSONTyped,
|
|
20
|
+
ListWorkflows200ResponseMetaToJSON,
|
|
21
|
+
ListWorkflows200ResponseMetaToJSONTyped,
|
|
22
|
+
} from './ListWorkflows200ResponseMeta';
|
|
23
|
+
import type { Workflow } from './Workflow';
|
|
24
|
+
import {
|
|
25
|
+
WorkflowFromJSON,
|
|
26
|
+
WorkflowFromJSONTyped,
|
|
27
|
+
WorkflowToJSON,
|
|
28
|
+
WorkflowToJSONTyped,
|
|
29
|
+
} from './Workflow';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface ListWorkflows200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface ListWorkflows200Response {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {Array<Workflow>}
|
|
40
|
+
* @memberof ListWorkflows200Response
|
|
41
|
+
*/
|
|
42
|
+
data?: Array<Workflow>;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {ListWorkflows200ResponseMeta}
|
|
46
|
+
* @memberof ListWorkflows200Response
|
|
47
|
+
*/
|
|
48
|
+
meta?: ListWorkflows200ResponseMeta;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the ListWorkflows200Response interface.
|
|
53
|
+
*/
|
|
54
|
+
export function instanceOfListWorkflows200Response(value: object): value is ListWorkflows200Response {
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function ListWorkflows200ResponseFromJSON(json: any): ListWorkflows200Response {
|
|
59
|
+
return ListWorkflows200ResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function ListWorkflows200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListWorkflows200Response {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
|
|
68
|
+
'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(WorkflowFromJSON)),
|
|
69
|
+
'meta': json['meta'] == null ? undefined : ListWorkflows200ResponseMetaFromJSON(json['meta']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function ListWorkflows200ResponseToJSON(json: any): ListWorkflows200Response {
|
|
74
|
+
return ListWorkflows200ResponseToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function ListWorkflows200ResponseToJSONTyped(value?: ListWorkflows200Response | 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(WorkflowToJSON)),
|
|
85
|
+
'meta': ListWorkflows200ResponseMetaToJSON(value['meta']),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
@@ -0,0 +1,121 @@
|
|
|
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 ListWorkflows200ResponseMeta
|
|
20
|
+
*/
|
|
21
|
+
export interface ListWorkflows200ResponseMeta {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
26
|
+
*/
|
|
27
|
+
requestId?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
32
|
+
*/
|
|
33
|
+
page?: number;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
38
|
+
*/
|
|
39
|
+
perPage?: number;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {number}
|
|
43
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
44
|
+
*/
|
|
45
|
+
total?: number;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
50
|
+
*/
|
|
51
|
+
totalPages?: number;
|
|
52
|
+
/**
|
|
53
|
+
* Maximum workflows allowed on the account's plan.
|
|
54
|
+
* @type {number}
|
|
55
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
56
|
+
*/
|
|
57
|
+
limit?: number;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
62
|
+
*/
|
|
63
|
+
plan?: string;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {number}
|
|
67
|
+
* @memberof ListWorkflows200ResponseMeta
|
|
68
|
+
*/
|
|
69
|
+
count?: number;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Check if a given object implements the ListWorkflows200ResponseMeta interface.
|
|
74
|
+
*/
|
|
75
|
+
export function instanceOfListWorkflows200ResponseMeta(value: object): value is ListWorkflows200ResponseMeta {
|
|
76
|
+
return true;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function ListWorkflows200ResponseMetaFromJSON(json: any): ListWorkflows200ResponseMeta {
|
|
80
|
+
return ListWorkflows200ResponseMetaFromJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function ListWorkflows200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListWorkflows200ResponseMeta {
|
|
84
|
+
if (json == null) {
|
|
85
|
+
return json;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
'requestId': json['request_id'] == null ? undefined : json['request_id'],
|
|
90
|
+
'page': json['page'] == null ? undefined : json['page'],
|
|
91
|
+
'perPage': json['per_page'] == null ? undefined : json['per_page'],
|
|
92
|
+
'total': json['total'] == null ? undefined : json['total'],
|
|
93
|
+
'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
|
|
94
|
+
'limit': json['limit'] == null ? undefined : json['limit'],
|
|
95
|
+
'plan': json['plan'] == null ? undefined : json['plan'],
|
|
96
|
+
'count': json['count'] == null ? undefined : json['count'],
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export function ListWorkflows200ResponseMetaToJSON(json: any): ListWorkflows200ResponseMeta {
|
|
101
|
+
return ListWorkflows200ResponseMetaToJSONTyped(json, false);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export function ListWorkflows200ResponseMetaToJSONTyped(value?: ListWorkflows200ResponseMeta | null, ignoreDiscriminator: boolean = false): any {
|
|
105
|
+
if (value == null) {
|
|
106
|
+
return value;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
return {
|
|
110
|
+
|
|
111
|
+
'request_id': value['requestId'],
|
|
112
|
+
'page': value['page'],
|
|
113
|
+
'per_page': value['perPage'],
|
|
114
|
+
'total': value['total'],
|
|
115
|
+
'total_pages': value['totalPages'],
|
|
116
|
+
'limit': value['limit'],
|
|
117
|
+
'plan': value['plan'],
|
|
118
|
+
'count': value['count'],
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
|
|
@@ -0,0 +1,66 @@
|
|
|
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 ReorderWorkflowStepsRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface ReorderWorkflowStepsRequest {
|
|
22
|
+
/**
|
|
23
|
+
* The workflow's step keys in the new desired order.
|
|
24
|
+
* @type {Array<string>}
|
|
25
|
+
* @memberof ReorderWorkflowStepsRequest
|
|
26
|
+
*/
|
|
27
|
+
stepKeys: Array<string>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the ReorderWorkflowStepsRequest interface.
|
|
32
|
+
*/
|
|
33
|
+
export function instanceOfReorderWorkflowStepsRequest(value: object): value is ReorderWorkflowStepsRequest {
|
|
34
|
+
if (!('stepKeys' in value) || value['stepKeys'] === undefined) return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function ReorderWorkflowStepsRequestFromJSON(json: any): ReorderWorkflowStepsRequest {
|
|
39
|
+
return ReorderWorkflowStepsRequestFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function ReorderWorkflowStepsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReorderWorkflowStepsRequest {
|
|
43
|
+
if (json == null) {
|
|
44
|
+
return json;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
|
|
48
|
+
'stepKeys': json['step_keys'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function ReorderWorkflowStepsRequestToJSON(json: any): ReorderWorkflowStepsRequest {
|
|
53
|
+
return ReorderWorkflowStepsRequestToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export function ReorderWorkflowStepsRequestToJSONTyped(value?: ReorderWorkflowStepsRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
57
|
+
if (value == null) {
|
|
58
|
+
return value;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return {
|
|
62
|
+
|
|
63
|
+
'step_keys': value['stepKeys'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
|
|
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface SignInWithGameCenterRequest {
|
|
22
22
|
/**
|
|
23
|
-
* The
|
|
23
|
+
* The player's `teamPlayerID` from `GKLocalPlayer` (the id GameKit signs the identity assertion over — form `T:_…`). NOT `gamePlayerID` (`A:_…`) and NOT the deprecated legacy `playerID`. Sending any other id yields a verification failure (opaque `401 invalid_assertion`).
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof SignInWithGameCenterRequest
|
|
26
26
|
*/
|
|
@@ -20,13 +20,13 @@ import {
|
|
|
20
20
|
SmsMessageToJSON,
|
|
21
21
|
SmsMessageToJSONTyped,
|
|
22
22
|
} from './SmsMessage';
|
|
23
|
-
import type {
|
|
23
|
+
import type { ListWorkflowExecutions200ResponseMeta } from './ListWorkflowExecutions200ResponseMeta';
|
|
24
24
|
import {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
} from './
|
|
25
|
+
ListWorkflowExecutions200ResponseMetaFromJSON,
|
|
26
|
+
ListWorkflowExecutions200ResponseMetaFromJSONTyped,
|
|
27
|
+
ListWorkflowExecutions200ResponseMetaToJSON,
|
|
28
|
+
ListWorkflowExecutions200ResponseMetaToJSONTyped,
|
|
29
|
+
} from './ListWorkflowExecutions200ResponseMeta';
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
@@ -42,10 +42,10 @@ export interface SmsListResponse {
|
|
|
42
42
|
data?: Array<SmsMessage>;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
|
-
* @type {
|
|
45
|
+
* @type {ListWorkflowExecutions200ResponseMeta}
|
|
46
46
|
* @memberof SmsListResponse
|
|
47
47
|
*/
|
|
48
|
-
meta?:
|
|
48
|
+
meta?: ListWorkflowExecutions200ResponseMeta;
|
|
49
49
|
}
|
|
50
50
|
|
|
51
51
|
/**
|
|
@@ -66,7 +66,7 @@ export function SmsListResponseFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
66
66
|
return {
|
|
67
67
|
|
|
68
68
|
'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(SmsMessageFromJSON)),
|
|
69
|
-
'meta': json['meta'] == null ? undefined :
|
|
69
|
+
'meta': json['meta'] == null ? undefined : ListWorkflowExecutions200ResponseMetaFromJSON(json['meta']),
|
|
70
70
|
};
|
|
71
71
|
}
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ export function SmsListResponseToJSONTyped(value?: SmsListResponse | null, ignor
|
|
|
82
82
|
return {
|
|
83
83
|
|
|
84
84
|
'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(SmsMessageToJSON)),
|
|
85
|
-
'meta':
|
|
85
|
+
'meta': ListWorkflowExecutions200ResponseMetaToJSON(value['meta']),
|
|
86
86
|
};
|
|
87
87
|
}
|
|
88
88
|
|
|
@@ -20,13 +20,13 @@ import {
|
|
|
20
20
|
RequestMetaToJSON,
|
|
21
21
|
RequestMetaToJSONTyped,
|
|
22
22
|
} from './RequestMeta';
|
|
23
|
-
import type {
|
|
23
|
+
import type { DeleteWorkflow200ResponseData } from './DeleteWorkflow200ResponseData';
|
|
24
24
|
import {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
} from './
|
|
25
|
+
DeleteWorkflow200ResponseDataFromJSON,
|
|
26
|
+
DeleteWorkflow200ResponseDataFromJSONTyped,
|
|
27
|
+
DeleteWorkflow200ResponseDataToJSON,
|
|
28
|
+
DeleteWorkflow200ResponseDataToJSONTyped,
|
|
29
|
+
} from './DeleteWorkflow200ResponseData';
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
@@ -36,10 +36,10 @@ import {
|
|
|
36
36
|
export interface TopicDeleteResponse {
|
|
37
37
|
/**
|
|
38
38
|
*
|
|
39
|
-
* @type {
|
|
39
|
+
* @type {DeleteWorkflow200ResponseData}
|
|
40
40
|
* @memberof TopicDeleteResponse
|
|
41
41
|
*/
|
|
42
|
-
data?:
|
|
42
|
+
data?: DeleteWorkflow200ResponseData;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
45
|
* @type {RequestMeta}
|
|
@@ -65,7 +65,7 @@ export function TopicDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
65
65
|
}
|
|
66
66
|
return {
|
|
67
67
|
|
|
68
|
-
'data': json['data'] == null ? undefined :
|
|
68
|
+
'data': json['data'] == null ? undefined : DeleteWorkflow200ResponseDataFromJSON(json['data']),
|
|
69
69
|
'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
|
|
70
70
|
};
|
|
71
71
|
}
|
|
@@ -81,7 +81,7 @@ export function TopicDeleteResponseToJSONTyped(value?: TopicDeleteResponse | nul
|
|
|
81
81
|
|
|
82
82
|
return {
|
|
83
83
|
|
|
84
|
-
'data':
|
|
84
|
+
'data': DeleteWorkflow200ResponseDataToJSON(value['data']),
|
|
85
85
|
'meta': RequestMetaToJSON(value['meta']),
|
|
86
86
|
};
|
|
87
87
|
}
|