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.
- checksums.yaml +4 -4
- data/README.md +37 -1
- data/docs/AuthUserDirectoryApi.md +57 -50
- data/docs/CloseWaaSEndpointCircuit200Response.md +20 -0
- data/docs/CloseWaaSEndpointCircuit200ResponseData.md +18 -0
- data/docs/DomainsApi.md +8 -7
- data/docs/GetEndUserById200Response.md +20 -0
- data/docs/GetEndUserClaims200Response.md +20 -0
- data/docs/GetEndUserClaims200ResponseData.md +18 -0
- data/docs/GetSubscriberInboxPreferences200Response.md +18 -0
- data/docs/GetSubscriberInboxPreferences200ResponseData.md +20 -0
- data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md +20 -0
- data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md +26 -0
- data/docs/GetSubscriberInboxPreferences200ResponseDataGlobal.md +18 -0
- data/docs/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md +22 -0
- data/docs/GetSubscriberNotification200Response.md +18 -0
- data/docs/GetSubscriberUnreadCount200Response.md +18 -0
- data/docs/GetWaaSDelivery200Response.md +20 -0
- data/docs/GetWaaSEndpointCircuit200Response.md +20 -0
- data/docs/GetWaaSEndpointCircuit200ResponseData.md +28 -0
- data/docs/GetWaaSEndpointMetrics200Response.md +20 -0
- data/docs/GetWaaSEndpointMetrics200ResponseData.md +22 -0
- data/docs/GetWaaSEndpointMetrics200ResponseDataHealth.md +20 -0
- data/docs/GetWaaSEndpointMetrics200ResponseDataWindowsValue.md +30 -0
- data/docs/InboxApi.md +73 -64
- data/docs/InviteEndUser200Response.md +20 -0
- data/docs/InviteEndUser200ResponseData.md +22 -0
- data/docs/ListEndUsers200Response.md +20 -0
- data/docs/{ListWorkflowExecutions200ResponseMeta.md → ListEndUsers200ResponseMeta.md} +2 -2
- data/docs/ListWorkflowExecutions200Response.md +1 -1
- data/docs/MarkAllSubscriberNotificationsRead200Response.md +18 -0
- data/docs/RotateWaaSEndpointSecret200Response.md +20 -0
- data/docs/RotateWaaSEndpointSecret200ResponseData.md +18 -0
- data/docs/SendTemplateTestEmail202Response.md +20 -0
- data/docs/SendTemplateTestEmail202ResponseData.md +30 -0
- data/docs/SendTemplateTestEmail202ResponseMeta.md +18 -0
- data/docs/SetEndUserClaims200Response.md +18 -0
- data/docs/SetEndUserClaims200ResponseData.md +20 -0
- data/docs/SmsListResponse.md +1 -1
- data/docs/TemplatesApi.md +7 -6
- data/docs/UpdateSubscriberPreferences200Response.md +18 -0
- data/docs/UpdateSubscriberPreferences200ResponseData.md +20 -0
- data/docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md +24 -0
- data/docs/UpdateWaaSEndpoint200Response.md +20 -0
- data/docs/UpdateWaaSEventType200Response.md +20 -0
- data/docs/WaaSDeliveriesApi.md +16 -14
- data/docs/WaaSEndpointsApi.md +40 -35
- data/docs/WaaSEventTypesApi.md +16 -14
- data/lib/zyphr/api/auth_user_directory_api.rb +51 -37
- data/lib/zyphr/api/domains_api.rb +7 -5
- data/lib/zyphr/api/inbox_api.rb +65 -47
- data/lib/zyphr/api/templates_api.rb +5 -5
- data/lib/zyphr/api/waa_s_deliveries_api.rb +14 -10
- data/lib/zyphr/api/waa_s_endpoints_api.rb +35 -25
- data/lib/zyphr/api/waa_s_event_types_api.rb +14 -10
- data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response.rb +229 -0
- data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response_data.rb +261 -0
- data/lib/zyphr/models/get_end_user_by_id200_response.rb +229 -0
- data/lib/zyphr/models/get_end_user_claims200_response.rb +229 -0
- data/lib/zyphr/models/get_end_user_claims200_response_data.rb +223 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response.rb +220 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data.rb +231 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner.rb +231 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category.rb +257 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global.rb +222 -0
- data/lib/zyphr/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner.rb +272 -0
- data/lib/zyphr/models/get_subscriber_notification200_response.rb +220 -0
- data/lib/zyphr/models/get_subscriber_unread_count200_response.rb +220 -0
- data/lib/zyphr/models/get_waa_s_delivery200_response.rb +229 -0
- data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response.rb +229 -0
- data/lib/zyphr/models/get_waa_s_endpoint_circuit200_response_data.rb +349 -0
- data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response.rb +229 -0
- data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data.rb +292 -0
- data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_health.rb +287 -0
- data/lib/zyphr/models/get_waa_s_endpoint_metrics200_response_data_windows_value.rb +308 -0
- data/lib/zyphr/models/invite_end_user200_response.rb +229 -0
- data/lib/zyphr/models/invite_end_user200_response_data.rb +240 -0
- data/lib/zyphr/models/list_end_users200_response.rb +231 -0
- data/lib/zyphr/models/{list_workflow_executions200_response_meta.rb → list_end_users200_response_meta.rb} +3 -3
- data/lib/zyphr/models/list_workflow_executions200_response.rb +1 -1
- data/lib/zyphr/models/mark_all_subscriber_notifications_read200_response.rb +220 -0
- data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response.rb +229 -0
- data/lib/zyphr/models/rotate_waa_s_endpoint_secret200_response_data.rb +238 -0
- data/lib/zyphr/models/send_template_test_email202_response.rb +263 -0
- data/lib/zyphr/models/send_template_test_email202_response_data.rb +393 -0
- data/lib/zyphr/models/send_template_test_email202_response_meta.rb +237 -0
- data/lib/zyphr/models/set_end_user_claims200_response.rb +220 -0
- data/lib/zyphr/models/set_end_user_claims200_response_data.rb +230 -0
- data/lib/zyphr/models/sms_list_response.rb +1 -1
- data/lib/zyphr/models/update_subscriber_preferences200_response.rb +220 -0
- data/lib/zyphr/models/update_subscriber_preferences200_response_data.rb +231 -0
- data/lib/zyphr/models/update_subscriber_preferences200_response_data_preferences_inner.rb +282 -0
- data/lib/zyphr/models/update_waa_s_endpoint200_response.rb +229 -0
- data/lib/zyphr/models/update_waa_s_event_type200_response.rb +229 -0
- data/lib/zyphr.rb +37 -1
- data/spec/api/auth_user_directory_api_spec.rb +8 -8
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/inbox_api_spec.rb +10 -10
- data/spec/api/templates_api_spec.rb +1 -1
- data/spec/api/waa_s_deliveries_api_spec.rb +2 -2
- data/spec/api/waa_s_endpoints_api_spec.rb +5 -5
- data/spec/api/waa_s_event_types_api_spec.rb +2 -2
- data/spec/models/close_waa_s_endpoint_circuit200_response_data_spec.rb +40 -0
- data/spec/models/close_waa_s_endpoint_circuit200_response_spec.rb +42 -0
- data/spec/models/get_end_user_by_id200_response_spec.rb +42 -0
- data/spec/models/get_end_user_claims200_response_data_spec.rb +36 -0
- data/spec/models/get_end_user_claims200_response_spec.rb +42 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_category_spec.rb +60 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_data_categories_inner_spec.rb +42 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_data_global_channels_inner_spec.rb +52 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_data_global_spec.rb +36 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_data_spec.rb +42 -0
- data/spec/models/get_subscriber_inbox_preferences200_response_spec.rb +36 -0
- data/spec/models/get_subscriber_notification200_response_spec.rb +36 -0
- data/spec/models/get_subscriber_unread_count200_response_spec.rb +36 -0
- data/spec/models/get_waa_s_delivery200_response_spec.rb +42 -0
- data/spec/models/get_waa_s_endpoint_circuit200_response_data_spec.rb +70 -0
- data/spec/models/get_waa_s_endpoint_circuit200_response_spec.rb +42 -0
- data/spec/models/get_waa_s_endpoint_metrics200_response_data_health_spec.rb +46 -0
- data/spec/models/get_waa_s_endpoint_metrics200_response_data_spec.rb +48 -0
- data/spec/models/get_waa_s_endpoint_metrics200_response_data_windows_value_spec.rb +76 -0
- data/spec/models/get_waa_s_endpoint_metrics200_response_spec.rb +42 -0
- data/spec/models/invite_end_user200_response_data_spec.rb +48 -0
- data/spec/models/invite_end_user200_response_spec.rb +42 -0
- data/spec/models/{list_workflow_executions200_response_meta_spec.rb → list_end_users200_response_meta_spec.rb} +6 -6
- data/spec/models/list_end_users200_response_spec.rb +42 -0
- data/spec/models/mark_all_subscriber_notifications_read200_response_spec.rb +36 -0
- data/spec/models/rotate_waa_s_endpoint_secret200_response_data_spec.rb +36 -0
- data/spec/models/rotate_waa_s_endpoint_secret200_response_spec.rb +42 -0
- data/spec/models/send_template_test_email202_response_data_spec.rb +72 -0
- data/spec/models/send_template_test_email202_response_meta_spec.rb +36 -0
- data/spec/models/send_template_test_email202_response_spec.rb +42 -0
- data/spec/models/set_end_user_claims200_response_data_spec.rb +42 -0
- data/spec/models/set_end_user_claims200_response_spec.rb +36 -0
- data/spec/models/update_subscriber_preferences200_response_data_preferences_inner_spec.rb +58 -0
- data/spec/models/update_subscriber_preferences200_response_data_spec.rb +42 -0
- data/spec/models/update_subscriber_preferences200_response_spec.rb +36 -0
- data/spec/models/update_waa_s_endpoint200_response_spec.rb +42 -0
- data/spec/models/update_waa_s_event_type200_response_spec.rb +42 -0
- data/zyphr.gemspec +1 -1
- metadata +150 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ebdab8198569c4cb0ec3851df67ee2f92dc78b98cd10814fdc338141fe394c0a
|
|
4
|
+
data.tar.gz: 6093a93aa1280e8b7885ca65d8110badf25cd77bba988ed3cea53c39cea80984
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 458f05916058c46f4af69e41fa2921737cd03f7fba339284f3728d3335269cd7b5f78a5a05ee9d8bf2cbd2b615d5ec0f3cdd958feac2f107ecf41e4f04793d62
|
|
7
|
+
data.tar.gz: 83cb0d9771508e9761f720c73f6769ef72864d47a524b593ebbf4645f343196cea6b7ef5f96bf774a748a769f928631ea217c90987c5de06d5bdb9d771f19bc6
|
data/README.md
CHANGED
|
@@ -428,6 +428,8 @@ Class | Method | HTTP request | Description
|
|
|
428
428
|
- [Zyphr::Category](docs/Category.md)
|
|
429
429
|
- [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
|
|
430
430
|
- [Zyphr::CategoryResponse](docs/CategoryResponse.md)
|
|
431
|
+
- [Zyphr::CloseWaaSEndpointCircuit200Response](docs/CloseWaaSEndpointCircuit200Response.md)
|
|
432
|
+
- [Zyphr::CloseWaaSEndpointCircuit200ResponseData](docs/CloseWaaSEndpointCircuit200ResponseData.md)
|
|
431
433
|
- [Zyphr::ConfirmEmailVerificationRequest](docs/ConfirmEmailVerificationRequest.md)
|
|
432
434
|
- [Zyphr::ConfirmEmailVerificationResponse](docs/ConfirmEmailVerificationResponse.md)
|
|
433
435
|
- [Zyphr::ConfirmEmailVerificationResponseData](docs/ConfirmEmailVerificationResponseData.md)
|
|
@@ -504,7 +506,25 @@ Class | Method | HTTP request | Description
|
|
|
504
506
|
- [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
|
|
505
507
|
- [Zyphr::GetDomain200Response](docs/GetDomain200Response.md)
|
|
506
508
|
- [Zyphr::GetDomain200ResponseMeta](docs/GetDomain200ResponseMeta.md)
|
|
509
|
+
- [Zyphr::GetEndUserById200Response](docs/GetEndUserById200Response.md)
|
|
510
|
+
- [Zyphr::GetEndUserClaims200Response](docs/GetEndUserClaims200Response.md)
|
|
511
|
+
- [Zyphr::GetEndUserClaims200ResponseData](docs/GetEndUserClaims200ResponseData.md)
|
|
512
|
+
- [Zyphr::GetSubscriberInboxPreferences200Response](docs/GetSubscriberInboxPreferences200Response.md)
|
|
513
|
+
- [Zyphr::GetSubscriberInboxPreferences200ResponseData](docs/GetSubscriberInboxPreferences200ResponseData.md)
|
|
514
|
+
- [Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner](docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md)
|
|
515
|
+
- [Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory](docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md)
|
|
516
|
+
- [Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobal](docs/GetSubscriberInboxPreferences200ResponseDataGlobal.md)
|
|
517
|
+
- [Zyphr::GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner](docs/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md)
|
|
518
|
+
- [Zyphr::GetSubscriberNotification200Response](docs/GetSubscriberNotification200Response.md)
|
|
519
|
+
- [Zyphr::GetSubscriberUnreadCount200Response](docs/GetSubscriberUnreadCount200Response.md)
|
|
520
|
+
- [Zyphr::GetWaaSDelivery200Response](docs/GetWaaSDelivery200Response.md)
|
|
507
521
|
- [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
|
|
522
|
+
- [Zyphr::GetWaaSEndpointCircuit200Response](docs/GetWaaSEndpointCircuit200Response.md)
|
|
523
|
+
- [Zyphr::GetWaaSEndpointCircuit200ResponseData](docs/GetWaaSEndpointCircuit200ResponseData.md)
|
|
524
|
+
- [Zyphr::GetWaaSEndpointMetrics200Response](docs/GetWaaSEndpointMetrics200Response.md)
|
|
525
|
+
- [Zyphr::GetWaaSEndpointMetrics200ResponseData](docs/GetWaaSEndpointMetrics200ResponseData.md)
|
|
526
|
+
- [Zyphr::GetWaaSEndpointMetrics200ResponseDataHealth](docs/GetWaaSEndpointMetrics200ResponseDataHealth.md)
|
|
527
|
+
- [Zyphr::GetWaaSEndpointMetrics200ResponseDataWindowsValue](docs/GetWaaSEndpointMetrics200ResponseDataWindowsValue.md)
|
|
508
528
|
- [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
|
|
509
529
|
- [Zyphr::InAppNotification](docs/InAppNotification.md)
|
|
510
530
|
- [Zyphr::InboundAttachmentUrlResponse](docs/InboundAttachmentUrlResponse.md)
|
|
@@ -518,13 +538,16 @@ Class | Method | HTTP request | Description
|
|
|
518
538
|
- [Zyphr::InboxListMeta](docs/InboxListMeta.md)
|
|
519
539
|
- [Zyphr::InboxListResponse](docs/InboxListResponse.md)
|
|
520
540
|
- [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
|
|
541
|
+
- [Zyphr::InviteEndUser200Response](docs/InviteEndUser200Response.md)
|
|
542
|
+
- [Zyphr::InviteEndUser200ResponseData](docs/InviteEndUser200ResponseData.md)
|
|
521
543
|
- [Zyphr::InviteEndUserRequest](docs/InviteEndUserRequest.md)
|
|
544
|
+
- [Zyphr::ListEndUsers200Response](docs/ListEndUsers200Response.md)
|
|
545
|
+
- [Zyphr::ListEndUsers200ResponseMeta](docs/ListEndUsers200ResponseMeta.md)
|
|
522
546
|
- [Zyphr::ListWaaSApplications200Response](docs/ListWaaSApplications200Response.md)
|
|
523
547
|
- [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
|
|
524
548
|
- [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
|
|
525
549
|
- [Zyphr::ListWaaSEventTypes200Response](docs/ListWaaSEventTypes200Response.md)
|
|
526
550
|
- [Zyphr::ListWorkflowExecutions200Response](docs/ListWorkflowExecutions200Response.md)
|
|
527
|
-
- [Zyphr::ListWorkflowExecutions200ResponseMeta](docs/ListWorkflowExecutions200ResponseMeta.md)
|
|
528
551
|
- [Zyphr::ListWorkflows200Response](docs/ListWorkflows200Response.md)
|
|
529
552
|
- [Zyphr::ListWorkflows200ResponseMeta](docs/ListWorkflows200ResponseMeta.md)
|
|
530
553
|
- [Zyphr::LoginRequest](docs/LoginRequest.md)
|
|
@@ -535,6 +558,7 @@ Class | Method | HTTP request | Description
|
|
|
535
558
|
- [Zyphr::MarkAllInboxReadRequest](docs/MarkAllInboxReadRequest.md)
|
|
536
559
|
- [Zyphr::MarkAllReadData](docs/MarkAllReadData.md)
|
|
537
560
|
- [Zyphr::MarkAllReadResponse](docs/MarkAllReadResponse.md)
|
|
561
|
+
- [Zyphr::MarkAllSubscriberNotificationsRead200Response](docs/MarkAllSubscriberNotificationsRead200Response.md)
|
|
538
562
|
- [Zyphr::MarkAllSubscriberNotificationsReadRequest](docs/MarkAllSubscriberNotificationsReadRequest.md)
|
|
539
563
|
- [Zyphr::MarkInboxReadRequest](docs/MarkInboxReadRequest.md)
|
|
540
564
|
- [Zyphr::MfaBackupCodesResponse](docs/MfaBackupCodesResponse.md)
|
|
@@ -631,6 +655,8 @@ Class | Method | HTTP request | Description
|
|
|
631
655
|
- [Zyphr::RevokeAllSessionsResponse](docs/RevokeAllSessionsResponse.md)
|
|
632
656
|
- [Zyphr::RevokeAllSessionsResponseData](docs/RevokeAllSessionsResponseData.md)
|
|
633
657
|
- [Zyphr::RevokeSessionRequest](docs/RevokeSessionRequest.md)
|
|
658
|
+
- [Zyphr::RotateWaaSEndpointSecret200Response](docs/RotateWaaSEndpointSecret200Response.md)
|
|
659
|
+
- [Zyphr::RotateWaaSEndpointSecret200ResponseData](docs/RotateWaaSEndpointSecret200ResponseData.md)
|
|
634
660
|
- [Zyphr::SendBatchEmailRequest](docs/SendBatchEmailRequest.md)
|
|
635
661
|
- [Zyphr::SendBatchEmailResponse](docs/SendBatchEmailResponse.md)
|
|
636
662
|
- [Zyphr::SendBatchEmailResult](docs/SendBatchEmailResult.md)
|
|
@@ -663,6 +689,9 @@ Class | Method | HTTP request | Description
|
|
|
663
689
|
- [Zyphr::SendSmsData](docs/SendSmsData.md)
|
|
664
690
|
- [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
|
|
665
691
|
- [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
|
|
692
|
+
- [Zyphr::SendTemplateTestEmail202Response](docs/SendTemplateTestEmail202Response.md)
|
|
693
|
+
- [Zyphr::SendTemplateTestEmail202ResponseData](docs/SendTemplateTestEmail202ResponseData.md)
|
|
694
|
+
- [Zyphr::SendTemplateTestEmail202ResponseMeta](docs/SendTemplateTestEmail202ResponseMeta.md)
|
|
666
695
|
- [Zyphr::SendTemplateTestEmailRequest](docs/SendTemplateTestEmailRequest.md)
|
|
667
696
|
- [Zyphr::SendTestSmsData](docs/SendTestSmsData.md)
|
|
668
697
|
- [Zyphr::SendTestSmsRequest](docs/SendTestSmsRequest.md)
|
|
@@ -672,6 +701,8 @@ Class | Method | HTTP request | Description
|
|
|
672
701
|
- [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
|
|
673
702
|
- [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
|
|
674
703
|
- [Zyphr::SetDomainInboundRequest](docs/SetDomainInboundRequest.md)
|
|
704
|
+
- [Zyphr::SetEndUserClaims200Response](docs/SetEndUserClaims200Response.md)
|
|
705
|
+
- [Zyphr::SetEndUserClaims200ResponseData](docs/SetEndUserClaims200ResponseData.md)
|
|
675
706
|
- [Zyphr::SetEndUserClaimsRequest](docs/SetEndUserClaimsRequest.md)
|
|
676
707
|
- [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
|
|
677
708
|
- [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
|
|
@@ -738,13 +769,18 @@ Class | Method | HTTP request | Description
|
|
|
738
769
|
- [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
|
|
739
770
|
- [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
|
|
740
771
|
- [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
|
|
772
|
+
- [Zyphr::UpdateSubscriberPreferences200Response](docs/UpdateSubscriberPreferences200Response.md)
|
|
773
|
+
- [Zyphr::UpdateSubscriberPreferences200ResponseData](docs/UpdateSubscriberPreferences200ResponseData.md)
|
|
774
|
+
- [Zyphr::UpdateSubscriberPreferences200ResponseDataPreferencesInner](docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md)
|
|
741
775
|
- [Zyphr::UpdateSubscriberPreferencesRequest](docs/UpdateSubscriberPreferencesRequest.md)
|
|
742
776
|
- [Zyphr::UpdateSubscriberPreferencesRequestPreferencesInner](docs/UpdateSubscriberPreferencesRequestPreferencesInner.md)
|
|
743
777
|
- [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
|
|
744
778
|
- [Zyphr::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
|
|
745
779
|
- [Zyphr::UpdateTopicRequest](docs/UpdateTopicRequest.md)
|
|
746
780
|
- [Zyphr::UpdateWaaSApplicationRequest](docs/UpdateWaaSApplicationRequest.md)
|
|
781
|
+
- [Zyphr::UpdateWaaSEndpoint200Response](docs/UpdateWaaSEndpoint200Response.md)
|
|
747
782
|
- [Zyphr::UpdateWaaSEndpointRequest](docs/UpdateWaaSEndpointRequest.md)
|
|
783
|
+
- [Zyphr::UpdateWaaSEventType200Response](docs/UpdateWaaSEventType200Response.md)
|
|
748
784
|
- [Zyphr::UpdateWaaSEventTypeRequest](docs/UpdateWaaSEventTypeRequest.md)
|
|
749
785
|
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
750
786
|
- [Zyphr::UpdateWorkflowRequest](docs/UpdateWorkflowRequest.md)
|
|
@@ -91,7 +91,7 @@ nil (empty response body)
|
|
|
91
91
|
|
|
92
92
|
## get_end_user_by_email
|
|
93
93
|
|
|
94
|
-
> get_end_user_by_email(email)
|
|
94
|
+
> <GetEndUserById200Response> get_end_user_by_email(email)
|
|
95
95
|
|
|
96
96
|
Look up an end user by email (server-side admin)
|
|
97
97
|
|
|
@@ -120,7 +120,8 @@ email = 'email_example' # String |
|
|
|
120
120
|
|
|
121
121
|
begin
|
|
122
122
|
# Look up an end user by email (server-side admin)
|
|
123
|
-
api_instance.get_end_user_by_email(email)
|
|
123
|
+
result = api_instance.get_end_user_by_email(email)
|
|
124
|
+
p result
|
|
124
125
|
rescue Zyphr::ApiError => e
|
|
125
126
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_by_email: #{e}"
|
|
126
127
|
end
|
|
@@ -128,9 +129,9 @@ end
|
|
|
128
129
|
|
|
129
130
|
#### Using the get_end_user_by_email_with_http_info variant
|
|
130
131
|
|
|
131
|
-
This returns an Array which contains the response data
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
132
133
|
|
|
133
|
-
> <Array(
|
|
134
|
+
> <Array(<GetEndUserById200Response>, Integer, Hash)> get_end_user_by_email_with_http_info(email)
|
|
134
135
|
|
|
135
136
|
```ruby
|
|
136
137
|
begin
|
|
@@ -138,7 +139,7 @@ begin
|
|
|
138
139
|
data, status_code, headers = api_instance.get_end_user_by_email_with_http_info(email)
|
|
139
140
|
p status_code # => 2xx
|
|
140
141
|
p headers # => { ... }
|
|
141
|
-
p data # =>
|
|
142
|
+
p data # => <GetEndUserById200Response>
|
|
142
143
|
rescue Zyphr::ApiError => e
|
|
143
144
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_by_email_with_http_info: #{e}"
|
|
144
145
|
end
|
|
@@ -152,7 +153,7 @@ end
|
|
|
152
153
|
|
|
153
154
|
### Return type
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
[**GetEndUserById200Response**](GetEndUserById200Response.md)
|
|
156
157
|
|
|
157
158
|
### Authorization
|
|
158
159
|
|
|
@@ -161,12 +162,12 @@ nil (empty response body)
|
|
|
161
162
|
### HTTP request headers
|
|
162
163
|
|
|
163
164
|
- **Content-Type**: Not defined
|
|
164
|
-
- **Accept**:
|
|
165
|
+
- **Accept**: application/json
|
|
165
166
|
|
|
166
167
|
|
|
167
168
|
## get_end_user_by_id
|
|
168
169
|
|
|
169
|
-
> get_end_user_by_id(user_id)
|
|
170
|
+
> <GetEndUserById200Response> get_end_user_by_id(user_id)
|
|
170
171
|
|
|
171
172
|
Get an end user by id (server-side admin)
|
|
172
173
|
|
|
@@ -195,7 +196,8 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
195
196
|
|
|
196
197
|
begin
|
|
197
198
|
# Get an end user by id (server-side admin)
|
|
198
|
-
api_instance.get_end_user_by_id(user_id)
|
|
199
|
+
result = api_instance.get_end_user_by_id(user_id)
|
|
200
|
+
p result
|
|
199
201
|
rescue Zyphr::ApiError => e
|
|
200
202
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_by_id: #{e}"
|
|
201
203
|
end
|
|
@@ -203,9 +205,9 @@ end
|
|
|
203
205
|
|
|
204
206
|
#### Using the get_end_user_by_id_with_http_info variant
|
|
205
207
|
|
|
206
|
-
This returns an Array which contains the response data
|
|
208
|
+
This returns an Array which contains the response data, status code and headers.
|
|
207
209
|
|
|
208
|
-
> <Array(
|
|
210
|
+
> <Array(<GetEndUserById200Response>, Integer, Hash)> get_end_user_by_id_with_http_info(user_id)
|
|
209
211
|
|
|
210
212
|
```ruby
|
|
211
213
|
begin
|
|
@@ -213,7 +215,7 @@ begin
|
|
|
213
215
|
data, status_code, headers = api_instance.get_end_user_by_id_with_http_info(user_id)
|
|
214
216
|
p status_code # => 2xx
|
|
215
217
|
p headers # => { ... }
|
|
216
|
-
p data # =>
|
|
218
|
+
p data # => <GetEndUserById200Response>
|
|
217
219
|
rescue Zyphr::ApiError => e
|
|
218
220
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_by_id_with_http_info: #{e}"
|
|
219
221
|
end
|
|
@@ -227,7 +229,7 @@ end
|
|
|
227
229
|
|
|
228
230
|
### Return type
|
|
229
231
|
|
|
230
|
-
|
|
232
|
+
[**GetEndUserById200Response**](GetEndUserById200Response.md)
|
|
231
233
|
|
|
232
234
|
### Authorization
|
|
233
235
|
|
|
@@ -236,12 +238,12 @@ nil (empty response body)
|
|
|
236
238
|
### HTTP request headers
|
|
237
239
|
|
|
238
240
|
- **Content-Type**: Not defined
|
|
239
|
-
- **Accept**:
|
|
241
|
+
- **Accept**: application/json
|
|
240
242
|
|
|
241
243
|
|
|
242
244
|
## get_end_user_claims
|
|
243
245
|
|
|
244
|
-
> get_end_user_claims(user_id)
|
|
246
|
+
> <GetEndUserClaims200Response> get_end_user_claims(user_id)
|
|
245
247
|
|
|
246
248
|
Get an end user's stored custom claims (server-side admin)
|
|
247
249
|
|
|
@@ -270,7 +272,8 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
270
272
|
|
|
271
273
|
begin
|
|
272
274
|
# Get an end user's stored custom claims (server-side admin)
|
|
273
|
-
api_instance.get_end_user_claims(user_id)
|
|
275
|
+
result = api_instance.get_end_user_claims(user_id)
|
|
276
|
+
p result
|
|
274
277
|
rescue Zyphr::ApiError => e
|
|
275
278
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_claims: #{e}"
|
|
276
279
|
end
|
|
@@ -278,9 +281,9 @@ end
|
|
|
278
281
|
|
|
279
282
|
#### Using the get_end_user_claims_with_http_info variant
|
|
280
283
|
|
|
281
|
-
This returns an Array which contains the response data
|
|
284
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
285
|
|
|
283
|
-
> <Array(
|
|
286
|
+
> <Array(<GetEndUserClaims200Response>, Integer, Hash)> get_end_user_claims_with_http_info(user_id)
|
|
284
287
|
|
|
285
288
|
```ruby
|
|
286
289
|
begin
|
|
@@ -288,7 +291,7 @@ begin
|
|
|
288
291
|
data, status_code, headers = api_instance.get_end_user_claims_with_http_info(user_id)
|
|
289
292
|
p status_code # => 2xx
|
|
290
293
|
p headers # => { ... }
|
|
291
|
-
p data # =>
|
|
294
|
+
p data # => <GetEndUserClaims200Response>
|
|
292
295
|
rescue Zyphr::ApiError => e
|
|
293
296
|
puts "Error when calling AuthUserDirectoryApi->get_end_user_claims_with_http_info: #{e}"
|
|
294
297
|
end
|
|
@@ -302,7 +305,7 @@ end
|
|
|
302
305
|
|
|
303
306
|
### Return type
|
|
304
307
|
|
|
305
|
-
|
|
308
|
+
[**GetEndUserClaims200Response**](GetEndUserClaims200Response.md)
|
|
306
309
|
|
|
307
310
|
### Authorization
|
|
308
311
|
|
|
@@ -311,12 +314,12 @@ nil (empty response body)
|
|
|
311
314
|
### HTTP request headers
|
|
312
315
|
|
|
313
316
|
- **Content-Type**: Not defined
|
|
314
|
-
- **Accept**:
|
|
317
|
+
- **Accept**: application/json
|
|
315
318
|
|
|
316
319
|
|
|
317
320
|
## invite_end_user
|
|
318
321
|
|
|
319
|
-
> invite_end_user(invite_end_user_request)
|
|
322
|
+
> <InviteEndUser200Response> invite_end_user(invite_end_user_request)
|
|
320
323
|
|
|
321
324
|
Pre-provision (invite) an end user (server-side admin)
|
|
322
325
|
|
|
@@ -345,7 +348,8 @@ invite_end_user_request = Zyphr::InviteEndUserRequest.new({email: 'email_example
|
|
|
345
348
|
|
|
346
349
|
begin
|
|
347
350
|
# Pre-provision (invite) an end user (server-side admin)
|
|
348
|
-
api_instance.invite_end_user(invite_end_user_request)
|
|
351
|
+
result = api_instance.invite_end_user(invite_end_user_request)
|
|
352
|
+
p result
|
|
349
353
|
rescue Zyphr::ApiError => e
|
|
350
354
|
puts "Error when calling AuthUserDirectoryApi->invite_end_user: #{e}"
|
|
351
355
|
end
|
|
@@ -353,9 +357,9 @@ end
|
|
|
353
357
|
|
|
354
358
|
#### Using the invite_end_user_with_http_info variant
|
|
355
359
|
|
|
356
|
-
This returns an Array which contains the response data
|
|
360
|
+
This returns an Array which contains the response data, status code and headers.
|
|
357
361
|
|
|
358
|
-
> <Array(
|
|
362
|
+
> <Array(<InviteEndUser200Response>, Integer, Hash)> invite_end_user_with_http_info(invite_end_user_request)
|
|
359
363
|
|
|
360
364
|
```ruby
|
|
361
365
|
begin
|
|
@@ -363,7 +367,7 @@ begin
|
|
|
363
367
|
data, status_code, headers = api_instance.invite_end_user_with_http_info(invite_end_user_request)
|
|
364
368
|
p status_code # => 2xx
|
|
365
369
|
p headers # => { ... }
|
|
366
|
-
p data # =>
|
|
370
|
+
p data # => <InviteEndUser200Response>
|
|
367
371
|
rescue Zyphr::ApiError => e
|
|
368
372
|
puts "Error when calling AuthUserDirectoryApi->invite_end_user_with_http_info: #{e}"
|
|
369
373
|
end
|
|
@@ -377,7 +381,7 @@ end
|
|
|
377
381
|
|
|
378
382
|
### Return type
|
|
379
383
|
|
|
380
|
-
|
|
384
|
+
[**InviteEndUser200Response**](InviteEndUser200Response.md)
|
|
381
385
|
|
|
382
386
|
### Authorization
|
|
383
387
|
|
|
@@ -386,12 +390,12 @@ nil (empty response body)
|
|
|
386
390
|
### HTTP request headers
|
|
387
391
|
|
|
388
392
|
- **Content-Type**: application/json
|
|
389
|
-
- **Accept**:
|
|
393
|
+
- **Accept**: application/json
|
|
390
394
|
|
|
391
395
|
|
|
392
396
|
## list_end_users
|
|
393
397
|
|
|
394
|
-
> list_end_users(opts)
|
|
398
|
+
> <ListEndUsers200Response> list_end_users(opts)
|
|
395
399
|
|
|
396
400
|
List / search end users (server-side admin)
|
|
397
401
|
|
|
@@ -425,7 +429,8 @@ opts = {
|
|
|
425
429
|
|
|
426
430
|
begin
|
|
427
431
|
# List / search end users (server-side admin)
|
|
428
|
-
api_instance.list_end_users(opts)
|
|
432
|
+
result = api_instance.list_end_users(opts)
|
|
433
|
+
p result
|
|
429
434
|
rescue Zyphr::ApiError => e
|
|
430
435
|
puts "Error when calling AuthUserDirectoryApi->list_end_users: #{e}"
|
|
431
436
|
end
|
|
@@ -433,9 +438,9 @@ end
|
|
|
433
438
|
|
|
434
439
|
#### Using the list_end_users_with_http_info variant
|
|
435
440
|
|
|
436
|
-
This returns an Array which contains the response data
|
|
441
|
+
This returns an Array which contains the response data, status code and headers.
|
|
437
442
|
|
|
438
|
-
> <Array(
|
|
443
|
+
> <Array(<ListEndUsers200Response>, Integer, Hash)> list_end_users_with_http_info(opts)
|
|
439
444
|
|
|
440
445
|
```ruby
|
|
441
446
|
begin
|
|
@@ -443,7 +448,7 @@ begin
|
|
|
443
448
|
data, status_code, headers = api_instance.list_end_users_with_http_info(opts)
|
|
444
449
|
p status_code # => 2xx
|
|
445
450
|
p headers # => { ... }
|
|
446
|
-
p data # =>
|
|
451
|
+
p data # => <ListEndUsers200Response>
|
|
447
452
|
rescue Zyphr::ApiError => e
|
|
448
453
|
puts "Error when calling AuthUserDirectoryApi->list_end_users_with_http_info: #{e}"
|
|
449
454
|
end
|
|
@@ -460,7 +465,7 @@ end
|
|
|
460
465
|
|
|
461
466
|
### Return type
|
|
462
467
|
|
|
463
|
-
|
|
468
|
+
[**ListEndUsers200Response**](ListEndUsers200Response.md)
|
|
464
469
|
|
|
465
470
|
### Authorization
|
|
466
471
|
|
|
@@ -469,16 +474,16 @@ nil (empty response body)
|
|
|
469
474
|
### HTTP request headers
|
|
470
475
|
|
|
471
476
|
- **Content-Type**: Not defined
|
|
472
|
-
- **Accept**:
|
|
477
|
+
- **Accept**: application/json
|
|
473
478
|
|
|
474
479
|
|
|
475
480
|
## set_end_user_claims
|
|
476
481
|
|
|
477
|
-
> set_end_user_claims(user_id, set_end_user_claims_request)
|
|
482
|
+
> <SetEndUserClaims200Response> set_end_user_claims(user_id, set_end_user_claims_request)
|
|
478
483
|
|
|
479
484
|
Set an end user's stored custom claims (server-side admin)
|
|
480
485
|
|
|
481
|
-
Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.
|
|
486
|
+
Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected. Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user's next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims.
|
|
482
487
|
|
|
483
488
|
### Examples
|
|
484
489
|
|
|
@@ -504,7 +509,8 @@ set_end_user_claims_request = Zyphr::SetEndUserClaimsRequest.new # SetEndUserCla
|
|
|
504
509
|
|
|
505
510
|
begin
|
|
506
511
|
# Set an end user's stored custom claims (server-side admin)
|
|
507
|
-
api_instance.set_end_user_claims(user_id, set_end_user_claims_request)
|
|
512
|
+
result = api_instance.set_end_user_claims(user_id, set_end_user_claims_request)
|
|
513
|
+
p result
|
|
508
514
|
rescue Zyphr::ApiError => e
|
|
509
515
|
puts "Error when calling AuthUserDirectoryApi->set_end_user_claims: #{e}"
|
|
510
516
|
end
|
|
@@ -512,9 +518,9 @@ end
|
|
|
512
518
|
|
|
513
519
|
#### Using the set_end_user_claims_with_http_info variant
|
|
514
520
|
|
|
515
|
-
This returns an Array which contains the response data
|
|
521
|
+
This returns an Array which contains the response data, status code and headers.
|
|
516
522
|
|
|
517
|
-
> <Array(
|
|
523
|
+
> <Array(<SetEndUserClaims200Response>, Integer, Hash)> set_end_user_claims_with_http_info(user_id, set_end_user_claims_request)
|
|
518
524
|
|
|
519
525
|
```ruby
|
|
520
526
|
begin
|
|
@@ -522,7 +528,7 @@ begin
|
|
|
522
528
|
data, status_code, headers = api_instance.set_end_user_claims_with_http_info(user_id, set_end_user_claims_request)
|
|
523
529
|
p status_code # => 2xx
|
|
524
530
|
p headers # => { ... }
|
|
525
|
-
p data # =>
|
|
531
|
+
p data # => <SetEndUserClaims200Response>
|
|
526
532
|
rescue Zyphr::ApiError => e
|
|
527
533
|
puts "Error when calling AuthUserDirectoryApi->set_end_user_claims_with_http_info: #{e}"
|
|
528
534
|
end
|
|
@@ -537,7 +543,7 @@ end
|
|
|
537
543
|
|
|
538
544
|
### Return type
|
|
539
545
|
|
|
540
|
-
|
|
546
|
+
[**SetEndUserClaims200Response**](SetEndUserClaims200Response.md)
|
|
541
547
|
|
|
542
548
|
### Authorization
|
|
543
549
|
|
|
@@ -546,12 +552,12 @@ nil (empty response body)
|
|
|
546
552
|
### HTTP request headers
|
|
547
553
|
|
|
548
554
|
- **Content-Type**: application/json
|
|
549
|
-
- **Accept**:
|
|
555
|
+
- **Accept**: application/json
|
|
550
556
|
|
|
551
557
|
|
|
552
558
|
## update_end_user_by_application
|
|
553
559
|
|
|
554
|
-
> update_end_user_by_application(user_id, update_end_user_by_application_request)
|
|
560
|
+
> <GetEndUserById200Response> update_end_user_by_application(user_id, update_end_user_by_application_request)
|
|
555
561
|
|
|
556
562
|
Update an end user (server-side admin)
|
|
557
563
|
|
|
@@ -581,7 +587,8 @@ update_end_user_by_application_request = Zyphr::UpdateEndUserByApplicationReques
|
|
|
581
587
|
|
|
582
588
|
begin
|
|
583
589
|
# Update an end user (server-side admin)
|
|
584
|
-
api_instance.update_end_user_by_application(user_id, update_end_user_by_application_request)
|
|
590
|
+
result = api_instance.update_end_user_by_application(user_id, update_end_user_by_application_request)
|
|
591
|
+
p result
|
|
585
592
|
rescue Zyphr::ApiError => e
|
|
586
593
|
puts "Error when calling AuthUserDirectoryApi->update_end_user_by_application: #{e}"
|
|
587
594
|
end
|
|
@@ -589,9 +596,9 @@ end
|
|
|
589
596
|
|
|
590
597
|
#### Using the update_end_user_by_application_with_http_info variant
|
|
591
598
|
|
|
592
|
-
This returns an Array which contains the response data
|
|
599
|
+
This returns an Array which contains the response data, status code and headers.
|
|
593
600
|
|
|
594
|
-
> <Array(
|
|
601
|
+
> <Array(<GetEndUserById200Response>, Integer, Hash)> update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request)
|
|
595
602
|
|
|
596
603
|
```ruby
|
|
597
604
|
begin
|
|
@@ -599,7 +606,7 @@ begin
|
|
|
599
606
|
data, status_code, headers = api_instance.update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request)
|
|
600
607
|
p status_code # => 2xx
|
|
601
608
|
p headers # => { ... }
|
|
602
|
-
p data # =>
|
|
609
|
+
p data # => <GetEndUserById200Response>
|
|
603
610
|
rescue Zyphr::ApiError => e
|
|
604
611
|
puts "Error when calling AuthUserDirectoryApi->update_end_user_by_application_with_http_info: #{e}"
|
|
605
612
|
end
|
|
@@ -614,7 +621,7 @@ end
|
|
|
614
621
|
|
|
615
622
|
### Return type
|
|
616
623
|
|
|
617
|
-
|
|
624
|
+
[**GetEndUserById200Response**](GetEndUserById200Response.md)
|
|
618
625
|
|
|
619
626
|
### Authorization
|
|
620
627
|
|
|
@@ -623,5 +630,5 @@ nil (empty response body)
|
|
|
623
630
|
### HTTP request headers
|
|
624
631
|
|
|
625
632
|
- **Content-Type**: application/json
|
|
626
|
-
- **Accept**:
|
|
633
|
+
- **Accept**: application/json
|
|
627
634
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::CloseWaaSEndpointCircuit200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**CloseWaaSEndpointCircuit200ResponseData**](CloseWaaSEndpointCircuit200ResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::CloseWaaSEndpointCircuit200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::CloseWaaSEndpointCircuit200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **state** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::CloseWaaSEndpointCircuit200ResponseData.new(
|
|
15
|
+
state: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/DomainsApi.md
CHANGED
|
@@ -367,7 +367,7 @@ This endpoint does not need any parameter.
|
|
|
367
367
|
|
|
368
368
|
## set_domain_inbound
|
|
369
369
|
|
|
370
|
-
> set_domain_inbound(id, set_domain_inbound_request)
|
|
370
|
+
> <GetDomain200Response> set_domain_inbound(id, set_domain_inbound_request)
|
|
371
371
|
|
|
372
372
|
Enable or disable inbound email for a domain
|
|
373
373
|
|
|
@@ -392,7 +392,8 @@ set_domain_inbound_request = Zyphr::SetDomainInboundRequest.new # SetDomainInbou
|
|
|
392
392
|
|
|
393
393
|
begin
|
|
394
394
|
# Enable or disable inbound email for a domain
|
|
395
|
-
api_instance.set_domain_inbound(id, set_domain_inbound_request)
|
|
395
|
+
result = api_instance.set_domain_inbound(id, set_domain_inbound_request)
|
|
396
|
+
p result
|
|
396
397
|
rescue Zyphr::ApiError => e
|
|
397
398
|
puts "Error when calling DomainsApi->set_domain_inbound: #{e}"
|
|
398
399
|
end
|
|
@@ -400,9 +401,9 @@ end
|
|
|
400
401
|
|
|
401
402
|
#### Using the set_domain_inbound_with_http_info variant
|
|
402
403
|
|
|
403
|
-
This returns an Array which contains the response data
|
|
404
|
+
This returns an Array which contains the response data, status code and headers.
|
|
404
405
|
|
|
405
|
-
> <Array(
|
|
406
|
+
> <Array(<GetDomain200Response>, Integer, Hash)> set_domain_inbound_with_http_info(id, set_domain_inbound_request)
|
|
406
407
|
|
|
407
408
|
```ruby
|
|
408
409
|
begin
|
|
@@ -410,7 +411,7 @@ begin
|
|
|
410
411
|
data, status_code, headers = api_instance.set_domain_inbound_with_http_info(id, set_domain_inbound_request)
|
|
411
412
|
p status_code # => 2xx
|
|
412
413
|
p headers # => { ... }
|
|
413
|
-
p data # =>
|
|
414
|
+
p data # => <GetDomain200Response>
|
|
414
415
|
rescue Zyphr::ApiError => e
|
|
415
416
|
puts "Error when calling DomainsApi->set_domain_inbound_with_http_info: #{e}"
|
|
416
417
|
end
|
|
@@ -425,7 +426,7 @@ end
|
|
|
425
426
|
|
|
426
427
|
### Return type
|
|
427
428
|
|
|
428
|
-
|
|
429
|
+
[**GetDomain200Response**](GetDomain200Response.md)
|
|
429
430
|
|
|
430
431
|
### Authorization
|
|
431
432
|
|
|
@@ -434,7 +435,7 @@ nil (empty response body)
|
|
|
434
435
|
### HTTP request headers
|
|
435
436
|
|
|
436
437
|
- **Content-Type**: application/json
|
|
437
|
-
- **Accept**:
|
|
438
|
+
- **Accept**: application/json
|
|
438
439
|
|
|
439
440
|
|
|
440
441
|
## verify_domain
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::GetEndUserById200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**AuthUser**](AuthUser.md) | | [optional] |
|
|
8
|
+
| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::GetEndUserById200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::GetEndUserClaims200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**GetEndUserClaims200ResponseData**](GetEndUserClaims200ResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::GetEndUserClaims200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::GetEndUserClaims200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **claims** | **Hash<String, Object>** | Stored custom_claims for the user; empty object when none are set. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::GetEndUserClaims200ResponseData.new(
|
|
15
|
+
claims: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::GetSubscriberInboxPreferences200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**GetSubscriberInboxPreferences200ResponseData**](GetSubscriberInboxPreferences200ResponseData.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::GetSubscriberInboxPreferences200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|