zyphr 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.
- 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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d0d73a75bc55c9872da49390d39398b086cd990f9a6f927902897505f6d2b06a
|
|
4
|
+
data.tar.gz: 6c6c1eab1f8d23f79081fdcdd352f2abdce1a2a83c4c0754ccd1c0663a576cfa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f29219dde8888dc37fec6f639aa7c8d6f0560bf81ba79efa4f9bdfd022c7239159a83a9be12275a1e3bf6ce19fe654083b754363ae4819bf49def41e191d69fe
|
|
7
|
+
data.tar.gz: 64813d1951012c5cdcb143f3ee3f46f5fce2f49833f84b5d3c7ee59a135ae4aeaf465e24c28307f4208cb3a4d6a2174265cd6ef9ac2f6bf8bd6c9f586943701e
|
data/README.md
CHANGED
|
@@ -249,6 +249,34 @@ Class | Method | HTTP request | Description
|
|
|
249
249
|
*Zyphr::TopicsApi* | [**remove_topic_subscribers**](docs/TopicsApi.md#remove_topic_subscribers) | **DELETE** /topics/{key}/subscribers | Remove subscribers from a topic
|
|
250
250
|
*Zyphr::TopicsApi* | [**update_topic**](docs/TopicsApi.md#update_topic) | **PATCH** /topics/{key} | Update a topic
|
|
251
251
|
*Zyphr::UtilityApi* | [**get_password_requirements**](docs/UtilityApi.md#get_password_requirements) | **GET** /auth/password-requirements | Get password requirements
|
|
252
|
+
*Zyphr::WaaSApplicationsApi* | [**create_waa_s_application**](docs/WaaSApplicationsApi.md#create_waa_s_application) | **POST** /v1/waas/applications | Create a WaaS application
|
|
253
|
+
*Zyphr::WaaSApplicationsApi* | [**delete_waa_s_application**](docs/WaaSApplicationsApi.md#delete_waa_s_application) | **DELETE** /v1/waas/applications/{appId} | Delete a WaaS application
|
|
254
|
+
*Zyphr::WaaSApplicationsApi* | [**get_waa_s_application**](docs/WaaSApplicationsApi.md#get_waa_s_application) | **GET** /v1/waas/applications/{appId} | Get a WaaS application
|
|
255
|
+
*Zyphr::WaaSApplicationsApi* | [**get_waa_s_usage**](docs/WaaSApplicationsApi.md#get_waa_s_usage) | **GET** /v1/waas/applications/{appId}/usage | Get WaaS usage
|
|
256
|
+
*Zyphr::WaaSApplicationsApi* | [**list_waa_s_applications**](docs/WaaSApplicationsApi.md#list_waa_s_applications) | **GET** /v1/waas/applications | List WaaS applications
|
|
257
|
+
*Zyphr::WaaSApplicationsApi* | [**update_waa_s_application**](docs/WaaSApplicationsApi.md#update_waa_s_application) | **PUT** /v1/waas/applications/{appId} | Update a WaaS application
|
|
258
|
+
*Zyphr::WaaSDeliveriesApi* | [**get_waa_s_delivery**](docs/WaaSDeliveriesApi.md#get_waa_s_delivery) | **GET** /v1/waas/applications/{appId}/deliveries/{deliveryId} | Get delivery detail
|
|
259
|
+
*Zyphr::WaaSDeliveriesApi* | [**list_waa_s_deliveries**](docs/WaaSDeliveriesApi.md#list_waa_s_deliveries) | **GET** /v1/waas/applications/{appId}/deliveries | List deliveries
|
|
260
|
+
*Zyphr::WaaSDeliveriesApi* | [**list_waa_s_endpoint_deliveries**](docs/WaaSDeliveriesApi.md#list_waa_s_endpoint_deliveries) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/deliveries | List endpoint deliveries
|
|
261
|
+
*Zyphr::WaaSDeliveriesApi* | [**retry_waa_s_delivery**](docs/WaaSDeliveriesApi.md#retry_waa_s_delivery) | **POST** /v1/waas/applications/{appId}/deliveries/{deliveryId}/retry | Retry a delivery
|
|
262
|
+
*Zyphr::WaaSEndpointsApi* | [**close_waa_s_endpoint_circuit**](docs/WaaSEndpointsApi.md#close_waa_s_endpoint_circuit) | **POST** /v1/waas/applications/{appId}/endpoints/{endpointId}/circuit/close | Force-close circuit breaker
|
|
263
|
+
*Zyphr::WaaSEndpointsApi* | [**create_waa_s_endpoint**](docs/WaaSEndpointsApi.md#create_waa_s_endpoint) | **POST** /v1/waas/applications/{appId}/endpoints | Create a tenant endpoint
|
|
264
|
+
*Zyphr::WaaSEndpointsApi* | [**delete_waa_s_endpoint**](docs/WaaSEndpointsApi.md#delete_waa_s_endpoint) | **DELETE** /v1/waas/applications/{appId}/endpoints/{endpointId} | Delete an endpoint
|
|
265
|
+
*Zyphr::WaaSEndpointsApi* | [**get_waa_s_endpoint**](docs/WaaSEndpointsApi.md#get_waa_s_endpoint) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId} | Get an endpoint
|
|
266
|
+
*Zyphr::WaaSEndpointsApi* | [**get_waa_s_endpoint_circuit**](docs/WaaSEndpointsApi.md#get_waa_s_endpoint_circuit) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/circuit | Get circuit breaker state
|
|
267
|
+
*Zyphr::WaaSEndpointsApi* | [**get_waa_s_endpoint_metrics**](docs/WaaSEndpointsApi.md#get_waa_s_endpoint_metrics) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/metrics | Get endpoint metrics
|
|
268
|
+
*Zyphr::WaaSEndpointsApi* | [**list_waa_s_endpoints**](docs/WaaSEndpointsApi.md#list_waa_s_endpoints) | **GET** /v1/waas/applications/{appId}/endpoints | List tenant endpoints
|
|
269
|
+
*Zyphr::WaaSEndpointsApi* | [**rotate_waa_s_endpoint_secret**](docs/WaaSEndpointsApi.md#rotate_waa_s_endpoint_secret) | **POST** /v1/waas/applications/{appId}/endpoints/{endpointId}/rotate-secret | Rotate endpoint secret
|
|
270
|
+
*Zyphr::WaaSEndpointsApi* | [**update_waa_s_endpoint**](docs/WaaSEndpointsApi.md#update_waa_s_endpoint) | **PUT** /v1/waas/applications/{appId}/endpoints/{endpointId} | Update an endpoint
|
|
271
|
+
*Zyphr::WaaSEventTypesApi* | [**create_waa_s_event_type**](docs/WaaSEventTypesApi.md#create_waa_s_event_type) | **POST** /v1/waas/applications/{appId}/event-types | Register an event type
|
|
272
|
+
*Zyphr::WaaSEventTypesApi* | [**delete_waa_s_event_type**](docs/WaaSEventTypesApi.md#delete_waa_s_event_type) | **DELETE** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Delete an event type
|
|
273
|
+
*Zyphr::WaaSEventTypesApi* | [**deprecate_waa_s_event_type**](docs/WaaSEventTypesApi.md#deprecate_waa_s_event_type) | **POST** /v1/waas/applications/{appId}/event-types/{eventTypeId}/deprecate | Deprecate an event type
|
|
274
|
+
*Zyphr::WaaSEventTypesApi* | [**get_waa_s_event_type**](docs/WaaSEventTypesApi.md#get_waa_s_event_type) | **GET** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Get an event type
|
|
275
|
+
*Zyphr::WaaSEventTypesApi* | [**list_waa_s_event_types**](docs/WaaSEventTypesApi.md#list_waa_s_event_types) | **GET** /v1/waas/applications/{appId}/event-types | List event types
|
|
276
|
+
*Zyphr::WaaSEventTypesApi* | [**update_waa_s_event_type**](docs/WaaSEventTypesApi.md#update_waa_s_event_type) | **PUT** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Update an event type
|
|
277
|
+
*Zyphr::WaaSEventsApi* | [**batch_publish_waa_s_events**](docs/WaaSEventsApi.md#batch_publish_waa_s_events) | **POST** /v1/waas/applications/{appId}/events/batch | Batch publish events
|
|
278
|
+
*Zyphr::WaaSEventsApi* | [**publish_waa_s_event**](docs/WaaSEventsApi.md#publish_waa_s_event) | **POST** /v1/waas/applications/{appId}/events | Publish an event
|
|
279
|
+
*Zyphr::WaaSPortalApi* | [**generate_waa_s_portal_token**](docs/WaaSPortalApi.md#generate_waa_s_portal_token) | **POST** /v1/waas/applications/{appId}/portal/token | Generate portal token
|
|
252
280
|
*Zyphr::WebhooksApi* | [**bulk_retry_webhook_deliveries**](docs/WebhooksApi.md#bulk_retry_webhook_deliveries) | **POST** /v1/webhooks/{id}/deliveries/bulk-retry | Bulk retry failed deliveries
|
|
253
281
|
*Zyphr::WebhooksApi* | [**close_webhook_circuit**](docs/WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker
|
|
254
282
|
*Zyphr::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook
|
|
@@ -290,6 +318,7 @@ Class | Method | HTTP request | Description
|
|
|
290
318
|
- [Zyphr::AuthUser](docs/AuthUser.md)
|
|
291
319
|
- [Zyphr::AuthUserResponse](docs/AuthUserResponse.md)
|
|
292
320
|
- [Zyphr::AuthUserResponseData](docs/AuthUserResponseData.md)
|
|
321
|
+
- [Zyphr::BatchPublishWaaSEvents201Response](docs/BatchPublishWaaSEvents201Response.md)
|
|
293
322
|
- [Zyphr::BulkRetryWebhookDeliveriesRequest](docs/BulkRetryWebhookDeliveriesRequest.md)
|
|
294
323
|
- [Zyphr::Category](docs/Category.md)
|
|
295
324
|
- [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
|
|
@@ -308,6 +337,13 @@ Class | Method | HTTP request | Description
|
|
|
308
337
|
- [Zyphr::CreateSubscriberRequest](docs/CreateSubscriberRequest.md)
|
|
309
338
|
- [Zyphr::CreateTemplateRequest](docs/CreateTemplateRequest.md)
|
|
310
339
|
- [Zyphr::CreateTopicRequest](docs/CreateTopicRequest.md)
|
|
340
|
+
- [Zyphr::CreateWaaSApplication201Response](docs/CreateWaaSApplication201Response.md)
|
|
341
|
+
- [Zyphr::CreateWaaSApplicationRequest](docs/CreateWaaSApplicationRequest.md)
|
|
342
|
+
- [Zyphr::CreateWaaSEndpoint201Response](docs/CreateWaaSEndpoint201Response.md)
|
|
343
|
+
- [Zyphr::CreateWaaSEndpointRequest](docs/CreateWaaSEndpointRequest.md)
|
|
344
|
+
- [Zyphr::CreateWaaSEndpointResponse](docs/CreateWaaSEndpointResponse.md)
|
|
345
|
+
- [Zyphr::CreateWaaSEventType201Response](docs/CreateWaaSEventType201Response.md)
|
|
346
|
+
- [Zyphr::CreateWaaSEventTypeRequest](docs/CreateWaaSEventTypeRequest.md)
|
|
311
347
|
- [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
|
312
348
|
- [Zyphr::DeleteResult](docs/DeleteResult.md)
|
|
313
349
|
- [Zyphr::DeleteResultData](docs/DeleteResultData.md)
|
|
@@ -334,10 +370,17 @@ Class | Method | HTTP request | Description
|
|
|
334
370
|
- [Zyphr::EndUserDeleteResponse](docs/EndUserDeleteResponse.md)
|
|
335
371
|
- [Zyphr::EndUserDeleteResponseData](docs/EndUserDeleteResponseData.md)
|
|
336
372
|
- [Zyphr::ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
|
|
373
|
+
- [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
|
|
374
|
+
- [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
|
|
375
|
+
- [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
|
|
337
376
|
- [Zyphr::InAppNotification](docs/InAppNotification.md)
|
|
338
377
|
- [Zyphr::InboxListMeta](docs/InboxListMeta.md)
|
|
339
378
|
- [Zyphr::InboxListResponse](docs/InboxListResponse.md)
|
|
340
379
|
- [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
|
|
380
|
+
- [Zyphr::ListWaaSApplications200Response](docs/ListWaaSApplications200Response.md)
|
|
381
|
+
- [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
|
|
382
|
+
- [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
|
|
383
|
+
- [Zyphr::ListWaaSEventTypes200Response](docs/ListWaaSEventTypes200Response.md)
|
|
341
384
|
- [Zyphr::LoginRequest](docs/LoginRequest.md)
|
|
342
385
|
- [Zyphr::MagicLinkSendRequest](docs/MagicLinkSendRequest.md)
|
|
343
386
|
- [Zyphr::MagicLinkVerifyRequest](docs/MagicLinkVerifyRequest.md)
|
|
@@ -395,6 +438,7 @@ Class | Method | HTTP request | Description
|
|
|
395
438
|
- [Zyphr::PhoneOtpSentResponseData](docs/PhoneOtpSentResponseData.md)
|
|
396
439
|
- [Zyphr::PhoneRegisterVerifyRequest](docs/PhoneRegisterVerifyRequest.md)
|
|
397
440
|
- [Zyphr::PreferenceListResponse](docs/PreferenceListResponse.md)
|
|
441
|
+
- [Zyphr::PublishWaaSEvent201Response](docs/PublishWaaSEvent201Response.md)
|
|
398
442
|
- [Zyphr::PushDetailResponse](docs/PushDetailResponse.md)
|
|
399
443
|
- [Zyphr::PushEvent](docs/PushEvent.md)
|
|
400
444
|
- [Zyphr::PushListResponse](docs/PushListResponse.md)
|
|
@@ -512,6 +556,9 @@ Class | Method | HTTP request | Description
|
|
|
512
556
|
- [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
|
|
513
557
|
- [Zyphr::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
|
|
514
558
|
- [Zyphr::UpdateTopicRequest](docs/UpdateTopicRequest.md)
|
|
559
|
+
- [Zyphr::UpdateWaaSApplicationRequest](docs/UpdateWaaSApplicationRequest.md)
|
|
560
|
+
- [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
|
|
561
|
+
- [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
|
|
515
562
|
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
516
563
|
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
517
564
|
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
@@ -521,6 +568,18 @@ Class | Method | HTTP request | Description
|
|
|
521
568
|
- [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
|
|
522
569
|
- [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
|
|
523
570
|
- [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
|
|
571
|
+
- [Zyphr::WaaSApplication](docs/WaaSApplication.md)
|
|
572
|
+
- [Zyphr::WaaSBatchPublishRequest](docs/WaaSBatchPublishRequest.md)
|
|
573
|
+
- [Zyphr::WaaSBatchPublishResponse](docs/WaaSBatchPublishResponse.md)
|
|
574
|
+
- [Zyphr::WaaSDelivery](docs/WaaSDelivery.md)
|
|
575
|
+
- [Zyphr::WaaSEndpoint](docs/WaaSEndpoint.md)
|
|
576
|
+
- [Zyphr::WaaSEventType](docs/WaaSEventType.md)
|
|
577
|
+
- [Zyphr::WaaSPortalTokenRequest](docs/WaaSPortalTokenRequest.md)
|
|
578
|
+
- [Zyphr::WaaSPortalTokenRequestTheme](docs/WaaSPortalTokenRequestTheme.md)
|
|
579
|
+
- [Zyphr::WaaSPortalTokenResponse](docs/WaaSPortalTokenResponse.md)
|
|
580
|
+
- [Zyphr::WaaSPublishEventRequest](docs/WaaSPublishEventRequest.md)
|
|
581
|
+
- [Zyphr::WaaSPublishEventResponse](docs/WaaSPublishEventResponse.md)
|
|
582
|
+
- [Zyphr::WaaSUsageResponse](docs/WaaSUsageResponse.md)
|
|
524
583
|
- [Zyphr::WebAuthnChallengeOptions](docs/WebAuthnChallengeOptions.md)
|
|
525
584
|
- [Zyphr::WebAuthnCredential](docs/WebAuthnCredential.md)
|
|
526
585
|
- [Zyphr::WebAuthnCredentialListResponse](docs/WebAuthnCredentialListResponse.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::BatchPublishWaaSEvents201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSBatchPublishResponse**](WaaSBatchPublishResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::BatchPublishWaaSEvents201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSApplication201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSApplication**](WaaSApplication.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::CreateWaaSApplication201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSApplicationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Human-readable application name | |
|
|
8
|
+
| **slug** | **String** | URL-safe identifier (lowercase, hyphens only) | |
|
|
9
|
+
| **description** | **String** | Optional description | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::CreateWaaSApplicationRequest.new(
|
|
17
|
+
name: My Platform,
|
|
18
|
+
slug: my-platform,
|
|
19
|
+
description: Webhook delivery for My Platform
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSEndpoint201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**CreateWaaSEndpointResponse**](CreateWaaSEndpointResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::CreateWaaSEndpoint201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSEndpointRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **tenant_id** | **String** | Your customer's identifier | |
|
|
8
|
+
| **url** | **String** | Webhook endpoint URL | |
|
|
9
|
+
| **events** | **Array<String>** | Event types to subscribe to | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::CreateWaaSEndpointRequest.new(
|
|
17
|
+
tenant_id: tenant_abc,
|
|
18
|
+
url: https://customer.example.com/webhooks,
|
|
19
|
+
events: ["order.created","order.updated"]
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSEndpointResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **tenant_id** | **String** | | [optional] |
|
|
9
|
+
| **url** | **String** | | [optional] |
|
|
10
|
+
| **events** | **Array<String>** | | [optional] |
|
|
11
|
+
| **secret** | **String** | HMAC signing secret (only returned on creation) | [optional] |
|
|
12
|
+
| **status** | **String** | | [optional] |
|
|
13
|
+
| **created_at** | **Time** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zyphr'
|
|
19
|
+
|
|
20
|
+
instance = Zyphr::CreateWaaSEndpointResponse.new(
|
|
21
|
+
id: null,
|
|
22
|
+
tenant_id: null,
|
|
23
|
+
url: null,
|
|
24
|
+
events: null,
|
|
25
|
+
secret: null,
|
|
26
|
+
status: null,
|
|
27
|
+
created_at: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSEventType201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSEventType**](WaaSEventType.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::CreateWaaSEventType201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zyphr::CreateWaaSEventTypeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | Dot-notation event identifier | |
|
|
8
|
+
| **name** | **String** | Human-readable name | |
|
|
9
|
+
| **description** | **String** | | [optional] |
|
|
10
|
+
| **category** | **String** | | [optional] |
|
|
11
|
+
| **example_payload** | **Object** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zyphr'
|
|
17
|
+
|
|
18
|
+
instance = Zyphr::CreateWaaSEventTypeRequest.new(
|
|
19
|
+
event_type: order.created,
|
|
20
|
+
name: Order Created,
|
|
21
|
+
description: null,
|
|
22
|
+
category: orders,
|
|
23
|
+
example_payload: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::GenerateWaaSPortalToken201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSPortalTokenResponse**](WaaSPortalTokenResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::GenerateWaaSPortalToken201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::GetWaaSEndpoint200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSEndpoint**](WaaSEndpoint.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::GetWaaSEndpoint200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::GetWaaSUsage200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSUsageResponse**](WaaSUsageResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::GetWaaSUsage200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::ListWaaSApplications200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<WaaSApplication>**](WaaSApplication.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::ListWaaSApplications200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::ListWaaSEndpointDeliveries200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<WaaSDelivery>**](WaaSDelivery.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::ListWaaSEndpointDeliveries200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::ListWaaSEndpoints200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<WaaSEndpoint>**](WaaSEndpoint.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::ListWaaSEndpoints200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::ListWaaSEventTypes200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<WaaSEventType>**](WaaSEventType.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::ListWaaSEventTypes200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::PublishWaaSEvent201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**WaaSPublishEventResponse**](WaaSPublishEventResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::PublishWaaSEvent201Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::UpdateWaaSApplicationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **status** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::UpdateWaaSApplicationRequest.new(
|
|
17
|
+
name: null,
|
|
18
|
+
description: null,
|
|
19
|
+
status: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::UpdateWaaSEndpointRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | [optional] |
|
|
8
|
+
| **events** | **Array<String>** | | [optional] |
|
|
9
|
+
| **status** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::UpdateWaaSEndpointRequest.new(
|
|
17
|
+
url: null,
|
|
18
|
+
events: null,
|
|
19
|
+
status: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zyphr::UpdateWaaSEventTypeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **category** | **String** | | [optional] |
|
|
10
|
+
| **example_payload** | **Object** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zyphr'
|
|
16
|
+
|
|
17
|
+
instance = Zyphr::UpdateWaaSEventTypeRequest.new(
|
|
18
|
+
name: null,
|
|
19
|
+
description: null,
|
|
20
|
+
category: null,
|
|
21
|
+
example_payload: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zyphr::WaaSApplication
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **workspace_id** | **String** | | [optional] |
|
|
9
|
+
| **name** | **String** | | [optional] |
|
|
10
|
+
| **slug** | **String** | | [optional] |
|
|
11
|
+
| **description** | **String** | | [optional] |
|
|
12
|
+
| **status** | **String** | | [optional] |
|
|
13
|
+
| **created_at** | **Time** | | [optional] |
|
|
14
|
+
| **updated_at** | **Time** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zyphr'
|
|
20
|
+
|
|
21
|
+
instance = Zyphr::WaaSApplication.new(
|
|
22
|
+
id: null,
|
|
23
|
+
workspace_id: null,
|
|
24
|
+
name: My Platform,
|
|
25
|
+
slug: my-platform,
|
|
26
|
+
description: Webhook delivery for My Platform,
|
|
27
|
+
status: null,
|
|
28
|
+
created_at: null,
|
|
29
|
+
updated_at: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|