@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,691 @@
|
|
|
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
|
+
CreateWaaSEndpoint201Response,
|
|
19
|
+
CreateWaaSEndpointRequest,
|
|
20
|
+
GetWaaSEndpoint200Response,
|
|
21
|
+
ListWaaSEndpoints200Response,
|
|
22
|
+
UpdateWaaSEndpointRequest,
|
|
23
|
+
} from '../models/index';
|
|
24
|
+
import {
|
|
25
|
+
CreateWaaSEndpoint201ResponseFromJSON,
|
|
26
|
+
CreateWaaSEndpoint201ResponseToJSON,
|
|
27
|
+
CreateWaaSEndpointRequestFromJSON,
|
|
28
|
+
CreateWaaSEndpointRequestToJSON,
|
|
29
|
+
GetWaaSEndpoint200ResponseFromJSON,
|
|
30
|
+
GetWaaSEndpoint200ResponseToJSON,
|
|
31
|
+
ListWaaSEndpoints200ResponseFromJSON,
|
|
32
|
+
ListWaaSEndpoints200ResponseToJSON,
|
|
33
|
+
UpdateWaaSEndpointRequestFromJSON,
|
|
34
|
+
UpdateWaaSEndpointRequestToJSON,
|
|
35
|
+
} from '../models/index';
|
|
36
|
+
|
|
37
|
+
export interface WaaSEndpointsApiCloseWaaSEndpointCircuitRequest {
|
|
38
|
+
appId: string;
|
|
39
|
+
endpointId: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface WaaSEndpointsApiCreateWaaSEndpointOperationRequest {
|
|
43
|
+
appId: string;
|
|
44
|
+
createWaaSEndpointRequest: CreateWaaSEndpointRequest;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export interface WaaSEndpointsApiDeleteWaaSEndpointRequest {
|
|
48
|
+
appId: string;
|
|
49
|
+
endpointId: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export interface WaaSEndpointsApiGetWaaSEndpointRequest {
|
|
53
|
+
appId: string;
|
|
54
|
+
endpointId: string;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface WaaSEndpointsApiGetWaaSEndpointCircuitRequest {
|
|
58
|
+
appId: string;
|
|
59
|
+
endpointId: string;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface WaaSEndpointsApiGetWaaSEndpointMetricsRequest {
|
|
63
|
+
appId: string;
|
|
64
|
+
endpointId: string;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface WaaSEndpointsApiListWaaSEndpointsRequest {
|
|
68
|
+
appId: string;
|
|
69
|
+
limit?: number;
|
|
70
|
+
offset?: number;
|
|
71
|
+
tenantId?: string;
|
|
72
|
+
status?: ListWaaSEndpointsStatusEnum;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export interface WaaSEndpointsApiRotateWaaSEndpointSecretRequest {
|
|
76
|
+
appId: string;
|
|
77
|
+
endpointId: string;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface WaaSEndpointsApiUpdateWaaSEndpointOperationRequest {
|
|
81
|
+
appId: string;
|
|
82
|
+
endpointId: string;
|
|
83
|
+
updateWaaSEndpointRequest: UpdateWaaSEndpointRequest;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* WaaSEndpointsApi - interface
|
|
88
|
+
*
|
|
89
|
+
* @export
|
|
90
|
+
* @interface WaaSEndpointsApiInterface
|
|
91
|
+
*/
|
|
92
|
+
export interface WaaSEndpointsApiInterface {
|
|
93
|
+
/**
|
|
94
|
+
* Force the circuit breaker to close, resuming deliveries to the endpoint.
|
|
95
|
+
* @summary Force-close circuit breaker
|
|
96
|
+
* @param {string} appId
|
|
97
|
+
* @param {string} endpointId
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof WaaSEndpointsApiInterface
|
|
101
|
+
*/
|
|
102
|
+
closeWaaSEndpointCircuitRaw(requestParameters: WaaSEndpointsApiCloseWaaSEndpointCircuitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Force the circuit breaker to close, resuming deliveries to the endpoint.
|
|
106
|
+
* Force-close circuit breaker
|
|
107
|
+
*/
|
|
108
|
+
closeWaaSEndpointCircuit(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Create a webhook endpoint for a specific tenant. The signing secret is returned only on creation.
|
|
112
|
+
* @summary Create a tenant endpoint
|
|
113
|
+
* @param {string} appId
|
|
114
|
+
* @param {CreateWaaSEndpointRequest} createWaaSEndpointRequest
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
* @memberof WaaSEndpointsApiInterface
|
|
118
|
+
*/
|
|
119
|
+
createWaaSEndpointRaw(requestParameters: WaaSEndpointsApiCreateWaaSEndpointOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSEndpoint201Response>>;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Create a webhook endpoint for a specific tenant. The signing secret is returned only on creation.
|
|
123
|
+
* Create a tenant endpoint
|
|
124
|
+
*/
|
|
125
|
+
createWaaSEndpoint(appId: string, createWaaSEndpointRequest: CreateWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSEndpoint201Response>;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Delete a tenant endpoint. Stops all future deliveries and removes pending retries.
|
|
129
|
+
* @summary Delete an endpoint
|
|
130
|
+
* @param {string} appId
|
|
131
|
+
* @param {string} endpointId
|
|
132
|
+
* @param {*} [options] Override http request option.
|
|
133
|
+
* @throws {RequiredError}
|
|
134
|
+
* @memberof WaaSEndpointsApiInterface
|
|
135
|
+
*/
|
|
136
|
+
deleteWaaSEndpointRaw(requestParameters: WaaSEndpointsApiDeleteWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Delete a tenant endpoint. Stops all future deliveries and removes pending retries.
|
|
140
|
+
* Delete an endpoint
|
|
141
|
+
*/
|
|
142
|
+
deleteWaaSEndpoint(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @summary Get an endpoint
|
|
147
|
+
* @param {string} appId
|
|
148
|
+
* @param {string} endpointId
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
* @memberof WaaSEndpointsApiInterface
|
|
152
|
+
*/
|
|
153
|
+
getWaaSEndpointRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWaaSEndpoint200Response>>;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Get an endpoint
|
|
157
|
+
*/
|
|
158
|
+
getWaaSEndpoint(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWaaSEndpoint200Response>;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Get the circuit breaker state for an endpoint (closed, open, or half-open).
|
|
162
|
+
* @summary Get circuit breaker state
|
|
163
|
+
* @param {string} appId
|
|
164
|
+
* @param {string} endpointId
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
* @memberof WaaSEndpointsApiInterface
|
|
168
|
+
*/
|
|
169
|
+
getWaaSEndpointCircuitRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointCircuitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Get the circuit breaker state for an endpoint (closed, open, or half-open).
|
|
173
|
+
* Get circuit breaker state
|
|
174
|
+
*/
|
|
175
|
+
getWaaSEndpointCircuit(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Get delivery success rate, latency, and health metrics for an endpoint.
|
|
179
|
+
* @summary Get endpoint metrics
|
|
180
|
+
* @param {string} appId
|
|
181
|
+
* @param {string} endpointId
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
* @memberof WaaSEndpointsApiInterface
|
|
185
|
+
*/
|
|
186
|
+
getWaaSEndpointMetricsRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Get delivery success rate, latency, and health metrics for an endpoint.
|
|
190
|
+
* Get endpoint metrics
|
|
191
|
+
*/
|
|
192
|
+
getWaaSEndpointMetrics(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* List all endpoints for a WaaS application. Optionally filter by tenant ID or status.
|
|
196
|
+
* @summary List tenant endpoints
|
|
197
|
+
* @param {string} appId
|
|
198
|
+
* @param {number} [limit]
|
|
199
|
+
* @param {number} [offset]
|
|
200
|
+
* @param {string} [tenantId]
|
|
201
|
+
* @param {'active' | 'paused' | 'disabled'} [status]
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
* @memberof WaaSEndpointsApiInterface
|
|
205
|
+
*/
|
|
206
|
+
listWaaSEndpointsRaw(requestParameters: WaaSEndpointsApiListWaaSEndpointsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpoints200Response>>;
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* List all endpoints for a WaaS application. Optionally filter by tenant ID or status.
|
|
210
|
+
* List tenant endpoints
|
|
211
|
+
*/
|
|
212
|
+
listWaaSEndpoints(appId: string, limit?: number, offset?: number, tenantId?: string, status?: ListWaaSEndpointsStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpoints200Response>;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Rotate the signing secret for an endpoint. During rotation, deliveries are signed with both old and new secrets.
|
|
216
|
+
* @summary Rotate endpoint secret
|
|
217
|
+
* @param {string} appId
|
|
218
|
+
* @param {string} endpointId
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
* @memberof WaaSEndpointsApiInterface
|
|
222
|
+
*/
|
|
223
|
+
rotateWaaSEndpointSecretRaw(requestParameters: WaaSEndpointsApiRotateWaaSEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* Rotate the signing secret for an endpoint. During rotation, deliveries are signed with both old and new secrets.
|
|
227
|
+
* Rotate endpoint secret
|
|
228
|
+
*/
|
|
229
|
+
rotateWaaSEndpointSecret(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
*
|
|
233
|
+
* @summary Update an endpoint
|
|
234
|
+
* @param {string} appId
|
|
235
|
+
* @param {string} endpointId
|
|
236
|
+
* @param {UpdateWaaSEndpointRequest} updateWaaSEndpointRequest
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
* @memberof WaaSEndpointsApiInterface
|
|
240
|
+
*/
|
|
241
|
+
updateWaaSEndpointRaw(requestParameters: WaaSEndpointsApiUpdateWaaSEndpointOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* Update an endpoint
|
|
245
|
+
*/
|
|
246
|
+
updateWaaSEndpoint(appId: string, endpointId: string, updateWaaSEndpointRequest: UpdateWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
247
|
+
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
*/
|
|
253
|
+
export class WaaSEndpointsApi extends runtime.BaseAPI implements WaaSEndpointsApiInterface {
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Force the circuit breaker to close, resuming deliveries to the endpoint.
|
|
257
|
+
* Force-close circuit breaker
|
|
258
|
+
*/
|
|
259
|
+
async closeWaaSEndpointCircuitRaw(requestParameters: WaaSEndpointsApiCloseWaaSEndpointCircuitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
260
|
+
if (requestParameters['appId'] == null) {
|
|
261
|
+
throw new runtime.RequiredError(
|
|
262
|
+
'appId',
|
|
263
|
+
'Required parameter "appId" was null or undefined when calling closeWaaSEndpointCircuit().'
|
|
264
|
+
);
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
if (requestParameters['endpointId'] == null) {
|
|
268
|
+
throw new runtime.RequiredError(
|
|
269
|
+
'endpointId',
|
|
270
|
+
'Required parameter "endpointId" was null or undefined when calling closeWaaSEndpointCircuit().'
|
|
271
|
+
);
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
const queryParameters: any = {};
|
|
275
|
+
|
|
276
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
277
|
+
|
|
278
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
279
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
const response = await this.request({
|
|
283
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}/circuit/close`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
284
|
+
method: 'POST',
|
|
285
|
+
headers: headerParameters,
|
|
286
|
+
query: queryParameters,
|
|
287
|
+
}, initOverrides);
|
|
288
|
+
|
|
289
|
+
return new runtime.VoidApiResponse(response);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Force the circuit breaker to close, resuming deliveries to the endpoint.
|
|
294
|
+
* Force-close circuit breaker
|
|
295
|
+
*/
|
|
296
|
+
async closeWaaSEndpointCircuit(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
297
|
+
await this.closeWaaSEndpointCircuitRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* Create a webhook endpoint for a specific tenant. The signing secret is returned only on creation.
|
|
302
|
+
* Create a tenant endpoint
|
|
303
|
+
*/
|
|
304
|
+
async createWaaSEndpointRaw(requestParameters: WaaSEndpointsApiCreateWaaSEndpointOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWaaSEndpoint201Response>> {
|
|
305
|
+
if (requestParameters['appId'] == null) {
|
|
306
|
+
throw new runtime.RequiredError(
|
|
307
|
+
'appId',
|
|
308
|
+
'Required parameter "appId" was null or undefined when calling createWaaSEndpoint().'
|
|
309
|
+
);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
if (requestParameters['createWaaSEndpointRequest'] == null) {
|
|
313
|
+
throw new runtime.RequiredError(
|
|
314
|
+
'createWaaSEndpointRequest',
|
|
315
|
+
'Required parameter "createWaaSEndpointRequest" was null or undefined when calling createWaaSEndpoint().'
|
|
316
|
+
);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
const queryParameters: any = {};
|
|
320
|
+
|
|
321
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
322
|
+
|
|
323
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
324
|
+
|
|
325
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
326
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
const response = await this.request({
|
|
330
|
+
path: `/v1/waas/applications/{appId}/endpoints`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
|
|
331
|
+
method: 'POST',
|
|
332
|
+
headers: headerParameters,
|
|
333
|
+
query: queryParameters,
|
|
334
|
+
body: CreateWaaSEndpointRequestToJSON(requestParameters['createWaaSEndpointRequest']),
|
|
335
|
+
}, initOverrides);
|
|
336
|
+
|
|
337
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateWaaSEndpoint201ResponseFromJSON(jsonValue));
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Create a webhook endpoint for a specific tenant. The signing secret is returned only on creation.
|
|
342
|
+
* Create a tenant endpoint
|
|
343
|
+
*/
|
|
344
|
+
async createWaaSEndpoint(appId: string, createWaaSEndpointRequest: CreateWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWaaSEndpoint201Response> {
|
|
345
|
+
const response = await this.createWaaSEndpointRaw({ appId: appId, createWaaSEndpointRequest: createWaaSEndpointRequest }, initOverrides);
|
|
346
|
+
return await response.value();
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* Delete a tenant endpoint. Stops all future deliveries and removes pending retries.
|
|
351
|
+
* Delete an endpoint
|
|
352
|
+
*/
|
|
353
|
+
async deleteWaaSEndpointRaw(requestParameters: WaaSEndpointsApiDeleteWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
354
|
+
if (requestParameters['appId'] == null) {
|
|
355
|
+
throw new runtime.RequiredError(
|
|
356
|
+
'appId',
|
|
357
|
+
'Required parameter "appId" was null or undefined when calling deleteWaaSEndpoint().'
|
|
358
|
+
);
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
if (requestParameters['endpointId'] == null) {
|
|
362
|
+
throw new runtime.RequiredError(
|
|
363
|
+
'endpointId',
|
|
364
|
+
'Required parameter "endpointId" was null or undefined when calling deleteWaaSEndpoint().'
|
|
365
|
+
);
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
const queryParameters: any = {};
|
|
369
|
+
|
|
370
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
371
|
+
|
|
372
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
373
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
const response = await this.request({
|
|
377
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
378
|
+
method: 'DELETE',
|
|
379
|
+
headers: headerParameters,
|
|
380
|
+
query: queryParameters,
|
|
381
|
+
}, initOverrides);
|
|
382
|
+
|
|
383
|
+
return new runtime.VoidApiResponse(response);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Delete a tenant endpoint. Stops all future deliveries and removes pending retries.
|
|
388
|
+
* Delete an endpoint
|
|
389
|
+
*/
|
|
390
|
+
async deleteWaaSEndpoint(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
391
|
+
await this.deleteWaaSEndpointRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* Get an endpoint
|
|
396
|
+
*/
|
|
397
|
+
async getWaaSEndpointRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWaaSEndpoint200Response>> {
|
|
398
|
+
if (requestParameters['appId'] == null) {
|
|
399
|
+
throw new runtime.RequiredError(
|
|
400
|
+
'appId',
|
|
401
|
+
'Required parameter "appId" was null or undefined when calling getWaaSEndpoint().'
|
|
402
|
+
);
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
if (requestParameters['endpointId'] == null) {
|
|
406
|
+
throw new runtime.RequiredError(
|
|
407
|
+
'endpointId',
|
|
408
|
+
'Required parameter "endpointId" was null or undefined when calling getWaaSEndpoint().'
|
|
409
|
+
);
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
const queryParameters: any = {};
|
|
413
|
+
|
|
414
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
415
|
+
|
|
416
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
417
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
const response = await this.request({
|
|
421
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
422
|
+
method: 'GET',
|
|
423
|
+
headers: headerParameters,
|
|
424
|
+
query: queryParameters,
|
|
425
|
+
}, initOverrides);
|
|
426
|
+
|
|
427
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetWaaSEndpoint200ResponseFromJSON(jsonValue));
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Get an endpoint
|
|
432
|
+
*/
|
|
433
|
+
async getWaaSEndpoint(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWaaSEndpoint200Response> {
|
|
434
|
+
const response = await this.getWaaSEndpointRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
435
|
+
return await response.value();
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* Get the circuit breaker state for an endpoint (closed, open, or half-open).
|
|
440
|
+
* Get circuit breaker state
|
|
441
|
+
*/
|
|
442
|
+
async getWaaSEndpointCircuitRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointCircuitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
443
|
+
if (requestParameters['appId'] == null) {
|
|
444
|
+
throw new runtime.RequiredError(
|
|
445
|
+
'appId',
|
|
446
|
+
'Required parameter "appId" was null or undefined when calling getWaaSEndpointCircuit().'
|
|
447
|
+
);
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
if (requestParameters['endpointId'] == null) {
|
|
451
|
+
throw new runtime.RequiredError(
|
|
452
|
+
'endpointId',
|
|
453
|
+
'Required parameter "endpointId" was null or undefined when calling getWaaSEndpointCircuit().'
|
|
454
|
+
);
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
const queryParameters: any = {};
|
|
458
|
+
|
|
459
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
460
|
+
|
|
461
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
462
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
const response = await this.request({
|
|
466
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}/circuit`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
467
|
+
method: 'GET',
|
|
468
|
+
headers: headerParameters,
|
|
469
|
+
query: queryParameters,
|
|
470
|
+
}, initOverrides);
|
|
471
|
+
|
|
472
|
+
return new runtime.VoidApiResponse(response);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Get the circuit breaker state for an endpoint (closed, open, or half-open).
|
|
477
|
+
* Get circuit breaker state
|
|
478
|
+
*/
|
|
479
|
+
async getWaaSEndpointCircuit(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
480
|
+
await this.getWaaSEndpointCircuitRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* Get delivery success rate, latency, and health metrics for an endpoint.
|
|
485
|
+
* Get endpoint metrics
|
|
486
|
+
*/
|
|
487
|
+
async getWaaSEndpointMetricsRaw(requestParameters: WaaSEndpointsApiGetWaaSEndpointMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
488
|
+
if (requestParameters['appId'] == null) {
|
|
489
|
+
throw new runtime.RequiredError(
|
|
490
|
+
'appId',
|
|
491
|
+
'Required parameter "appId" was null or undefined when calling getWaaSEndpointMetrics().'
|
|
492
|
+
);
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
if (requestParameters['endpointId'] == null) {
|
|
496
|
+
throw new runtime.RequiredError(
|
|
497
|
+
'endpointId',
|
|
498
|
+
'Required parameter "endpointId" was null or undefined when calling getWaaSEndpointMetrics().'
|
|
499
|
+
);
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
const queryParameters: any = {};
|
|
503
|
+
|
|
504
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
505
|
+
|
|
506
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
507
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
const response = await this.request({
|
|
511
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}/metrics`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
512
|
+
method: 'GET',
|
|
513
|
+
headers: headerParameters,
|
|
514
|
+
query: queryParameters,
|
|
515
|
+
}, initOverrides);
|
|
516
|
+
|
|
517
|
+
return new runtime.VoidApiResponse(response);
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Get delivery success rate, latency, and health metrics for an endpoint.
|
|
522
|
+
* Get endpoint metrics
|
|
523
|
+
*/
|
|
524
|
+
async getWaaSEndpointMetrics(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
525
|
+
await this.getWaaSEndpointMetricsRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
/**
|
|
529
|
+
* List all endpoints for a WaaS application. Optionally filter by tenant ID or status.
|
|
530
|
+
* List tenant endpoints
|
|
531
|
+
*/
|
|
532
|
+
async listWaaSEndpointsRaw(requestParameters: WaaSEndpointsApiListWaaSEndpointsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWaaSEndpoints200Response>> {
|
|
533
|
+
if (requestParameters['appId'] == null) {
|
|
534
|
+
throw new runtime.RequiredError(
|
|
535
|
+
'appId',
|
|
536
|
+
'Required parameter "appId" was null or undefined when calling listWaaSEndpoints().'
|
|
537
|
+
);
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
const queryParameters: any = {};
|
|
541
|
+
|
|
542
|
+
if (requestParameters['limit'] != null) {
|
|
543
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
if (requestParameters['offset'] != null) {
|
|
547
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
if (requestParameters['tenantId'] != null) {
|
|
551
|
+
queryParameters['tenant_id'] = requestParameters['tenantId'];
|
|
552
|
+
}
|
|
553
|
+
|
|
554
|
+
if (requestParameters['status'] != null) {
|
|
555
|
+
queryParameters['status'] = requestParameters['status'];
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
559
|
+
|
|
560
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
561
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
const response = await this.request({
|
|
565
|
+
path: `/v1/waas/applications/{appId}/endpoints`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))),
|
|
566
|
+
method: 'GET',
|
|
567
|
+
headers: headerParameters,
|
|
568
|
+
query: queryParameters,
|
|
569
|
+
}, initOverrides);
|
|
570
|
+
|
|
571
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListWaaSEndpoints200ResponseFromJSON(jsonValue));
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* List all endpoints for a WaaS application. Optionally filter by tenant ID or status.
|
|
576
|
+
* List tenant endpoints
|
|
577
|
+
*/
|
|
578
|
+
async listWaaSEndpoints(appId: string, limit?: number, offset?: number, tenantId?: string, status?: ListWaaSEndpointsStatusEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWaaSEndpoints200Response> {
|
|
579
|
+
const response = await this.listWaaSEndpointsRaw({ appId: appId, limit: limit, offset: offset, tenantId: tenantId, status: status }, initOverrides);
|
|
580
|
+
return await response.value();
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
/**
|
|
584
|
+
* Rotate the signing secret for an endpoint. During rotation, deliveries are signed with both old and new secrets.
|
|
585
|
+
* Rotate endpoint secret
|
|
586
|
+
*/
|
|
587
|
+
async rotateWaaSEndpointSecretRaw(requestParameters: WaaSEndpointsApiRotateWaaSEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
588
|
+
if (requestParameters['appId'] == null) {
|
|
589
|
+
throw new runtime.RequiredError(
|
|
590
|
+
'appId',
|
|
591
|
+
'Required parameter "appId" was null or undefined when calling rotateWaaSEndpointSecret().'
|
|
592
|
+
);
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
if (requestParameters['endpointId'] == null) {
|
|
596
|
+
throw new runtime.RequiredError(
|
|
597
|
+
'endpointId',
|
|
598
|
+
'Required parameter "endpointId" was null or undefined when calling rotateWaaSEndpointSecret().'
|
|
599
|
+
);
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
const queryParameters: any = {};
|
|
603
|
+
|
|
604
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
605
|
+
|
|
606
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
607
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
608
|
+
}
|
|
609
|
+
|
|
610
|
+
const response = await this.request({
|
|
611
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}/rotate-secret`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
612
|
+
method: 'POST',
|
|
613
|
+
headers: headerParameters,
|
|
614
|
+
query: queryParameters,
|
|
615
|
+
}, initOverrides);
|
|
616
|
+
|
|
617
|
+
return new runtime.VoidApiResponse(response);
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* Rotate the signing secret for an endpoint. During rotation, deliveries are signed with both old and new secrets.
|
|
622
|
+
* Rotate endpoint secret
|
|
623
|
+
*/
|
|
624
|
+
async rotateWaaSEndpointSecret(appId: string, endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
625
|
+
await this.rotateWaaSEndpointSecretRaw({ appId: appId, endpointId: endpointId }, initOverrides);
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* Update an endpoint
|
|
630
|
+
*/
|
|
631
|
+
async updateWaaSEndpointRaw(requestParameters: WaaSEndpointsApiUpdateWaaSEndpointOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
632
|
+
if (requestParameters['appId'] == null) {
|
|
633
|
+
throw new runtime.RequiredError(
|
|
634
|
+
'appId',
|
|
635
|
+
'Required parameter "appId" was null or undefined when calling updateWaaSEndpoint().'
|
|
636
|
+
);
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
if (requestParameters['endpointId'] == null) {
|
|
640
|
+
throw new runtime.RequiredError(
|
|
641
|
+
'endpointId',
|
|
642
|
+
'Required parameter "endpointId" was null or undefined when calling updateWaaSEndpoint().'
|
|
643
|
+
);
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
if (requestParameters['updateWaaSEndpointRequest'] == null) {
|
|
647
|
+
throw new runtime.RequiredError(
|
|
648
|
+
'updateWaaSEndpointRequest',
|
|
649
|
+
'Required parameter "updateWaaSEndpointRequest" was null or undefined when calling updateWaaSEndpoint().'
|
|
650
|
+
);
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
const queryParameters: any = {};
|
|
654
|
+
|
|
655
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
656
|
+
|
|
657
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
658
|
+
|
|
659
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
660
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
const response = await this.request({
|
|
664
|
+
path: `/v1/waas/applications/{appId}/endpoints/{endpointId}`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
|
|
665
|
+
method: 'PUT',
|
|
666
|
+
headers: headerParameters,
|
|
667
|
+
query: queryParameters,
|
|
668
|
+
body: UpdateWaaSEndpointRequestToJSON(requestParameters['updateWaaSEndpointRequest']),
|
|
669
|
+
}, initOverrides);
|
|
670
|
+
|
|
671
|
+
return new runtime.VoidApiResponse(response);
|
|
672
|
+
}
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Update an endpoint
|
|
676
|
+
*/
|
|
677
|
+
async updateWaaSEndpoint(appId: string, endpointId: string, updateWaaSEndpointRequest: UpdateWaaSEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
678
|
+
await this.updateWaaSEndpointRaw({ appId: appId, endpointId: endpointId, updateWaaSEndpointRequest: updateWaaSEndpointRequest }, initOverrides);
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* @export
|
|
685
|
+
*/
|
|
686
|
+
export const ListWaaSEndpointsStatusEnum = {
|
|
687
|
+
ACTIVE: 'active',
|
|
688
|
+
PAUSED: 'paused',
|
|
689
|
+
DISABLED: 'disabled'
|
|
690
|
+
} as const;
|
|
691
|
+
export type ListWaaSEndpointsStatusEnum = typeof ListWaaSEndpointsStatusEnum[keyof typeof ListWaaSEndpointsStatusEnum];
|