zyphr 0.1.41 → 0.1.43

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.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -1
  3. data/docs/AuthUserDirectoryApi.md +57 -50
  4. data/docs/CloseWaaSEndpointCircuit200Response.md +20 -0
  5. data/docs/CloseWaaSEndpointCircuit200ResponseData.md +18 -0
  6. data/docs/DomainsApi.md +8 -7
  7. data/docs/GetEndUserById200Response.md +20 -0
  8. data/docs/GetEndUserClaims200Response.md +20 -0
  9. data/docs/GetEndUserClaims200ResponseData.md +18 -0
  10. data/docs/GetSubscriberInboxPreferences200Response.md +18 -0
  11. data/docs/GetSubscriberInboxPreferences200ResponseData.md +20 -0
  12. data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md +20 -0
  13. data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md +26 -0
  14. data/docs/GetSubscriberInboxPreferences200ResponseDataGlobal.md +18 -0
  15. data/docs/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md +22 -0
  16. data/docs/GetSubscriberNotification200Response.md +18 -0
  17. data/docs/GetSubscriberUnreadCount200Response.md +18 -0
  18. data/docs/GetWaaSDelivery200Response.md +20 -0
  19. data/docs/GetWaaSEndpointCircuit200Response.md +20 -0
  20. data/docs/GetWaaSEndpointCircuit200ResponseData.md +28 -0
  21. data/docs/GetWaaSEndpointMetrics200Response.md +20 -0
  22. data/docs/GetWaaSEndpointMetrics200ResponseData.md +22 -0
  23. data/docs/GetWaaSEndpointMetrics200ResponseDataHealth.md +20 -0
  24. data/docs/GetWaaSEndpointMetrics200ResponseDataWindowsValue.md +30 -0
  25. data/docs/InboxApi.md +73 -64
  26. data/docs/InviteEndUser200Response.md +20 -0
  27. data/docs/InviteEndUser200ResponseData.md +22 -0
  28. data/docs/ListEndUsers200Response.md +20 -0
  29. data/docs/{ListWorkflowExecutions200ResponseMeta.md → ListEndUsers200ResponseMeta.md} +2 -2
  30. data/docs/ListWorkflowExecutions200Response.md +1 -1
  31. data/docs/MarkAllSubscriberNotificationsRead200Response.md +18 -0
  32. data/docs/RotateWaaSEndpointSecret200Response.md +20 -0
  33. data/docs/RotateWaaSEndpointSecret200ResponseData.md +18 -0
  34. data/docs/SendTemplateTestEmail202Response.md +20 -0
  35. data/docs/SendTemplateTestEmail202ResponseData.md +30 -0
  36. data/docs/SendTemplateTestEmail202ResponseMeta.md +18 -0
  37. data/docs/SetEndUserClaims200Response.md +18 -0
  38. data/docs/SetEndUserClaims200ResponseData.md +20 -0
  39. data/docs/SmsListResponse.md +1 -1
  40. data/docs/TemplatesApi.md +7 -6
  41. data/docs/UpdateSubscriberPreferences200Response.md +18 -0
  42. data/docs/UpdateSubscriberPreferences200ResponseData.md +20 -0
  43. data/docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md +24 -0
  44. data/docs/UpdateWaaSEndpoint200Response.md +20 -0
  45. data/docs/UpdateWaaSEventType200Response.md +20 -0
  46. data/docs/WaaSDeliveriesApi.md +16 -14
  47. data/docs/WaaSEndpointsApi.md +40 -35
  48. data/docs/WaaSEventTypesApi.md +16 -14
  49. data/lib/zyphr/api/auth_user_directory_api.rb +51 -37
  50. data/lib/zyphr/api/domains_api.rb +7 -5
  51. data/lib/zyphr/api/inbox_api.rb +65 -47
  52. data/lib/zyphr/api/templates_api.rb +5 -5
  53. data/lib/zyphr/api/waa_s_deliveries_api.rb +14 -10
  54. data/lib/zyphr/api/waa_s_endpoints_api.rb +35 -25
  55. data/lib/zyphr/api/waa_s_event_types_api.rb +14 -10
  56. data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response.rb +229 -0
  57. data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response_data.rb +261 -0
  58. data/lib/zyphr/models/get_end_user_by_id200_response.rb +229 -0
  59. data/lib/zyphr/models/get_end_user_claims200_response.rb +229 -0
  60. data/lib/zyphr/models/get_end_user_claims200_response_data.rb +223 -0
  61. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response.rb +220 -0
  62. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data.rb +231 -0
  63. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner.rb +231 -0
  64. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category.rb +257 -0
  65. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global.rb +222 -0
  66. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner.rb +272 -0
  67. data/lib/zyphr/models/get_subscriber_notification200_response.rb +220 -0
  68. data/lib/zyphr/models/get_subscriber_unread_count200_response.rb +220 -0
  69. data/lib/zyphr/models/get_waa_s_delivery200_response.rb +229 -0
  70. data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response.rb +229 -0
  71. data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response_data.rb +349 -0
  72. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response.rb +229 -0
  73. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data.rb +292 -0
  74. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_health.rb +287 -0
  75. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_windows_value.rb +308 -0
  76. data/lib/zyphr/models/invite_end_user200_response.rb +229 -0
  77. data/lib/zyphr/models/invite_end_user200_response_data.rb +240 -0
  78. data/lib/zyphr/models/list_end_users200_response.rb +231 -0
  79. data/lib/zyphr/models/{list_workflow_executions200_response_meta.rb → list_end_users200_response_meta.rb} +3 -3
  80. data/lib/zyphr/models/list_workflow_executions200_response.rb +1 -1
  81. data/lib/zyphr/models/mark_all_subscriber_notifications_read200_response.rb +220 -0
  82. data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response.rb +229 -0
  83. data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response_data.rb +238 -0
  84. data/lib/zyphr/models/send_template_test_email202_response.rb +263 -0
  85. data/lib/zyphr/models/send_template_test_email202_response_data.rb +393 -0
  86. data/lib/zyphr/models/send_template_test_email202_response_meta.rb +237 -0
  87. data/lib/zyphr/models/set_end_user_claims200_response.rb +220 -0
  88. data/lib/zyphr/models/set_end_user_claims200_response_data.rb +230 -0
  89. data/lib/zyphr/models/sms_list_response.rb +1 -1
  90. data/lib/zyphr/models/update_subscriber_preferences200_response.rb +220 -0
  91. data/lib/zyphr/models/update_subscriber_preferences200_response_data.rb +231 -0
  92. data/lib/zyphr/models/update_subscriber_preferences200_response_data_preferences_inner.rb +282 -0
  93. data/lib/zyphr/models/update_waa_s_endpoint200_response.rb +229 -0
  94. data/lib/zyphr/models/update_waa_s_event_type200_response.rb +229 -0
  95. data/lib/zyphr.rb +37 -1
  96. data/spec/api/auth_user_directory_api_spec.rb +8 -8
  97. data/spec/api/domains_api_spec.rb +1 -1
  98. data/spec/api/inbox_api_spec.rb +10 -10
  99. data/spec/api/templates_api_spec.rb +1 -1
  100. data/spec/api/waa_s_deliveries_api_spec.rb +2 -2
  101. data/spec/api/waa_s_endpoints_api_spec.rb +5 -5
  102. data/spec/api/waa_s_event_types_api_spec.rb +2 -2
  103. data/spec/models/close_waa_s_endpoint_circuit200_response_data_spec.rb +40 -0
  104. data/spec/models/close_waa_s_endpoint_circuit200_response_spec.rb +42 -0
  105. data/spec/models/get_end_user_by_id200_response_spec.rb +42 -0
  106. data/spec/models/get_end_user_claims200_response_data_spec.rb +36 -0
  107. data/spec/models/get_end_user_claims200_response_spec.rb +42 -0
  108. data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category_spec.rb +60 -0
  109. data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_spec.rb +42 -0
  110. data/spec/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner_spec.rb +52 -0
  111. data/spec/models/get_subscriber_inbox_preferences200_response_data_global_spec.rb +36 -0
  112. data/spec/models/get_subscriber_inbox_preferences200_response_data_spec.rb +42 -0
  113. data/spec/models/get_subscriber_inbox_preferences200_response_spec.rb +36 -0
  114. data/spec/models/get_subscriber_notification200_response_spec.rb +36 -0
  115. data/spec/models/get_subscriber_unread_count200_response_spec.rb +36 -0
  116. data/spec/models/get_waa_s_delivery200_response_spec.rb +42 -0
  117. data/spec/models/get_waa_s_endpoint_circuit200_response_data_spec.rb +70 -0
  118. data/spec/models/get_waa_s_endpoint_circuit200_response_spec.rb +42 -0
  119. data/spec/models/get_waa_s_endpoint_metrics200_response_data_health_spec.rb +46 -0
  120. data/spec/models/get_waa_s_endpoint_metrics200_response_data_spec.rb +48 -0
  121. data/spec/models/get_waa_s_endpoint_metrics200_response_data_windows_value_spec.rb +76 -0
  122. data/spec/models/get_waa_s_endpoint_metrics200_response_spec.rb +42 -0
  123. data/spec/models/invite_end_user200_response_data_spec.rb +48 -0
  124. data/spec/models/invite_end_user200_response_spec.rb +42 -0
  125. data/spec/models/{list_workflow_executions200_response_meta_spec.rb → list_end_users200_response_meta_spec.rb} +6 -6
  126. data/spec/models/list_end_users200_response_spec.rb +42 -0
  127. data/spec/models/mark_all_subscriber_notifications_read200_response_spec.rb +36 -0
  128. data/spec/models/rotate_waa_s_endpoint_secret200_response_data_spec.rb +36 -0
  129. data/spec/models/rotate_waa_s_endpoint_secret200_response_spec.rb +42 -0
  130. data/spec/models/send_template_test_email202_response_data_spec.rb +72 -0
  131. data/spec/models/send_template_test_email202_response_meta_spec.rb +36 -0
  132. data/spec/models/send_template_test_email202_response_spec.rb +42 -0
  133. data/spec/models/set_end_user_claims200_response_data_spec.rb +42 -0
  134. data/spec/models/set_end_user_claims200_response_spec.rb +36 -0
  135. data/spec/models/update_subscriber_preferences200_response_data_preferences_inner_spec.rb +58 -0
  136. data/spec/models/update_subscriber_preferences200_response_data_spec.rb +42 -0
  137. data/spec/models/update_subscriber_preferences200_response_spec.rb +36 -0
  138. data/spec/models/update_waa_s_endpoint200_response_spec.rb +42 -0
  139. data/spec/models/update_waa_s_event_type200_response_spec.rb +42 -0
  140. data/zyphr.gemspec +1 -1
  141. metadata +150 -6
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetSubscriberInboxPreferences200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **global** | [**GetSubscriberInboxPreferences200ResponseDataGlobal**](GetSubscriberInboxPreferences200ResponseDataGlobal.md) | | [optional] |
8
+ | **categories** | [**Array<GetSubscriberInboxPreferences200ResponseDataCategoriesInner>**](GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetSubscriberInboxPreferences200ResponseData.new(
16
+ global: null,
17
+ categories: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category** | [**GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory**](GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md) | | [optional] |
8
+ | **channels** | [**Array<GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner>**](GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner.new(
16
+ category: null,
17
+ channels: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+ | **slug** | **String** | | [optional] |
10
+ | **description** | **String** | | [optional] |
11
+ | **allow_unsubscribe** | **Boolean** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zyphr'
17
+
18
+ instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.new(
19
+ id: null,
20
+ name: null,
21
+ slug: null,
22
+ description: null,
23
+ allow_unsubscribe: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobal
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **channels** | [**Array<GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner>**](GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobal.new(
15
+ channels: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **channel** | **String** | | [optional] |
8
+ | **enabled** | **Boolean** | | [optional] |
9
+ | **source** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zyphr'
15
+
16
+ instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.new(
17
+ channel: null,
18
+ enabled: null,
19
+ source: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # Zyphr::GetSubscriberNotification200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**InAppNotification**](InAppNotification.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::GetSubscriberNotification200Response.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # Zyphr::GetSubscriberUnreadCount200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**UnreadCountData**](UnreadCountData.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::GetSubscriberUnreadCount200Response.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetWaaSDelivery200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**WaaSDelivery**](WaaSDelivery.md) | | [optional] |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetWaaSDelivery200Response.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetWaaSEndpointCircuit200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**GetWaaSEndpointCircuit200ResponseData**](GetWaaSEndpointCircuit200ResponseData.md) | | [optional] |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetWaaSEndpointCircuit200Response.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # Zyphr::GetWaaSEndpointCircuit200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **state** | **String** | | |
8
+ | **failures** | **Integer** | | |
9
+ | **last_failure_at** | **Time** | | |
10
+ | **opened_at** | **Time** | | |
11
+ | **next_test_at** | **Time** | | |
12
+ | **recovery_attempts** | **Integer** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zyphr'
18
+
19
+ instance = Zyphr::GetWaaSEndpointCircuit200ResponseData.new(
20
+ state: null,
21
+ failures: null,
22
+ last_failure_at: null,
23
+ opened_at: null,
24
+ next_test_at: null,
25
+ recovery_attempts: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetWaaSEndpointMetrics200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**GetWaaSEndpointMetrics200ResponseData**](GetWaaSEndpointMetrics200ResponseData.md) | | [optional] |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetWaaSEndpointMetrics200Response.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # Zyphr::GetWaaSEndpointMetrics200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **webhook_id** | **String** | | |
8
+ | **health** | [**GetWaaSEndpointMetrics200ResponseDataHealth**](GetWaaSEndpointMetrics200ResponseDataHealth.md) | | |
9
+ | **windows** | [**Hash<String, GetWaaSEndpointMetrics200ResponseDataWindowsValue>**](GetWaaSEndpointMetrics200ResponseDataWindowsValue.md) | Per-window delivery metrics (1h / 24h / 7d / 30d). Each window has the same shape. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zyphr'
15
+
16
+ instance = Zyphr::GetWaaSEndpointMetrics200ResponseData.new(
17
+ webhook_id: null,
18
+ health: null,
19
+ windows: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::GetWaaSEndpointMetrics200ResponseDataHealth
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **score** | **Integer** | | |
8
+ | **status** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GetWaaSEndpointMetrics200ResponseDataHealth.new(
16
+ score: null,
17
+ status: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # Zyphr::GetWaaSEndpointMetrics200ResponseDataWindowsValue
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **window** | **String** | | [optional] |
8
+ | **total** | **Integer** | | [optional] |
9
+ | **successes** | **Integer** | | [optional] |
10
+ | **failures** | **Integer** | | [optional] |
11
+ | **success_rate** | **Float** | | [optional] |
12
+ | **avg_latency_ms** | **Integer** | | [optional] |
13
+ | **p95_latency_ms** | **Integer** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zyphr'
19
+
20
+ instance = Zyphr::GetWaaSEndpointMetrics200ResponseDataWindowsValue.new(
21
+ window: null,
22
+ total: null,
23
+ successes: null,
24
+ failures: null,
25
+ success_rate: null,
26
+ avg_latency_ms: null,
27
+ p95_latency_ms: null
28
+ )
29
+ ```
30
+