Module: Zyphr

Defined in:: lib/zyphr/version.rb,
lib/zyphr.rb,
lib/zyphr/api_error.rb,
lib/zyphr/api_client.rb,
lib/zyphr/api/sms_api.rb,
lib/zyphr/api/push_api.rb,
lib/zyphr/models/topic.rb,
lib/zyphr/api/inbox_api.rb,
lib/zyphr/configuration.rb,
lib/zyphr/models/device.rb,
lib/zyphr/api/emails_api.rb,
lib/zyphr/api/topics_api.rb,
lib/zyphr/models/webhook.rb,
lib/zyphr/api/devices_api.rb,
lib/zyphr/api/utility_api.rb,
lib/zyphr/models/category.rb,
lib/zyphr/models/template.rb,
lib/zyphr/api/auth_mfa_api.rb,
lib/zyphr/api/webhooks_api.rb,
lib/zyphr/models/api_error.rb,
lib/zyphr/models/auth_user.rb,
lib/zyphr/api/templates_api.rb,
lib/zyphr/models/push_event.rb,
lib/zyphr/models/sms_config.rb,
lib/zyphr/models/subscriber.rb,
lib/zyphr/api/auth_login_api.rb,
lib/zyphr/api/auth_phone_api.rb,
lib/zyphr/models/auth_result.rb,
lib/zyphr/models/auth_tokens.rb,
lib/zyphr/models/email_event.rb,
lib/zyphr/models/sms_message.rb,
lib/zyphr/models/unsubscribe.rb,
lib/zyphr/api/auth_o_auth_api.rb,
lib/zyphr/api/subscribers_api.rb,
lib/zyphr/models/auth_session.rb,
lib/zyphr/models/device_stats.rb,
lib/zyphr/models/push_message.rb,
lib/zyphr/models/request_meta.rb,
lib/zyphr/api/waa_s_events_api.rb,
lib/zyphr/api/waa_s_portal_api.rb,
lib/zyphr/models/delete_result.rb,
lib/zyphr/models/email_address.rb,
lib/zyphr/models/email_message.rb,
lib/zyphr/models/login_request.rb,
lib/zyphr/models/send_sms_data.rb,
lib/zyphr/api/auth_sessions_api.rb,
lib/zyphr/models/api_error_meta.rb,
lib/zyphr/models/consent_status.rb,
lib/zyphr/models/email_response.rb,
lib/zyphr/models/success_result.rb,
lib/zyphr/models/topic_response.rb,
lib/zyphr/models/waa_s_delivery.rb,
lib/zyphr/models/waa_s_endpoint.rb,
lib/zyphr/models/webhook_region.rb,
lib/zyphr/api/auth_web_authn_api.rb,
lib/zyphr/models/api_error_error.rb,
lib/zyphr/models/device_response.rb,
lib/zyphr/models/inbox_list_meta.rb,
lib/zyphr/models/o_auth_provider.rb,
lib/zyphr/models/pagination_meta.rb,
lib/zyphr/models/push_stats_data.rb,
lib/zyphr/models/webhook_version.rb,
lib/zyphr/api/waa_s_endpoints_api.rb,
lib/zyphr/models/email_attachment.rb,
lib/zyphr/models/register_request.rb,
lib/zyphr/models/send_in_app_meta.rb,
lib/zyphr/models/send_sms_request.rb,
lib/zyphr/models/topic_stats_data.rb,
lib/zyphr/models/topic_subscriber.rb,
lib/zyphr/models/waa_s_event_type.rb,
lib/zyphr/models/webhook_delivery.rb,
lib/zyphr/models/webhook_response.rb,
lib/zyphr/api/auth_magic_links_api.rb,
lib/zyphr/api/waa_s_deliveries_api.rb,
lib/zyphr/models/auth_login_result.rb,
lib/zyphr/models/category_response.rb,
lib/zyphr/models/device_push_topic.rb,
lib/zyphr/models/o_auth_connection.rb,
lib/zyphr/models/push_topic_device.rb,
lib/zyphr/models/send_push_request.rb,
lib/zyphr/models/send_sms_response.rb,
lib/zyphr/models/sms_list_response.rb,
lib/zyphr/models/template_response.rb,
lib/zyphr/models/unread_count_data.rb,
lib/zyphr/models/waa_s_application.rb,
lib/zyphr/api/auth_registration_api.rb,
lib/zyphr/api/auth_user_profile_api.rb,
lib/zyphr/api/waa_s_event_types_api.rb,
lib/zyphr/models/auth_user_response.rb,
lib/zyphr/models/delete_result_data.rb,
lib/zyphr/models/mark_all_read_data.rb,
lib/zyphr/models/mfa_enroll_request.rb,
lib/zyphr/models/mfa_verify_request.rb,
lib/zyphr/models/push_list_response.rb,
lib/zyphr/models/send_email_request.rb,
lib/zyphr/models/send_push_response.rb,
lib/zyphr/models/send_test_sms_data.rb,
lib/zyphr/models/sms_message_detail.rb,
lib/zyphr/api/waa_s_applications_api.rb,
lib/zyphr/models/auth_login_response.rb,
lib/zyphr/models/email_list_response.rb,
lib/zyphr/models/email_tracking_data.rb,
lib/zyphr/models/in_app_notification.rb,
lib/zyphr/models/inbox_list_response.rb,
lib/zyphr/models/mfa_disable_request.rb,
lib/zyphr/models/mfa_status_response.rb,
lib/zyphr/models/push_message_detail.rb,
lib/zyphr/models/push_stats_response.rb,
lib/zyphr/models/resubscribe_request.rb,
lib/zyphr/models/send_batch_sms_data.rb,
lib/zyphr/models/send_email_response.rb,
lib/zyphr/models/send_in_app_request.rb,
lib/zyphr/models/sms_config_response.rb,
lib/zyphr/models/sms_detail_response.rb,
lib/zyphr/models/subscriber_response.rb,
lib/zyphr/models/success_result_data.rb,
lib/zyphr/models/topic_list_response.rb,
lib/zyphr/models/unsubscribe_request.rb,
lib/zyphr/api/auth_password_reset_api.rb,
lib/zyphr/models/auth_result_response.rb,
lib/zyphr/models/create_topic_request.rb,
lib/zyphr/models/device_list_response.rb,
lib/zyphr/models/email_tracking_opens.rb,
lib/zyphr/models/mfa_disable_response.rb,
lib/zyphr/models/o_auth_provider_info.rb,
lib/zyphr/models/push_detail_response.rb,
lib/zyphr/models/resubscribe_response.rb,
lib/zyphr/models/send_in_app_response.rb,
lib/zyphr/models/topic_stats_response.rb,
lib/zyphr/models/unsubscribe_response.rb,
lib/zyphr/models/update_topic_request.rb,
lib/zyphr/models/waa_s_usage_response.rb,
lib/zyphr/models/web_authn_credential.rb,
lib/zyphr/models/webhook_ips_response.rb,
lib/zyphr/models/webhook_job_response.rb,
lib/zyphr/models/consent_history_entry.rb,
lib/zyphr/models/device_stats_response.rb,
lib/zyphr/models/email_events_response.rb,
lib/zyphr/models/email_tracking_clicks.rb,
lib/zyphr/models/password_requirements.rb,
lib/zyphr/models/send_test_sms_request.rb,
lib/zyphr/models/session_list_response.rb,
lib/zyphr/models/subscriber_preference.rb,
lib/zyphr/models/topic_delete_response.rb,
lib/zyphr/models/unread_count_response.rb,
lib/zyphr/models/webhook_circuit_state.rb,
lib/zyphr/models/webhook_list_response.rb,
lib/zyphr/models/category_list_response.rb,
lib/zyphr/models/create_webhook_request.rb,
lib/zyphr/models/mark_all_read_response.rb,
lib/zyphr/models/o_auth_tokens_response.rb,
lib/zyphr/models/phone_otp_send_request.rb,
lib/zyphr/models/refresh_token_response.rb,
lib/zyphr/models/reset_password_request.rb,
lib/zyphr/models/revoke_session_request.rb,
lib/zyphr/models/send_batch_in_app_meta.rb,
lib/zyphr/models/send_batch_sms_request.rb,
lib/zyphr/models/send_test_sms_response.rb,
lib/zyphr/models/sms_list_response_meta.rb,
lib/zyphr/models/template_list_response.rb,
lib/zyphr/models/update_webhook_request.rb,
lib/zyphr/models/verify_sms_config_data.rb,
lib/zyphr/models/webhook_usage_response.rb,
lib/zyphr/models/auth_user_response_data.rb,
lib/zyphr/models/consent_record_response.rb,
lib/zyphr/models/consent_status_response.rb,
lib/zyphr/models/create_category_request.rb,
lib/zyphr/models/create_template_request.rb,
lib/zyphr/models/email_tracking_response.rb,
lib/zyphr/models/forgot_password_request.rb,
lib/zyphr/models/magic_link_send_request.rb,
lib/zyphr/models/mark_inbox_read_request.rb,
lib/zyphr/models/mfa_enrollment_response.rb,
lib/zyphr/models/o_auth_callback_request.rb,
lib/zyphr/models/phone_otp_sent_response.rb,
lib/zyphr/models/refresh_session_request.rb,
lib/zyphr/models/register_device_request.rb,
lib/zyphr/models/render_template_request.rb,
lib/zyphr/models/reset_password_response.rb,
lib/zyphr/models/send_batch_email_result.rb,
lib/zyphr/models/send_batch_sms_response.rb,
lib/zyphr/models/send_push_response_data.rb,
lib/zyphr/models/send_push_to_topic_data.rb,
lib/zyphr/models/set_preferences_request.rb,
lib/zyphr/models/update_category_request.rb,
lib/zyphr/models/update_end_user_request.rb,
lib/zyphr/models/update_template_request.rb,
lib/zyphr/models/webhook_create_response.rb,
lib/zyphr/models/webhook_delete_response.rb,
lib/zyphr/models/webhook_delivery_detail.rb,
lib/zyphr/models/webhook_replay_response.rb,
lib/zyphr/api/auth_email_verification_api.rb,
lib/zyphr/models/consent_history_response.rb,
lib/zyphr/models/end_user_delete_response.rb,
lib/zyphr/models/mfa_status_response_data.rb,
lib/zyphr/models/o_auth_callback_response.rb,
lib/zyphr/models/preference_list_response.rb,
lib/zyphr/models/send_batch_email_request.rb,
lib/zyphr/models/send_email_response_data.rb,
lib/zyphr/models/send_email_response_meta.rb,
lib/zyphr/models/sms_batch_result_message.rb,
lib/zyphr/models/sms_batch_result_summary.rb,
lib/zyphr/models/subscriber_list_response.rb,
lib/zyphr/models/template_render_response.rb,
lib/zyphr/models/webhook_metrics_response.rb,
lib/zyphr/models/webhook_regions_response.rb,
lib/zyphr/models/consent_withdraw_response.rb,
lib/zyphr/models/create_subscriber_request.rb,
lib/zyphr/models/email_tracking_click_link.rb,
lib/zyphr/models/magic_link_verify_request.rb,
lib/zyphr/models/mfa_backup_codes_response.rb,
lib/zyphr/models/mfa_disable_response_data.rb,
lib/zyphr/models/mfa_verify_backup_request.rb,
lib/zyphr/models/o_auth_providers_response.rb,
lib/zyphr/models/push_topic_subscribe_data.rb,
lib/zyphr/models/send_batch_email_response.rb,
lib/zyphr/models/send_batch_in_app_request.rb,
lib/zyphr/models/template_rendered_content.rb,
lib/zyphr/models/unsubscribe_list_response.rb,
lib/zyphr/models/update_subscriber_request.rb,
lib/zyphr/models/upsert_sms_config_request.rb,
lib/zyphr/models/web_authn_status_response.rb,
lib/zyphr/models/webhook_delivery_response.rb,
lib/zyphr/models/webhook_ips_response_data.rb,
lib/zyphr/models/webhook_versions_response.rb,
lib/zyphr/models/magic_link_verify_response.rb,
lib/zyphr/models/mfa_verify_backup_response.rb,
lib/zyphr/models/phone_login_verify_request.rb,
lib/zyphr/models/send_batch_in_app_response.rb,
lib/zyphr/models/send_push_to_topic_request.rb,
lib/zyphr/models/session_list_response_data.rb,
lib/zyphr/models/sms_config_delete_response.rb,
lib/zyphr/models/topic_delete_response_data.rb,
lib/zyphr/models/verify_sms_config_response.rb,
lib/zyphr/models/waa_s_portal_token_request.rb,
lib/zyphr/models/get_waa_s_usage200_response.rb,
lib/zyphr/models/inbox_notification_response.rb,
lib/zyphr/models/mark_all_inbox_read_request.rb,
lib/zyphr/models/o_auth_connections_response.rb,
lib/zyphr/models/o_auth_tokens_response_data.rb,
lib/zyphr/models/push_topic_unsubscribe_data.rb,
lib/zyphr/models/refresh_token_response_data.rb,
lib/zyphr/models/send_push_to_topic_response.rb,
lib/zyphr/models/waa_s_batch_publish_request.rb,
lib/zyphr/models/waa_s_portal_token_response.rb,
lib/zyphr/models/waa_s_publish_event_request.rb,
lib/zyphr/models/web_authn_challenge_options.rb,
lib/zyphr/models/webhook_bulk_retry_response.rb,
lib/zyphr/models/webhook_test_event_response.rb,
lib/zyphr/models/consent_record_response_data.rb,
lib/zyphr/models/mfa_enrollment_response_data.rb,
lib/zyphr/models/phone_otp_sent_response_data.rb,
lib/zyphr/models/revoke_all_sessions_response.rb,
lib/zyphr/models/send_batch_email_result_item.rb,
lib/zyphr/models/subscribe_push_topic_request.rb,
lib/zyphr/models/topic_subscribers_add_result.rb,
lib/zyphr/models/user_devices_delete_response.rb,
lib/zyphr/models/validate_reset_token_request.rb,
lib/zyphr/models/waa_s_batch_publish_response.rb,
lib/zyphr/models/waa_s_publish_event_response.rb,
lib/zyphr/models/web_authn_start_auth_request.rb,
lib/zyphr/models/webhook_create_response_data.rb,
lib/zyphr/models/webhook_delete_response_data.rb,
lib/zyphr/models/webhook_event_types_response.rb,
lib/zyphr/models/add_topic_subscribers_request.rb,
lib/zyphr/models/create_waa_s_endpoint_request.rb,
lib/zyphr/models/end_user_delete_response_data.rb,
lib/zyphr/models/mfa_verify_enrollment_request.rb,
lib/zyphr/models/o_auth_callback_response_data.rb,
lib/zyphr/models/phone_register_verify_request.rb,
lib/zyphr/models/push_topic_subscribe_response.rb,
lib/zyphr/models/refresh_o_auth_tokens_request.rb,
lib/zyphr/models/replay_webhook_events_request.rb,
lib/zyphr/models/update_waa_s_endpoint_request.rb,
lib/zyphr/models/validate_reset_token_response.rb,
lib/zyphr/models/web_authn_credential_response.rb,
lib/zyphr/models/web_authn_start_auth_response.rb,
lib/zyphr/models/web_authn_verify_auth_request.rb,
lib/zyphr/models/webhook_regions_response_data.rb,
lib/zyphr/models/create_waa_s_endpoint_response.rb,
lib/zyphr/models/get_waa_s_endpoint200_response.rb,
lib/zyphr/models/mfa_backup_codes_response_data.rb,
lib/zyphr/models/mfa_verify_enrollment_response.rb,
lib/zyphr/models/o_auth_providers_response_data.rb,
lib/zyphr/models/o_auth_tokens_refresh_response.rb,
lib/zyphr/models/password_requirements_response.rb,
lib/zyphr/models/test_webhook_transform_request.rb,
lib/zyphr/models/topic_subscriber_list_response.rb,
lib/zyphr/models/topic_subscribers_add_response.rb,
lib/zyphr/models/web_authn_status_response_data.rb,
lib/zyphr/models/webhook_circuit_state_response.rb,
lib/zyphr/models/webhook_delivery_list_response.rb,
lib/zyphr/models/webhook_secret_rotate_response.rb,
lib/zyphr/models/webhook_versions_response_data.rb,
lib/zyphr/models/auth_login_result_mfa_challenge.rb,
lib/zyphr/models/create_waa_s_event_type_request.rb,
lib/zyphr/models/device_push_topic_list_response.rb,
lib/zyphr/models/magic_link_verify_response_data.rb,
lib/zyphr/models/mfa_verify_backup_response_data.rb,
lib/zyphr/models/o_auth_connection_info_response.rb,
lib/zyphr/models/publish_waa_s_event201_response.rb,
lib/zyphr/models/push_topic_device_list_response.rb,
lib/zyphr/models/push_topic_unsubscribe_response.rb,
lib/zyphr/models/send_email_verification_request.rb,
lib/zyphr/models/send_webhook_test_event_request.rb,
lib/zyphr/models/sms_config_delete_response_data.rb,
lib/zyphr/models/topic_subscribers_remove_result.rb,
lib/zyphr/models/update_waa_s_event_type_request.rb,
lib/zyphr/models/webhook_delivery_retry_response.rb,
lib/zyphr/models/webhook_transform_test_response.rb,
lib/zyphr/models/create_waa_s_application_request.rb,
lib/zyphr/models/list_waa_s_endpoints200_response.rb,
lib/zyphr/models/o_auth_connections_response_data.rb,
lib/zyphr/models/phone_auth_availability_response.rb,
lib/zyphr/models/remove_topic_subscribers_request.rb,
lib/zyphr/models/update_waa_s_application_request.rb,
lib/zyphr/models/waa_s_portal_token_request_theme.rb,
lib/zyphr/models/webhook_account_metrics_response.rb,
lib/zyphr/models/webhook_test_event_response_data.rb,
lib/zyphr/models/create_waa_s_endpoint201_response.rb,
lib/zyphr/models/generate_subscriber_token_request.rb,
lib/zyphr/models/o_auth_authorization_url_response.rb,
lib/zyphr/models/revoke_all_sessions_response_data.rb,
lib/zyphr/models/topic_subscribers_remove_response.rb,
lib/zyphr/models/user_devices_delete_response_data.rb,
lib/zyphr/models/webhook_event_types_response_data.rb,
lib/zyphr/models/confirm_email_verification_request.rb,
lib/zyphr/models/list_waa_s_event_types200_response.rb,
lib/zyphr/models/validate_reset_token_response_data.rb,
lib/zyphr/models/web_authn_credential_list_response.rb,
lib/zyphr/models/confirm_email_verification_response.rb,
lib/zyphr/models/create_waa_s_event_type201_response.rb,
lib/zyphr/models/list_waa_s_applications200_response.rb,
lib/zyphr/models/mfa_regenerate_backup_codes_request.rb,
lib/zyphr/models/mfa_verify_enrollment_response_data.rb,
lib/zyphr/models/o_auth_tokens_refresh_response_data.rb,
lib/zyphr/models/password_requirements_response_data.rb,
lib/zyphr/models/rename_web_authn_credential_request.rb,
lib/zyphr/models/webhook_secret_rotate_response_data.rb,
lib/zyphr/models/withdraw_subscriber_consent_request.rb,
lib/zyphr/models/create_waa_s_application201_response.rb,
lib/zyphr/models/device_push_topic_list_response_meta.rb,
lib/zyphr/models/o_auth_connection_info_response_data.rb,
lib/zyphr/models/web_authn_start_registration_request.rb,
lib/zyphr/models/webhook_delivery_retry_response_data.rb,
lib/zyphr/models/bulk_retry_webhook_deliveries_request.rb,
lib/zyphr/models/generate_subscriber_token200_response.rb,
lib/zyphr/models/phone_auth_availability_response_data.rb,
lib/zyphr/models/update_subscriber_preferences_request.rb,
lib/zyphr/models/web_authn_start_registration_response.rb,
lib/zyphr/models/web_authn_verify_registration_request.rb,
lib/zyphr/models/batch_publish_waa_s_events201_response.rb,
lib/zyphr/models/o_auth_authorization_url_response_data.rb,
lib/zyphr/models/send_push_request_action_buttons_inner.rb,
lib/zyphr/models/web_authn_verify_registration_response.rb,
lib/zyphr/models/generate_waa_s_portal_token201_response.rb,
lib/zyphr/models/session_list_response_data_session_info.rb,
lib/zyphr/models/web_authn_credential_list_response_data.rb,
lib/zyphr/models/confirm_email_verification_response_data.rb,
lib/zyphr/models/push_message_detail_all_of_action_buttons.rb,
lib/zyphr/models/set_preferences_request_preferences_inner.rb,
lib/zyphr/models/generate_subscriber_token200_response_data.rb,
lib/zyphr/models/list_waa_s_endpoint_deliveries200_response.rb,
lib/zyphr/models/web_authn_verify_registration_response_data.rb,
lib/zyphr/models/mark_all_subscriber_notifications_read_request.rb,
lib/zyphr/models/topic_stats_data_topics_by_subscriber_count_inner.rb,
lib/zyphr/models/update_subscriber_preferences_request_preferences_inner.rb

Overview

#Zyphr API

#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" } } “`

The version of the OpenAPI document: 1.0.0 Contact: support@zyphr.dev Generated by: openapi-generator.tech Generator version: 7.12.0

Defined Under Namespace

Constant Summary collapse

VERSION =

'1.0.0'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

Zyphr.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/zyphr.rb', line 393

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end