@zyphr-dev/node-sdk 0.1.54 → 0.1.56

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.
@@ -1,88 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Zyphr API
5
- * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- * Contact: support@zyphr.dev
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
- import { mapValues } from '../runtime';
16
- import type { WebhookRegionsResponseData } from './WebhookRegionsResponseData';
17
- import {
18
- WebhookRegionsResponseDataFromJSON,
19
- WebhookRegionsResponseDataFromJSONTyped,
20
- WebhookRegionsResponseDataToJSON,
21
- WebhookRegionsResponseDataToJSONTyped,
22
- } from './WebhookRegionsResponseData';
23
- import type { RequestMeta } from './RequestMeta';
24
- import {
25
- RequestMetaFromJSON,
26
- RequestMetaFromJSONTyped,
27
- RequestMetaToJSON,
28
- RequestMetaToJSONTyped,
29
- } from './RequestMeta';
30
-
31
- /**
32
- *
33
- * @export
34
- * @interface WebhookRegionsResponse
35
- */
36
- export interface WebhookRegionsResponse {
37
- /**
38
- *
39
- * @type {WebhookRegionsResponseData}
40
- * @memberof WebhookRegionsResponse
41
- */
42
- data?: WebhookRegionsResponseData;
43
- /**
44
- *
45
- * @type {RequestMeta}
46
- * @memberof WebhookRegionsResponse
47
- */
48
- meta?: RequestMeta;
49
- }
50
-
51
- /**
52
- * Check if a given object implements the WebhookRegionsResponse interface.
53
- */
54
- export function instanceOfWebhookRegionsResponse(value: object): value is WebhookRegionsResponse {
55
- return true;
56
- }
57
-
58
- export function WebhookRegionsResponseFromJSON(json: any): WebhookRegionsResponse {
59
- return WebhookRegionsResponseFromJSONTyped(json, false);
60
- }
61
-
62
- export function WebhookRegionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookRegionsResponse {
63
- if (json == null) {
64
- return json;
65
- }
66
- return {
67
-
68
- 'data': json['data'] == null ? undefined : WebhookRegionsResponseDataFromJSON(json['data']),
69
- 'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
70
- };
71
- }
72
-
73
- export function WebhookRegionsResponseToJSON(json: any): WebhookRegionsResponse {
74
- return WebhookRegionsResponseToJSONTyped(json, false);
75
- }
76
-
77
- export function WebhookRegionsResponseToJSONTyped(value?: WebhookRegionsResponse | null, ignoreDiscriminator: boolean = false): any {
78
- if (value == null) {
79
- return value;
80
- }
81
-
82
- return {
83
-
84
- 'data': WebhookRegionsResponseDataToJSON(value['data']),
85
- 'meta': RequestMetaToJSON(value['meta']),
86
- };
87
- }
88
-
@@ -1,81 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Zyphr API
5
- * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- * Contact: support@zyphr.dev
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
- import { mapValues } from '../runtime';
16
- import type { WebhookRegion } from './WebhookRegion';
17
- import {
18
- WebhookRegionFromJSON,
19
- WebhookRegionFromJSONTyped,
20
- WebhookRegionToJSON,
21
- WebhookRegionToJSONTyped,
22
- } from './WebhookRegion';
23
-
24
- /**
25
- *
26
- * @export
27
- * @interface WebhookRegionsResponseData
28
- */
29
- export interface WebhookRegionsResponseData {
30
- /**
31
- *
32
- * @type {Array<WebhookRegion>}
33
- * @memberof WebhookRegionsResponseData
34
- */
35
- regions?: Array<WebhookRegion>;
36
- /**
37
- * Default delivery region
38
- * @type {string}
39
- * @memberof WebhookRegionsResponseData
40
- */
41
- defaultRegion?: string;
42
- }
43
-
44
- /**
45
- * Check if a given object implements the WebhookRegionsResponseData interface.
46
- */
47
- export function instanceOfWebhookRegionsResponseData(value: object): value is WebhookRegionsResponseData {
48
- return true;
49
- }
50
-
51
- export function WebhookRegionsResponseDataFromJSON(json: any): WebhookRegionsResponseData {
52
- return WebhookRegionsResponseDataFromJSONTyped(json, false);
53
- }
54
-
55
- export function WebhookRegionsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookRegionsResponseData {
56
- if (json == null) {
57
- return json;
58
- }
59
- return {
60
-
61
- 'regions': json['regions'] == null ? undefined : ((json['regions'] as Array<any>).map(WebhookRegionFromJSON)),
62
- 'defaultRegion': json['default_region'] == null ? undefined : json['default_region'],
63
- };
64
- }
65
-
66
- export function WebhookRegionsResponseDataToJSON(json: any): WebhookRegionsResponseData {
67
- return WebhookRegionsResponseDataToJSONTyped(json, false);
68
- }
69
-
70
- export function WebhookRegionsResponseDataToJSONTyped(value?: WebhookRegionsResponseData | null, ignoreDiscriminator: boolean = false): any {
71
- if (value == null) {
72
- return value;
73
- }
74
-
75
- return {
76
-
77
- 'regions': value['regions'] == null ? undefined : ((value['regions'] as Array<any>).map(WebhookRegionToJSON)),
78
- 'default_region': value['defaultRegion'],
79
- };
80
- }
81
-