zyphr 0.1.36 → 0.1.38
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 +25 -1
- data/docs/AuthOAuthApi.md +12 -12
- data/docs/AuthRegistrationApi.md +73 -1
- data/docs/AuthUserDirectoryApi.md +627 -0
- data/docs/AuthUserProfileApi.md +0 -76
- data/docs/InviteEndUserRequest.md +26 -0
- data/docs/OAuthProviderName.md +15 -0
- data/docs/SendTemplateTestEmailRequest.md +20 -0
- data/docs/SetEndUserClaimsRequest.md +18 -0
- data/docs/SignInAnonymouslyRequest.md +5 -1
- data/docs/SignInWithGameCenterRequest.md +28 -0
- data/docs/TemplatesApi.md +71 -0
- data/docs/UpdateEndUserByApplicationRequest.md +26 -0
- data/lib/zyphr/api/auth_email_otp_api.rb +1 -1
- data/lib/zyphr/api/auth_email_templates_api.rb +1 -1
- data/lib/zyphr/api/auth_email_verification_api.rb +1 -1
- data/lib/zyphr/api/auth_login_api.rb +1 -1
- data/lib/zyphr/api/auth_magic_links_api.rb +1 -1
- data/lib/zyphr/api/auth_mfa_api.rb +1 -1
- data/lib/zyphr/api/auth_o_auth_api.rb +13 -13
- data/lib/zyphr/api/auth_organizations_api.rb +1 -1
- data/lib/zyphr/api/auth_password_reset_api.rb +1 -1
- data/lib/zyphr/api/auth_phone_api.rb +1 -1
- data/lib/zyphr/api/auth_registration_api.rb +71 -3
- data/lib/zyphr/api/auth_sessions_api.rb +1 -1
- data/lib/zyphr/api/auth_user_directory_api.rb +560 -0
- data/lib/zyphr/api/auth_user_profile_api.rb +1 -62
- data/lib/zyphr/api/auth_web_authn_api.rb +1 -1
- data/lib/zyphr/api/devices_api.rb +1 -1
- data/lib/zyphr/api/domains_api.rb +1 -1
- data/lib/zyphr/api/emails_api.rb +1 -1
- data/lib/zyphr/api/executions_api.rb +1 -1
- data/lib/zyphr/api/inbound_email_api.rb +1 -1
- data/lib/zyphr/api/inbox_api.rb +1 -1
- data/lib/zyphr/api/muse_api.rb +1 -1
- data/lib/zyphr/api/push_api.rb +1 -1
- data/lib/zyphr/api/slack_api.rb +1 -1
- data/lib/zyphr/api/sms_api.rb +1 -1
- data/lib/zyphr/api/subscribers_api.rb +1 -1
- data/lib/zyphr/api/templates_api.rb +75 -1
- data/lib/zyphr/api/topics_api.rb +1 -1
- data/lib/zyphr/api/utility_api.rb +1 -1
- data/lib/zyphr/api/waa_s_applications_api.rb +1 -1
- data/lib/zyphr/api/waa_s_deliveries_api.rb +1 -1
- data/lib/zyphr/api/waa_s_endpoints_api.rb +1 -1
- data/lib/zyphr/api/waa_s_event_types_api.rb +1 -1
- data/lib/zyphr/api/waa_s_events_api.rb +1 -1
- data/lib/zyphr/api/waa_s_portal_api.rb +1 -1
- data/lib/zyphr/api/webhooks_api.rb +1 -1
- data/lib/zyphr/api_client.rb +1 -1
- data/lib/zyphr/api_error.rb +1 -1
- data/lib/zyphr/configuration.rb +1 -1
- data/lib/zyphr/models/add_domain200_response.rb +1 -1
- data/lib/zyphr/models/add_domain200_response_meta.rb +1 -1
- data/lib/zyphr/models/add_domain_request.rb +1 -1
- data/lib/zyphr/models/add_organization_member_request.rb +1 -1
- data/lib/zyphr/models/add_topic_subscribers_request.rb +1 -1
- data/lib/zyphr/models/api_error.rb +1 -1
- data/lib/zyphr/models/api_error_error.rb +1 -1
- data/lib/zyphr/models/api_error_meta.rb +1 -1
- data/lib/zyphr/models/auth_email_template.rb +1 -1
- data/lib/zyphr/models/auth_email_template_default.rb +1 -1
- data/lib/zyphr/models/auth_email_template_default_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_delete_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_delete_response_data.rb +1 -1
- data/lib/zyphr/models/auth_email_template_list_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_preview_draft.rb +1 -1
- data/lib/zyphr/models/auth_email_template_preview_request.rb +1 -1
- data/lib/zyphr/models/auth_email_template_preview_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_preview_result.rb +1 -1
- data/lib/zyphr/models/auth_email_template_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_test_request.rb +1 -1
- data/lib/zyphr/models/auth_email_template_test_response.rb +1 -1
- data/lib/zyphr/models/auth_email_template_test_result.rb +1 -1
- data/lib/zyphr/models/auth_email_template_version.rb +1 -1
- data/lib/zyphr/models/auth_email_template_versions_response.rb +1 -1
- data/lib/zyphr/models/auth_email_type.rb +1 -1
- data/lib/zyphr/models/auth_login_response.rb +1 -1
- data/lib/zyphr/models/auth_login_result.rb +1 -1
- data/lib/zyphr/models/auth_login_result_mfa_challenge.rb +1 -1
- data/lib/zyphr/models/auth_result.rb +1 -1
- data/lib/zyphr/models/auth_result_response.rb +1 -1
- data/lib/zyphr/models/auth_session.rb +1 -1
- data/lib/zyphr/models/auth_tokens.rb +1 -1
- data/lib/zyphr/models/auth_user.rb +1 -1
- data/lib/zyphr/models/auth_user_response.rb +1 -1
- data/lib/zyphr/models/auth_user_response_data.rb +1 -1
- data/lib/zyphr/models/batch_publish_waa_s_events201_response.rb +1 -1
- data/lib/zyphr/models/batch_recipient.rb +1 -1
- data/lib/zyphr/models/bulk_retry_webhook_deliveries_request.rb +1 -1
- data/lib/zyphr/models/bulk_upsert_auth_email_templates_request.rb +1 -1
- data/lib/zyphr/models/bulk_upsert_auth_email_templates_response.rb +1 -1
- data/lib/zyphr/models/category.rb +1 -1
- data/lib/zyphr/models/category_list_response.rb +1 -1
- data/lib/zyphr/models/category_response.rb +1 -1
- data/lib/zyphr/models/confirm_email_verification_request.rb +1 -1
- data/lib/zyphr/models/confirm_email_verification_response.rb +1 -1
- data/lib/zyphr/models/confirm_email_verification_response_data.rb +1 -1
- data/lib/zyphr/models/consent_history_entry.rb +1 -1
- data/lib/zyphr/models/consent_history_response.rb +1 -1
- data/lib/zyphr/models/consent_record_response.rb +1 -1
- data/lib/zyphr/models/consent_record_response_data.rb +1 -1
- data/lib/zyphr/models/consent_status.rb +1 -1
- data/lib/zyphr/models/consent_status_response.rb +1 -1
- data/lib/zyphr/models/consent_withdraw_response.rb +1 -1
- data/lib/zyphr/models/convert_anonymous_user_request.rb +1 -1
- data/lib/zyphr/models/convert_anonymous_user_request_one_of.rb +1 -1
- data/lib/zyphr/models/convert_anonymous_user_request_one_of1.rb +1 -1
- data/lib/zyphr/models/convert_anonymous_user_request_one_of1_apple_user.rb +1 -1
- data/lib/zyphr/models/convert_anonymous_user_request_one_of1_apple_user_name.rb +1 -1
- data/lib/zyphr/models/create_category_request.rb +1 -1
- data/lib/zyphr/models/create_organization_request.rb +1 -1
- data/lib/zyphr/models/create_subscriber_request.rb +1 -1
- data/lib/zyphr/models/create_template_request.rb +1 -1
- data/lib/zyphr/models/create_topic_request.rb +1 -1
- data/lib/zyphr/models/create_waa_s_application201_response.rb +1 -1
- data/lib/zyphr/models/create_waa_s_application_request.rb +1 -1
- data/lib/zyphr/models/create_waa_s_endpoint201_response.rb +1 -1
- data/lib/zyphr/models/create_waa_s_endpoint_request.rb +1 -1
- data/lib/zyphr/models/create_waa_s_endpoint_response.rb +1 -1
- data/lib/zyphr/models/create_waa_s_event_type201_response.rb +1 -1
- data/lib/zyphr/models/create_waa_s_event_type_request.rb +1 -1
- data/lib/zyphr/models/create_webhook_request.rb +1 -1
- data/lib/zyphr/models/delete_domain_response.rb +1 -1
- data/lib/zyphr/models/delete_domain_response_data.rb +1 -1
- data/lib/zyphr/models/delete_result.rb +1 -1
- data/lib/zyphr/models/delete_result_data.rb +1 -1
- data/lib/zyphr/models/device.rb +1 -1
- data/lib/zyphr/models/device_list_response.rb +1 -1
- data/lib/zyphr/models/device_push_topic.rb +1 -1
- data/lib/zyphr/models/device_push_topic_list_response.rb +1 -1
- data/lib/zyphr/models/device_push_topic_list_response_meta.rb +1 -1
- data/lib/zyphr/models/device_response.rb +1 -1
- data/lib/zyphr/models/device_stats.rb +1 -1
- data/lib/zyphr/models/device_stats_response.rb +1 -1
- data/lib/zyphr/models/dns_record.rb +1 -1
- data/lib/zyphr/models/domain_list_response.rb +1 -1
- data/lib/zyphr/models/domain_list_response_meta.rb +1 -1
- data/lib/zyphr/models/domain_response.rb +1 -1
- data/lib/zyphr/models/email_address.rb +1 -1
- data/lib/zyphr/models/email_attachment.rb +1 -1
- data/lib/zyphr/models/email_event.rb +1 -1
- data/lib/zyphr/models/email_events_response.rb +1 -1
- data/lib/zyphr/models/email_list_response.rb +1 -1
- data/lib/zyphr/models/email_message.rb +1 -1
- data/lib/zyphr/models/email_response.rb +1 -1
- data/lib/zyphr/models/email_tracking_click_link.rb +1 -1
- data/lib/zyphr/models/email_tracking_clicks.rb +1 -1
- data/lib/zyphr/models/email_tracking_data.rb +1 -1
- data/lib/zyphr/models/email_tracking_opens.rb +1 -1
- data/lib/zyphr/models/email_tracking_response.rb +1 -1
- data/lib/zyphr/models/end_user_delete_response.rb +1 -1
- data/lib/zyphr/models/end_user_delete_response_data.rb +1 -1
- data/lib/zyphr/models/execution_cancel_response.rb +1 -1
- data/lib/zyphr/models/execution_cancel_response_data.rb +1 -1
- data/lib/zyphr/models/execution_response.rb +1 -1
- data/lib/zyphr/models/execution_retry_response.rb +1 -1
- data/lib/zyphr/models/execution_retry_response_data.rb +1 -1
- data/lib/zyphr/models/forgot_password_request.rb +1 -1
- data/lib/zyphr/models/generate_subscriber_token200_response.rb +1 -1
- data/lib/zyphr/models/generate_subscriber_token200_response_data.rb +1 -1
- data/lib/zyphr/models/generate_subscriber_token_request.rb +1 -1
- data/lib/zyphr/models/generate_waa_s_portal_token201_response.rb +1 -1
- data/lib/zyphr/models/get_domain200_response.rb +1 -1
- data/lib/zyphr/models/get_domain200_response_meta.rb +1 -1
- data/lib/zyphr/models/get_waa_s_endpoint200_response.rb +1 -1
- data/lib/zyphr/models/get_waa_s_usage200_response.rb +1 -1
- data/lib/zyphr/models/in_app_notification.rb +1 -1
- data/lib/zyphr/models/inbound_attachment_url_response.rb +1 -1
- data/lib/zyphr/models/inbound_attachment_url_response_data.rb +1 -1
- data/lib/zyphr/models/inbound_email.rb +1 -1
- data/lib/zyphr/models/inbound_email_attachment.rb +1 -1
- data/lib/zyphr/models/inbound_email_from.rb +1 -1
- data/lib/zyphr/models/inbound_email_list_response.rb +1 -1
- data/lib/zyphr/models/inbound_email_list_response_meta.rb +1 -1
- data/lib/zyphr/models/inbound_email_response.rb +1 -1
- data/lib/zyphr/models/inbox_list_meta.rb +1 -1
- data/lib/zyphr/models/inbox_list_response.rb +1 -1
- data/lib/zyphr/models/inbox_notification_response.rb +1 -1
- data/lib/zyphr/models/invite_end_user_request.rb +309 -0
- data/lib/zyphr/models/list_waa_s_applications200_response.rb +1 -1
- data/lib/zyphr/models/list_waa_s_endpoint_deliveries200_response.rb +1 -1
- data/lib/zyphr/models/list_waa_s_endpoints200_response.rb +1 -1
- data/lib/zyphr/models/list_waa_s_event_types200_response.rb +1 -1
- data/lib/zyphr/models/login_request.rb +1 -1
- data/lib/zyphr/models/magic_link_send_request.rb +1 -1
- data/lib/zyphr/models/magic_link_verify_request.rb +1 -1
- data/lib/zyphr/models/magic_link_verify_response.rb +1 -1
- data/lib/zyphr/models/magic_link_verify_response_data.rb +1 -1
- data/lib/zyphr/models/mark_all_inbox_read_request.rb +1 -1
- data/lib/zyphr/models/mark_all_read_data.rb +1 -1
- data/lib/zyphr/models/mark_all_read_response.rb +1 -1
- data/lib/zyphr/models/mark_all_subscriber_notifications_read_request.rb +1 -1
- data/lib/zyphr/models/mark_inbox_read_request.rb +1 -1
- data/lib/zyphr/models/mfa_backup_codes_response.rb +1 -1
- data/lib/zyphr/models/mfa_backup_codes_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_disable_request.rb +1 -1
- data/lib/zyphr/models/mfa_disable_response.rb +1 -1
- data/lib/zyphr/models/mfa_disable_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_enroll_request.rb +1 -1
- data/lib/zyphr/models/mfa_enrollment_response.rb +1 -1
- data/lib/zyphr/models/mfa_enrollment_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_regenerate_backup_codes_request.rb +1 -1
- data/lib/zyphr/models/mfa_status_response.rb +1 -1
- data/lib/zyphr/models/mfa_status_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_verify_backup_request.rb +1 -1
- data/lib/zyphr/models/mfa_verify_backup_response.rb +1 -1
- data/lib/zyphr/models/mfa_verify_backup_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_verify_enrollment_request.rb +1 -1
- data/lib/zyphr/models/mfa_verify_enrollment_response.rb +1 -1
- data/lib/zyphr/models/mfa_verify_enrollment_response_data.rb +1 -1
- data/lib/zyphr/models/mfa_verify_request.rb +1 -1
- data/lib/zyphr/models/o_auth_authorization_url_response.rb +1 -1
- data/lib/zyphr/models/o_auth_authorization_url_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_callback_request.rb +1 -1
- data/lib/zyphr/models/o_auth_callback_response.rb +1 -1
- data/lib/zyphr/models/o_auth_callback_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_connection.rb +1 -1
- data/lib/zyphr/models/o_auth_connection_info_response.rb +1 -1
- data/lib/zyphr/models/o_auth_connection_info_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_connections_response.rb +1 -1
- data/lib/zyphr/models/o_auth_connections_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_provider.rb +1 -1
- data/lib/zyphr/models/o_auth_provider_info.rb +1 -1
- data/lib/zyphr/models/o_auth_provider_name.rb +43 -0
- data/lib/zyphr/models/o_auth_providers_response.rb +1 -1
- data/lib/zyphr/models/o_auth_providers_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_tokens_refresh_response.rb +1 -1
- data/lib/zyphr/models/o_auth_tokens_refresh_response_data.rb +1 -1
- data/lib/zyphr/models/o_auth_tokens_response.rb +1 -1
- data/lib/zyphr/models/o_auth_tokens_response_data.rb +1 -1
- data/lib/zyphr/models/organization.rb +1 -1
- data/lib/zyphr/models/organization_list_response.rb +1 -1
- data/lib/zyphr/models/organization_list_response_meta.rb +1 -1
- data/lib/zyphr/models/organization_members_list_response.rb +1 -1
- data/lib/zyphr/models/organization_membership.rb +1 -1
- data/lib/zyphr/models/organization_membership_response.rb +1 -1
- data/lib/zyphr/models/organization_membership_with_user.rb +1 -1
- data/lib/zyphr/models/organization_response.rb +1 -1
- data/lib/zyphr/models/pagination_meta.rb +1 -1
- data/lib/zyphr/models/password_requirements.rb +1 -1
- data/lib/zyphr/models/password_requirements_response.rb +1 -1
- data/lib/zyphr/models/password_requirements_response_data.rb +1 -1
- data/lib/zyphr/models/payload_too_large_error.rb +1 -1
- data/lib/zyphr/models/payload_too_large_error_error.rb +1 -1
- data/lib/zyphr/models/payload_too_large_error_error_details.rb +1 -1
- data/lib/zyphr/models/phone_auth_availability_response.rb +1 -1
- data/lib/zyphr/models/phone_auth_availability_response_data.rb +1 -1
- data/lib/zyphr/models/phone_login_verify_request.rb +1 -1
- data/lib/zyphr/models/phone_otp_send_request.rb +1 -1
- data/lib/zyphr/models/phone_otp_sent_response.rb +1 -1
- data/lib/zyphr/models/phone_otp_sent_response_data.rb +1 -1
- data/lib/zyphr/models/phone_register_verify_request.rb +1 -1
- data/lib/zyphr/models/preference_list_response.rb +1 -1
- data/lib/zyphr/models/publish_waa_s_event201_response.rb +1 -1
- data/lib/zyphr/models/push_detail_response.rb +1 -1
- data/lib/zyphr/models/push_event.rb +1 -1
- data/lib/zyphr/models/push_list_response.rb +1 -1
- data/lib/zyphr/models/push_message.rb +1 -1
- data/lib/zyphr/models/push_message_detail.rb +1 -1
- data/lib/zyphr/models/push_message_detail_all_of_action_buttons.rb +1 -1
- data/lib/zyphr/models/push_stats_data.rb +1 -1
- data/lib/zyphr/models/push_stats_response.rb +1 -1
- data/lib/zyphr/models/push_topic_device.rb +1 -1
- data/lib/zyphr/models/push_topic_device_list_response.rb +1 -1
- data/lib/zyphr/models/push_topic_subscribe_data.rb +1 -1
- data/lib/zyphr/models/push_topic_subscribe_response.rb +1 -1
- data/lib/zyphr/models/push_topic_unsubscribe_data.rb +1 -1
- data/lib/zyphr/models/push_topic_unsubscribe_response.rb +1 -1
- data/lib/zyphr/models/refresh_o_auth_tokens_request.rb +1 -1
- data/lib/zyphr/models/refresh_session_request.rb +1 -1
- data/lib/zyphr/models/refresh_token_response.rb +1 -1
- data/lib/zyphr/models/refresh_token_response_data.rb +1 -1
- data/lib/zyphr/models/register_device_request.rb +1 -1
- data/lib/zyphr/models/register_request.rb +1 -1
- data/lib/zyphr/models/remove_topic_subscribers_request.rb +1 -1
- data/lib/zyphr/models/rename_web_authn_credential_request.rb +1 -1
- data/lib/zyphr/models/render_template_request.rb +1 -1
- data/lib/zyphr/models/replay_webhook_events_request.rb +1 -1
- data/lib/zyphr/models/request_meta.rb +1 -1
- data/lib/zyphr/models/reset_password_request.rb +1 -1
- data/lib/zyphr/models/reset_password_response.rb +1 -1
- data/lib/zyphr/models/resubscribe_request.rb +1 -1
- data/lib/zyphr/models/resubscribe_response.rb +1 -1
- data/lib/zyphr/models/revoke_all_sessions_response.rb +1 -1
- data/lib/zyphr/models/revoke_all_sessions_response_data.rb +1 -1
- data/lib/zyphr/models/revoke_session_request.rb +1 -1
- data/lib/zyphr/models/send_batch_email_request.rb +1 -1
- data/lib/zyphr/models/send_batch_email_response.rb +1 -1
- data/lib/zyphr/models/send_batch_email_result.rb +1 -1
- data/lib/zyphr/models/send_batch_email_result_item.rb +1 -1
- data/lib/zyphr/models/send_batch_in_app_meta.rb +1 -1
- data/lib/zyphr/models/send_batch_in_app_request.rb +1 -1
- data/lib/zyphr/models/send_batch_in_app_response.rb +1 -1
- data/lib/zyphr/models/send_batch_sms_data.rb +1 -1
- data/lib/zyphr/models/send_batch_sms_request.rb +1 -1
- data/lib/zyphr/models/send_batch_sms_response.rb +1 -1
- data/lib/zyphr/models/send_email_otp_registration_request.rb +1 -1
- data/lib/zyphr/models/send_email_request.rb +1 -1
- data/lib/zyphr/models/send_email_response.rb +1 -1
- data/lib/zyphr/models/send_email_response_data.rb +1 -1
- data/lib/zyphr/models/send_email_response_meta.rb +1 -1
- data/lib/zyphr/models/send_email_verification_request.rb +1 -1
- data/lib/zyphr/models/send_in_app_meta.rb +1 -1
- data/lib/zyphr/models/send_in_app_request.rb +1 -1
- data/lib/zyphr/models/send_in_app_response.rb +1 -1
- data/lib/zyphr/models/send_push_request.rb +1 -1
- data/lib/zyphr/models/send_push_request_action_buttons_inner.rb +1 -1
- data/lib/zyphr/models/send_push_response.rb +1 -1
- data/lib/zyphr/models/send_push_response_data.rb +1 -1
- data/lib/zyphr/models/send_push_to_topic_data.rb +1 -1
- data/lib/zyphr/models/send_push_to_topic_request.rb +1 -1
- data/lib/zyphr/models/send_push_to_topic_response.rb +1 -1
- data/lib/zyphr/models/send_slack_message_request.rb +1 -1
- data/lib/zyphr/models/send_slack_message_response.rb +1 -1
- data/lib/zyphr/models/send_slack_message_result.rb +1 -1
- data/lib/zyphr/models/send_sms_data.rb +1 -1
- data/lib/zyphr/models/send_sms_request.rb +1 -1
- data/lib/zyphr/models/send_sms_response.rb +1 -1
- data/lib/zyphr/models/send_template_test_email_request.rb +248 -0
- data/lib/zyphr/models/send_test_sms_data.rb +1 -1
- data/lib/zyphr/models/send_test_sms_request.rb +1 -1
- data/lib/zyphr/models/send_test_sms_response.rb +1 -1
- data/lib/zyphr/models/send_webhook_test_event_request.rb +1 -1
- data/lib/zyphr/models/session_list_response.rb +1 -1
- data/lib/zyphr/models/session_list_response_data.rb +1 -1
- data/lib/zyphr/models/session_list_response_data_session_info.rb +1 -1
- data/lib/zyphr/models/set_domain_inbound_request.rb +1 -1
- data/lib/zyphr/models/set_end_user_claims_request.rb +220 -0
- data/lib/zyphr/models/set_preferences_request.rb +1 -1
- data/lib/zyphr/models/set_preferences_request_preferences_inner.rb +1 -1
- data/lib/zyphr/models/sign_in_anonymously_request.rb +44 -5
- data/lib/zyphr/models/sign_in_with_game_center_request.rb +373 -0
- data/lib/zyphr/models/slack_message.rb +1 -1
- data/lib/zyphr/models/slack_message_list_response.rb +1 -1
- data/lib/zyphr/models/slack_message_list_response_meta.rb +1 -1
- data/lib/zyphr/models/slack_message_response.rb +1 -1
- data/lib/zyphr/models/slack_message_status.rb +1 -1
- data/lib/zyphr/models/slack_message_summary.rb +1 -1
- data/lib/zyphr/models/sms_batch_result_message.rb +1 -1
- data/lib/zyphr/models/sms_batch_result_summary.rb +1 -1
- data/lib/zyphr/models/sms_config.rb +1 -1
- data/lib/zyphr/models/sms_config_delete_response.rb +1 -1
- data/lib/zyphr/models/sms_config_delete_response_data.rb +1 -1
- data/lib/zyphr/models/sms_config_response.rb +1 -1
- data/lib/zyphr/models/sms_detail_response.rb +1 -1
- data/lib/zyphr/models/sms_list_response.rb +1 -1
- data/lib/zyphr/models/sms_list_response_meta.rb +1 -1
- data/lib/zyphr/models/sms_message.rb +1 -1
- data/lib/zyphr/models/sms_message_detail.rb +1 -1
- data/lib/zyphr/models/subscribe_push_topic_request.rb +1 -1
- data/lib/zyphr/models/subscriber.rb +1 -1
- data/lib/zyphr/models/subscriber_list_response.rb +1 -1
- data/lib/zyphr/models/subscriber_preference.rb +1 -1
- data/lib/zyphr/models/subscriber_response.rb +1 -1
- data/lib/zyphr/models/success_result.rb +1 -1
- data/lib/zyphr/models/switch_organization_request.rb +1 -1
- data/lib/zyphr/models/switch_organization_response.rb +1 -1
- data/lib/zyphr/models/switch_organization_response_data.rb +1 -1
- data/lib/zyphr/models/switch_organization_response_data_tokens.rb +1 -1
- data/lib/zyphr/models/switch_organization_response_data_user.rb +1 -1
- data/lib/zyphr/models/template.rb +1 -1
- data/lib/zyphr/models/template_list_response.rb +1 -1
- data/lib/zyphr/models/template_render_response.rb +1 -1
- data/lib/zyphr/models/template_rendered_content.rb +1 -1
- data/lib/zyphr/models/template_response.rb +1 -1
- data/lib/zyphr/models/test_webhook_transform_request.rb +1 -1
- data/lib/zyphr/models/topic.rb +1 -1
- data/lib/zyphr/models/topic_delete_response.rb +1 -1
- data/lib/zyphr/models/topic_delete_response_data.rb +1 -1
- data/lib/zyphr/models/topic_list_response.rb +1 -1
- data/lib/zyphr/models/topic_response.rb +1 -1
- data/lib/zyphr/models/topic_stats_data.rb +1 -1
- data/lib/zyphr/models/topic_stats_data_topics_by_subscriber_count_inner.rb +1 -1
- data/lib/zyphr/models/topic_stats_response.rb +1 -1
- data/lib/zyphr/models/topic_subscriber.rb +1 -1
- data/lib/zyphr/models/topic_subscriber_list_response.rb +1 -1
- data/lib/zyphr/models/topic_subscribers_add_response.rb +1 -1
- data/lib/zyphr/models/topic_subscribers_add_result.rb +1 -1
- data/lib/zyphr/models/topic_subscribers_remove_response.rb +1 -1
- data/lib/zyphr/models/topic_subscribers_remove_result.rb +1 -1
- data/lib/zyphr/models/unread_count_data.rb +1 -1
- data/lib/zyphr/models/unread_count_response.rb +1 -1
- data/lib/zyphr/models/unsubscribe.rb +1 -1
- data/lib/zyphr/models/unsubscribe_list_response.rb +1 -1
- data/lib/zyphr/models/unsubscribe_request.rb +1 -1
- data/lib/zyphr/models/unsubscribe_response.rb +1 -1
- data/lib/zyphr/models/update_category_request.rb +1 -1
- data/lib/zyphr/models/update_end_user_by_application_request.rb +256 -0
- data/lib/zyphr/models/update_end_user_request.rb +1 -1
- data/lib/zyphr/models/update_organization_member_role_request.rb +1 -1
- data/lib/zyphr/models/update_organization_request.rb +1 -1
- data/lib/zyphr/models/update_subscriber_preferences_request.rb +1 -1
- data/lib/zyphr/models/update_subscriber_preferences_request_preferences_inner.rb +1 -1
- data/lib/zyphr/models/update_subscriber_request.rb +1 -1
- data/lib/zyphr/models/update_template_request.rb +1 -1
- data/lib/zyphr/models/update_topic_request.rb +1 -1
- data/lib/zyphr/models/update_waa_s_application_request.rb +1 -1
- data/lib/zyphr/models/update_waa_s_endpoint_request.rb +1 -1
- data/lib/zyphr/models/update_waa_s_event_type_request.rb +1 -1
- data/lib/zyphr/models/update_webhook_request.rb +1 -1
- data/lib/zyphr/models/upsert_auth_email_template_request.rb +1 -1
- data/lib/zyphr/models/upsert_sms_config_request.rb +1 -1
- data/lib/zyphr/models/user_devices_delete_response.rb +1 -1
- data/lib/zyphr/models/user_devices_delete_response_data.rb +1 -1
- data/lib/zyphr/models/v1_muse_subjects_suggest_post_request.rb +1 -1
- data/lib/zyphr/models/validate_reset_token_request.rb +1 -1
- data/lib/zyphr/models/validate_reset_token_response.rb +1 -1
- data/lib/zyphr/models/validate_reset_token_response_data.rb +1 -1
- data/lib/zyphr/models/verification_status_response.rb +1 -1
- data/lib/zyphr/models/verification_status_response_data.rb +1 -1
- data/lib/zyphr/models/verify_domain_response.rb +1 -1
- data/lib/zyphr/models/verify_domain_response_data.rb +1 -1
- data/lib/zyphr/models/verify_email_otp_login_request.rb +1 -1
- data/lib/zyphr/models/verify_email_otp_registration_request.rb +1 -1
- data/lib/zyphr/models/verify_sms_config_data.rb +1 -1
- data/lib/zyphr/models/verify_sms_config_response.rb +1 -1
- data/lib/zyphr/models/waa_s_application.rb +1 -1
- data/lib/zyphr/models/waa_s_batch_publish_request.rb +1 -1
- data/lib/zyphr/models/waa_s_batch_publish_response.rb +1 -1
- data/lib/zyphr/models/waa_s_delivery.rb +1 -1
- data/lib/zyphr/models/waa_s_endpoint.rb +1 -1
- data/lib/zyphr/models/waa_s_event_type.rb +1 -1
- data/lib/zyphr/models/waa_s_portal_token_request.rb +1 -1
- data/lib/zyphr/models/waa_s_portal_token_request_theme.rb +1 -1
- data/lib/zyphr/models/waa_s_portal_token_response.rb +1 -1
- data/lib/zyphr/models/waa_s_publish_event_request.rb +1 -1
- data/lib/zyphr/models/waa_s_publish_event_response.rb +1 -1
- data/lib/zyphr/models/waa_s_usage_response.rb +1 -1
- data/lib/zyphr/models/web_authn_challenge_options.rb +1 -1
- data/lib/zyphr/models/web_authn_credential.rb +1 -1
- data/lib/zyphr/models/web_authn_credential_list_response.rb +1 -1
- data/lib/zyphr/models/web_authn_credential_list_response_data.rb +1 -1
- data/lib/zyphr/models/web_authn_credential_response.rb +1 -1
- data/lib/zyphr/models/web_authn_start_auth_request.rb +1 -1
- data/lib/zyphr/models/web_authn_start_auth_response.rb +1 -1
- data/lib/zyphr/models/web_authn_start_registration_request.rb +1 -1
- data/lib/zyphr/models/web_authn_start_registration_response.rb +1 -1
- data/lib/zyphr/models/web_authn_status_response.rb +1 -1
- data/lib/zyphr/models/web_authn_status_response_data.rb +1 -1
- data/lib/zyphr/models/web_authn_verify_auth_request.rb +1 -1
- data/lib/zyphr/models/web_authn_verify_registration_request.rb +1 -1
- data/lib/zyphr/models/web_authn_verify_registration_response.rb +1 -1
- data/lib/zyphr/models/web_authn_verify_registration_response_data.rb +1 -1
- data/lib/zyphr/models/webhook.rb +1 -1
- data/lib/zyphr/models/webhook_account_metrics_response.rb +1 -1
- data/lib/zyphr/models/webhook_bulk_retry_response.rb +1 -1
- data/lib/zyphr/models/webhook_circuit_state.rb +1 -1
- data/lib/zyphr/models/webhook_circuit_state_response.rb +1 -1
- data/lib/zyphr/models/webhook_create_response.rb +1 -1
- data/lib/zyphr/models/webhook_create_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_delete_response.rb +1 -1
- data/lib/zyphr/models/webhook_delete_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_delivery.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_detail.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_list_response.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_response.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_retry_response.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_retry_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_event_types_response.rb +1 -1
- data/lib/zyphr/models/webhook_event_types_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_ips_response.rb +1 -1
- data/lib/zyphr/models/webhook_ips_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_job_response.rb +1 -1
- data/lib/zyphr/models/webhook_list_response.rb +1 -1
- data/lib/zyphr/models/webhook_metrics_response.rb +1 -1
- data/lib/zyphr/models/webhook_region.rb +1 -1
- data/lib/zyphr/models/webhook_regions_response.rb +1 -1
- data/lib/zyphr/models/webhook_regions_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_replay_response.rb +1 -1
- data/lib/zyphr/models/webhook_response.rb +1 -1
- data/lib/zyphr/models/webhook_secret_rotate_response.rb +1 -1
- data/lib/zyphr/models/webhook_secret_rotate_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_test_event_response.rb +1 -1
- data/lib/zyphr/models/webhook_test_event_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_transform_test_response.rb +1 -1
- data/lib/zyphr/models/webhook_usage_response.rb +1 -1
- data/lib/zyphr/models/webhook_version.rb +1 -1
- data/lib/zyphr/models/webhook_versions_response.rb +1 -1
- data/lib/zyphr/models/webhook_versions_response_data.rb +1 -1
- data/lib/zyphr/models/withdraw_subscriber_consent_request.rb +1 -1
- data/lib/zyphr/models/workflow_execution.rb +1 -1
- data/lib/zyphr/models/workflow_execution_status.rb +1 -1
- data/lib/zyphr/models/workflow_step_execution.rb +1 -1
- data/lib/zyphr/models/workflow_step_execution_status.rb +1 -1
- data/lib/zyphr/version.rb +1 -1
- data/lib/zyphr.rb +8 -1
- data/spec/api/auth_email_otp_api_spec.rb +1 -1
- data/spec/api/auth_email_templates_api_spec.rb +1 -1
- data/spec/api/auth_email_verification_api_spec.rb +1 -1
- data/spec/api/auth_login_api_spec.rb +1 -1
- data/spec/api/auth_magic_links_api_spec.rb +1 -1
- data/spec/api/auth_mfa_api_spec.rb +1 -1
- data/spec/api/auth_o_auth_api_spec.rb +1 -1
- data/spec/api/auth_organizations_api_spec.rb +1 -1
- data/spec/api/auth_password_reset_api_spec.rb +1 -1
- data/spec/api/auth_phone_api_spec.rb +1 -1
- data/spec/api/auth_registration_api_spec.rb +14 -2
- data/spec/api/auth_sessions_api_spec.rb +1 -1
- data/spec/api/auth_user_directory_api_spec.rb +136 -0
- data/spec/api/auth_user_profile_api_spec.rb +1 -13
- data/spec/api/auth_web_authn_api_spec.rb +1 -1
- data/spec/api/devices_api_spec.rb +1 -1
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/emails_api_spec.rb +1 -1
- data/spec/api/executions_api_spec.rb +1 -1
- data/spec/api/inbound_email_api_spec.rb +1 -1
- data/spec/api/inbox_api_spec.rb +1 -1
- data/spec/api/muse_api_spec.rb +1 -1
- data/spec/api/push_api_spec.rb +1 -1
- data/spec/api/slack_api_spec.rb +1 -1
- data/spec/api/sms_api_spec.rb +1 -1
- data/spec/api/subscribers_api_spec.rb +1 -1
- data/spec/api/templates_api_spec.rb +14 -1
- data/spec/api/topics_api_spec.rb +1 -1
- data/spec/api/utility_api_spec.rb +1 -1
- data/spec/api/waa_s_applications_api_spec.rb +1 -1
- data/spec/api/waa_s_deliveries_api_spec.rb +1 -1
- data/spec/api/waa_s_endpoints_api_spec.rb +1 -1
- data/spec/api/waa_s_event_types_api_spec.rb +1 -1
- data/spec/api/waa_s_events_api_spec.rb +1 -1
- data/spec/api/waa_s_portal_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/add_domain200_response_meta_spec.rb +1 -1
- data/spec/models/add_domain200_response_spec.rb +1 -1
- data/spec/models/add_domain_request_spec.rb +1 -1
- data/spec/models/add_organization_member_request_spec.rb +1 -1
- data/spec/models/add_topic_subscribers_request_spec.rb +1 -1
- data/spec/models/api_error_error_spec.rb +1 -1
- data/spec/models/api_error_meta_spec.rb +1 -1
- data/spec/models/api_error_spec.rb +1 -1
- data/spec/models/auth_email_template_default_response_spec.rb +1 -1
- data/spec/models/auth_email_template_default_spec.rb +1 -1
- data/spec/models/auth_email_template_delete_response_data_spec.rb +1 -1
- data/spec/models/auth_email_template_delete_response_spec.rb +1 -1
- data/spec/models/auth_email_template_list_response_spec.rb +1 -1
- data/spec/models/auth_email_template_preview_draft_spec.rb +1 -1
- data/spec/models/auth_email_template_preview_request_spec.rb +1 -1
- data/spec/models/auth_email_template_preview_response_spec.rb +1 -1
- data/spec/models/auth_email_template_preview_result_spec.rb +1 -1
- data/spec/models/auth_email_template_response_spec.rb +1 -1
- data/spec/models/auth_email_template_spec.rb +1 -1
- data/spec/models/auth_email_template_test_request_spec.rb +1 -1
- data/spec/models/auth_email_template_test_response_spec.rb +1 -1
- data/spec/models/auth_email_template_test_result_spec.rb +1 -1
- data/spec/models/auth_email_template_version_spec.rb +1 -1
- data/spec/models/auth_email_template_versions_response_spec.rb +1 -1
- data/spec/models/auth_email_type_spec.rb +1 -1
- data/spec/models/auth_login_response_spec.rb +1 -1
- data/spec/models/auth_login_result_mfa_challenge_spec.rb +1 -1
- data/spec/models/auth_login_result_spec.rb +1 -1
- data/spec/models/auth_result_response_spec.rb +1 -1
- data/spec/models/auth_result_spec.rb +1 -1
- data/spec/models/auth_session_spec.rb +1 -1
- data/spec/models/auth_tokens_spec.rb +1 -1
- data/spec/models/auth_user_response_data_spec.rb +1 -1
- data/spec/models/auth_user_response_spec.rb +1 -1
- data/spec/models/auth_user_spec.rb +1 -1
- data/spec/models/batch_publish_waa_s_events201_response_spec.rb +1 -1
- data/spec/models/batch_recipient_spec.rb +1 -1
- data/spec/models/bulk_retry_webhook_deliveries_request_spec.rb +1 -1
- data/spec/models/bulk_upsert_auth_email_templates_request_spec.rb +1 -1
- data/spec/models/bulk_upsert_auth_email_templates_response_spec.rb +1 -1
- data/spec/models/category_list_response_spec.rb +1 -1
- data/spec/models/category_response_spec.rb +1 -1
- data/spec/models/category_spec.rb +1 -1
- data/spec/models/confirm_email_verification_request_spec.rb +1 -1
- data/spec/models/confirm_email_verification_response_data_spec.rb +1 -1
- data/spec/models/confirm_email_verification_response_spec.rb +1 -1
- data/spec/models/consent_history_entry_spec.rb +1 -1
- data/spec/models/consent_history_response_spec.rb +1 -1
- data/spec/models/consent_record_response_data_spec.rb +1 -1
- data/spec/models/consent_record_response_spec.rb +1 -1
- data/spec/models/consent_status_response_spec.rb +1 -1
- data/spec/models/consent_status_spec.rb +1 -1
- data/spec/models/consent_withdraw_response_spec.rb +1 -1
- data/spec/models/convert_anonymous_user_request_one_of1_apple_user_name_spec.rb +1 -1
- data/spec/models/convert_anonymous_user_request_one_of1_apple_user_spec.rb +1 -1
- data/spec/models/convert_anonymous_user_request_one_of1_spec.rb +1 -1
- data/spec/models/convert_anonymous_user_request_one_of_spec.rb +1 -1
- data/spec/models/convert_anonymous_user_request_spec.rb +1 -1
- data/spec/models/create_category_request_spec.rb +1 -1
- data/spec/models/create_organization_request_spec.rb +1 -1
- data/spec/models/create_subscriber_request_spec.rb +1 -1
- data/spec/models/create_template_request_spec.rb +1 -1
- data/spec/models/create_topic_request_spec.rb +1 -1
- data/spec/models/create_waa_s_application201_response_spec.rb +1 -1
- data/spec/models/create_waa_s_application_request_spec.rb +1 -1
- data/spec/models/create_waa_s_endpoint201_response_spec.rb +1 -1
- data/spec/models/create_waa_s_endpoint_request_spec.rb +1 -1
- data/spec/models/create_waa_s_endpoint_response_spec.rb +1 -1
- data/spec/models/create_waa_s_event_type201_response_spec.rb +1 -1
- data/spec/models/create_waa_s_event_type_request_spec.rb +1 -1
- data/spec/models/create_webhook_request_spec.rb +1 -1
- data/spec/models/delete_domain_response_data_spec.rb +1 -1
- data/spec/models/delete_domain_response_spec.rb +1 -1
- data/spec/models/delete_result_data_spec.rb +1 -1
- data/spec/models/delete_result_spec.rb +1 -1
- data/spec/models/device_list_response_spec.rb +1 -1
- data/spec/models/device_push_topic_list_response_meta_spec.rb +1 -1
- data/spec/models/device_push_topic_list_response_spec.rb +1 -1
- data/spec/models/device_push_topic_spec.rb +1 -1
- data/spec/models/device_response_spec.rb +1 -1
- data/spec/models/device_spec.rb +1 -1
- data/spec/models/device_stats_response_spec.rb +1 -1
- data/spec/models/device_stats_spec.rb +1 -1
- data/spec/models/dns_record_spec.rb +1 -1
- data/spec/models/domain_list_response_meta_spec.rb +1 -1
- data/spec/models/domain_list_response_spec.rb +1 -1
- data/spec/models/domain_response_spec.rb +1 -1
- data/spec/models/email_address_spec.rb +1 -1
- data/spec/models/email_attachment_spec.rb +1 -1
- data/spec/models/email_event_spec.rb +1 -1
- data/spec/models/email_events_response_spec.rb +1 -1
- data/spec/models/email_list_response_spec.rb +1 -1
- data/spec/models/email_message_spec.rb +1 -1
- data/spec/models/email_response_spec.rb +1 -1
- data/spec/models/email_tracking_click_link_spec.rb +1 -1
- data/spec/models/email_tracking_clicks_spec.rb +1 -1
- data/spec/models/email_tracking_data_spec.rb +1 -1
- data/spec/models/email_tracking_opens_spec.rb +1 -1
- data/spec/models/email_tracking_response_spec.rb +1 -1
- data/spec/models/end_user_delete_response_data_spec.rb +1 -1
- data/spec/models/end_user_delete_response_spec.rb +1 -1
- data/spec/models/execution_cancel_response_data_spec.rb +1 -1
- data/spec/models/execution_cancel_response_spec.rb +1 -1
- data/spec/models/execution_response_spec.rb +1 -1
- data/spec/models/execution_retry_response_data_spec.rb +1 -1
- data/spec/models/execution_retry_response_spec.rb +1 -1
- data/spec/models/forgot_password_request_spec.rb +1 -1
- data/spec/models/generate_subscriber_token200_response_data_spec.rb +1 -1
- data/spec/models/generate_subscriber_token200_response_spec.rb +1 -1
- data/spec/models/generate_subscriber_token_request_spec.rb +1 -1
- data/spec/models/generate_waa_s_portal_token201_response_spec.rb +1 -1
- data/spec/models/get_domain200_response_meta_spec.rb +1 -1
- data/spec/models/get_domain200_response_spec.rb +1 -1
- data/spec/models/get_waa_s_endpoint200_response_spec.rb +1 -1
- data/spec/models/get_waa_s_usage200_response_spec.rb +1 -1
- data/spec/models/in_app_notification_spec.rb +1 -1
- data/spec/models/inbound_attachment_url_response_data_spec.rb +1 -1
- data/spec/models/inbound_attachment_url_response_spec.rb +1 -1
- data/spec/models/inbound_email_attachment_spec.rb +1 -1
- data/spec/models/inbound_email_from_spec.rb +1 -1
- data/spec/models/inbound_email_list_response_meta_spec.rb +1 -1
- data/spec/models/inbound_email_list_response_spec.rb +1 -1
- data/spec/models/inbound_email_response_spec.rb +1 -1
- data/spec/models/inbound_email_spec.rb +1 -1
- data/spec/models/inbox_list_meta_spec.rb +1 -1
- data/spec/models/inbox_list_response_spec.rb +1 -1
- data/spec/models/inbox_notification_response_spec.rb +1 -1
- data/spec/models/invite_end_user_request_spec.rb +64 -0
- data/spec/models/list_waa_s_applications200_response_spec.rb +1 -1
- data/spec/models/list_waa_s_endpoint_deliveries200_response_spec.rb +1 -1
- data/spec/models/list_waa_s_endpoints200_response_spec.rb +1 -1
- data/spec/models/list_waa_s_event_types200_response_spec.rb +1 -1
- data/spec/models/login_request_spec.rb +1 -1
- data/spec/models/magic_link_send_request_spec.rb +1 -1
- data/spec/models/magic_link_verify_request_spec.rb +1 -1
- data/spec/models/magic_link_verify_response_data_spec.rb +1 -1
- data/spec/models/magic_link_verify_response_spec.rb +1 -1
- data/spec/models/mark_all_inbox_read_request_spec.rb +1 -1
- data/spec/models/mark_all_read_data_spec.rb +1 -1
- data/spec/models/mark_all_read_response_spec.rb +1 -1
- data/spec/models/mark_all_subscriber_notifications_read_request_spec.rb +1 -1
- data/spec/models/mark_inbox_read_request_spec.rb +1 -1
- data/spec/models/mfa_backup_codes_response_data_spec.rb +1 -1
- data/spec/models/mfa_backup_codes_response_spec.rb +1 -1
- data/spec/models/mfa_disable_request_spec.rb +1 -1
- data/spec/models/mfa_disable_response_data_spec.rb +1 -1
- data/spec/models/mfa_disable_response_spec.rb +1 -1
- data/spec/models/mfa_enroll_request_spec.rb +1 -1
- data/spec/models/mfa_enrollment_response_data_spec.rb +1 -1
- data/spec/models/mfa_enrollment_response_spec.rb +1 -1
- data/spec/models/mfa_regenerate_backup_codes_request_spec.rb +1 -1
- data/spec/models/mfa_status_response_data_spec.rb +1 -1
- data/spec/models/mfa_status_response_spec.rb +1 -1
- data/spec/models/mfa_verify_backup_request_spec.rb +1 -1
- data/spec/models/mfa_verify_backup_response_data_spec.rb +1 -1
- data/spec/models/mfa_verify_backup_response_spec.rb +1 -1
- data/spec/models/mfa_verify_enrollment_request_spec.rb +1 -1
- data/spec/models/mfa_verify_enrollment_response_data_spec.rb +1 -1
- data/spec/models/mfa_verify_enrollment_response_spec.rb +1 -1
- data/spec/models/mfa_verify_request_spec.rb +1 -1
- data/spec/models/o_auth_authorization_url_response_data_spec.rb +1 -1
- data/spec/models/o_auth_authorization_url_response_spec.rb +1 -1
- data/spec/models/o_auth_callback_request_spec.rb +1 -1
- data/spec/models/o_auth_callback_response_data_spec.rb +1 -1
- data/spec/models/o_auth_callback_response_spec.rb +1 -1
- data/spec/models/o_auth_connection_info_response_data_spec.rb +1 -1
- data/spec/models/o_auth_connection_info_response_spec.rb +1 -1
- data/spec/models/o_auth_connection_spec.rb +1 -1
- data/spec/models/o_auth_connections_response_data_spec.rb +1 -1
- data/spec/models/o_auth_connections_response_spec.rb +1 -1
- data/spec/models/o_auth_provider_info_spec.rb +1 -1
- data/spec/models/o_auth_provider_name_spec.rb +30 -0
- data/spec/models/o_auth_provider_spec.rb +1 -1
- data/spec/models/o_auth_providers_response_data_spec.rb +1 -1
- data/spec/models/o_auth_providers_response_spec.rb +1 -1
- data/spec/models/o_auth_tokens_refresh_response_data_spec.rb +1 -1
- data/spec/models/o_auth_tokens_refresh_response_spec.rb +1 -1
- data/spec/models/o_auth_tokens_response_data_spec.rb +1 -1
- data/spec/models/o_auth_tokens_response_spec.rb +1 -1
- data/spec/models/organization_list_response_meta_spec.rb +1 -1
- data/spec/models/organization_list_response_spec.rb +1 -1
- data/spec/models/organization_members_list_response_spec.rb +1 -1
- data/spec/models/organization_membership_response_spec.rb +1 -1
- data/spec/models/organization_membership_spec.rb +1 -1
- data/spec/models/organization_membership_with_user_spec.rb +1 -1
- data/spec/models/organization_response_spec.rb +1 -1
- data/spec/models/organization_spec.rb +1 -1
- data/spec/models/pagination_meta_spec.rb +1 -1
- data/spec/models/password_requirements_response_data_spec.rb +1 -1
- data/spec/models/password_requirements_response_spec.rb +1 -1
- data/spec/models/password_requirements_spec.rb +1 -1
- data/spec/models/payload_too_large_error_error_details_spec.rb +1 -1
- data/spec/models/payload_too_large_error_error_spec.rb +1 -1
- data/spec/models/payload_too_large_error_spec.rb +1 -1
- data/spec/models/phone_auth_availability_response_data_spec.rb +1 -1
- data/spec/models/phone_auth_availability_response_spec.rb +1 -1
- data/spec/models/phone_login_verify_request_spec.rb +1 -1
- data/spec/models/phone_otp_send_request_spec.rb +1 -1
- data/spec/models/phone_otp_sent_response_data_spec.rb +1 -1
- data/spec/models/phone_otp_sent_response_spec.rb +1 -1
- data/spec/models/phone_register_verify_request_spec.rb +1 -1
- data/spec/models/preference_list_response_spec.rb +1 -1
- data/spec/models/publish_waa_s_event201_response_spec.rb +1 -1
- data/spec/models/push_detail_response_spec.rb +1 -1
- data/spec/models/push_event_spec.rb +1 -1
- data/spec/models/push_list_response_spec.rb +1 -1
- data/spec/models/push_message_detail_all_of_action_buttons_spec.rb +1 -1
- data/spec/models/push_message_detail_spec.rb +1 -1
- data/spec/models/push_message_spec.rb +1 -1
- data/spec/models/push_stats_data_spec.rb +1 -1
- data/spec/models/push_stats_response_spec.rb +1 -1
- data/spec/models/push_topic_device_list_response_spec.rb +1 -1
- data/spec/models/push_topic_device_spec.rb +1 -1
- data/spec/models/push_topic_subscribe_data_spec.rb +1 -1
- data/spec/models/push_topic_subscribe_response_spec.rb +1 -1
- data/spec/models/push_topic_unsubscribe_data_spec.rb +1 -1
- data/spec/models/push_topic_unsubscribe_response_spec.rb +1 -1
- data/spec/models/refresh_o_auth_tokens_request_spec.rb +1 -1
- data/spec/models/refresh_session_request_spec.rb +1 -1
- data/spec/models/refresh_token_response_data_spec.rb +1 -1
- data/spec/models/refresh_token_response_spec.rb +1 -1
- data/spec/models/register_device_request_spec.rb +1 -1
- data/spec/models/register_request_spec.rb +1 -1
- data/spec/models/remove_topic_subscribers_request_spec.rb +1 -1
- data/spec/models/rename_web_authn_credential_request_spec.rb +1 -1
- data/spec/models/render_template_request_spec.rb +1 -1
- data/spec/models/replay_webhook_events_request_spec.rb +1 -1
- data/spec/models/request_meta_spec.rb +1 -1
- data/spec/models/reset_password_request_spec.rb +1 -1
- data/spec/models/reset_password_response_spec.rb +1 -1
- data/spec/models/resubscribe_request_spec.rb +1 -1
- data/spec/models/resubscribe_response_spec.rb +1 -1
- data/spec/models/revoke_all_sessions_response_data_spec.rb +1 -1
- data/spec/models/revoke_all_sessions_response_spec.rb +1 -1
- data/spec/models/revoke_session_request_spec.rb +1 -1
- data/spec/models/send_batch_email_request_spec.rb +1 -1
- data/spec/models/send_batch_email_response_spec.rb +1 -1
- data/spec/models/send_batch_email_result_item_spec.rb +1 -1
- data/spec/models/send_batch_email_result_spec.rb +1 -1
- data/spec/models/send_batch_in_app_meta_spec.rb +1 -1
- data/spec/models/send_batch_in_app_request_spec.rb +1 -1
- data/spec/models/send_batch_in_app_response_spec.rb +1 -1
- data/spec/models/send_batch_sms_data_spec.rb +1 -1
- data/spec/models/send_batch_sms_request_spec.rb +1 -1
- data/spec/models/send_batch_sms_response_spec.rb +1 -1
- data/spec/models/send_email_otp_registration_request_spec.rb +1 -1
- data/spec/models/send_email_request_spec.rb +1 -1
- data/spec/models/send_email_response_data_spec.rb +1 -1
- data/spec/models/send_email_response_meta_spec.rb +1 -1
- data/spec/models/send_email_response_spec.rb +1 -1
- data/spec/models/send_email_verification_request_spec.rb +1 -1
- data/spec/models/send_in_app_meta_spec.rb +1 -1
- data/spec/models/send_in_app_request_spec.rb +1 -1
- data/spec/models/send_in_app_response_spec.rb +1 -1
- data/spec/models/send_push_request_action_buttons_inner_spec.rb +1 -1
- data/spec/models/send_push_request_spec.rb +1 -1
- data/spec/models/send_push_response_data_spec.rb +1 -1
- data/spec/models/send_push_response_spec.rb +1 -1
- data/spec/models/send_push_to_topic_data_spec.rb +1 -1
- data/spec/models/send_push_to_topic_request_spec.rb +1 -1
- data/spec/models/send_push_to_topic_response_spec.rb +1 -1
- data/spec/models/send_slack_message_request_spec.rb +1 -1
- data/spec/models/send_slack_message_response_spec.rb +1 -1
- data/spec/models/send_slack_message_result_spec.rb +1 -1
- data/spec/models/send_sms_data_spec.rb +1 -1
- data/spec/models/send_sms_request_spec.rb +1 -1
- data/spec/models/send_sms_response_spec.rb +1 -1
- data/spec/models/send_template_test_email_request_spec.rb +42 -0
- data/spec/models/send_test_sms_data_spec.rb +1 -1
- data/spec/models/send_test_sms_request_spec.rb +1 -1
- data/spec/models/send_test_sms_response_spec.rb +1 -1
- data/spec/models/send_webhook_test_event_request_spec.rb +1 -1
- data/spec/models/session_list_response_data_session_info_spec.rb +1 -1
- data/spec/models/session_list_response_data_spec.rb +1 -1
- data/spec/models/session_list_response_spec.rb +1 -1
- data/spec/models/set_domain_inbound_request_spec.rb +1 -1
- data/spec/models/set_end_user_claims_request_spec.rb +36 -0
- data/spec/models/set_preferences_request_preferences_inner_spec.rb +1 -1
- data/spec/models/set_preferences_request_spec.rb +1 -1
- data/spec/models/sign_in_anonymously_request_spec.rb +13 -1
- data/spec/models/sign_in_with_game_center_request_spec.rb +66 -0
- data/spec/models/slack_message_list_response_meta_spec.rb +1 -1
- data/spec/models/slack_message_list_response_spec.rb +1 -1
- data/spec/models/slack_message_response_spec.rb +1 -1
- data/spec/models/slack_message_spec.rb +1 -1
- data/spec/models/slack_message_status_spec.rb +1 -1
- data/spec/models/slack_message_summary_spec.rb +1 -1
- data/spec/models/sms_batch_result_message_spec.rb +1 -1
- data/spec/models/sms_batch_result_summary_spec.rb +1 -1
- data/spec/models/sms_config_delete_response_data_spec.rb +1 -1
- data/spec/models/sms_config_delete_response_spec.rb +1 -1
- data/spec/models/sms_config_response_spec.rb +1 -1
- data/spec/models/sms_config_spec.rb +1 -1
- data/spec/models/sms_detail_response_spec.rb +1 -1
- data/spec/models/sms_list_response_meta_spec.rb +1 -1
- data/spec/models/sms_list_response_spec.rb +1 -1
- data/spec/models/sms_message_detail_spec.rb +1 -1
- data/spec/models/sms_message_spec.rb +1 -1
- data/spec/models/subscribe_push_topic_request_spec.rb +1 -1
- data/spec/models/subscriber_list_response_spec.rb +1 -1
- data/spec/models/subscriber_preference_spec.rb +1 -1
- data/spec/models/subscriber_response_spec.rb +1 -1
- data/spec/models/subscriber_spec.rb +1 -1
- data/spec/models/success_result_spec.rb +1 -1
- data/spec/models/switch_organization_request_spec.rb +1 -1
- data/spec/models/switch_organization_response_data_spec.rb +1 -1
- data/spec/models/switch_organization_response_data_tokens_spec.rb +1 -1
- data/spec/models/switch_organization_response_data_user_spec.rb +1 -1
- data/spec/models/switch_organization_response_spec.rb +1 -1
- data/spec/models/template_list_response_spec.rb +1 -1
- data/spec/models/template_render_response_spec.rb +1 -1
- data/spec/models/template_rendered_content_spec.rb +1 -1
- data/spec/models/template_response_spec.rb +1 -1
- data/spec/models/template_spec.rb +1 -1
- data/spec/models/test_webhook_transform_request_spec.rb +1 -1
- data/spec/models/topic_delete_response_data_spec.rb +1 -1
- data/spec/models/topic_delete_response_spec.rb +1 -1
- data/spec/models/topic_list_response_spec.rb +1 -1
- data/spec/models/topic_response_spec.rb +1 -1
- data/spec/models/topic_spec.rb +1 -1
- data/spec/models/topic_stats_data_spec.rb +1 -1
- data/spec/models/topic_stats_data_topics_by_subscriber_count_inner_spec.rb +1 -1
- data/spec/models/topic_stats_response_spec.rb +1 -1
- data/spec/models/topic_subscriber_list_response_spec.rb +1 -1
- data/spec/models/topic_subscriber_spec.rb +1 -1
- data/spec/models/topic_subscribers_add_response_spec.rb +1 -1
- data/spec/models/topic_subscribers_add_result_spec.rb +1 -1
- data/spec/models/topic_subscribers_remove_response_spec.rb +1 -1
- data/spec/models/topic_subscribers_remove_result_spec.rb +1 -1
- data/spec/models/unread_count_data_spec.rb +1 -1
- data/spec/models/unread_count_response_spec.rb +1 -1
- data/spec/models/unsubscribe_list_response_spec.rb +1 -1
- data/spec/models/unsubscribe_request_spec.rb +1 -1
- data/spec/models/unsubscribe_response_spec.rb +1 -1
- data/spec/models/unsubscribe_spec.rb +1 -1
- data/spec/models/update_category_request_spec.rb +1 -1
- data/spec/models/update_end_user_by_application_request_spec.rb +60 -0
- data/spec/models/update_end_user_request_spec.rb +1 -1
- data/spec/models/update_organization_member_role_request_spec.rb +1 -1
- data/spec/models/update_organization_request_spec.rb +1 -1
- data/spec/models/update_subscriber_preferences_request_preferences_inner_spec.rb +1 -1
- data/spec/models/update_subscriber_preferences_request_spec.rb +1 -1
- data/spec/models/update_subscriber_request_spec.rb +1 -1
- data/spec/models/update_template_request_spec.rb +1 -1
- data/spec/models/update_topic_request_spec.rb +1 -1
- data/spec/models/update_waa_s_application_request_spec.rb +1 -1
- data/spec/models/update_waa_s_endpoint_request_spec.rb +1 -1
- data/spec/models/update_waa_s_event_type_request_spec.rb +1 -1
- data/spec/models/update_webhook_request_spec.rb +1 -1
- data/spec/models/upsert_auth_email_template_request_spec.rb +1 -1
- data/spec/models/upsert_sms_config_request_spec.rb +1 -1
- data/spec/models/user_devices_delete_response_data_spec.rb +1 -1
- data/spec/models/user_devices_delete_response_spec.rb +1 -1
- data/spec/models/v1_muse_subjects_suggest_post_request_spec.rb +1 -1
- data/spec/models/validate_reset_token_request_spec.rb +1 -1
- data/spec/models/validate_reset_token_response_data_spec.rb +1 -1
- data/spec/models/validate_reset_token_response_spec.rb +1 -1
- data/spec/models/verification_status_response_data_spec.rb +1 -1
- data/spec/models/verification_status_response_spec.rb +1 -1
- data/spec/models/verify_domain_response_data_spec.rb +1 -1
- data/spec/models/verify_domain_response_spec.rb +1 -1
- data/spec/models/verify_email_otp_login_request_spec.rb +1 -1
- data/spec/models/verify_email_otp_registration_request_spec.rb +1 -1
- data/spec/models/verify_sms_config_data_spec.rb +1 -1
- data/spec/models/verify_sms_config_response_spec.rb +1 -1
- data/spec/models/waa_s_application_spec.rb +1 -1
- data/spec/models/waa_s_batch_publish_request_spec.rb +1 -1
- data/spec/models/waa_s_batch_publish_response_spec.rb +1 -1
- data/spec/models/waa_s_delivery_spec.rb +1 -1
- data/spec/models/waa_s_endpoint_spec.rb +1 -1
- data/spec/models/waa_s_event_type_spec.rb +1 -1
- data/spec/models/waa_s_portal_token_request_spec.rb +1 -1
- data/spec/models/waa_s_portal_token_request_theme_spec.rb +1 -1
- data/spec/models/waa_s_portal_token_response_spec.rb +1 -1
- data/spec/models/waa_s_publish_event_request_spec.rb +1 -1
- data/spec/models/waa_s_publish_event_response_spec.rb +1 -1
- data/spec/models/waa_s_usage_response_spec.rb +1 -1
- data/spec/models/web_authn_challenge_options_spec.rb +1 -1
- data/spec/models/web_authn_credential_list_response_data_spec.rb +1 -1
- data/spec/models/web_authn_credential_list_response_spec.rb +1 -1
- data/spec/models/web_authn_credential_response_spec.rb +1 -1
- data/spec/models/web_authn_credential_spec.rb +1 -1
- data/spec/models/web_authn_start_auth_request_spec.rb +1 -1
- data/spec/models/web_authn_start_auth_response_spec.rb +1 -1
- data/spec/models/web_authn_start_registration_request_spec.rb +1 -1
- data/spec/models/web_authn_start_registration_response_spec.rb +1 -1
- data/spec/models/web_authn_status_response_data_spec.rb +1 -1
- data/spec/models/web_authn_status_response_spec.rb +1 -1
- data/spec/models/web_authn_verify_auth_request_spec.rb +1 -1
- data/spec/models/web_authn_verify_registration_request_spec.rb +1 -1
- data/spec/models/web_authn_verify_registration_response_data_spec.rb +1 -1
- data/spec/models/web_authn_verify_registration_response_spec.rb +1 -1
- data/spec/models/webhook_account_metrics_response_spec.rb +1 -1
- data/spec/models/webhook_bulk_retry_response_spec.rb +1 -1
- data/spec/models/webhook_circuit_state_response_spec.rb +1 -1
- data/spec/models/webhook_circuit_state_spec.rb +1 -1
- data/spec/models/webhook_create_response_data_spec.rb +1 -1
- data/spec/models/webhook_create_response_spec.rb +1 -1
- data/spec/models/webhook_delete_response_data_spec.rb +1 -1
- data/spec/models/webhook_delete_response_spec.rb +1 -1
- data/spec/models/webhook_delivery_detail_spec.rb +1 -1
- data/spec/models/webhook_delivery_list_response_spec.rb +1 -1
- data/spec/models/webhook_delivery_response_spec.rb +1 -1
- data/spec/models/webhook_delivery_retry_response_data_spec.rb +1 -1
- data/spec/models/webhook_delivery_retry_response_spec.rb +1 -1
- data/spec/models/webhook_delivery_spec.rb +1 -1
- data/spec/models/webhook_event_types_response_data_spec.rb +1 -1
- data/spec/models/webhook_event_types_response_spec.rb +1 -1
- data/spec/models/webhook_ips_response_data_spec.rb +1 -1
- data/spec/models/webhook_ips_response_spec.rb +1 -1
- data/spec/models/webhook_job_response_spec.rb +1 -1
- data/spec/models/webhook_list_response_spec.rb +1 -1
- data/spec/models/webhook_metrics_response_spec.rb +1 -1
- data/spec/models/webhook_region_spec.rb +1 -1
- data/spec/models/webhook_regions_response_data_spec.rb +1 -1
- data/spec/models/webhook_regions_response_spec.rb +1 -1
- data/spec/models/webhook_replay_response_spec.rb +1 -1
- data/spec/models/webhook_response_spec.rb +1 -1
- data/spec/models/webhook_secret_rotate_response_data_spec.rb +1 -1
- data/spec/models/webhook_secret_rotate_response_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhook_test_event_response_data_spec.rb +1 -1
- data/spec/models/webhook_test_event_response_spec.rb +1 -1
- data/spec/models/webhook_transform_test_response_spec.rb +1 -1
- data/spec/models/webhook_usage_response_spec.rb +1 -1
- data/spec/models/webhook_version_spec.rb +1 -1
- data/spec/models/webhook_versions_response_data_spec.rb +1 -1
- data/spec/models/webhook_versions_response_spec.rb +1 -1
- data/spec/models/withdraw_subscriber_consent_request_spec.rb +1 -1
- data/spec/models/workflow_execution_spec.rb +1 -1
- data/spec/models/workflow_execution_status_spec.rb +1 -1
- data/spec/models/workflow_step_execution_spec.rb +1 -1
- data/spec/models/workflow_step_execution_status_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/zyphr.gemspec +2 -2
- metadata +449 -421
data/docs/AuthUserProfileApi.md
CHANGED
|
@@ -5,7 +5,6 @@ All URIs are relative to *https://api.zyphr.dev/v1*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**delete_end_user**](AuthUserProfileApi.md#delete_end_user) | **DELETE** /auth/users/me | Delete current end user account |
|
|
8
|
-
| [**delete_end_user_by_application**](AuthUserProfileApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (test environment only) |
|
|
9
8
|
| [**get_end_user**](AuthUserProfileApi.md#get_end_user) | **GET** /auth/users/me | Get current end user profile |
|
|
10
9
|
| [**update_end_user**](AuthUserProfileApi.md#update_end_user) | **PATCH** /auth/users/me | Update current end user profile |
|
|
11
10
|
|
|
@@ -81,81 +80,6 @@ This endpoint does not need any parameter.
|
|
|
81
80
|
- **Accept**: application/json
|
|
82
81
|
|
|
83
82
|
|
|
84
|
-
## delete_end_user_by_application
|
|
85
|
-
|
|
86
|
-
> delete_end_user_by_application(user_id)
|
|
87
|
-
|
|
88
|
-
Delete an end user (test environment only)
|
|
89
|
-
|
|
90
|
-
App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status='deleted'), and emits a `user.deleted` webhook with `method='application_admin'`. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user's own session or the dashboard.
|
|
91
|
-
|
|
92
|
-
### Examples
|
|
93
|
-
|
|
94
|
-
```ruby
|
|
95
|
-
require 'time'
|
|
96
|
-
require 'zyphr'
|
|
97
|
-
# setup authorization
|
|
98
|
-
Zyphr.configure do |config|
|
|
99
|
-
# Configure API key authorization: ApplicationSecret
|
|
100
|
-
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
101
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
102
|
-
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
103
|
-
|
|
104
|
-
# Configure API key authorization: ApplicationPublicKey
|
|
105
|
-
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
106
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
107
|
-
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
api_instance = Zyphr::AuthUserProfileApi.new
|
|
111
|
-
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
112
|
-
|
|
113
|
-
begin
|
|
114
|
-
# Delete an end user (test environment only)
|
|
115
|
-
api_instance.delete_end_user_by_application(user_id)
|
|
116
|
-
rescue Zyphr::ApiError => e
|
|
117
|
-
puts "Error when calling AuthUserProfileApi->delete_end_user_by_application: #{e}"
|
|
118
|
-
end
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
#### Using the delete_end_user_by_application_with_http_info variant
|
|
122
|
-
|
|
123
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
124
|
-
|
|
125
|
-
> <Array(nil, Integer, Hash)> delete_end_user_by_application_with_http_info(user_id)
|
|
126
|
-
|
|
127
|
-
```ruby
|
|
128
|
-
begin
|
|
129
|
-
# Delete an end user (test environment only)
|
|
130
|
-
data, status_code, headers = api_instance.delete_end_user_by_application_with_http_info(user_id)
|
|
131
|
-
p status_code # => 2xx
|
|
132
|
-
p headers # => { ... }
|
|
133
|
-
p data # => nil
|
|
134
|
-
rescue Zyphr::ApiError => e
|
|
135
|
-
puts "Error when calling AuthUserProfileApi->delete_end_user_by_application_with_http_info: #{e}"
|
|
136
|
-
end
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Parameters
|
|
140
|
-
|
|
141
|
-
| Name | Type | Description | Notes |
|
|
142
|
-
| ---- | ---- | ----------- | ----- |
|
|
143
|
-
| **user_id** | **String** | | |
|
|
144
|
-
|
|
145
|
-
### Return type
|
|
146
|
-
|
|
147
|
-
nil (empty response body)
|
|
148
|
-
|
|
149
|
-
### Authorization
|
|
150
|
-
|
|
151
|
-
[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
152
|
-
|
|
153
|
-
### HTTP request headers
|
|
154
|
-
|
|
155
|
-
- **Content-Type**: Not defined
|
|
156
|
-
- **Accept**: Not defined
|
|
157
|
-
|
|
158
|
-
|
|
159
83
|
## get_end_user
|
|
160
84
|
|
|
161
85
|
> <AuthUserResponse> get_end_user
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zyphr::InviteEndUserRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **metadata** | **Object** | | [optional] |
|
|
10
|
+
| **send_link** | **String** | | [optional][default to 'none'] |
|
|
11
|
+
| **redirect_url** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zyphr'
|
|
17
|
+
|
|
18
|
+
instance = Zyphr::InviteEndUserRequest.new(
|
|
19
|
+
email: null,
|
|
20
|
+
name: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
send_link: null,
|
|
23
|
+
redirect_url: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::SendTemplateTestEmailRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **to** | **String** | | |
|
|
8
|
+
| **variables** | **Hash<String, Object>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::SendTemplateTestEmailRequest.new(
|
|
16
|
+
to: null,
|
|
17
|
+
variables: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::SetEndUserClaimsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **claims** | **Object** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::SetEndUserClaimsRequest.new(
|
|
15
|
+
claims: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
| **device_id** | **String** | Stable per-device identifier supplied by the client. Use a cryptographically-random opaque value persisted to client storage on first run. | |
|
|
8
8
|
| **name** | **String** | Optional display name. If omitted, the user has no name until conversion. | [optional] |
|
|
9
9
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
10
|
+
| **organization_id** | **String** | Optional organization to scope the anonymous user into. Must exist in the key's environment. When set, the returned token carries org_id and orgs. | [optional] |
|
|
11
|
+
| **organization_role** | **String** | Optional membership role for the org add. Requires organization_id. Opaque, up to 80 characters. | [optional] |
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -16,7 +18,9 @@ require 'zyphr'
|
|
|
16
18
|
instance = Zyphr::SignInAnonymouslyRequest.new(
|
|
17
19
|
device_id: null,
|
|
18
20
|
name: null,
|
|
19
|
-
metadata: null
|
|
21
|
+
metadata: null,
|
|
22
|
+
organization_id: null,
|
|
23
|
+
organization_role: null
|
|
20
24
|
)
|
|
21
25
|
```
|
|
22
26
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zyphr::SignInWithGameCenterRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **player_id** | **String** | The modern scoped gamePlayerID from GKLocalPlayer (NOT the deprecated legacy playerID). | |
|
|
8
|
+
| **public_key_url** | **String** | Apple-supplied URL to the public-key certificate. Must be https on an apple.com host; server-side SSRF-guarded before fetch. | |
|
|
9
|
+
| **signature** | **String** | Base64-encoded RSA signature returned by GameKit. | |
|
|
10
|
+
| **salt** | **String** | Base64-encoded salt bytes returned by GameKit. | |
|
|
11
|
+
| **timestamp** | **Float** | Apple-supplied timestamp (epoch milliseconds) returned by GameKit. | |
|
|
12
|
+
| **bundle_id** | **String** | The iOS bundle identifier the assertion was generated for. Must match a bundle id configured on the application's Game Center provider. | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zyphr'
|
|
18
|
+
|
|
19
|
+
instance = Zyphr::SignInWithGameCenterRequest.new(
|
|
20
|
+
player_id: null,
|
|
21
|
+
public_key_url: null,
|
|
22
|
+
signature: null,
|
|
23
|
+
salt: null,
|
|
24
|
+
timestamp: null,
|
|
25
|
+
bundle_id: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/TemplatesApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
|
|
|
9
9
|
| [**get_template**](TemplatesApi.md#get_template) | **GET** /templates/{id} | Get template |
|
|
10
10
|
| [**list_templates**](TemplatesApi.md#list_templates) | **GET** /templates | List templates |
|
|
11
11
|
| [**render_template**](TemplatesApi.md#render_template) | **POST** /templates/{id}/render | Render template |
|
|
12
|
+
| [**send_template_test_email**](TemplatesApi.md#send_template_test_email) | **POST** /templates/{id}/test | Send a test email using a template |
|
|
12
13
|
| [**update_template**](TemplatesApi.md#update_template) | **PUT** /templates/{id} | Update template |
|
|
13
14
|
|
|
14
15
|
|
|
@@ -373,6 +374,76 @@ end
|
|
|
373
374
|
- **Accept**: application/json
|
|
374
375
|
|
|
375
376
|
|
|
377
|
+
## send_template_test_email
|
|
378
|
+
|
|
379
|
+
> send_template_test_email(id, send_template_test_email_request)
|
|
380
|
+
|
|
381
|
+
Send a test email using a template
|
|
382
|
+
|
|
383
|
+
Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`.
|
|
384
|
+
|
|
385
|
+
### Examples
|
|
386
|
+
|
|
387
|
+
```ruby
|
|
388
|
+
require 'time'
|
|
389
|
+
require 'zyphr'
|
|
390
|
+
# setup authorization
|
|
391
|
+
Zyphr.configure do |config|
|
|
392
|
+
# Configure Bearer authorization (JWT): DashboardAuth
|
|
393
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
api_instance = Zyphr::TemplatesApi.new
|
|
397
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
398
|
+
send_template_test_email_request = Zyphr::SendTemplateTestEmailRequest.new({to: 'to_example'}) # SendTemplateTestEmailRequest |
|
|
399
|
+
|
|
400
|
+
begin
|
|
401
|
+
# Send a test email using a template
|
|
402
|
+
api_instance.send_template_test_email(id, send_template_test_email_request)
|
|
403
|
+
rescue Zyphr::ApiError => e
|
|
404
|
+
puts "Error when calling TemplatesApi->send_template_test_email: #{e}"
|
|
405
|
+
end
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
#### Using the send_template_test_email_with_http_info variant
|
|
409
|
+
|
|
410
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
411
|
+
|
|
412
|
+
> <Array(nil, Integer, Hash)> send_template_test_email_with_http_info(id, send_template_test_email_request)
|
|
413
|
+
|
|
414
|
+
```ruby
|
|
415
|
+
begin
|
|
416
|
+
# Send a test email using a template
|
|
417
|
+
data, status_code, headers = api_instance.send_template_test_email_with_http_info(id, send_template_test_email_request)
|
|
418
|
+
p status_code # => 2xx
|
|
419
|
+
p headers # => { ... }
|
|
420
|
+
p data # => nil
|
|
421
|
+
rescue Zyphr::ApiError => e
|
|
422
|
+
puts "Error when calling TemplatesApi->send_template_test_email_with_http_info: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Name | Type | Description | Notes |
|
|
429
|
+
| ---- | ---- | ----------- | ----- |
|
|
430
|
+
| **id** | **String** | | |
|
|
431
|
+
| **send_template_test_email_request** | [**SendTemplateTestEmailRequest**](SendTemplateTestEmailRequest.md) | | |
|
|
432
|
+
|
|
433
|
+
### Return type
|
|
434
|
+
|
|
435
|
+
nil (empty response body)
|
|
436
|
+
|
|
437
|
+
### Authorization
|
|
438
|
+
|
|
439
|
+
[DashboardAuth](../README.md#DashboardAuth)
|
|
440
|
+
|
|
441
|
+
### HTTP request headers
|
|
442
|
+
|
|
443
|
+
- **Content-Type**: application/json
|
|
444
|
+
- **Accept**: application/json
|
|
445
|
+
|
|
446
|
+
|
|
376
447
|
## update_template
|
|
377
448
|
|
|
378
449
|
> <TemplateResponse> update_template(id, update_template_request)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zyphr::UpdateEndUserByApplicationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **avatar_url** | **String** | | [optional] |
|
|
10
|
+
| **metadata** | **Object** | | [optional] |
|
|
11
|
+
| **status** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zyphr'
|
|
17
|
+
|
|
18
|
+
instance = Zyphr::UpdateEndUserByApplicationRequest.new(
|
|
19
|
+
email: null,
|
|
20
|
+
name: null,
|
|
21
|
+
avatar_url: null,
|
|
22
|
+
metadata: null,
|
|
23
|
+
status: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -21,7 +21,7 @@ module Zyphr
|
|
|
21
21
|
end
|
|
22
22
|
# Disconnect OAuth provider
|
|
23
23
|
# Disconnect an OAuth provider from the current user.
|
|
24
|
-
# @param provider [
|
|
24
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [SuccessResult]
|
|
27
27
|
def disconnect_o_auth_provider(provider, opts = {})
|
|
@@ -31,7 +31,7 @@ module Zyphr
|
|
|
31
31
|
|
|
32
32
|
# Disconnect OAuth provider
|
|
33
33
|
# Disconnect an OAuth provider from the current user.
|
|
34
|
-
# @param provider [
|
|
34
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
|
|
37
37
|
def disconnect_o_auth_provider_with_http_info(provider, opts = {})
|
|
@@ -84,7 +84,7 @@ module Zyphr
|
|
|
84
84
|
|
|
85
85
|
# Get OAuth authorization URL
|
|
86
86
|
# Generate an OAuth authorization URL for the specified provider.
|
|
87
|
-
# @param provider [
|
|
87
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
88
88
|
# @param redirect_uri [String] Redirect URI after authorization
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
90
|
# @return [OAuthAuthorizationUrlResponse]
|
|
@@ -95,7 +95,7 @@ module Zyphr
|
|
|
95
95
|
|
|
96
96
|
# Get OAuth authorization URL
|
|
97
97
|
# Generate an OAuth authorization URL for the specified provider.
|
|
98
|
-
# @param provider [
|
|
98
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
99
99
|
# @param redirect_uri [String] Redirect URI after authorization
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
101
101
|
# @return [Array<(OAuthAuthorizationUrlResponse, Integer, Hash)>] OAuthAuthorizationUrlResponse data, response status code and response headers
|
|
@@ -154,7 +154,7 @@ module Zyphr
|
|
|
154
154
|
|
|
155
155
|
# Get OAuth connection info
|
|
156
156
|
# Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
|
|
157
|
-
# @param provider [
|
|
157
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
158
158
|
# @param [Hash] opts the optional parameters
|
|
159
159
|
# @return [OAuthConnectionInfoResponse]
|
|
160
160
|
def get_o_auth_connection_info(provider, opts = {})
|
|
@@ -164,7 +164,7 @@ module Zyphr
|
|
|
164
164
|
|
|
165
165
|
# Get OAuth connection info
|
|
166
166
|
# Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
|
|
167
|
-
# @param provider [
|
|
167
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
168
168
|
# @param [Hash] opts the optional parameters
|
|
169
169
|
# @return [Array<(OAuthConnectionInfoResponse, Integer, Hash)>] OAuthConnectionInfoResponse data, response status code and response headers
|
|
170
170
|
def get_o_auth_connection_info_with_http_info(provider, opts = {})
|
|
@@ -217,7 +217,7 @@ module Zyphr
|
|
|
217
217
|
|
|
218
218
|
# Get OAuth provider tokens
|
|
219
219
|
# Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users.
|
|
220
|
-
# @param provider [
|
|
220
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
221
221
|
# @param user_id [String] End user ID
|
|
222
222
|
# @param [Hash] opts the optional parameters
|
|
223
223
|
# @return [OAuthTokensResponse]
|
|
@@ -228,7 +228,7 @@ module Zyphr
|
|
|
228
228
|
|
|
229
229
|
# Get OAuth provider tokens
|
|
230
230
|
# Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users.
|
|
231
|
-
# @param provider [
|
|
231
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
232
232
|
# @param user_id [String] End user ID
|
|
233
233
|
# @param [Hash] opts the optional parameters
|
|
234
234
|
# @return [Array<(OAuthTokensResponse, Integer, Hash)>] OAuthTokensResponse data, response status code and response headers
|
|
@@ -287,7 +287,7 @@ module Zyphr
|
|
|
287
287
|
|
|
288
288
|
# Handle OAuth callback
|
|
289
289
|
# Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
|
|
290
|
-
# @param provider [
|
|
290
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
291
291
|
# @param o_auth_callback_request [OAuthCallbackRequest]
|
|
292
292
|
# @param [Hash] opts the optional parameters
|
|
293
293
|
# @return [OAuthCallbackResponse]
|
|
@@ -298,7 +298,7 @@ module Zyphr
|
|
|
298
298
|
|
|
299
299
|
# Handle OAuth callback
|
|
300
300
|
# Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
|
|
301
|
-
# @param provider [
|
|
301
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
302
302
|
# @param o_auth_callback_request [OAuthCallbackRequest]
|
|
303
303
|
# @param [Hash] opts the optional parameters
|
|
304
304
|
# @return [Array<(OAuthCallbackResponse, Integer, Hash)>] OAuthCallbackResponse data, response status code and response headers
|
|
@@ -475,7 +475,7 @@ module Zyphr
|
|
|
475
475
|
|
|
476
476
|
# Refresh OAuth provider tokens
|
|
477
477
|
# Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft).
|
|
478
|
-
# @param provider [
|
|
478
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
479
479
|
# @param refresh_o_auth_tokens_request [RefreshOAuthTokensRequest]
|
|
480
480
|
# @param [Hash] opts the optional parameters
|
|
481
481
|
# @return [OAuthTokensRefreshResponse]
|
|
@@ -486,7 +486,7 @@ module Zyphr
|
|
|
486
486
|
|
|
487
487
|
# Refresh OAuth provider tokens
|
|
488
488
|
# Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft).
|
|
489
|
-
# @param provider [
|
|
489
|
+
# @param provider [OAuthProviderName] OAuth provider name
|
|
490
490
|
# @param refresh_o_auth_tokens_request [RefreshOAuthTokensRequest]
|
|
491
491
|
# @param [Hash] opts the optional parameters
|
|
492
492
|
# @return [Array<(OAuthTokensRefreshResponse, Integer, Hash)>] OAuthTokensRefreshResponse data, response status code and response headers
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zyphr API
|
|
3
3
|
|
|
4
|
-
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zyphr.dev
|