zyphr 0.1.0 → 0.1.2
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.
- checksums.yaml +4 -4
- data/README.md +59 -0
- data/docs/BatchPublishWaaSEvents201Response.md +18 -0
- data/docs/CreateWaaSApplication201Response.md +18 -0
- data/docs/CreateWaaSApplicationRequest.md +22 -0
- data/docs/CreateWaaSEndpoint201Response.md +18 -0
- data/docs/CreateWaaSEndpointRequest.md +22 -0
- data/docs/CreateWaaSEndpointResponse.md +30 -0
- data/docs/CreateWaaSEventType201Response.md +18 -0
- data/docs/CreateWaaSEventTypeRequest.md +26 -0
- data/docs/GenerateWaaSPortalToken201Response.md +18 -0
- data/docs/GetWaaSEndpoint200Response.md +18 -0
- data/docs/GetWaaSUsage200Response.md +18 -0
- data/docs/ListWaaSApplications200Response.md +18 -0
- data/docs/ListWaaSEndpointDeliveries200Response.md +18 -0
- data/docs/ListWaaSEndpoints200Response.md +18 -0
- data/docs/ListWaaSEventTypes200Response.md +18 -0
- data/docs/PublishWaaSEvent201Response.md +18 -0
- data/docs/UpdateWaaSApplicationRequest.md +22 -0
- data/docs/UpdateWaaSEndpointRequest.md +22 -0
- data/docs/UpdateWaaSEventTypeRequest.md +24 -0
- data/docs/WaaSApplication.md +32 -0
- data/docs/WaaSApplicationsApi.md +446 -0
- data/docs/WaaSBatchPublishRequest.md +18 -0
- data/docs/WaaSBatchPublishResponse.md +22 -0
- data/docs/WaaSDeliveriesApi.md +319 -0
- data/docs/WaaSDelivery.md +38 -0
- data/docs/WaaSEndpoint.md +32 -0
- data/docs/WaaSEndpointsApi.md +673 -0
- data/docs/WaaSEventType.md +36 -0
- data/docs/WaaSEventTypesApi.md +454 -0
- data/docs/WaaSEventsApi.md +155 -0
- data/docs/WaaSPortalApi.md +81 -0
- data/docs/WaaSPortalTokenRequest.md +24 -0
- data/docs/WaaSPortalTokenRequestTheme.md +20 -0
- data/docs/WaaSPortalTokenResponse.md +20 -0
- data/docs/WaaSPublishEventRequest.md +24 -0
- data/docs/WaaSPublishEventResponse.md +26 -0
- data/docs/WaaSUsageResponse.md +28 -0
- data/lib/zyphr/api/waa_s_applications_api.rb +425 -0
- data/lib/zyphr/api/waa_s_deliveries_api.rb +316 -0
- data/lib/zyphr/api/waa_s_endpoints_api.rb +653 -0
- data/lib/zyphr/api/waa_s_event_types_api.rb +452 -0
- data/lib/zyphr/api/waa_s_events_api.rb +170 -0
- data/lib/zyphr/api/waa_s_portal_api.rb +96 -0
- data/lib/zyphr/models/batch_publish_waa_s_events201_response.rb +220 -0
- data/lib/zyphr/models/create_waa_s_application201_response.rb +220 -0
- data/lib/zyphr/models/create_waa_s_application_request.rb +275 -0
- data/lib/zyphr/models/create_waa_s_endpoint201_response.rb +220 -0
- data/lib/zyphr/models/create_waa_s_endpoint_request.rb +294 -0
- data/lib/zyphr/models/create_waa_s_endpoint_response.rb +277 -0
- data/lib/zyphr/models/create_waa_s_event_type201_response.rb +220 -0
- data/lib/zyphr/models/create_waa_s_event_type_request.rb +292 -0
- data/lib/zyphr/models/generate_waa_s_portal_token201_response.rb +220 -0
- data/lib/zyphr/models/get_waa_s_endpoint200_response.rb +220 -0
- data/lib/zyphr/models/get_waa_s_usage200_response.rb +220 -0
- data/lib/zyphr/models/list_waa_s_applications200_response.rb +222 -0
- data/lib/zyphr/models/list_waa_s_endpoint_deliveries200_response.rb +222 -0
- data/lib/zyphr/models/list_waa_s_endpoints200_response.rb +222 -0
- data/lib/zyphr/models/list_waa_s_event_types200_response.rb +222 -0
- data/lib/zyphr/models/publish_waa_s_event201_response.rb +220 -0
- data/lib/zyphr/models/update_waa_s_application_request.rb +272 -0
- data/lib/zyphr/models/update_waa_s_endpoint_request.rb +274 -0
- data/lib/zyphr/models/update_waa_s_event_type_request.rb +247 -0
- data/lib/zyphr/models/waa_s_application.rb +317 -0
- data/lib/zyphr/models/waa_s_batch_publish_request.rb +248 -0
- data/lib/zyphr/models/waa_s_batch_publish_response.rb +240 -0
- data/lib/zyphr/models/waa_s_delivery.rb +344 -0
- data/lib/zyphr/models/waa_s_endpoint.rb +319 -0
- data/lib/zyphr/models/waa_s_event_type.rb +335 -0
- data/lib/zyphr/models/waa_s_portal_token_request.rb +267 -0
- data/lib/zyphr/models/waa_s_portal_token_request_theme.rb +263 -0
- data/lib/zyphr/models/waa_s_portal_token_response.rb +229 -0
- data/lib/zyphr/models/waa_s_publish_event_request.rb +302 -0
- data/lib/zyphr/models/waa_s_publish_event_response.rb +256 -0
- data/lib/zyphr/models/waa_s_usage_response.rb +265 -0
- data/lib/zyphr.rb +37 -0
- data/spec/api/waa_s_applications_api_spec.rb +110 -0
- data/spec/api/waa_s_deliveries_api_spec.rb +94 -0
- data/spec/api/waa_s_endpoints_api_spec.rb +154 -0
- data/spec/api/waa_s_event_types_api_spec.rb +115 -0
- data/spec/api/waa_s_events_api_spec.rb +61 -0
- data/spec/api/waa_s_portal_api_spec.rb +48 -0
- data/spec/models/batch_publish_waa_s_events201_response_spec.rb +36 -0
- data/spec/models/create_waa_s_application201_response_spec.rb +36 -0
- data/spec/models/create_waa_s_application_request_spec.rb +48 -0
- data/spec/models/create_waa_s_endpoint201_response_spec.rb +36 -0
- data/spec/models/create_waa_s_endpoint_request_spec.rb +48 -0
- data/spec/models/create_waa_s_endpoint_response_spec.rb +72 -0
- data/spec/models/create_waa_s_event_type201_response_spec.rb +36 -0
- data/spec/models/create_waa_s_event_type_request_spec.rb +60 -0
- data/spec/models/generate_waa_s_portal_token201_response_spec.rb +36 -0
- data/spec/models/get_waa_s_endpoint200_response_spec.rb +36 -0
- data/spec/models/get_waa_s_usage200_response_spec.rb +36 -0
- data/spec/models/list_waa_s_applications200_response_spec.rb +36 -0
- data/spec/models/list_waa_s_endpoint_deliveries200_response_spec.rb +36 -0
- data/spec/models/list_waa_s_endpoints200_response_spec.rb +36 -0
- data/spec/models/list_waa_s_event_types200_response_spec.rb +36 -0
- data/spec/models/publish_waa_s_event201_response_spec.rb +36 -0
- data/spec/models/update_waa_s_application_request_spec.rb +52 -0
- data/spec/models/update_waa_s_endpoint_request_spec.rb +52 -0
- data/spec/models/update_waa_s_event_type_request_spec.rb +54 -0
- data/spec/models/waa_s_application_spec.rb +82 -0
- data/spec/models/waa_s_batch_publish_request_spec.rb +36 -0
- data/spec/models/waa_s_batch_publish_response_spec.rb +48 -0
- data/spec/models/waa_s_delivery_spec.rb +100 -0
- data/spec/models/waa_s_endpoint_spec.rb +82 -0
- data/spec/models/waa_s_event_type_spec.rb +94 -0
- data/spec/models/waa_s_portal_token_request_spec.rb +54 -0
- data/spec/models/waa_s_portal_token_request_theme_spec.rb +46 -0
- data/spec/models/waa_s_portal_token_response_spec.rb +42 -0
- data/spec/models/waa_s_publish_event_request_spec.rb +54 -0
- data/spec/models/waa_s_publish_event_response_spec.rb +60 -0
- data/spec/models/waa_s_usage_response_spec.rb +66 -0
- data/zyphr.gemspec +1 -1
- metadata +150 -2
|
@@ -0,0 +1,673 @@
|
|
|
1
|
+
# Zyphr::WaaSEndpointsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.zyphr.dev/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**close_waa_s_endpoint_circuit**](WaaSEndpointsApi.md#close_waa_s_endpoint_circuit) | **POST** /v1/waas/applications/{appId}/endpoints/{endpointId}/circuit/close | Force-close circuit breaker |
|
|
8
|
+
| [**create_waa_s_endpoint**](WaaSEndpointsApi.md#create_waa_s_endpoint) | **POST** /v1/waas/applications/{appId}/endpoints | Create a tenant endpoint |
|
|
9
|
+
| [**delete_waa_s_endpoint**](WaaSEndpointsApi.md#delete_waa_s_endpoint) | **DELETE** /v1/waas/applications/{appId}/endpoints/{endpointId} | Delete an endpoint |
|
|
10
|
+
| [**get_waa_s_endpoint**](WaaSEndpointsApi.md#get_waa_s_endpoint) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId} | Get an endpoint |
|
|
11
|
+
| [**get_waa_s_endpoint_circuit**](WaaSEndpointsApi.md#get_waa_s_endpoint_circuit) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/circuit | Get circuit breaker state |
|
|
12
|
+
| [**get_waa_s_endpoint_metrics**](WaaSEndpointsApi.md#get_waa_s_endpoint_metrics) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/metrics | Get endpoint metrics |
|
|
13
|
+
| [**list_waa_s_endpoints**](WaaSEndpointsApi.md#list_waa_s_endpoints) | **GET** /v1/waas/applications/{appId}/endpoints | List tenant endpoints |
|
|
14
|
+
| [**rotate_waa_s_endpoint_secret**](WaaSEndpointsApi.md#rotate_waa_s_endpoint_secret) | **POST** /v1/waas/applications/{appId}/endpoints/{endpointId}/rotate-secret | Rotate endpoint secret |
|
|
15
|
+
| [**update_waa_s_endpoint**](WaaSEndpointsApi.md#update_waa_s_endpoint) | **PUT** /v1/waas/applications/{appId}/endpoints/{endpointId} | Update an endpoint |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## close_waa_s_endpoint_circuit
|
|
19
|
+
|
|
20
|
+
> close_waa_s_endpoint_circuit(app_id, endpoint_id)
|
|
21
|
+
|
|
22
|
+
Force-close circuit breaker
|
|
23
|
+
|
|
24
|
+
Force the circuit breaker to close, resuming deliveries to the endpoint.
|
|
25
|
+
|
|
26
|
+
### Examples
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'time'
|
|
30
|
+
require 'zyphr'
|
|
31
|
+
# setup authorization
|
|
32
|
+
Zyphr.configure do |config|
|
|
33
|
+
# Configure API key authorization: ApiKeyAuth
|
|
34
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
40
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
41
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
# Force-close circuit breaker
|
|
45
|
+
api_instance.close_waa_s_endpoint_circuit(app_id, endpoint_id)
|
|
46
|
+
rescue Zyphr::ApiError => e
|
|
47
|
+
puts "Error when calling WaaSEndpointsApi->close_waa_s_endpoint_circuit: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the close_waa_s_endpoint_circuit_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(nil, Integer, Hash)> close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# Force-close circuit breaker
|
|
60
|
+
data, status_code, headers = api_instance.close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => nil
|
|
64
|
+
rescue Zyphr::ApiError => e
|
|
65
|
+
puts "Error when calling WaaSEndpointsApi->close_waa_s_endpoint_circuit_with_http_info: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **app_id** | **String** | | |
|
|
74
|
+
| **endpoint_id** | **String** | | |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
nil (empty response body)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: Not defined
|
|
87
|
+
- **Accept**: Not defined
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## create_waa_s_endpoint
|
|
91
|
+
|
|
92
|
+
> <CreateWaaSEndpoint201Response> create_waa_s_endpoint(app_id, create_waa_s_endpoint_request)
|
|
93
|
+
|
|
94
|
+
Create a tenant endpoint
|
|
95
|
+
|
|
96
|
+
Create a webhook endpoint for a specific tenant. The signing secret is returned only on creation.
|
|
97
|
+
|
|
98
|
+
### Examples
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require 'time'
|
|
102
|
+
require 'zyphr'
|
|
103
|
+
# setup authorization
|
|
104
|
+
Zyphr.configure do |config|
|
|
105
|
+
# Configure API key authorization: ApiKeyAuth
|
|
106
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
112
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
113
|
+
create_waa_s_endpoint_request = Zyphr::CreateWaaSEndpointRequest.new({tenant_id: 'tenant_abc', url: 'https://customer.example.com/webhooks', events: ["order.created", "order.updated"]}) # CreateWaaSEndpointRequest |
|
|
114
|
+
|
|
115
|
+
begin
|
|
116
|
+
# Create a tenant endpoint
|
|
117
|
+
result = api_instance.create_waa_s_endpoint(app_id, create_waa_s_endpoint_request)
|
|
118
|
+
p result
|
|
119
|
+
rescue Zyphr::ApiError => e
|
|
120
|
+
puts "Error when calling WaaSEndpointsApi->create_waa_s_endpoint: #{e}"
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
#### Using the create_waa_s_endpoint_with_http_info variant
|
|
125
|
+
|
|
126
|
+
This returns an Array which contains the response data, status code and headers.
|
|
127
|
+
|
|
128
|
+
> <Array(<CreateWaaSEndpoint201Response>, Integer, Hash)> create_waa_s_endpoint_with_http_info(app_id, create_waa_s_endpoint_request)
|
|
129
|
+
|
|
130
|
+
```ruby
|
|
131
|
+
begin
|
|
132
|
+
# Create a tenant endpoint
|
|
133
|
+
data, status_code, headers = api_instance.create_waa_s_endpoint_with_http_info(app_id, create_waa_s_endpoint_request)
|
|
134
|
+
p status_code # => 2xx
|
|
135
|
+
p headers # => { ... }
|
|
136
|
+
p data # => <CreateWaaSEndpoint201Response>
|
|
137
|
+
rescue Zyphr::ApiError => e
|
|
138
|
+
puts "Error when calling WaaSEndpointsApi->create_waa_s_endpoint_with_http_info: #{e}"
|
|
139
|
+
end
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
| Name | Type | Description | Notes |
|
|
145
|
+
| ---- | ---- | ----------- | ----- |
|
|
146
|
+
| **app_id** | **String** | | |
|
|
147
|
+
| **create_waa_s_endpoint_request** | [**CreateWaaSEndpointRequest**](CreateWaaSEndpointRequest.md) | | |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**CreateWaaSEndpoint201Response**](CreateWaaSEndpoint201Response.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: application/json
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## delete_waa_s_endpoint
|
|
164
|
+
|
|
165
|
+
> delete_waa_s_endpoint(app_id, endpoint_id)
|
|
166
|
+
|
|
167
|
+
Delete an endpoint
|
|
168
|
+
|
|
169
|
+
Delete a tenant endpoint. Stops all future deliveries and removes pending retries.
|
|
170
|
+
|
|
171
|
+
### Examples
|
|
172
|
+
|
|
173
|
+
```ruby
|
|
174
|
+
require 'time'
|
|
175
|
+
require 'zyphr'
|
|
176
|
+
# setup authorization
|
|
177
|
+
Zyphr.configure do |config|
|
|
178
|
+
# Configure API key authorization: ApiKeyAuth
|
|
179
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
180
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
181
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
185
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
186
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
# Delete an endpoint
|
|
190
|
+
api_instance.delete_waa_s_endpoint(app_id, endpoint_id)
|
|
191
|
+
rescue Zyphr::ApiError => e
|
|
192
|
+
puts "Error when calling WaaSEndpointsApi->delete_waa_s_endpoint: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
#### Using the delete_waa_s_endpoint_with_http_info variant
|
|
197
|
+
|
|
198
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
199
|
+
|
|
200
|
+
> <Array(nil, Integer, Hash)> delete_waa_s_endpoint_with_http_info(app_id, endpoint_id)
|
|
201
|
+
|
|
202
|
+
```ruby
|
|
203
|
+
begin
|
|
204
|
+
# Delete an endpoint
|
|
205
|
+
data, status_code, headers = api_instance.delete_waa_s_endpoint_with_http_info(app_id, endpoint_id)
|
|
206
|
+
p status_code # => 2xx
|
|
207
|
+
p headers # => { ... }
|
|
208
|
+
p data # => nil
|
|
209
|
+
rescue Zyphr::ApiError => e
|
|
210
|
+
puts "Error when calling WaaSEndpointsApi->delete_waa_s_endpoint_with_http_info: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Parameters
|
|
215
|
+
|
|
216
|
+
| Name | Type | Description | Notes |
|
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
|
218
|
+
| **app_id** | **String** | | |
|
|
219
|
+
| **endpoint_id** | **String** | | |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
nil (empty response body)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: Not defined
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
## get_waa_s_endpoint
|
|
236
|
+
|
|
237
|
+
> <GetWaaSEndpoint200Response> get_waa_s_endpoint(app_id, endpoint_id)
|
|
238
|
+
|
|
239
|
+
Get an endpoint
|
|
240
|
+
|
|
241
|
+
### Examples
|
|
242
|
+
|
|
243
|
+
```ruby
|
|
244
|
+
require 'time'
|
|
245
|
+
require 'zyphr'
|
|
246
|
+
# setup authorization
|
|
247
|
+
Zyphr.configure do |config|
|
|
248
|
+
# Configure API key authorization: ApiKeyAuth
|
|
249
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
251
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
255
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
256
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
257
|
+
|
|
258
|
+
begin
|
|
259
|
+
# Get an endpoint
|
|
260
|
+
result = api_instance.get_waa_s_endpoint(app_id, endpoint_id)
|
|
261
|
+
p result
|
|
262
|
+
rescue Zyphr::ApiError => e
|
|
263
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint: #{e}"
|
|
264
|
+
end
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
#### Using the get_waa_s_endpoint_with_http_info variant
|
|
268
|
+
|
|
269
|
+
This returns an Array which contains the response data, status code and headers.
|
|
270
|
+
|
|
271
|
+
> <Array(<GetWaaSEndpoint200Response>, Integer, Hash)> get_waa_s_endpoint_with_http_info(app_id, endpoint_id)
|
|
272
|
+
|
|
273
|
+
```ruby
|
|
274
|
+
begin
|
|
275
|
+
# Get an endpoint
|
|
276
|
+
data, status_code, headers = api_instance.get_waa_s_endpoint_with_http_info(app_id, endpoint_id)
|
|
277
|
+
p status_code # => 2xx
|
|
278
|
+
p headers # => { ... }
|
|
279
|
+
p data # => <GetWaaSEndpoint200Response>
|
|
280
|
+
rescue Zyphr::ApiError => e
|
|
281
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_with_http_info: #{e}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Parameters
|
|
286
|
+
|
|
287
|
+
| Name | Type | Description | Notes |
|
|
288
|
+
| ---- | ---- | ----------- | ----- |
|
|
289
|
+
| **app_id** | **String** | | |
|
|
290
|
+
| **endpoint_id** | **String** | | |
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
[**GetWaaSEndpoint200Response**](GetWaaSEndpoint200Response.md)
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: Not defined
|
|
303
|
+
- **Accept**: application/json
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
## get_waa_s_endpoint_circuit
|
|
307
|
+
|
|
308
|
+
> get_waa_s_endpoint_circuit(app_id, endpoint_id)
|
|
309
|
+
|
|
310
|
+
Get circuit breaker state
|
|
311
|
+
|
|
312
|
+
Get the circuit breaker state for an endpoint (closed, open, or half-open).
|
|
313
|
+
|
|
314
|
+
### Examples
|
|
315
|
+
|
|
316
|
+
```ruby
|
|
317
|
+
require 'time'
|
|
318
|
+
require 'zyphr'
|
|
319
|
+
# setup authorization
|
|
320
|
+
Zyphr.configure do |config|
|
|
321
|
+
# Configure API key authorization: ApiKeyAuth
|
|
322
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
323
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
324
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
328
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
329
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Get circuit breaker state
|
|
333
|
+
api_instance.get_waa_s_endpoint_circuit(app_id, endpoint_id)
|
|
334
|
+
rescue Zyphr::ApiError => e
|
|
335
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_circuit: #{e}"
|
|
336
|
+
end
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
#### Using the get_waa_s_endpoint_circuit_with_http_info variant
|
|
340
|
+
|
|
341
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
342
|
+
|
|
343
|
+
> <Array(nil, Integer, Hash)> get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
|
|
344
|
+
|
|
345
|
+
```ruby
|
|
346
|
+
begin
|
|
347
|
+
# Get circuit breaker state
|
|
348
|
+
data, status_code, headers = api_instance.get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
|
|
349
|
+
p status_code # => 2xx
|
|
350
|
+
p headers # => { ... }
|
|
351
|
+
p data # => nil
|
|
352
|
+
rescue Zyphr::ApiError => e
|
|
353
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_circuit_with_http_info: #{e}"
|
|
354
|
+
end
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### Parameters
|
|
358
|
+
|
|
359
|
+
| Name | Type | Description | Notes |
|
|
360
|
+
| ---- | ---- | ----------- | ----- |
|
|
361
|
+
| **app_id** | **String** | | |
|
|
362
|
+
| **endpoint_id** | **String** | | |
|
|
363
|
+
|
|
364
|
+
### Return type
|
|
365
|
+
|
|
366
|
+
nil (empty response body)
|
|
367
|
+
|
|
368
|
+
### Authorization
|
|
369
|
+
|
|
370
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
371
|
+
|
|
372
|
+
### HTTP request headers
|
|
373
|
+
|
|
374
|
+
- **Content-Type**: Not defined
|
|
375
|
+
- **Accept**: Not defined
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
## get_waa_s_endpoint_metrics
|
|
379
|
+
|
|
380
|
+
> get_waa_s_endpoint_metrics(app_id, endpoint_id)
|
|
381
|
+
|
|
382
|
+
Get endpoint metrics
|
|
383
|
+
|
|
384
|
+
Get delivery success rate, latency, and health metrics for an endpoint.
|
|
385
|
+
|
|
386
|
+
### Examples
|
|
387
|
+
|
|
388
|
+
```ruby
|
|
389
|
+
require 'time'
|
|
390
|
+
require 'zyphr'
|
|
391
|
+
# setup authorization
|
|
392
|
+
Zyphr.configure do |config|
|
|
393
|
+
# Configure API key authorization: ApiKeyAuth
|
|
394
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
395
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
396
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
400
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
401
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
402
|
+
|
|
403
|
+
begin
|
|
404
|
+
# Get endpoint metrics
|
|
405
|
+
api_instance.get_waa_s_endpoint_metrics(app_id, endpoint_id)
|
|
406
|
+
rescue Zyphr::ApiError => e
|
|
407
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_metrics: #{e}"
|
|
408
|
+
end
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
#### Using the get_waa_s_endpoint_metrics_with_http_info variant
|
|
412
|
+
|
|
413
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
414
|
+
|
|
415
|
+
> <Array(nil, Integer, Hash)> get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id)
|
|
416
|
+
|
|
417
|
+
```ruby
|
|
418
|
+
begin
|
|
419
|
+
# Get endpoint metrics
|
|
420
|
+
data, status_code, headers = api_instance.get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id)
|
|
421
|
+
p status_code # => 2xx
|
|
422
|
+
p headers # => { ... }
|
|
423
|
+
p data # => nil
|
|
424
|
+
rescue Zyphr::ApiError => e
|
|
425
|
+
puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_metrics_with_http_info: #{e}"
|
|
426
|
+
end
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
### Parameters
|
|
430
|
+
|
|
431
|
+
| Name | Type | Description | Notes |
|
|
432
|
+
| ---- | ---- | ----------- | ----- |
|
|
433
|
+
| **app_id** | **String** | | |
|
|
434
|
+
| **endpoint_id** | **String** | | |
|
|
435
|
+
|
|
436
|
+
### Return type
|
|
437
|
+
|
|
438
|
+
nil (empty response body)
|
|
439
|
+
|
|
440
|
+
### Authorization
|
|
441
|
+
|
|
442
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
443
|
+
|
|
444
|
+
### HTTP request headers
|
|
445
|
+
|
|
446
|
+
- **Content-Type**: Not defined
|
|
447
|
+
- **Accept**: Not defined
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
## list_waa_s_endpoints
|
|
451
|
+
|
|
452
|
+
> <ListWaaSEndpoints200Response> list_waa_s_endpoints(app_id, opts)
|
|
453
|
+
|
|
454
|
+
List tenant endpoints
|
|
455
|
+
|
|
456
|
+
List all endpoints for a WaaS application. Optionally filter by tenant ID or status.
|
|
457
|
+
|
|
458
|
+
### Examples
|
|
459
|
+
|
|
460
|
+
```ruby
|
|
461
|
+
require 'time'
|
|
462
|
+
require 'zyphr'
|
|
463
|
+
# setup authorization
|
|
464
|
+
Zyphr.configure do |config|
|
|
465
|
+
# Configure API key authorization: ApiKeyAuth
|
|
466
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
467
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
468
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
472
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
473
|
+
opts = {
|
|
474
|
+
limit: 56, # Integer |
|
|
475
|
+
offset: 56, # Integer |
|
|
476
|
+
tenant_id: 'tenant_id_example', # String |
|
|
477
|
+
status: 'active' # String |
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
begin
|
|
481
|
+
# List tenant endpoints
|
|
482
|
+
result = api_instance.list_waa_s_endpoints(app_id, opts)
|
|
483
|
+
p result
|
|
484
|
+
rescue Zyphr::ApiError => e
|
|
485
|
+
puts "Error when calling WaaSEndpointsApi->list_waa_s_endpoints: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
#### Using the list_waa_s_endpoints_with_http_info variant
|
|
490
|
+
|
|
491
|
+
This returns an Array which contains the response data, status code and headers.
|
|
492
|
+
|
|
493
|
+
> <Array(<ListWaaSEndpoints200Response>, Integer, Hash)> list_waa_s_endpoints_with_http_info(app_id, opts)
|
|
494
|
+
|
|
495
|
+
```ruby
|
|
496
|
+
begin
|
|
497
|
+
# List tenant endpoints
|
|
498
|
+
data, status_code, headers = api_instance.list_waa_s_endpoints_with_http_info(app_id, opts)
|
|
499
|
+
p status_code # => 2xx
|
|
500
|
+
p headers # => { ... }
|
|
501
|
+
p data # => <ListWaaSEndpoints200Response>
|
|
502
|
+
rescue Zyphr::ApiError => e
|
|
503
|
+
puts "Error when calling WaaSEndpointsApi->list_waa_s_endpoints_with_http_info: #{e}"
|
|
504
|
+
end
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
| Name | Type | Description | Notes |
|
|
510
|
+
| ---- | ---- | ----------- | ----- |
|
|
511
|
+
| **app_id** | **String** | | |
|
|
512
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
513
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
514
|
+
| **tenant_id** | **String** | | [optional] |
|
|
515
|
+
| **status** | **String** | | [optional] |
|
|
516
|
+
|
|
517
|
+
### Return type
|
|
518
|
+
|
|
519
|
+
[**ListWaaSEndpoints200Response**](ListWaaSEndpoints200Response.md)
|
|
520
|
+
|
|
521
|
+
### Authorization
|
|
522
|
+
|
|
523
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
524
|
+
|
|
525
|
+
### HTTP request headers
|
|
526
|
+
|
|
527
|
+
- **Content-Type**: Not defined
|
|
528
|
+
- **Accept**: application/json
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
## rotate_waa_s_endpoint_secret
|
|
532
|
+
|
|
533
|
+
> rotate_waa_s_endpoint_secret(app_id, endpoint_id)
|
|
534
|
+
|
|
535
|
+
Rotate endpoint secret
|
|
536
|
+
|
|
537
|
+
Rotate the signing secret for an endpoint. During rotation, deliveries are signed with both old and new secrets.
|
|
538
|
+
|
|
539
|
+
### Examples
|
|
540
|
+
|
|
541
|
+
```ruby
|
|
542
|
+
require 'time'
|
|
543
|
+
require 'zyphr'
|
|
544
|
+
# setup authorization
|
|
545
|
+
Zyphr.configure do |config|
|
|
546
|
+
# Configure API key authorization: ApiKeyAuth
|
|
547
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
548
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
549
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
553
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
554
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
555
|
+
|
|
556
|
+
begin
|
|
557
|
+
# Rotate endpoint secret
|
|
558
|
+
api_instance.rotate_waa_s_endpoint_secret(app_id, endpoint_id)
|
|
559
|
+
rescue Zyphr::ApiError => e
|
|
560
|
+
puts "Error when calling WaaSEndpointsApi->rotate_waa_s_endpoint_secret: #{e}"
|
|
561
|
+
end
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
#### Using the rotate_waa_s_endpoint_secret_with_http_info variant
|
|
565
|
+
|
|
566
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
567
|
+
|
|
568
|
+
> <Array(nil, Integer, Hash)> rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id)
|
|
569
|
+
|
|
570
|
+
```ruby
|
|
571
|
+
begin
|
|
572
|
+
# Rotate endpoint secret
|
|
573
|
+
data, status_code, headers = api_instance.rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id)
|
|
574
|
+
p status_code # => 2xx
|
|
575
|
+
p headers # => { ... }
|
|
576
|
+
p data # => nil
|
|
577
|
+
rescue Zyphr::ApiError => e
|
|
578
|
+
puts "Error when calling WaaSEndpointsApi->rotate_waa_s_endpoint_secret_with_http_info: #{e}"
|
|
579
|
+
end
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
### Parameters
|
|
583
|
+
|
|
584
|
+
| Name | Type | Description | Notes |
|
|
585
|
+
| ---- | ---- | ----------- | ----- |
|
|
586
|
+
| **app_id** | **String** | | |
|
|
587
|
+
| **endpoint_id** | **String** | | |
|
|
588
|
+
|
|
589
|
+
### Return type
|
|
590
|
+
|
|
591
|
+
nil (empty response body)
|
|
592
|
+
|
|
593
|
+
### Authorization
|
|
594
|
+
|
|
595
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
596
|
+
|
|
597
|
+
### HTTP request headers
|
|
598
|
+
|
|
599
|
+
- **Content-Type**: Not defined
|
|
600
|
+
- **Accept**: Not defined
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
## update_waa_s_endpoint
|
|
604
|
+
|
|
605
|
+
> update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
|
|
606
|
+
|
|
607
|
+
Update an endpoint
|
|
608
|
+
|
|
609
|
+
### Examples
|
|
610
|
+
|
|
611
|
+
```ruby
|
|
612
|
+
require 'time'
|
|
613
|
+
require 'zyphr'
|
|
614
|
+
# setup authorization
|
|
615
|
+
Zyphr.configure do |config|
|
|
616
|
+
# Configure API key authorization: ApiKeyAuth
|
|
617
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
618
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
619
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
620
|
+
end
|
|
621
|
+
|
|
622
|
+
api_instance = Zyphr::WaaSEndpointsApi.new
|
|
623
|
+
app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
624
|
+
endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
625
|
+
update_waa_s_endpoint_request = Zyphr::UpdateWaaSEndpointRequest.new # UpdateWaaSEndpointRequest |
|
|
626
|
+
|
|
627
|
+
begin
|
|
628
|
+
# Update an endpoint
|
|
629
|
+
api_instance.update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
|
|
630
|
+
rescue Zyphr::ApiError => e
|
|
631
|
+
puts "Error when calling WaaSEndpointsApi->update_waa_s_endpoint: #{e}"
|
|
632
|
+
end
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
#### Using the update_waa_s_endpoint_with_http_info variant
|
|
636
|
+
|
|
637
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
638
|
+
|
|
639
|
+
> <Array(nil, Integer, Hash)> update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request)
|
|
640
|
+
|
|
641
|
+
```ruby
|
|
642
|
+
begin
|
|
643
|
+
# Update an endpoint
|
|
644
|
+
data, status_code, headers = api_instance.update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request)
|
|
645
|
+
p status_code # => 2xx
|
|
646
|
+
p headers # => { ... }
|
|
647
|
+
p data # => nil
|
|
648
|
+
rescue Zyphr::ApiError => e
|
|
649
|
+
puts "Error when calling WaaSEndpointsApi->update_waa_s_endpoint_with_http_info: #{e}"
|
|
650
|
+
end
|
|
651
|
+
```
|
|
652
|
+
|
|
653
|
+
### Parameters
|
|
654
|
+
|
|
655
|
+
| Name | Type | Description | Notes |
|
|
656
|
+
| ---- | ---- | ----------- | ----- |
|
|
657
|
+
| **app_id** | **String** | | |
|
|
658
|
+
| **endpoint_id** | **String** | | |
|
|
659
|
+
| **update_waa_s_endpoint_request** | [**UpdateWaaSEndpointRequest**](UpdateWaaSEndpointRequest.md) | | |
|
|
660
|
+
|
|
661
|
+
### Return type
|
|
662
|
+
|
|
663
|
+
nil (empty response body)
|
|
664
|
+
|
|
665
|
+
### Authorization
|
|
666
|
+
|
|
667
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
668
|
+
|
|
669
|
+
### HTTP request headers
|
|
670
|
+
|
|
671
|
+
- **Content-Type**: application/json
|
|
672
|
+
- **Accept**: Not defined
|
|
673
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Zyphr::WaaSEventType
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **application_id** | **String** | | [optional] |
|
|
9
|
+
| **event_type** | **String** | | [optional] |
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
|
+
| **description** | **String** | | [optional] |
|
|
12
|
+
| **category** | **String** | | [optional] |
|
|
13
|
+
| **example_payload** | **Object** | | [optional] |
|
|
14
|
+
| **status** | **String** | | [optional] |
|
|
15
|
+
| **created_at** | **Time** | | [optional] |
|
|
16
|
+
| **updated_at** | **Time** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'zyphr'
|
|
22
|
+
|
|
23
|
+
instance = Zyphr::WaaSEventType.new(
|
|
24
|
+
id: null,
|
|
25
|
+
application_id: null,
|
|
26
|
+
event_type: order.created,
|
|
27
|
+
name: Order Created,
|
|
28
|
+
description: null,
|
|
29
|
+
category: orders,
|
|
30
|
+
example_payload: null,
|
|
31
|
+
status: null,
|
|
32
|
+
created_at: null,
|
|
33
|
+
updated_at: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|