@zyphr-dev/node-sdk 0.1.0 → 0.1.1
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/client.d.ts +9 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +10 -1
- package/dist/client.js.map +1 -1
- package/dist/src/apis/WaaSApplicationsApi.d.ts +204 -0
- package/dist/src/apis/WaaSApplicationsApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSApplicationsApi.js +215 -0
- package/dist/src/apis/WaaSApplicationsApi.js.map +1 -0
- package/dist/src/apis/WaaSDeliveriesApi.d.ts +169 -0
- package/dist/src/apis/WaaSDeliveriesApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSDeliveriesApi.js +179 -0
- package/dist/src/apis/WaaSDeliveriesApi.js.map +1 -0
- package/dist/src/apis/WaaSEndpointsApi.d.ts +299 -0
- package/dist/src/apis/WaaSEndpointsApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSEndpointsApi.js +323 -0
- package/dist/src/apis/WaaSEndpointsApi.js.map +1 -0
- package/dist/src/apis/WaaSEventTypesApi.d.ts +211 -0
- package/dist/src/apis/WaaSEventTypesApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSEventTypesApi.js +229 -0
- package/dist/src/apis/WaaSEventTypesApi.js.map +1 -0
- package/dist/src/apis/WaaSEventsApi.d.ts +85 -0
- package/dist/src/apis/WaaSEventsApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSEventsApi.js +89 -0
- package/dist/src/apis/WaaSEventsApi.js.map +1 -0
- package/dist/src/apis/WaaSPortalApi.d.ts +56 -0
- package/dist/src/apis/WaaSPortalApi.d.ts.map +1 -0
- package/dist/src/apis/WaaSPortalApi.js +55 -0
- package/dist/src/apis/WaaSPortalApi.js.map +1 -0
- package/dist/src/apis/index.d.ts +6 -0
- package/dist/src/apis/index.d.ts.map +1 -1
- package/dist/src/apis/index.js +6 -0
- package/dist/src/apis/index.js.map +1 -1
- package/dist/src/models/BatchPublishWaaSEvents201Response.d.ts +34 -0
- package/dist/src/models/BatchPublishWaaSEvents201Response.d.ts.map +1 -0
- package/dist/src/models/BatchPublishWaaSEvents201Response.js +43 -0
- package/dist/src/models/BatchPublishWaaSEvents201Response.js.map +1 -0
- package/dist/src/models/CreateWaaSApplication201Response.d.ts +34 -0
- package/dist/src/models/CreateWaaSApplication201Response.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSApplication201Response.js +43 -0
- package/dist/src/models/CreateWaaSApplication201Response.js.map +1 -0
- package/dist/src/models/CreateWaaSApplicationRequest.d.ts +45 -0
- package/dist/src/models/CreateWaaSApplicationRequest.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSApplicationRequest.js +50 -0
- package/dist/src/models/CreateWaaSApplicationRequest.js.map +1 -0
- package/dist/src/models/CreateWaaSEndpoint201Response.d.ts +34 -0
- package/dist/src/models/CreateWaaSEndpoint201Response.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSEndpoint201Response.js +43 -0
- package/dist/src/models/CreateWaaSEndpoint201Response.js.map +1 -0
- package/dist/src/models/CreateWaaSEndpointRequest.d.ts +45 -0
- package/dist/src/models/CreateWaaSEndpointRequest.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSEndpointRequest.js +52 -0
- package/dist/src/models/CreateWaaSEndpointRequest.js.map +1 -0
- package/dist/src/models/CreateWaaSEndpointResponse.d.ts +69 -0
- package/dist/src/models/CreateWaaSEndpointResponse.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSEndpointResponse.js +54 -0
- package/dist/src/models/CreateWaaSEndpointResponse.js.map +1 -0
- package/dist/src/models/CreateWaaSEventType201Response.d.ts +34 -0
- package/dist/src/models/CreateWaaSEventType201Response.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSEventType201Response.js +43 -0
- package/dist/src/models/CreateWaaSEventType201Response.js.map +1 -0
- package/dist/src/models/CreateWaaSEventTypeRequest.d.ts +57 -0
- package/dist/src/models/CreateWaaSEventTypeRequest.d.ts.map +1 -0
- package/dist/src/models/CreateWaaSEventTypeRequest.js +54 -0
- package/dist/src/models/CreateWaaSEventTypeRequest.js.map +1 -0
- package/dist/src/models/GenerateWaaSPortalToken201Response.d.ts +34 -0
- package/dist/src/models/GenerateWaaSPortalToken201Response.d.ts.map +1 -0
- package/dist/src/models/GenerateWaaSPortalToken201Response.js +43 -0
- package/dist/src/models/GenerateWaaSPortalToken201Response.js.map +1 -0
- package/dist/src/models/GetWaaSEndpoint200Response.d.ts +34 -0
- package/dist/src/models/GetWaaSEndpoint200Response.d.ts.map +1 -0
- package/dist/src/models/GetWaaSEndpoint200Response.js +43 -0
- package/dist/src/models/GetWaaSEndpoint200Response.js.map +1 -0
- package/dist/src/models/GetWaaSUsage200Response.d.ts +34 -0
- package/dist/src/models/GetWaaSUsage200Response.d.ts.map +1 -0
- package/dist/src/models/GetWaaSUsage200Response.js +43 -0
- package/dist/src/models/GetWaaSUsage200Response.js.map +1 -0
- package/dist/src/models/ListWaaSApplications200Response.d.ts +34 -0
- package/dist/src/models/ListWaaSApplications200Response.d.ts.map +1 -0
- package/dist/src/models/ListWaaSApplications200Response.js +43 -0
- package/dist/src/models/ListWaaSApplications200Response.js.map +1 -0
- package/dist/src/models/ListWaaSEndpointDeliveries200Response.d.ts +34 -0
- package/dist/src/models/ListWaaSEndpointDeliveries200Response.d.ts.map +1 -0
- package/dist/src/models/ListWaaSEndpointDeliveries200Response.js +43 -0
- package/dist/src/models/ListWaaSEndpointDeliveries200Response.js.map +1 -0
- package/dist/src/models/ListWaaSEndpoints200Response.d.ts +34 -0
- package/dist/src/models/ListWaaSEndpoints200Response.d.ts.map +1 -0
- package/dist/src/models/ListWaaSEndpoints200Response.js +43 -0
- package/dist/src/models/ListWaaSEndpoints200Response.js.map +1 -0
- package/dist/src/models/ListWaaSEventTypes200Response.d.ts +34 -0
- package/dist/src/models/ListWaaSEventTypes200Response.d.ts.map +1 -0
- package/dist/src/models/ListWaaSEventTypes200Response.js +43 -0
- package/dist/src/models/ListWaaSEventTypes200Response.js.map +1 -0
- package/dist/src/models/PublishWaaSEvent201Response.d.ts +34 -0
- package/dist/src/models/PublishWaaSEvent201Response.d.ts.map +1 -0
- package/dist/src/models/PublishWaaSEvent201Response.js +43 -0
- package/dist/src/models/PublishWaaSEvent201Response.js.map +1 -0
- package/dist/src/models/UpdateWaaSApplicationRequest.d.ts +54 -0
- package/dist/src/models/UpdateWaaSApplicationRequest.d.ts.map +1 -0
- package/dist/src/models/UpdateWaaSApplicationRequest.js +54 -0
- package/dist/src/models/UpdateWaaSApplicationRequest.js.map +1 -0
- package/dist/src/models/UpdateWaaSEndpointRequest.d.ts +54 -0
- package/dist/src/models/UpdateWaaSEndpointRequest.d.ts.map +1 -0
- package/dist/src/models/UpdateWaaSEndpointRequest.js +54 -0
- package/dist/src/models/UpdateWaaSEndpointRequest.js.map +1 -0
- package/dist/src/models/UpdateWaaSEventTypeRequest.d.ts +51 -0
- package/dist/src/models/UpdateWaaSEventTypeRequest.d.ts.map +1 -0
- package/dist/src/models/UpdateWaaSEventTypeRequest.js +48 -0
- package/dist/src/models/UpdateWaaSEventTypeRequest.js.map +1 -0
- package/dist/src/models/WaaSApplication.d.ts +84 -0
- package/dist/src/models/WaaSApplication.d.ts.map +1 -0
- package/dist/src/models/WaaSApplication.js +64 -0
- package/dist/src/models/WaaSApplication.js.map +1 -0
- package/dist/src/models/WaaSBatchPublishRequest.d.ts +34 -0
- package/dist/src/models/WaaSBatchPublishRequest.d.ts.map +1 -0
- package/dist/src/models/WaaSBatchPublishRequest.js +45 -0
- package/dist/src/models/WaaSBatchPublishRequest.js.map +1 -0
- package/dist/src/models/WaaSBatchPublishResponse.d.ts +45 -0
- package/dist/src/models/WaaSBatchPublishResponse.d.ts.map +1 -0
- package/dist/src/models/WaaSBatchPublishResponse.js +46 -0
- package/dist/src/models/WaaSBatchPublishResponse.js.map +1 -0
- package/dist/src/models/WaaSDelivery.d.ts +105 -0
- package/dist/src/models/WaaSDelivery.d.ts.map +1 -0
- package/dist/src/models/WaaSDelivery.js +73 -0
- package/dist/src/models/WaaSDelivery.js.map +1 -0
- package/dist/src/models/WaaSEndpoint.d.ts +84 -0
- package/dist/src/models/WaaSEndpoint.d.ts.map +1 -0
- package/dist/src/models/WaaSEndpoint.js +64 -0
- package/dist/src/models/WaaSEndpoint.js.map +1 -0
- package/dist/src/models/WaaSEventType.d.ts +95 -0
- package/dist/src/models/WaaSEventType.d.ts.map +1 -0
- package/dist/src/models/WaaSEventType.js +67 -0
- package/dist/src/models/WaaSEventType.js.map +1 -0
- package/dist/src/models/WaaSPortalTokenRequest.d.ts +52 -0
- package/dist/src/models/WaaSPortalTokenRequest.d.ts.map +1 -0
- package/dist/src/models/WaaSPortalTokenRequest.js +51 -0
- package/dist/src/models/WaaSPortalTokenRequest.js.map +1 -0
- package/dist/src/models/WaaSPortalTokenRequestTheme.d.ts +47 -0
- package/dist/src/models/WaaSPortalTokenRequestTheme.d.ts.map +1 -0
- package/dist/src/models/WaaSPortalTokenRequestTheme.js +51 -0
- package/dist/src/models/WaaSPortalTokenRequestTheme.js.map +1 -0
- package/dist/src/models/WaaSPortalTokenResponse.d.ts +39 -0
- package/dist/src/models/WaaSPortalTokenResponse.d.ts.map +1 -0
- package/dist/src/models/WaaSPortalTokenResponse.js +44 -0
- package/dist/src/models/WaaSPortalTokenResponse.js.map +1 -0
- package/dist/src/models/WaaSPublishEventRequest.d.ts +51 -0
- package/dist/src/models/WaaSPublishEventRequest.d.ts.map +1 -0
- package/dist/src/models/WaaSPublishEventRequest.js +54 -0
- package/dist/src/models/WaaSPublishEventRequest.js.map +1 -0
- package/dist/src/models/WaaSPublishEventResponse.d.ts +57 -0
- package/dist/src/models/WaaSPublishEventResponse.d.ts.map +1 -0
- package/dist/src/models/WaaSPublishEventResponse.js +50 -0
- package/dist/src/models/WaaSPublishEventResponse.js.map +1 -0
- package/dist/src/models/WaaSUsageResponse.d.ts +63 -0
- package/dist/src/models/WaaSUsageResponse.d.ts.map +1 -0
- package/dist/src/models/WaaSUsageResponse.js +52 -0
- package/dist/src/models/WaaSUsageResponse.js.map +1 -0
- package/dist/src/models/index.d.ts +31 -0
- package/dist/src/models/index.d.ts.map +1 -1
- package/dist/src/models/index.js +31 -0
- package/dist/src/models/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +37 -0
- package/src/client.ts +24 -0
- package/src/src/apis/WaaSApplicationsApi.ts +438 -0
- package/src/src/apis/WaaSDeliveriesApi.ts +361 -0
- package/src/src/apis/WaaSEndpointsApi.ts +691 -0
- package/src/src/apis/WaaSEventTypesApi.ts +486 -0
- package/src/src/apis/WaaSEventsApi.ts +190 -0
- package/src/src/apis/WaaSPortalApi.ts +113 -0
- package/src/src/apis/index.ts +6 -0
- package/src/src/models/BatchPublishWaaSEvents201Response.ts +73 -0
- package/src/src/models/CreateWaaSApplication201Response.ts +73 -0
- package/src/src/models/CreateWaaSApplicationRequest.ts +83 -0
- package/src/src/models/CreateWaaSEndpoint201Response.ts +73 -0
- package/src/src/models/CreateWaaSEndpointRequest.ts +84 -0
- package/src/src/models/CreateWaaSEndpointResponse.ts +113 -0
- package/src/src/models/CreateWaaSEventType201Response.ts +73 -0
- package/src/src/models/CreateWaaSEventTypeRequest.ts +99 -0
- package/src/src/models/GenerateWaaSPortalToken201Response.ts +73 -0
- package/src/src/models/GetWaaSEndpoint200Response.ts +73 -0
- package/src/src/models/GetWaaSUsage200Response.ts +73 -0
- package/src/src/models/ListWaaSApplications200Response.ts +73 -0
- package/src/src/models/ListWaaSEndpointDeliveries200Response.ts +73 -0
- package/src/src/models/ListWaaSEndpoints200Response.ts +73 -0
- package/src/src/models/ListWaaSEventTypes200Response.ts +73 -0
- package/src/src/models/PublishWaaSEvent201Response.ts +73 -0
- package/src/src/models/UpdateWaaSApplicationRequest.ts +93 -0
- package/src/src/models/UpdateWaaSEndpointRequest.ts +93 -0
- package/src/src/models/UpdateWaaSEventTypeRequest.ts +89 -0
- package/src/src/models/WaaSApplication.ts +133 -0
- package/src/src/models/WaaSBatchPublishRequest.ts +74 -0
- package/src/src/models/WaaSBatchPublishResponse.ts +81 -0
- package/src/src/models/WaaSDelivery.ts +160 -0
- package/src/src/models/WaaSEndpoint.ts +133 -0
- package/src/src/models/WaaSEventType.ts +148 -0
- package/src/src/models/WaaSPortalTokenRequest.ts +98 -0
- package/src/src/models/WaaSPortalTokenRequestTheme.ts +84 -0
- package/src/src/models/WaaSPortalTokenResponse.ts +73 -0
- package/src/src/models/WaaSPublishEventRequest.ts +92 -0
- package/src/src/models/WaaSPublishEventResponse.ts +97 -0
- package/src/src/models/WaaSUsageResponse.ts +105 -0
- package/src/src/models/index.ts +31 -0
|
@@ -0,0 +1,113 @@
|
|
|
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
|
+
|
|
16
|
+
import * as runtime from '../runtime';
|
|
17
|
+
import type {
|
|
18
|
+
GenerateWaaSPortalToken201Response,
|
|
19
|
+
WaaSPortalTokenRequest,
|
|
20
|
+
} from '../models/index';
|
|
21
|
+
import {
|
|
22
|
+
GenerateWaaSPortalToken201ResponseFromJSON,
|
|
23
|
+
GenerateWaaSPortalToken201ResponseToJSON,
|
|
24
|
+
WaaSPortalTokenRequestFromJSON,
|
|
25
|
+
WaaSPortalTokenRequestToJSON,
|
|
26
|
+
} from '../models/index';
|
|
27
|
+
|
|
28
|
+
export interface WaaSPortalApiGenerateWaaSPortalTokenRequest {
|
|
29
|
+
appId: string;
|
|
30
|
+
waaSPortalTokenRequest: WaaSPortalTokenRequest;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* WaaSPortalApi - interface
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @interface WaaSPortalApiInterface
|
|
38
|
+
*/
|
|
39
|
+
export interface WaaSPortalApiInterface {
|
|
40
|
+
/**
|
|
41
|
+
* Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.
|
|
42
|
+
* @summary Generate portal token
|
|
43
|
+
* @param {string} appId
|
|
44
|
+
* @param {WaaSPortalTokenRequest} waaSPortalTokenRequest
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
* @memberof WaaSPortalApiInterface
|
|
48
|
+
*/
|
|
49
|
+
generateWaaSPortalTokenRaw(requestParameters: WaaSPortalApiGenerateWaaSPortalTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateWaaSPortalToken201Response>>;
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.
|
|
53
|
+
* Generate portal token
|
|
54
|
+
*/
|
|
55
|
+
generateWaaSPortalToken(appId: string, waaSPortalTokenRequest: WaaSPortalTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateWaaSPortalToken201Response>;
|
|
56
|
+
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
export class WaaSPortalApi extends runtime.BaseAPI implements WaaSPortalApiInterface {
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.
|
|
66
|
+
* Generate portal token
|
|
67
|
+
*/
|
|
68
|
+
async generateWaaSPortalTokenRaw(requestParameters: WaaSPortalApiGenerateWaaSPortalTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateWaaSPortalToken201Response>> {
|
|
69
|
+
if (requestParameters['appId'] == null) {
|
|
70
|
+
throw new runtime.RequiredError(
|
|
71
|
+
'appId',
|
|
72
|
+
'Required parameter "appId" was null or undefined when calling generateWaaSPortalToken().'
|
|
73
|
+
);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
if (requestParameters['waaSPortalTokenRequest'] == null) {
|
|
77
|
+
throw new runtime.RequiredError(
|
|
78
|
+
'waaSPortalTokenRequest',
|
|
79
|
+
'Required parameter "waaSPortalTokenRequest" was null or undefined when calling generateWaaSPortalToken().'
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
const queryParameters: any = {};
|
|
84
|
+
|
|
85
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
86
|
+
|
|
87
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
88
|
+
|
|
89
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
90
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
const response = await this.request({
|
|
94
|
+
path: `/v1/waas/applications/{appId}/portal/token`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
|
|
95
|
+
method: 'POST',
|
|
96
|
+
headers: headerParameters,
|
|
97
|
+
query: queryParameters,
|
|
98
|
+
body: WaaSPortalTokenRequestToJSON(requestParameters['waaSPortalTokenRequest']),
|
|
99
|
+
}, initOverrides);
|
|
100
|
+
|
|
101
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GenerateWaaSPortalToken201ResponseFromJSON(jsonValue));
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.
|
|
106
|
+
* Generate portal token
|
|
107
|
+
*/
|
|
108
|
+
async generateWaaSPortalToken(appId: string, waaSPortalTokenRequest: WaaSPortalTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateWaaSPortalToken201Response> {
|
|
109
|
+
const response = await this.generateWaaSPortalTokenRaw({ appId: appId, waaSPortalTokenRequest: waaSPortalTokenRequest }, initOverrides);
|
|
110
|
+
return await response.value();
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
}
|
package/src/src/apis/index.ts
CHANGED
|
@@ -20,4 +20,10 @@ export * from './SubscribersApi';
|
|
|
20
20
|
export * from './TemplatesApi';
|
|
21
21
|
export * from './TopicsApi';
|
|
22
22
|
export * from './UtilityApi';
|
|
23
|
+
export * from './WaaSApplicationsApi';
|
|
24
|
+
export * from './WaaSDeliveriesApi';
|
|
25
|
+
export * from './WaaSEndpointsApi';
|
|
26
|
+
export * from './WaaSEventTypesApi';
|
|
27
|
+
export * from './WaaSEventsApi';
|
|
28
|
+
export * from './WaaSPortalApi';
|
|
23
29
|
export * from './WebhooksApi';
|
|
@@ -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 ## 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 { WaaSBatchPublishResponse } from './WaaSBatchPublishResponse';
|
|
17
|
+
import {
|
|
18
|
+
WaaSBatchPublishResponseFromJSON,
|
|
19
|
+
WaaSBatchPublishResponseFromJSONTyped,
|
|
20
|
+
WaaSBatchPublishResponseToJSON,
|
|
21
|
+
WaaSBatchPublishResponseToJSONTyped,
|
|
22
|
+
} from './WaaSBatchPublishResponse';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface BatchPublishWaaSEvents201Response
|
|
28
|
+
*/
|
|
29
|
+
export interface BatchPublishWaaSEvents201Response {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {WaaSBatchPublishResponse}
|
|
33
|
+
* @memberof BatchPublishWaaSEvents201Response
|
|
34
|
+
*/
|
|
35
|
+
data?: WaaSBatchPublishResponse;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the BatchPublishWaaSEvents201Response interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfBatchPublishWaaSEvents201Response(value: object): value is BatchPublishWaaSEvents201Response {
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function BatchPublishWaaSEvents201ResponseFromJSON(json: any): BatchPublishWaaSEvents201Response {
|
|
46
|
+
return BatchPublishWaaSEvents201ResponseFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function BatchPublishWaaSEvents201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BatchPublishWaaSEvents201Response {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'data': json['data'] == null ? undefined : WaaSBatchPublishResponseFromJSON(json['data']),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function BatchPublishWaaSEvents201ResponseToJSON(json: any): BatchPublishWaaSEvents201Response {
|
|
60
|
+
return BatchPublishWaaSEvents201ResponseToJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function BatchPublishWaaSEvents201ResponseToJSONTyped(value?: BatchPublishWaaSEvents201Response | null, ignoreDiscriminator: boolean = false): any {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'data': WaaSBatchPublishResponseToJSON(value['data']),
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
@@ -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 ## 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 { WaaSApplication } from './WaaSApplication';
|
|
17
|
+
import {
|
|
18
|
+
WaaSApplicationFromJSON,
|
|
19
|
+
WaaSApplicationFromJSONTyped,
|
|
20
|
+
WaaSApplicationToJSON,
|
|
21
|
+
WaaSApplicationToJSONTyped,
|
|
22
|
+
} from './WaaSApplication';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface CreateWaaSApplication201Response
|
|
28
|
+
*/
|
|
29
|
+
export interface CreateWaaSApplication201Response {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {WaaSApplication}
|
|
33
|
+
* @memberof CreateWaaSApplication201Response
|
|
34
|
+
*/
|
|
35
|
+
data?: WaaSApplication;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the CreateWaaSApplication201Response interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfCreateWaaSApplication201Response(value: object): value is CreateWaaSApplication201Response {
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function CreateWaaSApplication201ResponseFromJSON(json: any): CreateWaaSApplication201Response {
|
|
46
|
+
return CreateWaaSApplication201ResponseFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function CreateWaaSApplication201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWaaSApplication201Response {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'data': json['data'] == null ? undefined : WaaSApplicationFromJSON(json['data']),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function CreateWaaSApplication201ResponseToJSON(json: any): CreateWaaSApplication201Response {
|
|
60
|
+
return CreateWaaSApplication201ResponseToJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function CreateWaaSApplication201ResponseToJSONTyped(value?: CreateWaaSApplication201Response | null, ignoreDiscriminator: boolean = false): any {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'data': WaaSApplicationToJSON(value['data']),
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
@@ -0,0 +1,83 @@
|
|
|
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 CreateWaaSApplicationRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateWaaSApplicationRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Human-readable application name
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateWaaSApplicationRequest
|
|
26
|
+
*/
|
|
27
|
+
name: string;
|
|
28
|
+
/**
|
|
29
|
+
* URL-safe identifier (lowercase, hyphens only)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateWaaSApplicationRequest
|
|
32
|
+
*/
|
|
33
|
+
slug: string;
|
|
34
|
+
/**
|
|
35
|
+
* Optional description
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof CreateWaaSApplicationRequest
|
|
38
|
+
*/
|
|
39
|
+
description?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Check if a given object implements the CreateWaaSApplicationRequest interface.
|
|
44
|
+
*/
|
|
45
|
+
export function instanceOfCreateWaaSApplicationRequest(value: object): value is CreateWaaSApplicationRequest {
|
|
46
|
+
if (!('name' in value) || value['name'] === undefined) return false;
|
|
47
|
+
if (!('slug' in value) || value['slug'] === undefined) return false;
|
|
48
|
+
return true;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function CreateWaaSApplicationRequestFromJSON(json: any): CreateWaaSApplicationRequest {
|
|
52
|
+
return CreateWaaSApplicationRequestFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function CreateWaaSApplicationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWaaSApplicationRequest {
|
|
56
|
+
if (json == null) {
|
|
57
|
+
return json;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
|
|
61
|
+
'name': json['name'],
|
|
62
|
+
'slug': json['slug'],
|
|
63
|
+
'description': json['description'] == null ? undefined : json['description'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function CreateWaaSApplicationRequestToJSON(json: any): CreateWaaSApplicationRequest {
|
|
68
|
+
return CreateWaaSApplicationRequestToJSONTyped(json, false);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function CreateWaaSApplicationRequestToJSONTyped(value?: CreateWaaSApplicationRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
72
|
+
if (value == null) {
|
|
73
|
+
return value;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'name': value['name'],
|
|
79
|
+
'slug': value['slug'],
|
|
80
|
+
'description': value['description'],
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
@@ -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 ## 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 { CreateWaaSEndpointResponse } from './CreateWaaSEndpointResponse';
|
|
17
|
+
import {
|
|
18
|
+
CreateWaaSEndpointResponseFromJSON,
|
|
19
|
+
CreateWaaSEndpointResponseFromJSONTyped,
|
|
20
|
+
CreateWaaSEndpointResponseToJSON,
|
|
21
|
+
CreateWaaSEndpointResponseToJSONTyped,
|
|
22
|
+
} from './CreateWaaSEndpointResponse';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface CreateWaaSEndpoint201Response
|
|
28
|
+
*/
|
|
29
|
+
export interface CreateWaaSEndpoint201Response {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {CreateWaaSEndpointResponse}
|
|
33
|
+
* @memberof CreateWaaSEndpoint201Response
|
|
34
|
+
*/
|
|
35
|
+
data?: CreateWaaSEndpointResponse;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the CreateWaaSEndpoint201Response interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfCreateWaaSEndpoint201Response(value: object): value is CreateWaaSEndpoint201Response {
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function CreateWaaSEndpoint201ResponseFromJSON(json: any): CreateWaaSEndpoint201Response {
|
|
46
|
+
return CreateWaaSEndpoint201ResponseFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function CreateWaaSEndpoint201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWaaSEndpoint201Response {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'data': json['data'] == null ? undefined : CreateWaaSEndpointResponseFromJSON(json['data']),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function CreateWaaSEndpoint201ResponseToJSON(json: any): CreateWaaSEndpoint201Response {
|
|
60
|
+
return CreateWaaSEndpoint201ResponseToJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function CreateWaaSEndpoint201ResponseToJSONTyped(value?: CreateWaaSEndpoint201Response | null, ignoreDiscriminator: boolean = false): any {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'data': CreateWaaSEndpointResponseToJSON(value['data']),
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
@@ -0,0 +1,84 @@
|
|
|
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 CreateWaaSEndpointRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateWaaSEndpointRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Your customer's identifier
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateWaaSEndpointRequest
|
|
26
|
+
*/
|
|
27
|
+
tenantId: string;
|
|
28
|
+
/**
|
|
29
|
+
* Webhook endpoint URL
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateWaaSEndpointRequest
|
|
32
|
+
*/
|
|
33
|
+
url: string;
|
|
34
|
+
/**
|
|
35
|
+
* Event types to subscribe to
|
|
36
|
+
* @type {Array<string>}
|
|
37
|
+
* @memberof CreateWaaSEndpointRequest
|
|
38
|
+
*/
|
|
39
|
+
events: Array<string>;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Check if a given object implements the CreateWaaSEndpointRequest interface.
|
|
44
|
+
*/
|
|
45
|
+
export function instanceOfCreateWaaSEndpointRequest(value: object): value is CreateWaaSEndpointRequest {
|
|
46
|
+
if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
|
|
47
|
+
if (!('url' in value) || value['url'] === undefined) return false;
|
|
48
|
+
if (!('events' in value) || value['events'] === undefined) return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function CreateWaaSEndpointRequestFromJSON(json: any): CreateWaaSEndpointRequest {
|
|
53
|
+
return CreateWaaSEndpointRequestFromJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export function CreateWaaSEndpointRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWaaSEndpointRequest {
|
|
57
|
+
if (json == null) {
|
|
58
|
+
return json;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
|
|
62
|
+
'tenantId': json['tenant_id'],
|
|
63
|
+
'url': json['url'],
|
|
64
|
+
'events': json['events'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function CreateWaaSEndpointRequestToJSON(json: any): CreateWaaSEndpointRequest {
|
|
69
|
+
return CreateWaaSEndpointRequestToJSONTyped(json, false);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function CreateWaaSEndpointRequestToJSONTyped(value?: CreateWaaSEndpointRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
73
|
+
if (value == null) {
|
|
74
|
+
return value;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
return {
|
|
78
|
+
|
|
79
|
+
'tenant_id': value['tenantId'],
|
|
80
|
+
'url': value['url'],
|
|
81
|
+
'events': value['events'],
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
@@ -0,0 +1,113 @@
|
|
|
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 CreateWaaSEndpointResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateWaaSEndpointResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateWaaSEndpointResponse
|
|
26
|
+
*/
|
|
27
|
+
id?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateWaaSEndpointResponse
|
|
32
|
+
*/
|
|
33
|
+
tenantId?: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof CreateWaaSEndpointResponse
|
|
38
|
+
*/
|
|
39
|
+
url?: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {Array<string>}
|
|
43
|
+
* @memberof CreateWaaSEndpointResponse
|
|
44
|
+
*/
|
|
45
|
+
events?: Array<string>;
|
|
46
|
+
/**
|
|
47
|
+
* HMAC signing secret (only returned on creation)
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof CreateWaaSEndpointResponse
|
|
50
|
+
*/
|
|
51
|
+
secret?: string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof CreateWaaSEndpointResponse
|
|
56
|
+
*/
|
|
57
|
+
status?: string;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {Date}
|
|
61
|
+
* @memberof CreateWaaSEndpointResponse
|
|
62
|
+
*/
|
|
63
|
+
createdAt?: Date;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Check if a given object implements the CreateWaaSEndpointResponse interface.
|
|
68
|
+
*/
|
|
69
|
+
export function instanceOfCreateWaaSEndpointResponse(value: object): value is CreateWaaSEndpointResponse {
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function CreateWaaSEndpointResponseFromJSON(json: any): CreateWaaSEndpointResponse {
|
|
74
|
+
return CreateWaaSEndpointResponseFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function CreateWaaSEndpointResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWaaSEndpointResponse {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'id': json['id'] == null ? undefined : json['id'],
|
|
84
|
+
'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
|
|
85
|
+
'url': json['url'] == null ? undefined : json['url'],
|
|
86
|
+
'events': json['events'] == null ? undefined : json['events'],
|
|
87
|
+
'secret': json['secret'] == null ? undefined : json['secret'],
|
|
88
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
89
|
+
'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export function CreateWaaSEndpointResponseToJSON(json: any): CreateWaaSEndpointResponse {
|
|
94
|
+
return CreateWaaSEndpointResponseToJSONTyped(json, false);
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function CreateWaaSEndpointResponseToJSONTyped(value?: CreateWaaSEndpointResponse | null, ignoreDiscriminator: boolean = false): any {
|
|
98
|
+
if (value == null) {
|
|
99
|
+
return value;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
return {
|
|
103
|
+
|
|
104
|
+
'id': value['id'],
|
|
105
|
+
'tenant_id': value['tenantId'],
|
|
106
|
+
'url': value['url'],
|
|
107
|
+
'events': value['events'],
|
|
108
|
+
'secret': value['secret'],
|
|
109
|
+
'status': value['status'],
|
|
110
|
+
'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|