zyphr 0.1.36 → 0.1.37
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 +11 -0
- data/docs/SendTemplateTestEmailRequest.md +20 -0
- data/docs/TemplatesApi.md +71 -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 +1 -1
- 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 +1 -1
- data/lib/zyphr/api/auth_sessions_api.rb +1 -1
- data/lib/zyphr/api/auth_user_profile_api.rb +1 -1
- 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/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_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_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 +1 -1
- 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_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 +2 -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 +1 -1
- data/spec/api/auth_sessions_api_spec.rb +1 -1
- data/spec/api/auth_user_profile_api_spec.rb +1 -1
- 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/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_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_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 +1 -1
- 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_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 +6 -2
|
@@ -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
|
data/lib/zyphr/version.rb
CHANGED
|
@@ -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
|
data/lib/zyphr.rb
CHANGED
|
@@ -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
|
|
@@ -282,6 +282,7 @@ require 'zyphr/models/send_slack_message_result'
|
|
|
282
282
|
require 'zyphr/models/send_sms_data'
|
|
283
283
|
require 'zyphr/models/send_sms_request'
|
|
284
284
|
require 'zyphr/models/send_sms_response'
|
|
285
|
+
require 'zyphr/models/send_template_test_email_request'
|
|
285
286
|
require 'zyphr/models/send_test_sms_data'
|
|
286
287
|
require 'zyphr/models/send_test_sms_request'
|
|
287
288
|
require 'zyphr/models/send_test_sms_response'
|
|
@@ -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
|
|
@@ -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
|
|
@@ -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
|
data/spec/api/emails_api_spec.rb
CHANGED
|
@@ -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
|
data/spec/api/inbox_api_spec.rb
CHANGED
|
@@ -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
|
data/spec/api/muse_api_spec.rb
CHANGED
|
@@ -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
|
data/spec/api/push_api_spec.rb
CHANGED
|
@@ -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
|
data/spec/api/slack_api_spec.rb
CHANGED
|
@@ -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
|
data/spec/api/sms_api_spec.rb
CHANGED
|
@@ -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
|
|
@@ -94,6 +94,19 @@ describe 'TemplatesApi' do
|
|
|
94
94
|
end
|
|
95
95
|
end
|
|
96
96
|
|
|
97
|
+
# unit tests for send_template_test_email
|
|
98
|
+
# Send a test email using a template
|
|
99
|
+
# 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`.
|
|
100
|
+
# @param id
|
|
101
|
+
# @param send_template_test_email_request
|
|
102
|
+
# @param [Hash] opts the optional parameters
|
|
103
|
+
# @return [nil]
|
|
104
|
+
describe 'send_template_test_email test' do
|
|
105
|
+
it 'should work' do
|
|
106
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
|
|
97
110
|
# unit tests for update_template
|
|
98
111
|
# Update template
|
|
99
112
|
# Update an existing template. Only provided fields are changed.
|
data/spec/api/topics_api_spec.rb
CHANGED
|
@@ -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
|
|
@@ -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
|