zyphr 0.1.42 → 0.1.44

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 (155) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +52 -5
  3. data/docs/ApplicationSelf.md +24 -0
  4. data/docs/ApplicationSelfResponse.md +20 -0
  5. data/docs/AuthApplicationApi.md +81 -0
  6. data/docs/AuthEmailTemplateTestRequest.md +1 -1
  7. data/docs/AuthEmailTemplatesApi.md +1 -1
  8. data/docs/AuthMethods.md +28 -0
  9. data/docs/AuthUserDirectoryApi.md +125 -42
  10. data/docs/CloseWaaSEndpointCircuit200Response.md +20 -0
  11. data/docs/CloseWaaSEndpointCircuit200ResponseData.md +18 -0
  12. data/docs/DomainsApi.md +8 -7
  13. data/docs/GetEndUserAuthMethods200Response.md +20 -0
  14. data/docs/GetEndUserById200Response.md +20 -0
  15. data/docs/GetEndUserClaims200Response.md +20 -0
  16. data/docs/GetEndUserClaims200ResponseData.md +18 -0
  17. data/docs/GetSubscriberInboxPreferences200Response.md +18 -0
  18. data/docs/GetSubscriberInboxPreferences200ResponseData.md +20 -0
  19. data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md +20 -0
  20. data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md +26 -0
  21. data/docs/GetSubscriberInboxPreferences200ResponseDataGlobal.md +18 -0
  22. data/docs/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md +22 -0
  23. data/docs/GetSubscriberNotification200Response.md +18 -0
  24. data/docs/GetSubscriberUnreadCount200Response.md +18 -0
  25. data/docs/GetWaaSDelivery200Response.md +20 -0
  26. data/docs/GetWaaSEndpointCircuit200Response.md +20 -0
  27. data/docs/GetWaaSEndpointCircuit200ResponseData.md +28 -0
  28. data/docs/GetWaaSEndpointMetrics200Response.md +20 -0
  29. data/docs/GetWaaSEndpointMetrics200ResponseData.md +22 -0
  30. data/docs/GetWaaSEndpointMetrics200ResponseDataHealth.md +20 -0
  31. data/docs/GetWaaSEndpointMetrics200ResponseDataWindowsValue.md +30 -0
  32. data/docs/InboxApi.md +72 -63
  33. data/docs/InviteEndUser200Response.md +20 -0
  34. data/docs/InviteEndUser200ResponseData.md +22 -0
  35. data/docs/ListEndUsers200Response.md +20 -0
  36. data/docs/{ListWorkflowExecutions200ResponseMeta.md → ListEndUsers200ResponseMeta.md} +2 -2
  37. data/docs/ListWorkflowExecutions200Response.md +1 -1
  38. data/docs/MarkAllSubscriberNotificationsRead200Response.md +18 -0
  39. data/docs/RotateWaaSEndpointSecret200Response.md +20 -0
  40. data/docs/RotateWaaSEndpointSecret200ResponseData.md +18 -0
  41. data/docs/SendTemplateTestEmail202Response.md +20 -0
  42. data/docs/SendTemplateTestEmail202ResponseData.md +30 -0
  43. data/docs/SendTemplateTestEmail202ResponseMeta.md +18 -0
  44. data/docs/SmsListResponse.md +1 -1
  45. data/docs/TemplatesApi.md +7 -6
  46. data/docs/UpdateSubscriberPreferences200Response.md +18 -0
  47. data/docs/UpdateSubscriberPreferences200ResponseData.md +20 -0
  48. data/docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md +24 -0
  49. data/docs/UpdateWaaSEndpoint200Response.md +20 -0
  50. data/docs/UpdateWaaSEventType200Response.md +20 -0
  51. data/docs/WaaSDeliveriesApi.md +16 -14
  52. data/docs/WaaSEndpointsApi.md +40 -35
  53. data/docs/WaaSEventTypesApi.md +16 -14
  54. data/lib/zyphr/api/auth_application_api.rb +79 -0
  55. data/lib/zyphr/api/auth_email_templates_api.rb +2 -2
  56. data/lib/zyphr/api/auth_user_directory_api.rb +105 -30
  57. data/lib/zyphr/api/domains_api.rb +7 -5
  58. data/lib/zyphr/api/inbox_api.rb +63 -45
  59. data/lib/zyphr/api/templates_api.rb +5 -5
  60. data/lib/zyphr/api/waa_s_deliveries_api.rb +14 -10
  61. data/lib/zyphr/api/waa_s_endpoints_api.rb +35 -25
  62. data/lib/zyphr/api/waa_s_event_types_api.rb +14 -10
  63. data/lib/zyphr/models/application_self.rb +342 -0
  64. data/lib/zyphr/models/application_self_response.rb +229 -0
  65. data/lib/zyphr/models/auth_email_template_test_request.rb +1 -1
  66. data/lib/zyphr/models/auth_methods.rb +376 -0
  67. data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response.rb +229 -0
  68. data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response_data.rb +261 -0
  69. data/lib/zyphr/models/get_end_user_auth_methods200_response.rb +229 -0
  70. data/lib/zyphr/models/get_end_user_by_id200_response.rb +229 -0
  71. data/lib/zyphr/models/get_end_user_claims200_response.rb +229 -0
  72. data/lib/zyphr/models/get_end_user_claims200_response_data.rb +223 -0
  73. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response.rb +220 -0
  74. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data.rb +231 -0
  75. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner.rb +231 -0
  76. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category.rb +257 -0
  77. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global.rb +222 -0
  78. data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner.rb +272 -0
  79. data/lib/zyphr/models/get_subscriber_notification200_response.rb +220 -0
  80. data/lib/zyphr/models/get_subscriber_unread_count200_response.rb +220 -0
  81. data/lib/zyphr/models/get_waa_s_delivery200_response.rb +229 -0
  82. data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response.rb +229 -0
  83. data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response_data.rb +349 -0
  84. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response.rb +229 -0
  85. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data.rb +292 -0
  86. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_health.rb +287 -0
  87. data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_windows_value.rb +308 -0
  88. data/lib/zyphr/models/invite_end_user200_response.rb +229 -0
  89. data/lib/zyphr/models/invite_end_user200_response_data.rb +240 -0
  90. data/lib/zyphr/models/list_end_users200_response.rb +231 -0
  91. data/lib/zyphr/models/{list_workflow_executions200_response_meta.rb → list_end_users200_response_meta.rb} +3 -3
  92. data/lib/zyphr/models/list_workflow_executions200_response.rb +1 -1
  93. data/lib/zyphr/models/mark_all_subscriber_notifications_read200_response.rb +220 -0
  94. data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response.rb +229 -0
  95. data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response_data.rb +238 -0
  96. data/lib/zyphr/models/send_template_test_email202_response.rb +263 -0
  97. data/lib/zyphr/models/send_template_test_email202_response_data.rb +393 -0
  98. data/lib/zyphr/models/send_template_test_email202_response_meta.rb +237 -0
  99. data/lib/zyphr/models/sms_list_response.rb +1 -1
  100. data/lib/zyphr/models/update_subscriber_preferences200_response.rb +220 -0
  101. data/lib/zyphr/models/update_subscriber_preferences200_response_data.rb +231 -0
  102. data/lib/zyphr/models/update_subscriber_preferences200_response_data_preferences_inner.rb +282 -0
  103. data/lib/zyphr/models/update_waa_s_endpoint200_response.rb +229 -0
  104. data/lib/zyphr/models/update_waa_s_event_type200_response.rb +229 -0
  105. data/lib/zyphr.rb +40 -1
  106. data/spec/api/auth_application_api_spec.rb +46 -0
  107. data/spec/api/auth_email_templates_api_spec.rb +1 -1
  108. data/spec/api/auth_user_directory_api_spec.rb +18 -6
  109. data/spec/api/domains_api_spec.rb +1 -1
  110. data/spec/api/inbox_api_spec.rb +9 -9
  111. data/spec/api/templates_api_spec.rb +1 -1
  112. data/spec/api/waa_s_deliveries_api_spec.rb +2 -2
  113. data/spec/api/waa_s_endpoints_api_spec.rb +5 -5
  114. data/spec/api/waa_s_event_types_api_spec.rb +2 -2
  115. data/spec/models/application_self_response_spec.rb +42 -0
  116. data/spec/models/application_self_spec.rb +62 -0
  117. data/spec/models/auth_methods_spec.rb +66 -0
  118. data/spec/models/close_waa_s_endpoint_circuit200_response_data_spec.rb +40 -0
  119. data/spec/models/close_waa_s_endpoint_circuit200_response_spec.rb +42 -0
  120. data/spec/models/get_end_user_auth_methods200_response_spec.rb +42 -0
  121. data/spec/models/get_end_user_by_id200_response_spec.rb +42 -0
  122. data/spec/models/get_end_user_claims200_response_data_spec.rb +36 -0
  123. data/spec/models/get_end_user_claims200_response_spec.rb +42 -0
  124. data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category_spec.rb +60 -0
  125. data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_spec.rb +42 -0
  126. data/spec/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner_spec.rb +52 -0
  127. data/spec/models/get_subscriber_inbox_preferences200_response_data_global_spec.rb +36 -0
  128. data/spec/models/get_subscriber_inbox_preferences200_response_data_spec.rb +42 -0
  129. data/spec/models/get_subscriber_inbox_preferences200_response_spec.rb +36 -0
  130. data/spec/models/get_subscriber_notification200_response_spec.rb +36 -0
  131. data/spec/models/get_subscriber_unread_count200_response_spec.rb +36 -0
  132. data/spec/models/get_waa_s_delivery200_response_spec.rb +42 -0
  133. data/spec/models/get_waa_s_endpoint_circuit200_response_data_spec.rb +70 -0
  134. data/spec/models/get_waa_s_endpoint_circuit200_response_spec.rb +42 -0
  135. data/spec/models/get_waa_s_endpoint_metrics200_response_data_health_spec.rb +46 -0
  136. data/spec/models/get_waa_s_endpoint_metrics200_response_data_spec.rb +48 -0
  137. data/spec/models/get_waa_s_endpoint_metrics200_response_data_windows_value_spec.rb +76 -0
  138. data/spec/models/get_waa_s_endpoint_metrics200_response_spec.rb +42 -0
  139. data/spec/models/invite_end_user200_response_data_spec.rb +48 -0
  140. data/spec/models/invite_end_user200_response_spec.rb +42 -0
  141. data/spec/models/{list_workflow_executions200_response_meta_spec.rb → list_end_users200_response_meta_spec.rb} +6 -6
  142. data/spec/models/list_end_users200_response_spec.rb +42 -0
  143. data/spec/models/mark_all_subscriber_notifications_read200_response_spec.rb +36 -0
  144. data/spec/models/rotate_waa_s_endpoint_secret200_response_data_spec.rb +36 -0
  145. data/spec/models/rotate_waa_s_endpoint_secret200_response_spec.rb +42 -0
  146. data/spec/models/send_template_test_email202_response_data_spec.rb +72 -0
  147. data/spec/models/send_template_test_email202_response_meta_spec.rb +36 -0
  148. data/spec/models/send_template_test_email202_response_spec.rb +42 -0
  149. data/spec/models/update_subscriber_preferences200_response_data_preferences_inner_spec.rb +58 -0
  150. data/spec/models/update_subscriber_preferences200_response_data_spec.rb +42 -0
  151. data/spec/models/update_subscriber_preferences200_response_spec.rb +36 -0
  152. data/spec/models/update_waa_s_endpoint200_response_spec.rb +42 -0
  153. data/spec/models/update_waa_s_event_type200_response_spec.rb +42 -0
  154. data/zyphr.gemspec +1 -1
  155. metadata +162 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6cb0a8537c63656fd45e496b199c8cb2250befd736dda868cea8b281aedf9166
4
- data.tar.gz: ac3965efb59990ba1c3ea00e71c34c58b734dad43bcccc018d0c1940be4b340c
3
+ metadata.gz: bdb232c25df3ba83aad2f1e205941038b186be722997d3f4a0b9a4d4866c5fec
4
+ data.tar.gz: c5e28ca2a16b510deca00ff1f99d769f273363bdde11c34afcd8617df54860e4
5
5
  SHA512:
6
- metadata.gz: fed4fac9fadfcce07fd077131fab2c7dc95ec623d974157c4bef8c387e3b4629ba3355155c0013637c18b5101c059735f946b22f9ae9902303304420c0835d2d
7
- data.tar.gz: 3a5684aff5a94c217b225f1a73113d58f2b777fcf7a9cce393729befc7b855f695b3cdcdcf74abbc1d49e1daaade748b171de886449062efda7e4a97610ee6fe
6
+ metadata.gz: 187ff2bea23ac4b9bd35b5c999a63f25a14e659924d5382d57062fae4a0d20ebb8a64eca421ceb1b517ef17ff855f8465ee9e9a8f64c962af4088f975df3dcd9
7
+ data.tar.gz: 54e87dc5d28157446a0feb49196231cf49789db4f2f87982fc2cffde9d2efced47d662e42bd4fa5610f28c64ff19d73900cf65c69b4eaa6fdcbaffab66d6e8f4
data/README.md CHANGED
@@ -104,6 +104,13 @@ require 'zyphr'
104
104
 
105
105
  # Setup authorization
106
106
  Zyphr.configure do |config|
107
+ # Configure API key authorization: ApplicationSecret
108
+ config.api_key['X-Application-Secret'] = 'YOUR API KEY'
109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
110
+ # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
111
+ # Configure faraday connection
112
+ config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
113
+
107
114
  # Configure API key authorization: ApplicationPublicKey
108
115
  config.api_key['X-Application-Key'] = 'YOUR API KEY'
109
116
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -112,14 +119,14 @@ Zyphr.configure do |config|
112
119
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
113
120
  end
114
121
 
115
- api_instance = Zyphr::AuthEmailOTPApi.new
122
+ api_instance = Zyphr::AuthApplicationApi.new
116
123
 
117
124
  begin
118
- #Check email OTP availability
119
- result = api_instance.check_email_otp_availability
125
+ #Get the authenticating application
126
+ result = api_instance.get_self_application
120
127
  p result
121
128
  rescue Zyphr::ApiError => e
122
- puts "Exception when calling AuthEmailOTPApi->check_email_otp_availability: #{e}"
129
+ puts "Exception when calling AuthApplicationApi->get_self_application: #{e}"
123
130
  end
124
131
 
125
132
  ```
@@ -130,6 +137,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
130
137
 
131
138
  Class | Method | HTTP request | Description
132
139
  ------------ | ------------- | ------------- | -------------
140
+ *Zyphr::AuthApplicationApi* | [**get_self_application**](docs/AuthApplicationApi.md#get_self_application) | **GET** /auth/application | Get the authenticating application
133
141
  *Zyphr::AuthEmailOTPApi* | [**check_email_otp_availability**](docs/AuthEmailOTPApi.md#check_email_otp_availability) | **GET** /auth/email-otp/available | Check email OTP availability
134
142
  *Zyphr::AuthEmailOTPApi* | [**send_email_otp_login**](docs/AuthEmailOTPApi.md#send_email_otp_login) | **POST** /auth/email-otp/login/send | Send email OTP for login
135
143
  *Zyphr::AuthEmailOTPApi* | [**send_email_otp_registration**](docs/AuthEmailOTPApi.md#send_email_otp_registration) | **POST** /auth/email-otp/register/send | Send email OTP for registration
@@ -195,6 +203,7 @@ Class | Method | HTTP request | Description
195
203
  *Zyphr::AuthSessionsApi* | [**revoke_all_end_user_sessions**](docs/AuthSessionsApi.md#revoke_all_end_user_sessions) | **POST** /auth/sessions/revoke-all | Revoke all sessions
196
204
  *Zyphr::AuthSessionsApi* | [**revoke_end_user_session**](docs/AuthSessionsApi.md#revoke_end_user_session) | **POST** /auth/sessions/revoke | Revoke a session
197
205
  *Zyphr::AuthUserDirectoryApi* | [**delete_end_user_by_application**](docs/AuthUserDirectoryApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (server-side admin)
206
+ *Zyphr::AuthUserDirectoryApi* | [**get_end_user_auth_methods**](docs/AuthUserDirectoryApi.md#get_end_user_auth_methods) | **GET** /auth/users/{user_id}/auth-methods | Get an end user's sign-in methods (server-side admin)
198
207
  *Zyphr::AuthUserDirectoryApi* | [**get_end_user_by_email**](docs/AuthUserDirectoryApi.md#get_end_user_by_email) | **GET** /auth/users/by-email | Look up an end user by email (server-side admin)
199
208
  *Zyphr::AuthUserDirectoryApi* | [**get_end_user_by_id**](docs/AuthUserDirectoryApi.md#get_end_user_by_id) | **GET** /auth/users/{user_id} | Get an end user by id (server-side admin)
200
209
  *Zyphr::AuthUserDirectoryApi* | [**get_end_user_claims**](docs/AuthUserDirectoryApi.md#get_end_user_claims) | **GET** /auth/users/{user_id}/claims | Get an end user's stored custom claims (server-side admin)
@@ -393,6 +402,8 @@ Class | Method | HTTP request | Description
393
402
  - [Zyphr::ApiError](docs/ApiError.md)
394
403
  - [Zyphr::ApiErrorError](docs/ApiErrorError.md)
395
404
  - [Zyphr::ApiErrorMeta](docs/ApiErrorMeta.md)
405
+ - [Zyphr::ApplicationSelf](docs/ApplicationSelf.md)
406
+ - [Zyphr::ApplicationSelfResponse](docs/ApplicationSelfResponse.md)
396
407
  - [Zyphr::AuthEmailTemplate](docs/AuthEmailTemplate.md)
397
408
  - [Zyphr::AuthEmailTemplateDefault](docs/AuthEmailTemplateDefault.md)
398
409
  - [Zyphr::AuthEmailTemplateDefaultResponse](docs/AuthEmailTemplateDefaultResponse.md)
@@ -413,6 +424,7 @@ Class | Method | HTTP request | Description
413
424
  - [Zyphr::AuthLoginResponse](docs/AuthLoginResponse.md)
414
425
  - [Zyphr::AuthLoginResult](docs/AuthLoginResult.md)
415
426
  - [Zyphr::AuthLoginResultMfaChallenge](docs/AuthLoginResultMfaChallenge.md)
427
+ - [Zyphr::AuthMethods](docs/AuthMethods.md)
416
428
  - [Zyphr::AuthResult](docs/AuthResult.md)
417
429
  - [Zyphr::AuthResultResponse](docs/AuthResultResponse.md)
418
430
  - [Zyphr::AuthSession](docs/AuthSession.md)
@@ -428,6 +440,8 @@ Class | Method | HTTP request | Description
428
440
  - [Zyphr::Category](docs/Category.md)
429
441
  - [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
430
442
  - [Zyphr::CategoryResponse](docs/CategoryResponse.md)
443
+ - [Zyphr::CloseWaaSEndpointCircuit200Response](docs/CloseWaaSEndpointCircuit200Response.md)
444
+ - [Zyphr::CloseWaaSEndpointCircuit200ResponseData](docs/CloseWaaSEndpointCircuit200ResponseData.md)
431
445
  - [Zyphr::ConfirmEmailVerificationRequest](docs/ConfirmEmailVerificationRequest.md)
432
446
  - [Zyphr::ConfirmEmailVerificationResponse](docs/ConfirmEmailVerificationResponse.md)
433
447
  - [Zyphr::ConfirmEmailVerificationResponseData](docs/ConfirmEmailVerificationResponseData.md)
@@ -504,7 +518,26 @@ Class | Method | HTTP request | Description
504
518
  - [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
505
519
  - [Zyphr::GetDomain200Response](docs/GetDomain200Response.md)
506
520
  - [Zyphr::GetDomain200ResponseMeta](docs/GetDomain200ResponseMeta.md)
521
+ - [Zyphr::GetEndUserAuthMethods200Response](docs/GetEndUserAuthMethods200Response.md)
522
+ - [Zyphr::GetEndUserById200Response](docs/GetEndUserById200Response.md)
523
+ - [Zyphr::GetEndUserClaims200Response](docs/GetEndUserClaims200Response.md)
524
+ - [Zyphr::GetEndUserClaims200ResponseData](docs/GetEndUserClaims200ResponseData.md)
525
+ - [Zyphr::GetSubscriberInboxPreferences200Response](docs/GetSubscriberInboxPreferences200Response.md)
526
+ - [Zyphr::GetSubscriberInboxPreferences200ResponseData](docs/GetSubscriberInboxPreferences200ResponseData.md)
527
+ - [Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner](docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md)
528
+ - [Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory](docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md)
529
+ - [Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobal](docs/GetSubscriberInboxPreferences200ResponseDataGlobal.md)
530
+ - [Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner](docs/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md)
531
+ - [Zyphr::GetSubscriberNotification200Response](docs/GetSubscriberNotification200Response.md)
532
+ - [Zyphr::GetSubscriberUnreadCount200Response](docs/GetSubscriberUnreadCount200Response.md)
533
+ - [Zyphr::GetWaaSDelivery200Response](docs/GetWaaSDelivery200Response.md)
507
534
  - [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
535
+ - [Zyphr::GetWaaSEndpointCircuit200Response](docs/GetWaaSEndpointCircuit200Response.md)
536
+ - [Zyphr::GetWaaSEndpointCircuit200ResponseData](docs/GetWaaSEndpointCircuit200ResponseData.md)
537
+ - [Zyphr::GetWaaSEndpointMetrics200Response](docs/GetWaaSEndpointMetrics200Response.md)
538
+ - [Zyphr::GetWaaSEndpointMetrics200ResponseData](docs/GetWaaSEndpointMetrics200ResponseData.md)
539
+ - [Zyphr::GetWaaSEndpointMetrics200ResponseDataHealth](docs/GetWaaSEndpointMetrics200ResponseDataHealth.md)
540
+ - [Zyphr::GetWaaSEndpointMetrics200ResponseDataWindowsValue](docs/GetWaaSEndpointMetrics200ResponseDataWindowsValue.md)
508
541
  - [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
509
542
  - [Zyphr::InAppNotification](docs/InAppNotification.md)
510
543
  - [Zyphr::InboundAttachmentUrlResponse](docs/InboundAttachmentUrlResponse.md)
@@ -518,13 +551,16 @@ Class | Method | HTTP request | Description
518
551
  - [Zyphr::InboxListMeta](docs/InboxListMeta.md)
519
552
  - [Zyphr::InboxListResponse](docs/InboxListResponse.md)
520
553
  - [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
554
+ - [Zyphr::InviteEndUser200Response](docs/InviteEndUser200Response.md)
555
+ - [Zyphr::InviteEndUser200ResponseData](docs/InviteEndUser200ResponseData.md)
521
556
  - [Zyphr::InviteEndUserRequest](docs/InviteEndUserRequest.md)
557
+ - [Zyphr::ListEndUsers200Response](docs/ListEndUsers200Response.md)
558
+ - [Zyphr::ListEndUsers200ResponseMeta](docs/ListEndUsers200ResponseMeta.md)
522
559
  - [Zyphr::ListWaaSApplications200Response](docs/ListWaaSApplications200Response.md)
523
560
  - [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
524
561
  - [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
525
562
  - [Zyphr::ListWaaSEventTypes200Response](docs/ListWaaSEventTypes200Response.md)
526
563
  - [Zyphr::ListWorkflowExecutions200Response](docs/ListWorkflowExecutions200Response.md)
527
- - [Zyphr::ListWorkflowExecutions200ResponseMeta](docs/ListWorkflowExecutions200ResponseMeta.md)
528
564
  - [Zyphr::ListWorkflows200Response](docs/ListWorkflows200Response.md)
529
565
  - [Zyphr::ListWorkflows200ResponseMeta](docs/ListWorkflows200ResponseMeta.md)
530
566
  - [Zyphr::LoginRequest](docs/LoginRequest.md)
@@ -535,6 +571,7 @@ Class | Method | HTTP request | Description
535
571
  - [Zyphr::MarkAllInboxReadRequest](docs/MarkAllInboxReadRequest.md)
536
572
  - [Zyphr::MarkAllReadData](docs/MarkAllReadData.md)
537
573
  - [Zyphr::MarkAllReadResponse](docs/MarkAllReadResponse.md)
574
+ - [Zyphr::MarkAllSubscriberNotificationsRead200Response](docs/MarkAllSubscriberNotificationsRead200Response.md)
538
575
  - [Zyphr::MarkAllSubscriberNotificationsReadRequest](docs/MarkAllSubscriberNotificationsReadRequest.md)
539
576
  - [Zyphr::MarkInboxReadRequest](docs/MarkInboxReadRequest.md)
540
577
  - [Zyphr::MfaBackupCodesResponse](docs/MfaBackupCodesResponse.md)
@@ -631,6 +668,8 @@ Class | Method | HTTP request | Description
631
668
  - [Zyphr::RevokeAllSessionsResponse](docs/RevokeAllSessionsResponse.md)
632
669
  - [Zyphr::RevokeAllSessionsResponseData](docs/RevokeAllSessionsResponseData.md)
633
670
  - [Zyphr::RevokeSessionRequest](docs/RevokeSessionRequest.md)
671
+ - [Zyphr::RotateWaaSEndpointSecret200Response](docs/RotateWaaSEndpointSecret200Response.md)
672
+ - [Zyphr::RotateWaaSEndpointSecret200ResponseData](docs/RotateWaaSEndpointSecret200ResponseData.md)
634
673
  - [Zyphr::SendBatchEmailRequest](docs/SendBatchEmailRequest.md)
635
674
  - [Zyphr::SendBatchEmailResponse](docs/SendBatchEmailResponse.md)
636
675
  - [Zyphr::SendBatchEmailResult](docs/SendBatchEmailResult.md)
@@ -663,6 +702,9 @@ Class | Method | HTTP request | Description
663
702
  - [Zyphr::SendSmsData](docs/SendSmsData.md)
664
703
  - [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
665
704
  - [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
705
+ - [Zyphr::SendTemplateTestEmail202Response](docs/SendTemplateTestEmail202Response.md)
706
+ - [Zyphr::SendTemplateTestEmail202ResponseData](docs/SendTemplateTestEmail202ResponseData.md)
707
+ - [Zyphr::SendTemplateTestEmail202ResponseMeta](docs/SendTemplateTestEmail202ResponseMeta.md)
666
708
  - [Zyphr::SendTemplateTestEmailRequest](docs/SendTemplateTestEmailRequest.md)
667
709
  - [Zyphr::SendTestSmsData](docs/SendTestSmsData.md)
668
710
  - [Zyphr::SendTestSmsRequest](docs/SendTestSmsRequest.md)
@@ -740,13 +782,18 @@ Class | Method | HTTP request | Description
740
782
  - [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
741
783
  - [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
742
784
  - [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
785
+ - [Zyphr::UpdateSubscriberPreferences200Response](docs/UpdateSubscriberPreferences200Response.md)
786
+ - [Zyphr::UpdateSubscriberPreferences200ResponseData](docs/UpdateSubscriberPreferences200ResponseData.md)
787
+ - [Zyphr::UpdateSubscriberPreferences200ResponseDataPreferencesInner](docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md)
743
788
  - [Zyphr::UpdateSubscriberPreferencesRequest](docs/UpdateSubscriberPreferencesRequest.md)
744
789
  - [Zyphr::UpdateSubscriberPreferencesRequestPreferencesInner](docs/UpdateSubscriberPreferencesRequestPreferencesInner.md)
745
790
  - [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
746
791
  - [Zyphr::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
747
792
  - [Zyphr::UpdateTopicRequest](docs/UpdateTopicRequest.md)
748
793
  - [Zyphr::UpdateWaaSApplicationRequest](docs/UpdateWaaSApplicationRequest.md)
794
+ - [Zyphr::UpdateWaaSEndpoint200Response](docs/UpdateWaaSEndpoint200Response.md)
749
795
  - [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
796
+ - [Zyphr::UpdateWaaSEventType200Response](docs/UpdateWaaSEventType200Response.md)
750
797
  - [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
751
798
  - [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
752
799
  - [Zyphr::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
@@ -0,0 +1,24 @@
1
+ # Zyphr::ApplicationSelf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The application's unique id (application_id). | |
8
+ | **name** | **String** | Human-readable application name. | |
9
+ | **environment** | **String** | The environment mode of the credentials used to authenticate this request. `null` when the environment cannot be determined (e.g. a legacy application-level key that predates environment-scoped keys) — not defaulted to a guessed value. | |
10
+ | **signing_algorithm** | **String** | JWT signing algorithm for this application's end-user tokens. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::ApplicationSelf.new(
18
+ id: null,
19
+ name: null,
20
+ environment: null,
21
+ signing_algorithm: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::ApplicationSelfResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**ApplicationSelf**](ApplicationSelf.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::ApplicationSelfResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,81 @@
1
+ # Zyphr::AuthApplicationApi
2
+
3
+ All URIs are relative to *https://api.zyphr.dev/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_self_application**](AuthApplicationApi.md#get_self_application) | **GET** /auth/application | Get the authenticating application |
8
+
9
+
10
+ ## get_self_application
11
+
12
+ > <ApplicationSelfResponse> get_self_application
13
+
14
+ Get the authenticating application
15
+
16
+ Return non-sensitive metadata about the application whose credentials authenticated this request. Lets an integrator read their own application_id (the sole tenant discriminator embedded in every end-user token) directly from the API, rather than only from the dashboard UI or by decoding a token. Returns only id, name, the calling environment's mode, and the JWT signing algorithm — never secrets, signing keys, or account-internal fields.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'zyphr'
23
+ # setup authorization
24
+ Zyphr.configure do |config|
25
+ # Configure API key authorization: ApplicationSecret
26
+ config.api_key['X-Application-Secret'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
29
+
30
+ # Configure API key authorization: ApplicationPublicKey
31
+ config.api_key['X-Application-Key'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ # config.api_key_prefix['X-Application-Key'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = Zyphr::AuthApplicationApi.new
37
+
38
+ begin
39
+ # Get the authenticating application
40
+ result = api_instance.get_self_application
41
+ p result
42
+ rescue Zyphr::ApiError => e
43
+ puts "Error when calling AuthApplicationApi->get_self_application: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the get_self_application_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<ApplicationSelfResponse>, Integer, Hash)> get_self_application_with_http_info
52
+
53
+ ```ruby
54
+ begin
55
+ # Get the authenticating application
56
+ data, status_code, headers = api_instance.get_self_application_with_http_info
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <ApplicationSelfResponse>
60
+ rescue Zyphr::ApiError => e
61
+ puts "Error when calling AuthApplicationApi->get_self_application_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ This endpoint does not need any parameter.
68
+
69
+ ### Return type
70
+
71
+ [**ApplicationSelfResponse**](ApplicationSelfResponse.md)
72
+
73
+ ### Authorization
74
+
75
+ [ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **to** | **String** | Recipient email. Must be in the application&#39;s &#x60;test_recipients&#x60; allowlist. | |
7
+ | **to** | **String** | Recipient email. Must be in the application&#39;s &#x60;test_recipients&#x60; allowlist. When non-empty, &#x60;test_recipients&#x60; gates ALL auth emails the application sends (magic link, password reset, verification, OTP) — only listed recipients receive auth email — which keeps non-production applications safe from mass sends. An empty allowlist imposes no restriction. | |
8
8
  | **variables** | **Hash&lt;String, Object&gt;** | | [optional] |
9
9
 
10
10
  ## Example
@@ -631,7 +631,7 @@ end
631
631
 
632
632
  Send a test render of a template
633
633
 
634
- Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited.
634
+ Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited. When non-empty, `test_recipients` gates ALL auth emails this application sends (magic link, password reset, email verification, and email OTP) — not just these test renders. Only listed recipients receive auth email; any other recipient is silently blocked. Use it to make a non-production application safe from mass sends. An empty allowlist (the default) imposes no restriction and every recipient receives auth email normally.
635
635
 
636
636
  ### Examples
637
637
 
@@ -0,0 +1,28 @@
1
+ # Zyphr::AuthMethods
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **has_password** | **Boolean** | True if the user has a password credential (false for OAuth-only / passwordless users). | |
8
+ | **oauth_providers** | **Array&lt;String&gt;** | Distinct OAuth providers linked to the user (e.g. google, apple). | |
9
+ | **mfa_enabled** | **Boolean** | True if the user has multi-factor authentication enabled. | |
10
+ | **email_verified** | **Boolean** | True if the user&#39;s email address has been verified. | |
11
+ | **phone_verified** | **Boolean** | True if the user&#39;s phone number has been verified. | |
12
+ | **passkeys** | **Integer** | Number of WebAuthn passkeys registered for the user. | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zyphr'
18
+
19
+ instance = Zyphr::AuthMethods.new(
20
+ has_password: null,
21
+ oauth_providers: null,
22
+ mfa_enabled: null,
23
+ email_verified: null,
24
+ phone_verified: null,
25
+ passkeys: null
26
+ )
27
+ ```
28
+