zyphr 0.1.0
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 +7 -0
- data/Gemfile +9 -0
- data/README.md +614 -0
- data/Rakefile +10 -0
- data/docs/AddTopicSubscribersRequest.md +20 -0
- data/docs/ApiError.md +20 -0
- data/docs/ApiErrorError.md +22 -0
- data/docs/ApiErrorMeta.md +18 -0
- data/docs/AuthEmailVerificationApi.md +248 -0
- data/docs/AuthLoginApi.md +84 -0
- data/docs/AuthLoginResponse.md +20 -0
- data/docs/AuthLoginResult.md +24 -0
- data/docs/AuthLoginResultMfaChallenge.md +20 -0
- data/docs/AuthMFAApi.md +546 -0
- data/docs/AuthMagicLinksApi.md +161 -0
- data/docs/AuthOAuthApi.md +597 -0
- data/docs/AuthPasswordResetApi.md +238 -0
- data/docs/AuthPhoneApi.md +384 -0
- data/docs/AuthRegistrationApi.md +84 -0
- data/docs/AuthResult.md +20 -0
- data/docs/AuthResultResponse.md +20 -0
- data/docs/AuthSession.md +28 -0
- data/docs/AuthSessionsApi.md +310 -0
- data/docs/AuthTokens.md +24 -0
- data/docs/AuthUser.md +42 -0
- data/docs/AuthUserProfileApi.md +226 -0
- data/docs/AuthUserResponse.md +20 -0
- data/docs/AuthUserResponseData.md +18 -0
- data/docs/AuthWebAuthnApi.md +621 -0
- data/docs/BulkRetryWebhookDeliveriesRequest.md +24 -0
- data/docs/Category.md +34 -0
- data/docs/CategoryListResponse.md +20 -0
- data/docs/CategoryResponse.md +20 -0
- data/docs/ConfirmEmailVerificationRequest.md +18 -0
- data/docs/ConfirmEmailVerificationResponse.md +20 -0
- data/docs/ConfirmEmailVerificationResponseData.md +20 -0
- data/docs/ConsentHistoryEntry.md +32 -0
- data/docs/ConsentHistoryResponse.md +20 -0
- data/docs/ConsentRecordResponse.md +20 -0
- data/docs/ConsentRecordResponseData.md +20 -0
- data/docs/ConsentStatus.md +24 -0
- data/docs/ConsentStatusResponse.md +20 -0
- data/docs/ConsentWithdrawResponse.md +20 -0
- data/docs/CreateCategoryRequest.md +26 -0
- data/docs/CreateSubscriberRequest.md +32 -0
- data/docs/CreateTemplateRequest.md +28 -0
- data/docs/CreateTopicRequest.md +22 -0
- data/docs/CreateWebhookRequest.md +36 -0
- data/docs/DeleteResult.md +20 -0
- data/docs/DeleteResultData.md +20 -0
- data/docs/Device.md +34 -0
- data/docs/DeviceListResponse.md +20 -0
- data/docs/DevicePushTopic.md +22 -0
- data/docs/DevicePushTopicListResponse.md +20 -0
- data/docs/DevicePushTopicListResponseMeta.md +20 -0
- data/docs/DeviceResponse.md +20 -0
- data/docs/DeviceStats.md +20 -0
- data/docs/DeviceStatsResponse.md +20 -0
- data/docs/DevicesApi.md +444 -0
- data/docs/EmailAddress.md +20 -0
- data/docs/EmailAttachment.md +26 -0
- data/docs/EmailEvent.md +32 -0
- data/docs/EmailEventsResponse.md +20 -0
- data/docs/EmailListResponse.md +20 -0
- data/docs/EmailMessage.md +42 -0
- data/docs/EmailResponse.md +20 -0
- data/docs/EmailTrackingClickLink.md +22 -0
- data/docs/EmailTrackingClicks.md +22 -0
- data/docs/EmailTrackingData.md +20 -0
- data/docs/EmailTrackingOpens.md +20 -0
- data/docs/EmailTrackingResponse.md +20 -0
- data/docs/EmailsApi.md +447 -0
- data/docs/EndUserDeleteResponse.md +20 -0
- data/docs/EndUserDeleteResponseData.md +20 -0
- data/docs/ForgotPasswordRequest.md +20 -0
- data/docs/InAppNotification.md +48 -0
- data/docs/InboxApi.md +694 -0
- data/docs/InboxListMeta.md +28 -0
- data/docs/InboxListResponse.md +20 -0
- data/docs/InboxNotificationResponse.md +20 -0
- data/docs/LoginRequest.md +22 -0
- data/docs/MagicLinkSendRequest.md +20 -0
- data/docs/MagicLinkVerifyRequest.md +18 -0
- data/docs/MagicLinkVerifyResponse.md +20 -0
- data/docs/MagicLinkVerifyResponseData.md +22 -0
- data/docs/MarkAllInboxReadRequest.md +22 -0
- data/docs/MarkAllReadData.md +18 -0
- data/docs/MarkAllReadResponse.md +20 -0
- data/docs/MarkInboxReadRequest.md +20 -0
- data/docs/MfaBackupCodesResponse.md +20 -0
- data/docs/MfaBackupCodesResponseData.md +18 -0
- data/docs/MfaDisableRequest.md +20 -0
- data/docs/MfaDisableResponse.md +20 -0
- data/docs/MfaDisableResponseData.md +18 -0
- data/docs/MfaEnrollRequest.md +18 -0
- data/docs/MfaEnrollmentResponse.md +20 -0
- data/docs/MfaEnrollmentResponseData.md +22 -0
- data/docs/MfaRegenerateBackupCodesRequest.md +20 -0
- data/docs/MfaStatusResponse.md +20 -0
- data/docs/MfaStatusResponseData.md +24 -0
- data/docs/MfaVerifyBackupRequest.md +20 -0
- data/docs/MfaVerifyBackupResponse.md +20 -0
- data/docs/MfaVerifyBackupResponseData.md +22 -0
- data/docs/MfaVerifyEnrollmentRequest.md +20 -0
- data/docs/MfaVerifyEnrollmentResponse.md +20 -0
- data/docs/MfaVerifyEnrollmentResponseData.md +18 -0
- data/docs/MfaVerifyRequest.md +20 -0
- data/docs/OAuthAuthorizationUrlResponse.md +20 -0
- data/docs/OAuthAuthorizationUrlResponseData.md +20 -0
- data/docs/OAuthCallbackRequest.md +22 -0
- data/docs/OAuthCallbackResponse.md +20 -0
- data/docs/OAuthCallbackResponseData.md +24 -0
- data/docs/OAuthConnection.md +30 -0
- data/docs/OAuthConnectionInfoResponse.md +20 -0
- data/docs/OAuthConnectionInfoResponseData.md +28 -0
- data/docs/OAuthConnectionsResponse.md +20 -0
- data/docs/OAuthConnectionsResponseData.md +18 -0
- data/docs/OAuthProvider.md +20 -0
- data/docs/OAuthProviderInfo.md +30 -0
- data/docs/OAuthProvidersResponse.md +20 -0
- data/docs/OAuthProvidersResponseData.md +18 -0
- data/docs/OAuthTokensRefreshResponse.md +20 -0
- data/docs/OAuthTokensRefreshResponseData.md +26 -0
- data/docs/OAuthTokensResponse.md +20 -0
- data/docs/OAuthTokensResponseData.md +28 -0
- data/docs/PaginationMeta.md +24 -0
- data/docs/PasswordRequirements.md +28 -0
- data/docs/PasswordRequirementsResponse.md +20 -0
- data/docs/PasswordRequirementsResponseData.md +18 -0
- data/docs/PhoneAuthAvailabilityResponse.md +20 -0
- data/docs/PhoneAuthAvailabilityResponseData.md +20 -0
- data/docs/PhoneLoginVerifyRequest.md +22 -0
- data/docs/PhoneOtpSendRequest.md +18 -0
- data/docs/PhoneOtpSentResponse.md +20 -0
- data/docs/PhoneOtpSentResponseData.md +20 -0
- data/docs/PhoneRegisterVerifyRequest.md +24 -0
- data/docs/PreferenceListResponse.md +20 -0
- data/docs/PushApi.md +674 -0
- data/docs/PushDetailResponse.md +20 -0
- data/docs/PushEvent.md +28 -0
- data/docs/PushListResponse.md +20 -0
- data/docs/PushMessage.md +36 -0
- data/docs/PushMessageDetail.md +62 -0
- data/docs/PushPayload.md +32 -0
- data/docs/PushStatsData.md +28 -0
- data/docs/PushStatsResponse.md +20 -0
- data/docs/PushTopicDevice.md +26 -0
- data/docs/PushTopicDeviceListResponse.md +20 -0
- data/docs/PushTopicSubscribeData.md +24 -0
- data/docs/PushTopicSubscribeResponse.md +20 -0
- data/docs/PushTopicUnsubscribeData.md +24 -0
- data/docs/PushTopicUnsubscribeResponse.md +20 -0
- data/docs/RefreshOAuthTokensRequest.md +18 -0
- data/docs/RefreshSessionRequest.md +20 -0
- data/docs/RefreshTokenResponse.md +20 -0
- data/docs/RefreshTokenResponseData.md +20 -0
- data/docs/RegisterDeviceRequest.md +34 -0
- data/docs/RegisterRequest.md +24 -0
- data/docs/RemoveTopicSubscribersRequest.md +18 -0
- data/docs/RenameWebAuthnCredentialRequest.md +18 -0
- data/docs/RenderTemplateRequest.md +18 -0
- data/docs/ReplayWebhookEventsRequest.md +22 -0
- data/docs/RequestMeta.md +18 -0
- data/docs/ResetPasswordRequest.md +20 -0
- data/docs/ResetPasswordResponse.md +20 -0
- data/docs/ResubscribeRequest.md +18 -0
- data/docs/ResubscribeResponse.md +20 -0
- data/docs/RevokeAllSessionsResponse.md +20 -0
- data/docs/RevokeAllSessionsResponseData.md +20 -0
- data/docs/RevokeSessionRequest.md +18 -0
- data/docs/SMSApi.md +654 -0
- data/docs/SendBatchEmailRequest.md +18 -0
- data/docs/SendBatchEmailResponse.md +20 -0
- data/docs/SendBatchEmailResult.md +26 -0
- data/docs/SendBatchEmailResultItem.md +22 -0
- data/docs/SendBatchInAppMeta.md +26 -0
- data/docs/SendBatchInAppRequest.md +18 -0
- data/docs/SendBatchInAppResponse.md +20 -0
- data/docs/SendBatchSmsData.md +24 -0
- data/docs/SendBatchSmsRequest.md +20 -0
- data/docs/SendBatchSmsResponse.md +20 -0
- data/docs/SendEmailRequest.md +50 -0
- data/docs/SendEmailResponse.md +20 -0
- data/docs/SendEmailResponseData.md +20 -0
- data/docs/SendEmailResponseMeta.md +20 -0
- data/docs/SendEmailVerificationRequest.md +18 -0
- data/docs/SendInAppMeta.md +18 -0
- data/docs/SendInAppRequest.md +40 -0
- data/docs/SendInAppResponse.md +20 -0
- data/docs/SendPushRequest.md +34 -0
- data/docs/SendPushResponse.md +20 -0
- data/docs/SendPushResponseData.md +24 -0
- data/docs/SendPushToTopicData.md +24 -0
- data/docs/SendPushToTopicRequest.md +36 -0
- data/docs/SendPushToTopicResponse.md +20 -0
- data/docs/SendSmsData.md +32 -0
- data/docs/SendSmsRequest.md +28 -0
- data/docs/SendSmsResponse.md +20 -0
- data/docs/SendTestSmsData.md +26 -0
- data/docs/SendTestSmsRequest.md +20 -0
- data/docs/SendTestSmsResponse.md +20 -0
- data/docs/SendWebhookTestEventRequest.md +20 -0
- data/docs/SessionListResponse.md +20 -0
- data/docs/SessionListResponseData.md +20 -0
- data/docs/SessionListResponseDataSessionInfo.md +22 -0
- data/docs/SetPreferencesRequest.md +18 -0
- data/docs/SetPreferencesRequestPreferencesInner.md +22 -0
- data/docs/SmsBatchResultMessage.md +26 -0
- data/docs/SmsBatchResultSummary.md +22 -0
- data/docs/SmsConfig.md +32 -0
- data/docs/SmsConfigDeleteResponse.md +20 -0
- data/docs/SmsConfigDeleteResponseData.md +18 -0
- data/docs/SmsConfigResponse.md +20 -0
- data/docs/SmsDetailResponse.md +20 -0
- data/docs/SmsListResponse.md +20 -0
- data/docs/SmsListResponseMeta.md +26 -0
- data/docs/SmsMessage.md +32 -0
- data/docs/SmsMessageDetail.md +52 -0
- data/docs/SubscribePushTopicRequest.md +18 -0
- data/docs/Subscriber.md +42 -0
- data/docs/SubscriberListResponse.md +20 -0
- data/docs/SubscriberPreference.md +30 -0
- data/docs/SubscriberResponse.md +20 -0
- data/docs/SubscribersApi.md +1450 -0
- data/docs/SuccessResult.md +20 -0
- data/docs/SuccessResultData.md +18 -0
- data/docs/Template.md +36 -0
- data/docs/TemplateListResponse.md +20 -0
- data/docs/TemplateRenderResponse.md +20 -0
- data/docs/TemplateRenderedContent.md +22 -0
- data/docs/TemplateResponse.md +20 -0
- data/docs/TemplatesApi.md +447 -0
- data/docs/TestWebhookTransformRequest.md +18 -0
- data/docs/Topic.md +30 -0
- data/docs/TopicDeleteResponse.md +20 -0
- data/docs/TopicDeleteResponseData.md +20 -0
- data/docs/TopicListResponse.md +20 -0
- data/docs/TopicResponse.md +20 -0
- data/docs/TopicStatsData.md +22 -0
- data/docs/TopicStatsDataTopicsBySubscriberCountInner.md +22 -0
- data/docs/TopicStatsResponse.md +20 -0
- data/docs/TopicSubscriber.md +22 -0
- data/docs/TopicSubscriberListResponse.md +20 -0
- data/docs/TopicSubscribersAddResponse.md +20 -0
- data/docs/TopicSubscribersAddResult.md +22 -0
- data/docs/TopicSubscribersRemoveResponse.md +20 -0
- data/docs/TopicSubscribersRemoveResult.md +22 -0
- data/docs/TopicsApi.md +670 -0
- data/docs/UnreadCountData.md +18 -0
- data/docs/UnreadCountResponse.md +20 -0
- data/docs/Unsubscribe.md +26 -0
- data/docs/UnsubscribeListResponse.md +20 -0
- data/docs/UnsubscribeRequest.md +20 -0
- data/docs/UnsubscribeResponse.md +20 -0
- data/docs/UpdateCategoryRequest.md +26 -0
- data/docs/UpdateEndUserRequest.md +22 -0
- data/docs/UpdateSubscriberRequest.md +32 -0
- data/docs/UpdateTemplateRequest.md +28 -0
- data/docs/UpdateTopicRequest.md +20 -0
- data/docs/UpdateWebhookRequest.md +36 -0
- data/docs/UpsertSmsConfigRequest.md +24 -0
- data/docs/UserDevicesDeleteResponse.md +20 -0
- data/docs/UserDevicesDeleteResponseData.md +20 -0
- data/docs/UtilityApi.md +76 -0
- data/docs/ValidateResetTokenRequest.md +18 -0
- data/docs/ValidateResetTokenResponse.md +20 -0
- data/docs/ValidateResetTokenResponseData.md +20 -0
- data/docs/VerifySmsConfigData.md +20 -0
- data/docs/VerifySmsConfigResponse.md +20 -0
- data/docs/WebAuthnChallengeOptions.md +20 -0
- data/docs/WebAuthnCredential.md +32 -0
- data/docs/WebAuthnCredentialListResponse.md +20 -0
- data/docs/WebAuthnCredentialListResponseData.md +18 -0
- data/docs/WebAuthnCredentialResponse.md +20 -0
- data/docs/WebAuthnStartAuthRequest.md +20 -0
- data/docs/WebAuthnStartAuthResponse.md +20 -0
- data/docs/WebAuthnStartRegistrationRequest.md +18 -0
- data/docs/WebAuthnStartRegistrationResponse.md +20 -0
- data/docs/WebAuthnStatusResponse.md +20 -0
- data/docs/WebAuthnStatusResponseData.md +20 -0
- data/docs/WebAuthnVerifyAuthRequest.md +22 -0
- data/docs/WebAuthnVerifyRegistrationRequest.md +22 -0
- data/docs/WebAuthnVerifyRegistrationResponse.md +20 -0
- data/docs/WebAuthnVerifyRegistrationResponseData.md +18 -0
- data/docs/Webhook.md +44 -0
- data/docs/WebhookBulkRetryResponse.md +20 -0
- data/docs/WebhookCircuitState.md +26 -0
- data/docs/WebhookCircuitStateResponse.md +20 -0
- data/docs/WebhookCreateResponse.md +20 -0
- data/docs/WebhookCreateResponseData.md +46 -0
- data/docs/WebhookDeleteResponse.md +20 -0
- data/docs/WebhookDeleteResponseData.md +20 -0
- data/docs/WebhookDelivery.md +48 -0
- data/docs/WebhookDeliveryDetail.md +56 -0
- data/docs/WebhookDeliveryListResponse.md +20 -0
- data/docs/WebhookDeliveryResponse.md +20 -0
- data/docs/WebhookDeliveryRetryResponse.md +20 -0
- data/docs/WebhookDeliveryRetryResponseData.md +22 -0
- data/docs/WebhookEventTypesResponse.md +20 -0
- data/docs/WebhookEventTypesResponseData.md +24 -0
- data/docs/WebhookIpsResponse.md +20 -0
- data/docs/WebhookIpsResponseData.md +22 -0
- data/docs/WebhookJobResponse.md +20 -0
- data/docs/WebhookListResponse.md +20 -0
- data/docs/WebhookMetricsResponse.md +20 -0
- data/docs/WebhookRegion.md +22 -0
- data/docs/WebhookRegionsResponse.md +20 -0
- data/docs/WebhookRegionsResponseData.md +20 -0
- data/docs/WebhookReplayResponse.md +20 -0
- data/docs/WebhookResponse.md +20 -0
- data/docs/WebhookSecretRotateResponse.md +20 -0
- data/docs/WebhookSecretRotateResponseData.md +20 -0
- data/docs/WebhookTestEventResponse.md +20 -0
- data/docs/WebhookTestEventResponseData.md +24 -0
- data/docs/WebhookTransformTestResponse.md +20 -0
- data/docs/WebhookUsageResponse.md +20 -0
- data/docs/WebhookVersion.md +32 -0
- data/docs/WebhookVersionsResponse.md +20 -0
- data/docs/WebhookVersionsResponseData.md +20 -0
- data/docs/WebhookWorkspaceMetricsResponse.md +20 -0
- data/docs/WebhooksApi.md +1688 -0
- data/docs/WithdrawSubscriberConsentRequest.md +18 -0
- data/git_push.sh +57 -0
- data/lib/zyphr/api/auth_email_verification_api.rb +218 -0
- data/lib/zyphr/api/auth_login_api.rb +90 -0
- data/lib/zyphr/api/auth_magic_links_api.rb +158 -0
- data/lib/zyphr/api/auth_mfa_api.rb +493 -0
- data/lib/zyphr/api/auth_o_auth_api.rb +550 -0
- data/lib/zyphr/api/auth_password_reset_api.rb +226 -0
- data/lib/zyphr/api/auth_phone_api.rb +351 -0
- data/lib/zyphr/api/auth_registration_api.rb +90 -0
- data/lib/zyphr/api/auth_sessions_api.rb +272 -0
- data/lib/zyphr/api/auth_user_profile_api.rb +204 -0
- data/lib/zyphr/api/auth_web_authn_api.rb +537 -0
- data/lib/zyphr/api/devices_api.rb +409 -0
- data/lib/zyphr/api/emails_api.rb +432 -0
- data/lib/zyphr/api/inbox_api.rb +650 -0
- data/lib/zyphr/api/push_api.rb +644 -0
- data/lib/zyphr/api/sms_api.rb +605 -0
- data/lib/zyphr/api/subscribers_api.rb +1340 -0
- data/lib/zyphr/api/templates_api.rb +427 -0
- data/lib/zyphr/api/topics_api.rb +630 -0
- data/lib/zyphr/api/utility_api.rb +79 -0
- data/lib/zyphr/api/webhooks_api.rb +1527 -0
- data/lib/zyphr/api_client.rb +437 -0
- data/lib/zyphr/api_error.rb +58 -0
- data/lib/zyphr/configuration.rb +438 -0
- data/lib/zyphr/models/add_topic_subscribers_request.rb +259 -0
- data/lib/zyphr/models/api_error.rb +246 -0
- data/lib/zyphr/models/api_error_error.rb +274 -0
- data/lib/zyphr/models/api_error_meta.rb +220 -0
- data/lib/zyphr/models/auth_login_response.rb +229 -0
- data/lib/zyphr/models/auth_login_result.rb +247 -0
- data/lib/zyphr/models/auth_login_result_mfa_challenge.rb +229 -0
- data/lib/zyphr/models/auth_result.rb +229 -0
- data/lib/zyphr/models/auth_result_response.rb +229 -0
- data/lib/zyphr/models/auth_session.rb +265 -0
- data/lib/zyphr/models/auth_tokens.rb +248 -0
- data/lib/zyphr/models/auth_user.rb +369 -0
- data/lib/zyphr/models/auth_user_response.rb +229 -0
- data/lib/zyphr/models/auth_user_response_data.rb +220 -0
- data/lib/zyphr/models/bulk_retry_webhook_deliveries_request.rb +287 -0
- data/lib/zyphr/models/category.rb +295 -0
- data/lib/zyphr/models/category_list_response.rb +231 -0
- data/lib/zyphr/models/category_response.rb +229 -0
- data/lib/zyphr/models/confirm_email_verification_request.rb +237 -0
- data/lib/zyphr/models/confirm_email_verification_response.rb +229 -0
- data/lib/zyphr/models/confirm_email_verification_response_data.rb +229 -0
- data/lib/zyphr/models/consent_history_entry.rb +287 -0
- data/lib/zyphr/models/consent_history_response.rb +231 -0
- data/lib/zyphr/models/consent_record_response.rb +229 -0
- data/lib/zyphr/models/consent_record_response_data.rb +229 -0
- data/lib/zyphr/models/consent_status.rb +249 -0
- data/lib/zyphr/models/consent_status_response.rb +229 -0
- data/lib/zyphr/models/consent_withdraw_response.rb +229 -0
- data/lib/zyphr/models/create_category_request.rb +309 -0
- data/lib/zyphr/models/create_subscriber_request.rb +303 -0
- data/lib/zyphr/models/create_template_request.rb +300 -0
- data/lib/zyphr/models/create_topic_request.rb +275 -0
- data/lib/zyphr/models/create_webhook_request.rb +350 -0
- data/lib/zyphr/models/delete_result.rb +229 -0
- data/lib/zyphr/models/delete_result_data.rb +229 -0
- data/lib/zyphr/models/device.rb +343 -0
- data/lib/zyphr/models/device_list_response.rb +231 -0
- data/lib/zyphr/models/device_push_topic.rb +238 -0
- data/lib/zyphr/models/device_push_topic_list_response.rb +231 -0
- data/lib/zyphr/models/device_push_topic_list_response_meta.rb +229 -0
- data/lib/zyphr/models/device_response.rb +229 -0
- data/lib/zyphr/models/device_stats.rb +231 -0
- data/lib/zyphr/models/device_stats_response.rb +229 -0
- data/lib/zyphr/models/email_address.rb +229 -0
- data/lib/zyphr/models/email_attachment.rb +328 -0
- data/lib/zyphr/models/email_event.rb +286 -0
- data/lib/zyphr/models/email_events_response.rb +231 -0
- data/lib/zyphr/models/email_list_response.rb +231 -0
- data/lib/zyphr/models/email_message.rb +369 -0
- data/lib/zyphr/models/email_response.rb +229 -0
- data/lib/zyphr/models/email_tracking_click_link.rb +238 -0
- data/lib/zyphr/models/email_tracking_clicks.rb +241 -0
- data/lib/zyphr/models/email_tracking_data.rb +229 -0
- data/lib/zyphr/models/email_tracking_opens.rb +230 -0
- data/lib/zyphr/models/email_tracking_response.rb +229 -0
- data/lib/zyphr/models/end_user_delete_response.rb +229 -0
- data/lib/zyphr/models/end_user_delete_response_data.rb +229 -0
- data/lib/zyphr/models/forgot_password_request.rb +246 -0
- data/lib/zyphr/models/in_app_notification.rb +400 -0
- data/lib/zyphr/models/inbox_list_meta.rb +266 -0
- data/lib/zyphr/models/inbox_list_response.rb +231 -0
- data/lib/zyphr/models/inbox_notification_response.rb +229 -0
- data/lib/zyphr/models/login_request.rb +275 -0
- data/lib/zyphr/models/magic_link_send_request.rb +246 -0
- data/lib/zyphr/models/magic_link_verify_request.rb +237 -0
- data/lib/zyphr/models/magic_link_verify_response.rb +229 -0
- data/lib/zyphr/models/magic_link_verify_response_data.rb +245 -0
- data/lib/zyphr/models/mark_all_inbox_read_request.rb +238 -0
- data/lib/zyphr/models/mark_all_read_data.rb +220 -0
- data/lib/zyphr/models/mark_all_read_response.rb +229 -0
- data/lib/zyphr/models/mark_inbox_read_request.rb +229 -0
- data/lib/zyphr/models/mfa_backup_codes_response.rb +229 -0
- data/lib/zyphr/models/mfa_backup_codes_response_data.rb +223 -0
- data/lib/zyphr/models/mfa_disable_request.rb +263 -0
- data/lib/zyphr/models/mfa_disable_response.rb +229 -0
- data/lib/zyphr/models/mfa_disable_response_data.rb +220 -0
- data/lib/zyphr/models/mfa_enroll_request.rb +237 -0
- data/lib/zyphr/models/mfa_enrollment_response.rb +229 -0
- data/lib/zyphr/models/mfa_enrollment_response_data.rb +243 -0
- data/lib/zyphr/models/mfa_regenerate_backup_codes_request.rb +281 -0
- data/lib/zyphr/models/mfa_status_response.rb +229 -0
- data/lib/zyphr/models/mfa_status_response_data.rb +282 -0
- data/lib/zyphr/models/mfa_verify_backup_request.rb +263 -0
- data/lib/zyphr/models/mfa_verify_backup_response.rb +229 -0
- data/lib/zyphr/models/mfa_verify_backup_response_data.rb +239 -0
- data/lib/zyphr/models/mfa_verify_enrollment_request.rb +281 -0
- data/lib/zyphr/models/mfa_verify_enrollment_response.rb +229 -0
- data/lib/zyphr/models/mfa_verify_enrollment_response_data.rb +220 -0
- data/lib/zyphr/models/mfa_verify_request.rb +281 -0
- data/lib/zyphr/models/o_auth_authorization_url_response.rb +229 -0
- data/lib/zyphr/models/o_auth_authorization_url_response_data.rb +229 -0
- data/lib/zyphr/models/o_auth_callback_request.rb +274 -0
- data/lib/zyphr/models/o_auth_callback_response.rb +229 -0
- data/lib/zyphr/models/o_auth_callback_response_data.rb +254 -0
- data/lib/zyphr/models/o_auth_connection.rb +276 -0
- data/lib/zyphr/models/o_auth_connection_info_response.rb +229 -0
- data/lib/zyphr/models/o_auth_connection_info_response_data.rb +267 -0
- data/lib/zyphr/models/o_auth_connections_response.rb +229 -0
- data/lib/zyphr/models/o_auth_connections_response_data.rb +222 -0
- data/lib/zyphr/models/o_auth_provider.rb +231 -0
- data/lib/zyphr/models/o_auth_provider_info.rb +276 -0
- data/lib/zyphr/models/o_auth_providers_response.rb +229 -0
- data/lib/zyphr/models/o_auth_providers_response_data.rb +222 -0
- data/lib/zyphr/models/o_auth_tokens_refresh_response.rb +229 -0
- data/lib/zyphr/models/o_auth_tokens_refresh_response_data.rb +258 -0
- data/lib/zyphr/models/o_auth_tokens_response.rb +229 -0
- data/lib/zyphr/models/o_auth_tokens_response_data.rb +267 -0
- data/lib/zyphr/models/pagination_meta.rb +247 -0
- data/lib/zyphr/models/password_requirements.rb +265 -0
- data/lib/zyphr/models/password_requirements_response.rb +229 -0
- data/lib/zyphr/models/password_requirements_response_data.rb +220 -0
- data/lib/zyphr/models/phone_auth_availability_response.rb +229 -0
- data/lib/zyphr/models/phone_auth_availability_response_data.rb +229 -0
- data/lib/zyphr/models/phone_login_verify_request.rb +274 -0
- data/lib/zyphr/models/phone_otp_send_request.rb +237 -0
- data/lib/zyphr/models/phone_otp_sent_response.rb +229 -0
- data/lib/zyphr/models/phone_otp_sent_response_data.rb +229 -0
- data/lib/zyphr/models/phone_register_verify_request.rb +283 -0
- data/lib/zyphr/models/preference_list_response.rb +231 -0
- data/lib/zyphr/models/push_detail_response.rb +229 -0
- data/lib/zyphr/models/push_event.rb +267 -0
- data/lib/zyphr/models/push_list_response.rb +231 -0
- data/lib/zyphr/models/push_message.rb +350 -0
- data/lib/zyphr/models/push_message_detail.rb +488 -0
- data/lib/zyphr/models/push_payload.rb +319 -0
- data/lib/zyphr/models/push_stats_data.rb +265 -0
- data/lib/zyphr/models/push_stats_response.rb +229 -0
- data/lib/zyphr/models/push_topic_device.rb +291 -0
- data/lib/zyphr/models/push_topic_device_list_response.rb +231 -0
- data/lib/zyphr/models/push_topic_subscribe_data.rb +249 -0
- data/lib/zyphr/models/push_topic_subscribe_response.rb +229 -0
- data/lib/zyphr/models/push_topic_unsubscribe_data.rb +249 -0
- data/lib/zyphr/models/push_topic_unsubscribe_response.rb +229 -0
- data/lib/zyphr/models/refresh_o_auth_tokens_request.rb +237 -0
- data/lib/zyphr/models/refresh_session_request.rb +248 -0
- data/lib/zyphr/models/refresh_token_response.rb +229 -0
- data/lib/zyphr/models/refresh_token_response_data.rb +229 -0
- data/lib/zyphr/models/register_device_request.rb +352 -0
- data/lib/zyphr/models/register_request.rb +283 -0
- data/lib/zyphr/models/remove_topic_subscribers_request.rb +249 -0
- data/lib/zyphr/models/rename_web_authn_credential_request.rb +246 -0
- data/lib/zyphr/models/render_template_request.rb +239 -0
- data/lib/zyphr/models/replay_webhook_events_request.rb +277 -0
- data/lib/zyphr/models/request_meta.rb +220 -0
- data/lib/zyphr/models/reset_password_request.rb +263 -0
- data/lib/zyphr/models/reset_password_response.rb +229 -0
- data/lib/zyphr/models/resubscribe_request.rb +254 -0
- data/lib/zyphr/models/resubscribe_response.rb +229 -0
- data/lib/zyphr/models/revoke_all_sessions_response.rb +229 -0
- data/lib/zyphr/models/revoke_all_sessions_response_data.rb +229 -0
- data/lib/zyphr/models/revoke_session_request.rb +237 -0
- data/lib/zyphr/models/send_batch_email_request.rb +248 -0
- data/lib/zyphr/models/send_batch_email_response.rb +229 -0
- data/lib/zyphr/models/send_batch_email_result.rb +258 -0
- data/lib/zyphr/models/send_batch_email_result_item.rb +238 -0
- data/lib/zyphr/models/send_batch_in_app_meta.rb +257 -0
- data/lib/zyphr/models/send_batch_in_app_request.rb +248 -0
- data/lib/zyphr/models/send_batch_in_app_response.rb +231 -0
- data/lib/zyphr/models/send_batch_sms_data.rb +251 -0
- data/lib/zyphr/models/send_batch_sms_request.rb +284 -0
- data/lib/zyphr/models/send_batch_sms_response.rb +229 -0
- data/lib/zyphr/models/send_email_request.rb +424 -0
- data/lib/zyphr/models/send_email_response.rb +229 -0
- data/lib/zyphr/models/send_email_response_data.rb +263 -0
- data/lib/zyphr/models/send_email_response_meta.rb +229 -0
- data/lib/zyphr/models/send_email_verification_request.rb +221 -0
- data/lib/zyphr/models/send_in_app_meta.rb +220 -0
- data/lib/zyphr/models/send_in_app_request.rb +393 -0
- data/lib/zyphr/models/send_in_app_response.rb +229 -0
- data/lib/zyphr/models/send_push_request.rb +353 -0
- data/lib/zyphr/models/send_push_response.rb +229 -0
- data/lib/zyphr/models/send_push_response_data.rb +247 -0
- data/lib/zyphr/models/send_push_to_topic_data.rb +247 -0
- data/lib/zyphr/models/send_push_to_topic_request.rb +309 -0
- data/lib/zyphr/models/send_push_to_topic_response.rb +229 -0
- data/lib/zyphr/models/send_sms_data.rb +284 -0
- data/lib/zyphr/models/send_sms_request.rb +312 -0
- data/lib/zyphr/models/send_sms_response.rb +229 -0
- data/lib/zyphr/models/send_test_sms_data.rb +256 -0
- data/lib/zyphr/models/send_test_sms_request.rb +248 -0
- data/lib/zyphr/models/send_test_sms_response.rb +229 -0
- data/lib/zyphr/models/send_webhook_test_event_request.rb +231 -0
- data/lib/zyphr/models/session_list_response.rb +229 -0
- data/lib/zyphr/models/session_list_response_data.rb +231 -0
- data/lib/zyphr/models/session_list_response_data_session_info.rb +239 -0
- data/lib/zyphr/models/set_preferences_request.rb +239 -0
- data/lib/zyphr/models/set_preferences_request_preferences_inner.rb +238 -0
- data/lib/zyphr/models/sms_batch_result_message.rb +256 -0
- data/lib/zyphr/models/sms_batch_result_summary.rb +238 -0
- data/lib/zyphr/models/sms_config.rb +285 -0
- data/lib/zyphr/models/sms_config_delete_response.rb +229 -0
- data/lib/zyphr/models/sms_config_delete_response_data.rb +220 -0
- data/lib/zyphr/models/sms_config_response.rb +229 -0
- data/lib/zyphr/models/sms_detail_response.rb +229 -0
- data/lib/zyphr/models/sms_list_response.rb +231 -0
- data/lib/zyphr/models/sms_list_response_meta.rb +256 -0
- data/lib/zyphr/models/sms_message.rb +319 -0
- data/lib/zyphr/models/sms_message_detail.rb +426 -0
- data/lib/zyphr/models/subscribe_push_topic_request.rb +257 -0
- data/lib/zyphr/models/subscriber.rb +367 -0
- data/lib/zyphr/models/subscriber_list_response.rb +231 -0
- data/lib/zyphr/models/subscriber_preference.rb +308 -0
- data/lib/zyphr/models/subscriber_response.rb +229 -0
- data/lib/zyphr/models/success_result.rb +229 -0
- data/lib/zyphr/models/success_result_data.rb +220 -0
- data/lib/zyphr/models/template.rb +306 -0
- data/lib/zyphr/models/template_list_response.rb +231 -0
- data/lib/zyphr/models/template_render_response.rb +229 -0
- data/lib/zyphr/models/template_rendered_content.rb +241 -0
- data/lib/zyphr/models/template_response.rb +229 -0
- data/lib/zyphr/models/test_webhook_transform_request.rb +238 -0
- data/lib/zyphr/models/topic.rb +275 -0
- data/lib/zyphr/models/topic_delete_response.rb +229 -0
- data/lib/zyphr/models/topic_delete_response_data.rb +229 -0
- data/lib/zyphr/models/topic_list_response.rb +231 -0
- data/lib/zyphr/models/topic_response.rb +229 -0
- data/lib/zyphr/models/topic_stats_data.rb +240 -0
- data/lib/zyphr/models/topic_stats_data_topics_by_subscriber_count_inner.rb +238 -0
- data/lib/zyphr/models/topic_stats_response.rb +229 -0
- data/lib/zyphr/models/topic_subscriber.rb +238 -0
- data/lib/zyphr/models/topic_subscriber_list_response.rb +231 -0
- data/lib/zyphr/models/topic_subscribers_add_response.rb +229 -0
- data/lib/zyphr/models/topic_subscribers_add_result.rb +242 -0
- data/lib/zyphr/models/topic_subscribers_remove_response.rb +229 -0
- data/lib/zyphr/models/topic_subscribers_remove_result.rb +242 -0
- data/lib/zyphr/models/unread_count_data.rb +220 -0
- data/lib/zyphr/models/unread_count_response.rb +229 -0
- data/lib/zyphr/models/unsubscribe.rb +292 -0
- data/lib/zyphr/models/unsubscribe_list_response.rb +231 -0
- data/lib/zyphr/models/unsubscribe_request.rb +263 -0
- data/lib/zyphr/models/unsubscribe_response.rb +229 -0
- data/lib/zyphr/models/update_category_request.rb +258 -0
- data/lib/zyphr/models/update_end_user_request.rb +238 -0
- data/lib/zyphr/models/update_subscriber_request.rb +323 -0
- data/lib/zyphr/models/update_template_request.rb +288 -0
- data/lib/zyphr/models/update_topic_request.rb +230 -0
- data/lib/zyphr/models/update_webhook_request.rb +307 -0
- data/lib/zyphr/models/upsert_sms_config_request.rb +302 -0
- data/lib/zyphr/models/user_devices_delete_response.rb +229 -0
- data/lib/zyphr/models/user_devices_delete_response_data.rb +229 -0
- data/lib/zyphr/models/validate_reset_token_request.rb +237 -0
- data/lib/zyphr/models/validate_reset_token_response.rb +229 -0
- data/lib/zyphr/models/validate_reset_token_response_data.rb +229 -0
- data/lib/zyphr/models/verify_sms_config_data.rb +230 -0
- data/lib/zyphr/models/verify_sms_config_response.rb +229 -0
- data/lib/zyphr/models/web_authn_challenge_options.rb +229 -0
- data/lib/zyphr/models/web_authn_credential.rb +286 -0
- data/lib/zyphr/models/web_authn_credential_list_response.rb +229 -0
- data/lib/zyphr/models/web_authn_credential_list_response_data.rb +222 -0
- data/lib/zyphr/models/web_authn_credential_response.rb +229 -0
- data/lib/zyphr/models/web_authn_start_auth_request.rb +231 -0
- data/lib/zyphr/models/web_authn_start_auth_response.rb +229 -0
- data/lib/zyphr/models/web_authn_start_registration_request.rb +220 -0
- data/lib/zyphr/models/web_authn_start_registration_response.rb +229 -0
- data/lib/zyphr/models/web_authn_status_response.rb +229 -0
- data/lib/zyphr/models/web_authn_status_response_data.rb +229 -0
- data/lib/zyphr/models/web_authn_verify_auth_request.rb +275 -0
- data/lib/zyphr/models/web_authn_verify_registration_request.rb +273 -0
- data/lib/zyphr/models/web_authn_verify_registration_response.rb +229 -0
- data/lib/zyphr/models/web_authn_verify_registration_response_data.rb +220 -0
- data/lib/zyphr/models/webhook.rb +381 -0
- data/lib/zyphr/models/webhook_bulk_retry_response.rb +230 -0
- data/lib/zyphr/models/webhook_circuit_state.rb +292 -0
- data/lib/zyphr/models/webhook_circuit_state_response.rb +229 -0
- data/lib/zyphr/models/webhook_create_response.rb +229 -0
- data/lib/zyphr/models/webhook_create_response_data.rb +398 -0
- data/lib/zyphr/models/webhook_delete_response.rb +229 -0
- data/lib/zyphr/models/webhook_delete_response_data.rb +229 -0
- data/lib/zyphr/models/webhook_delivery.rb +397 -0
- data/lib/zyphr/models/webhook_delivery_detail.rb +444 -0
- data/lib/zyphr/models/webhook_delivery_list_response.rb +231 -0
- data/lib/zyphr/models/webhook_delivery_response.rb +229 -0
- data/lib/zyphr/models/webhook_delivery_retry_response.rb +229 -0
- data/lib/zyphr/models/webhook_delivery_retry_response_data.rb +238 -0
- data/lib/zyphr/models/webhook_event_types_response.rb +229 -0
- data/lib/zyphr/models/webhook_event_types_response_data.rb +253 -0
- data/lib/zyphr/models/webhook_ips_response.rb +229 -0
- data/lib/zyphr/models/webhook_ips_response_data.rb +243 -0
- data/lib/zyphr/models/webhook_job_response.rb +230 -0
- data/lib/zyphr/models/webhook_list_response.rb +231 -0
- data/lib/zyphr/models/webhook_metrics_response.rb +230 -0
- data/lib/zyphr/models/webhook_region.rb +240 -0
- data/lib/zyphr/models/webhook_regions_response.rb +229 -0
- data/lib/zyphr/models/webhook_regions_response_data.rb +232 -0
- data/lib/zyphr/models/webhook_replay_response.rb +230 -0
- data/lib/zyphr/models/webhook_response.rb +229 -0
- data/lib/zyphr/models/webhook_secret_rotate_response.rb +229 -0
- data/lib/zyphr/models/webhook_secret_rotate_response_data.rb +230 -0
- data/lib/zyphr/models/webhook_test_event_response.rb +229 -0
- data/lib/zyphr/models/webhook_test_event_response_data.rb +247 -0
- data/lib/zyphr/models/webhook_transform_test_response.rb +230 -0
- data/lib/zyphr/models/webhook_usage_response.rb +230 -0
- data/lib/zyphr/models/webhook_version.rb +288 -0
- data/lib/zyphr/models/webhook_versions_response.rb +229 -0
- data/lib/zyphr/models/webhook_versions_response_data.rb +231 -0
- data/lib/zyphr/models/webhook_workspace_metrics_response.rb +230 -0
- data/lib/zyphr/models/withdraw_subscriber_consent_request.rb +220 -0
- data/lib/zyphr/version.rb +15 -0
- data/lib/zyphr.rb +357 -0
- data/spec/api/auth_email_verification_api_spec.rb +71 -0
- data/spec/api/auth_login_api_spec.rb +47 -0
- data/spec/api/auth_magic_links_api_spec.rb +59 -0
- data/spec/api/auth_mfa_api_spec.rb +119 -0
- data/spec/api/auth_o_auth_api_spec.rb +133 -0
- data/spec/api/auth_password_reset_api_spec.rb +71 -0
- data/spec/api/auth_phone_api_spec.rb +94 -0
- data/spec/api/auth_registration_api_spec.rb +47 -0
- data/spec/api/auth_sessions_api_spec.rb +81 -0
- data/spec/api/auth_user_profile_api_spec.rb +69 -0
- data/spec/api/auth_web_authn_api_spec.rb +130 -0
- data/spec/api/devices_api_spec.rb +109 -0
- data/spec/api/emails_api_spec.rb +110 -0
- data/spec/api/inbox_api_spec.rb +157 -0
- data/spec/api/push_api_spec.rb +151 -0
- data/spec/api/sms_api_spec.rb +143 -0
- data/spec/api/subscribers_api_spec.rb +272 -0
- data/spec/api/templates_api_spec.rb +110 -0
- data/spec/api/topics_api_spec.rb +149 -0
- data/spec/api/utility_api_spec.rb +46 -0
- data/spec/api/webhooks_api_spec.rb +321 -0
- data/spec/models/add_topic_subscribers_request_spec.rb +42 -0
- data/spec/models/api_error_error_spec.rb +48 -0
- data/spec/models/api_error_meta_spec.rb +36 -0
- data/spec/models/api_error_spec.rb +42 -0
- data/spec/models/auth_login_response_spec.rb +42 -0
- data/spec/models/auth_login_result_mfa_challenge_spec.rb +42 -0
- data/spec/models/auth_login_result_spec.rb +54 -0
- data/spec/models/auth_result_response_spec.rb +42 -0
- data/spec/models/auth_result_spec.rb +42 -0
- data/spec/models/auth_session_spec.rb +66 -0
- data/spec/models/auth_tokens_spec.rb +54 -0
- data/spec/models/auth_user_response_data_spec.rb +36 -0
- data/spec/models/auth_user_response_spec.rb +42 -0
- data/spec/models/auth_user_spec.rb +112 -0
- data/spec/models/bulk_retry_webhook_deliveries_request_spec.rb +58 -0
- data/spec/models/category_list_response_spec.rb +42 -0
- data/spec/models/category_response_spec.rb +42 -0
- data/spec/models/category_spec.rb +84 -0
- data/spec/models/confirm_email_verification_request_spec.rb +36 -0
- data/spec/models/confirm_email_verification_response_data_spec.rb +42 -0
- data/spec/models/confirm_email_verification_response_spec.rb +42 -0
- data/spec/models/consent_history_entry_spec.rb +78 -0
- data/spec/models/consent_history_response_spec.rb +42 -0
- data/spec/models/consent_record_response_data_spec.rb +42 -0
- data/spec/models/consent_record_response_spec.rb +42 -0
- data/spec/models/consent_status_response_spec.rb +42 -0
- data/spec/models/consent_status_spec.rb +54 -0
- data/spec/models/consent_withdraw_response_spec.rb +42 -0
- data/spec/models/create_category_request_spec.rb +60 -0
- data/spec/models/create_subscriber_request_spec.rb +78 -0
- data/spec/models/create_template_request_spec.rb +66 -0
- data/spec/models/create_topic_request_spec.rb +48 -0
- data/spec/models/create_webhook_request_spec.rb +90 -0
- data/spec/models/delete_result_data_spec.rb +42 -0
- data/spec/models/delete_result_spec.rb +42 -0
- data/spec/models/device_list_response_spec.rb +42 -0
- data/spec/models/device_push_topic_list_response_meta_spec.rb +42 -0
- data/spec/models/device_push_topic_list_response_spec.rb +42 -0
- data/spec/models/device_push_topic_spec.rb +48 -0
- data/spec/models/device_response_spec.rb +42 -0
- data/spec/models/device_spec.rb +92 -0
- data/spec/models/device_stats_response_spec.rb +42 -0
- data/spec/models/device_stats_spec.rb +42 -0
- data/spec/models/email_address_spec.rb +42 -0
- data/spec/models/email_attachment_spec.rb +64 -0
- data/spec/models/email_event_spec.rb +78 -0
- data/spec/models/email_events_response_spec.rb +42 -0
- data/spec/models/email_list_response_spec.rb +42 -0
- data/spec/models/email_message_spec.rb +112 -0
- data/spec/models/email_response_spec.rb +42 -0
- data/spec/models/email_tracking_click_link_spec.rb +48 -0
- data/spec/models/email_tracking_clicks_spec.rb +48 -0
- data/spec/models/email_tracking_data_spec.rb +42 -0
- data/spec/models/email_tracking_opens_spec.rb +42 -0
- data/spec/models/email_tracking_response_spec.rb +42 -0
- data/spec/models/end_user_delete_response_data_spec.rb +42 -0
- data/spec/models/end_user_delete_response_spec.rb +42 -0
- data/spec/models/forgot_password_request_spec.rb +42 -0
- data/spec/models/in_app_notification_spec.rb +130 -0
- data/spec/models/inbox_list_meta_spec.rb +66 -0
- data/spec/models/inbox_list_response_spec.rb +42 -0
- data/spec/models/inbox_notification_response_spec.rb +42 -0
- data/spec/models/login_request_spec.rb +48 -0
- data/spec/models/magic_link_send_request_spec.rb +42 -0
- data/spec/models/magic_link_verify_request_spec.rb +36 -0
- data/spec/models/magic_link_verify_response_data_spec.rb +48 -0
- data/spec/models/magic_link_verify_response_spec.rb +42 -0
- data/spec/models/mark_all_inbox_read_request_spec.rb +48 -0
- data/spec/models/mark_all_read_data_spec.rb +36 -0
- data/spec/models/mark_all_read_response_spec.rb +42 -0
- data/spec/models/mark_inbox_read_request_spec.rb +42 -0
- data/spec/models/mfa_backup_codes_response_data_spec.rb +36 -0
- data/spec/models/mfa_backup_codes_response_spec.rb +42 -0
- data/spec/models/mfa_disable_request_spec.rb +42 -0
- data/spec/models/mfa_disable_response_data_spec.rb +36 -0
- data/spec/models/mfa_disable_response_spec.rb +42 -0
- data/spec/models/mfa_enroll_request_spec.rb +36 -0
- data/spec/models/mfa_enrollment_response_data_spec.rb +48 -0
- data/spec/models/mfa_enrollment_response_spec.rb +42 -0
- data/spec/models/mfa_regenerate_backup_codes_request_spec.rb +42 -0
- data/spec/models/mfa_status_response_data_spec.rb +58 -0
- data/spec/models/mfa_status_response_spec.rb +42 -0
- data/spec/models/mfa_verify_backup_request_spec.rb +42 -0
- data/spec/models/mfa_verify_backup_response_data_spec.rb +48 -0
- data/spec/models/mfa_verify_backup_response_spec.rb +42 -0
- data/spec/models/mfa_verify_enrollment_request_spec.rb +42 -0
- data/spec/models/mfa_verify_enrollment_response_data_spec.rb +36 -0
- data/spec/models/mfa_verify_enrollment_response_spec.rb +42 -0
- data/spec/models/mfa_verify_request_spec.rb +42 -0
- data/spec/models/o_auth_authorization_url_response_data_spec.rb +42 -0
- data/spec/models/o_auth_authorization_url_response_spec.rb +42 -0
- data/spec/models/o_auth_callback_request_spec.rb +48 -0
- data/spec/models/o_auth_callback_response_data_spec.rb +54 -0
- data/spec/models/o_auth_callback_response_spec.rb +42 -0
- data/spec/models/o_auth_connection_info_response_data_spec.rb +66 -0
- data/spec/models/o_auth_connection_info_response_spec.rb +42 -0
- data/spec/models/o_auth_connection_spec.rb +72 -0
- data/spec/models/o_auth_connections_response_data_spec.rb +36 -0
- data/spec/models/o_auth_connections_response_spec.rb +42 -0
- data/spec/models/o_auth_provider_info_spec.rb +72 -0
- data/spec/models/o_auth_provider_spec.rb +42 -0
- data/spec/models/o_auth_providers_response_data_spec.rb +36 -0
- data/spec/models/o_auth_providers_response_spec.rb +42 -0
- data/spec/models/o_auth_tokens_refresh_response_data_spec.rb +60 -0
- data/spec/models/o_auth_tokens_refresh_response_spec.rb +42 -0
- data/spec/models/o_auth_tokens_response_data_spec.rb +66 -0
- data/spec/models/o_auth_tokens_response_spec.rb +42 -0
- data/spec/models/pagination_meta_spec.rb +54 -0
- data/spec/models/password_requirements_response_data_spec.rb +36 -0
- data/spec/models/password_requirements_response_spec.rb +42 -0
- data/spec/models/password_requirements_spec.rb +66 -0
- data/spec/models/phone_auth_availability_response_data_spec.rb +42 -0
- data/spec/models/phone_auth_availability_response_spec.rb +42 -0
- data/spec/models/phone_login_verify_request_spec.rb +48 -0
- data/spec/models/phone_otp_send_request_spec.rb +36 -0
- data/spec/models/phone_otp_sent_response_data_spec.rb +42 -0
- data/spec/models/phone_otp_sent_response_spec.rb +42 -0
- data/spec/models/phone_register_verify_request_spec.rb +54 -0
- data/spec/models/preference_list_response_spec.rb +42 -0
- data/spec/models/push_detail_response_spec.rb +42 -0
- data/spec/models/push_event_spec.rb +66 -0
- data/spec/models/push_list_response_spec.rb +42 -0
- data/spec/models/push_message_detail_spec.rb +176 -0
- data/spec/models/push_message_spec.rb +98 -0
- data/spec/models/push_payload_spec.rb +78 -0
- data/spec/models/push_stats_data_spec.rb +66 -0
- data/spec/models/push_stats_response_spec.rb +42 -0
- data/spec/models/push_topic_device_list_response_spec.rb +42 -0
- data/spec/models/push_topic_device_spec.rb +64 -0
- data/spec/models/push_topic_subscribe_data_spec.rb +54 -0
- data/spec/models/push_topic_subscribe_response_spec.rb +42 -0
- data/spec/models/push_topic_unsubscribe_data_spec.rb +54 -0
- data/spec/models/push_topic_unsubscribe_response_spec.rb +42 -0
- data/spec/models/refresh_o_auth_tokens_request_spec.rb +36 -0
- data/spec/models/refresh_session_request_spec.rb +42 -0
- data/spec/models/refresh_token_response_data_spec.rb +42 -0
- data/spec/models/refresh_token_response_spec.rb +42 -0
- data/spec/models/register_device_request_spec.rb +88 -0
- data/spec/models/register_request_spec.rb +54 -0
- data/spec/models/remove_topic_subscribers_request_spec.rb +36 -0
- data/spec/models/rename_web_authn_credential_request_spec.rb +36 -0
- data/spec/models/render_template_request_spec.rb +36 -0
- data/spec/models/replay_webhook_events_request_spec.rb +48 -0
- data/spec/models/request_meta_spec.rb +36 -0
- data/spec/models/reset_password_request_spec.rb +42 -0
- data/spec/models/reset_password_response_spec.rb +42 -0
- data/spec/models/resubscribe_request_spec.rb +40 -0
- data/spec/models/resubscribe_response_spec.rb +42 -0
- data/spec/models/revoke_all_sessions_response_data_spec.rb +42 -0
- data/spec/models/revoke_all_sessions_response_spec.rb +42 -0
- data/spec/models/revoke_session_request_spec.rb +36 -0
- data/spec/models/send_batch_email_request_spec.rb +36 -0
- data/spec/models/send_batch_email_response_spec.rb +42 -0
- data/spec/models/send_batch_email_result_item_spec.rb +48 -0
- data/spec/models/send_batch_email_result_spec.rb +60 -0
- data/spec/models/send_batch_in_app_meta_spec.rb +60 -0
- data/spec/models/send_batch_in_app_request_spec.rb +36 -0
- data/spec/models/send_batch_in_app_response_spec.rb +42 -0
- data/spec/models/send_batch_sms_data_spec.rb +54 -0
- data/spec/models/send_batch_sms_request_spec.rb +42 -0
- data/spec/models/send_batch_sms_response_spec.rb +42 -0
- data/spec/models/send_email_request_spec.rb +132 -0
- data/spec/models/send_email_response_data_spec.rb +46 -0
- data/spec/models/send_email_response_meta_spec.rb +42 -0
- data/spec/models/send_email_response_spec.rb +42 -0
- data/spec/models/send_email_verification_request_spec.rb +36 -0
- data/spec/models/send_in_app_meta_spec.rb +36 -0
- data/spec/models/send_in_app_request_spec.rb +106 -0
- data/spec/models/send_in_app_response_spec.rb +42 -0
- data/spec/models/send_push_request_spec.rb +88 -0
- data/spec/models/send_push_response_data_spec.rb +54 -0
- data/spec/models/send_push_response_spec.rb +42 -0
- data/spec/models/send_push_to_topic_data_spec.rb +54 -0
- data/spec/models/send_push_to_topic_request_spec.rb +90 -0
- data/spec/models/send_push_to_topic_response_spec.rb +42 -0
- data/spec/models/send_sms_data_spec.rb +78 -0
- data/spec/models/send_sms_request_spec.rb +66 -0
- data/spec/models/send_sms_response_spec.rb +42 -0
- data/spec/models/send_test_sms_data_spec.rb +60 -0
- data/spec/models/send_test_sms_request_spec.rb +42 -0
- data/spec/models/send_test_sms_response_spec.rb +42 -0
- data/spec/models/send_webhook_test_event_request_spec.rb +42 -0
- data/spec/models/session_list_response_data_session_info_spec.rb +48 -0
- data/spec/models/session_list_response_data_spec.rb +42 -0
- data/spec/models/session_list_response_spec.rb +42 -0
- data/spec/models/set_preferences_request_preferences_inner_spec.rb +48 -0
- data/spec/models/set_preferences_request_spec.rb +36 -0
- data/spec/models/sms_batch_result_message_spec.rb +60 -0
- data/spec/models/sms_batch_result_summary_spec.rb +48 -0
- data/spec/models/sms_config_delete_response_data_spec.rb +36 -0
- data/spec/models/sms_config_delete_response_spec.rb +42 -0
- data/spec/models/sms_config_response_spec.rb +42 -0
- data/spec/models/sms_config_spec.rb +78 -0
- data/spec/models/sms_detail_response_spec.rb +42 -0
- data/spec/models/sms_list_response_meta_spec.rb +60 -0
- data/spec/models/sms_list_response_spec.rb +42 -0
- data/spec/models/sms_message_detail_spec.rb +142 -0
- data/spec/models/sms_message_spec.rb +82 -0
- data/spec/models/subscribe_push_topic_request_spec.rb +36 -0
- data/spec/models/subscriber_list_response_spec.rb +42 -0
- data/spec/models/subscriber_preference_spec.rb +76 -0
- data/spec/models/subscriber_response_spec.rb +42 -0
- data/spec/models/subscriber_spec.rb +112 -0
- data/spec/models/success_result_data_spec.rb +36 -0
- data/spec/models/success_result_spec.rb +42 -0
- data/spec/models/template_list_response_spec.rb +42 -0
- data/spec/models/template_render_response_spec.rb +42 -0
- data/spec/models/template_rendered_content_spec.rb +48 -0
- data/spec/models/template_response_spec.rb +42 -0
- data/spec/models/template_spec.rb +90 -0
- data/spec/models/test_webhook_transform_request_spec.rb +36 -0
- data/spec/models/topic_delete_response_data_spec.rb +42 -0
- data/spec/models/topic_delete_response_spec.rb +42 -0
- data/spec/models/topic_list_response_spec.rb +42 -0
- data/spec/models/topic_response_spec.rb +42 -0
- data/spec/models/topic_spec.rb +72 -0
- data/spec/models/topic_stats_data_spec.rb +48 -0
- data/spec/models/topic_stats_data_topics_by_subscriber_count_inner_spec.rb +48 -0
- data/spec/models/topic_stats_response_spec.rb +42 -0
- data/spec/models/topic_subscriber_list_response_spec.rb +42 -0
- data/spec/models/topic_subscriber_spec.rb +48 -0
- data/spec/models/topic_subscribers_add_response_spec.rb +42 -0
- data/spec/models/topic_subscribers_add_result_spec.rb +48 -0
- data/spec/models/topic_subscribers_remove_response_spec.rb +42 -0
- data/spec/models/topic_subscribers_remove_result_spec.rb +48 -0
- data/spec/models/unread_count_data_spec.rb +36 -0
- data/spec/models/unread_count_response_spec.rb +42 -0
- data/spec/models/unsubscribe_list_response_spec.rb +42 -0
- data/spec/models/unsubscribe_request_spec.rb +46 -0
- data/spec/models/unsubscribe_response_spec.rb +42 -0
- data/spec/models/unsubscribe_spec.rb +64 -0
- data/spec/models/update_category_request_spec.rb +60 -0
- data/spec/models/update_end_user_request_spec.rb +48 -0
- data/spec/models/update_subscriber_request_spec.rb +82 -0
- data/spec/models/update_template_request_spec.rb +66 -0
- data/spec/models/update_topic_request_spec.rb +42 -0
- data/spec/models/update_webhook_request_spec.rb +90 -0
- data/spec/models/upsert_sms_config_request_spec.rb +54 -0
- data/spec/models/user_devices_delete_response_data_spec.rb +42 -0
- data/spec/models/user_devices_delete_response_spec.rb +42 -0
- data/spec/models/validate_reset_token_request_spec.rb +36 -0
- data/spec/models/validate_reset_token_response_data_spec.rb +42 -0
- data/spec/models/validate_reset_token_response_spec.rb +42 -0
- data/spec/models/verify_sms_config_data_spec.rb +42 -0
- data/spec/models/verify_sms_config_response_spec.rb +42 -0
- data/spec/models/web_authn_challenge_options_spec.rb +42 -0
- data/spec/models/web_authn_credential_list_response_data_spec.rb +36 -0
- data/spec/models/web_authn_credential_list_response_spec.rb +42 -0
- data/spec/models/web_authn_credential_response_spec.rb +42 -0
- data/spec/models/web_authn_credential_spec.rb +78 -0
- data/spec/models/web_authn_start_auth_request_spec.rb +42 -0
- data/spec/models/web_authn_start_auth_response_spec.rb +42 -0
- data/spec/models/web_authn_start_registration_request_spec.rb +36 -0
- data/spec/models/web_authn_start_registration_response_spec.rb +42 -0
- data/spec/models/web_authn_status_response_data_spec.rb +42 -0
- data/spec/models/web_authn_status_response_spec.rb +42 -0
- data/spec/models/web_authn_verify_auth_request_spec.rb +48 -0
- data/spec/models/web_authn_verify_registration_request_spec.rb +48 -0
- data/spec/models/web_authn_verify_registration_response_data_spec.rb +36 -0
- data/spec/models/web_authn_verify_registration_response_spec.rb +42 -0
- data/spec/models/webhook_bulk_retry_response_spec.rb +42 -0
- data/spec/models/webhook_circuit_state_response_spec.rb +42 -0
- data/spec/models/webhook_circuit_state_spec.rb +64 -0
- data/spec/models/webhook_create_response_data_spec.rb +124 -0
- data/spec/models/webhook_create_response_spec.rb +42 -0
- data/spec/models/webhook_delete_response_data_spec.rb +42 -0
- data/spec/models/webhook_delete_response_spec.rb +42 -0
- data/spec/models/webhook_delivery_detail_spec.rb +154 -0
- data/spec/models/webhook_delivery_list_response_spec.rb +42 -0
- data/spec/models/webhook_delivery_response_spec.rb +42 -0
- data/spec/models/webhook_delivery_retry_response_data_spec.rb +48 -0
- data/spec/models/webhook_delivery_retry_response_spec.rb +42 -0
- data/spec/models/webhook_delivery_spec.rb +130 -0
- data/spec/models/webhook_event_types_response_data_spec.rb +54 -0
- data/spec/models/webhook_event_types_response_spec.rb +42 -0
- data/spec/models/webhook_ips_response_data_spec.rb +48 -0
- data/spec/models/webhook_ips_response_spec.rb +42 -0
- data/spec/models/webhook_job_response_spec.rb +42 -0
- data/spec/models/webhook_list_response_spec.rb +42 -0
- data/spec/models/webhook_metrics_response_spec.rb +42 -0
- data/spec/models/webhook_region_spec.rb +48 -0
- data/spec/models/webhook_regions_response_data_spec.rb +42 -0
- data/spec/models/webhook_regions_response_spec.rb +42 -0
- data/spec/models/webhook_replay_response_spec.rb +42 -0
- data/spec/models/webhook_response_spec.rb +42 -0
- data/spec/models/webhook_secret_rotate_response_data_spec.rb +42 -0
- data/spec/models/webhook_secret_rotate_response_spec.rb +42 -0
- data/spec/models/webhook_spec.rb +118 -0
- data/spec/models/webhook_test_event_response_data_spec.rb +54 -0
- data/spec/models/webhook_test_event_response_spec.rb +42 -0
- data/spec/models/webhook_transform_test_response_spec.rb +42 -0
- data/spec/models/webhook_usage_response_spec.rb +42 -0
- data/spec/models/webhook_version_spec.rb +78 -0
- data/spec/models/webhook_versions_response_data_spec.rb +42 -0
- data/spec/models/webhook_versions_response_spec.rb +42 -0
- data/spec/models/webhook_workspace_metrics_response_spec.rb +42 -0
- data/spec/models/withdraw_subscriber_consent_request_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/zyphr.gemspec +41 -0
- metadata +1395 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 1d4f0f60ebefa4ac12bcc6d8bf9616896accea419f1bc5afd4afe1c4feaa9a06
|
|
4
|
+
data.tar.gz: baa2efc8029f205bd81262dea7fcd87cdd8b5f514b5f64ef36bd8716ea5490f8
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 3c51be12ff5623d4b41bef6b55f64a07383330059fde44fa2bcf2a552ca0cac3f1f207ab6dda5f480f18ea0a71837b6a822a0aa31d7ce8bc7c607b6ca6d57bf8
|
|
7
|
+
data.tar.gz: 6b14c3a96a5cda5d503be61366c262d7be66fddc627d6a32d30e23486624043bba0dc47b0a2259d34116c77418dc1881056d5bdc76397a38b48aeeb245849140
|
data/Gemfile
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,614 @@
|
|
|
1
|
+
# zyphr
|
|
2
|
+
|
|
3
|
+
Zyphr - the Ruby gem for the Zyphr API
|
|
4
|
+
|
|
5
|
+
Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.
|
|
6
|
+
|
|
7
|
+
## Authentication
|
|
8
|
+
|
|
9
|
+
All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
X-API-Key: zy_live_xxxxxxxxxxxx
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.
|
|
16
|
+
|
|
17
|
+
## Rate Limiting
|
|
18
|
+
|
|
19
|
+
The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:
|
|
20
|
+
|
|
21
|
+
- `X-RateLimit-Limit`: Maximum requests per window
|
|
22
|
+
- `X-RateLimit-Remaining`: Remaining requests in current window
|
|
23
|
+
- `X-RateLimit-Reset`: Unix timestamp when the window resets
|
|
24
|
+
|
|
25
|
+
## Errors
|
|
26
|
+
|
|
27
|
+
All errors follow a consistent format:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
\"error\": {
|
|
32
|
+
\"code\": \"error_code\",
|
|
33
|
+
\"message\": \"Human readable message\",
|
|
34
|
+
\"details\": {}
|
|
35
|
+
},
|
|
36
|
+
\"meta\": {
|
|
37
|
+
\"request_id\": \"req_xxxx\"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
43
|
+
|
|
44
|
+
- API version: 1.0.0
|
|
45
|
+
- Package version: 1.0.0
|
|
46
|
+
- Generator version: 7.12.0
|
|
47
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
48
|
+
For more information, please visit [https://zyphr.dev](https://zyphr.dev)
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
|
|
52
|
+
### Build a gem
|
|
53
|
+
|
|
54
|
+
To build the Ruby code into a gem:
|
|
55
|
+
|
|
56
|
+
```shell
|
|
57
|
+
gem build zyphr.gemspec
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Then either install the gem locally:
|
|
61
|
+
|
|
62
|
+
```shell
|
|
63
|
+
gem install ./zyphr-1.0.0.gem
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
(for development, run `gem install --dev ./zyphr-1.0.0.gem` to install the development dependencies)
|
|
67
|
+
|
|
68
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
69
|
+
|
|
70
|
+
Finally add this to the Gemfile:
|
|
71
|
+
|
|
72
|
+
gem 'zyphr', '~> 1.0.0'
|
|
73
|
+
|
|
74
|
+
### Install from Git
|
|
75
|
+
|
|
76
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
77
|
+
|
|
78
|
+
gem 'zyphr', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
79
|
+
|
|
80
|
+
### Include the Ruby code directly
|
|
81
|
+
|
|
82
|
+
Include the Ruby code directly using `-I` as follows:
|
|
83
|
+
|
|
84
|
+
```shell
|
|
85
|
+
ruby -Ilib script.rb
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Getting Started
|
|
89
|
+
|
|
90
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
# Load the gem
|
|
94
|
+
require 'zyphr'
|
|
95
|
+
|
|
96
|
+
# Setup authorization
|
|
97
|
+
Zyphr.configure do |config|
|
|
98
|
+
# Configure API key authorization: ApplicationSecret
|
|
99
|
+
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
101
|
+
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
102
|
+
# Configure faraday connection
|
|
103
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
104
|
+
|
|
105
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
106
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
109
|
+
# Configure faraday connection
|
|
110
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
api_instance = Zyphr::AuthEmailVerificationApi.new
|
|
114
|
+
confirm_email_verification_request = Zyphr::ConfirmEmailVerificationRequest.new({token: 'token_example'}) # ConfirmEmailVerificationRequest |
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
#Confirm email verification
|
|
118
|
+
result = api_instance.confirm_email_verification(confirm_email_verification_request)
|
|
119
|
+
p result
|
|
120
|
+
rescue Zyphr::ApiError => e
|
|
121
|
+
puts "Exception when calling AuthEmailVerificationApi->confirm_email_verification: #{e}"
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Documentation for API Endpoints
|
|
127
|
+
|
|
128
|
+
All URIs are relative to *https://api.zyphr.dev/v1*
|
|
129
|
+
|
|
130
|
+
Class | Method | HTTP request | Description
|
|
131
|
+
------------ | ------------- | ------------- | -------------
|
|
132
|
+
*Zyphr::AuthEmailVerificationApi* | [**confirm_email_verification**](docs/AuthEmailVerificationApi.md#confirm_email_verification) | **POST** /auth/verify-email/confirm | Confirm email verification
|
|
133
|
+
*Zyphr::AuthEmailVerificationApi* | [**resend_email_verification**](docs/AuthEmailVerificationApi.md#resend_email_verification) | **POST** /auth/verify-email/resend | Resend email verification
|
|
134
|
+
*Zyphr::AuthEmailVerificationApi* | [**send_email_verification**](docs/AuthEmailVerificationApi.md#send_email_verification) | **POST** /auth/verify-email/send | Send email verification
|
|
135
|
+
*Zyphr::AuthLoginApi* | [**login_end_user**](docs/AuthLoginApi.md#login_end_user) | **POST** /auth/users/login | Login end user
|
|
136
|
+
*Zyphr::AuthMFAApi* | [**disable_mfa**](docs/AuthMFAApi.md#disable_mfa) | **POST** /auth/mfa/disable | Disable MFA for a user
|
|
137
|
+
*Zyphr::AuthMFAApi* | [**get_mfa_status**](docs/AuthMFAApi.md#get_mfa_status) | **GET** /auth/mfa/status/{userId} | Get MFA status for a user
|
|
138
|
+
*Zyphr::AuthMFAApi* | [**regenerate_backup_codes**](docs/AuthMFAApi.md#regenerate_backup_codes) | **POST** /auth/mfa/regenerate-backup-codes | Regenerate MFA backup codes
|
|
139
|
+
*Zyphr::AuthMFAApi* | [**start_mfa_enrollment**](docs/AuthMFAApi.md#start_mfa_enrollment) | **POST** /auth/mfa/enroll | Start MFA enrollment
|
|
140
|
+
*Zyphr::AuthMFAApi* | [**verify_mfa_challenge**](docs/AuthMFAApi.md#verify_mfa_challenge) | **POST** /auth/mfa/verify | Verify MFA challenge with TOTP code
|
|
141
|
+
*Zyphr::AuthMFAApi* | [**verify_mfa_challenge_with_backup_code**](docs/AuthMFAApi.md#verify_mfa_challenge_with_backup_code) | **POST** /auth/mfa/verify-backup | Verify MFA challenge with backup code
|
|
142
|
+
*Zyphr::AuthMFAApi* | [**verify_mfa_enrollment**](docs/AuthMFAApi.md#verify_mfa_enrollment) | **POST** /auth/mfa/verify-enrollment | Verify MFA enrollment
|
|
143
|
+
*Zyphr::AuthMagicLinksApi* | [**send_magic_link**](docs/AuthMagicLinksApi.md#send_magic_link) | **POST** /auth/magic-link/send | Send a magic link
|
|
144
|
+
*Zyphr::AuthMagicLinksApi* | [**verify_magic_link**](docs/AuthMagicLinksApi.md#verify_magic_link) | **POST** /auth/magic-link/verify | Verify a magic link
|
|
145
|
+
*Zyphr::AuthOAuthApi* | [**disconnect_o_auth_provider**](docs/AuthOAuthApi.md#disconnect_o_auth_provider) | **DELETE** /auth/oauth/{provider} | Disconnect OAuth provider
|
|
146
|
+
*Zyphr::AuthOAuthApi* | [**get_o_auth_authorization_url**](docs/AuthOAuthApi.md#get_o_auth_authorization_url) | **GET** /auth/oauth/{provider}/authorize | Get OAuth authorization URL
|
|
147
|
+
*Zyphr::AuthOAuthApi* | [**get_o_auth_connection_info**](docs/AuthOAuthApi.md#get_o_auth_connection_info) | **GET** /auth/oauth/connections/{provider} | Get OAuth connection info
|
|
148
|
+
*Zyphr::AuthOAuthApi* | [**get_o_auth_tokens**](docs/AuthOAuthApi.md#get_o_auth_tokens) | **GET** /auth/oauth/tokens/{provider} | Get OAuth provider tokens
|
|
149
|
+
*Zyphr::AuthOAuthApi* | [**handle_o_auth_callback**](docs/AuthOAuthApi.md#handle_o_auth_callback) | **POST** /auth/oauth/{provider}/callback | Handle OAuth callback
|
|
150
|
+
*Zyphr::AuthOAuthApi* | [**list_o_auth_connections**](docs/AuthOAuthApi.md#list_o_auth_connections) | **GET** /auth/oauth/connections | List OAuth connections
|
|
151
|
+
*Zyphr::AuthOAuthApi* | [**list_o_auth_providers**](docs/AuthOAuthApi.md#list_o_auth_providers) | **GET** /auth/oauth/providers | List OAuth providers
|
|
152
|
+
*Zyphr::AuthOAuthApi* | [**refresh_o_auth_tokens**](docs/AuthOAuthApi.md#refresh_o_auth_tokens) | **POST** /auth/oauth/tokens/{provider}/refresh | Refresh OAuth provider tokens
|
|
153
|
+
*Zyphr::AuthPasswordResetApi* | [**forgot_password**](docs/AuthPasswordResetApi.md#forgot_password) | **POST** /auth/forgot-password | Request a password reset
|
|
154
|
+
*Zyphr::AuthPasswordResetApi* | [**reset_end_user_password**](docs/AuthPasswordResetApi.md#reset_end_user_password) | **POST** /auth/reset-password | Reset password
|
|
155
|
+
*Zyphr::AuthPasswordResetApi* | [**validate_reset_token**](docs/AuthPasswordResetApi.md#validate_reset_token) | **POST** /auth/validate-reset-token | Validate a password reset token
|
|
156
|
+
*Zyphr::AuthPhoneApi* | [**check_phone_auth_availability**](docs/AuthPhoneApi.md#check_phone_auth_availability) | **GET** /auth/phone/available | Check phone auth availability
|
|
157
|
+
*Zyphr::AuthPhoneApi* | [**send_phone_login_otp**](docs/AuthPhoneApi.md#send_phone_login_otp) | **POST** /auth/phone/login/send | Send phone login OTP
|
|
158
|
+
*Zyphr::AuthPhoneApi* | [**send_phone_registration_otp**](docs/AuthPhoneApi.md#send_phone_registration_otp) | **POST** /auth/phone/register/send | Send phone registration OTP
|
|
159
|
+
*Zyphr::AuthPhoneApi* | [**verify_phone_login**](docs/AuthPhoneApi.md#verify_phone_login) | **POST** /auth/phone/login/verify | Verify phone login OTP
|
|
160
|
+
*Zyphr::AuthPhoneApi* | [**verify_phone_registration**](docs/AuthPhoneApi.md#verify_phone_registration) | **POST** /auth/phone/register/verify | Verify phone registration OTP
|
|
161
|
+
*Zyphr::AuthRegistrationApi* | [**register_end_user**](docs/AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user
|
|
162
|
+
*Zyphr::AuthSessionsApi* | [**list_end_user_sessions**](docs/AuthSessionsApi.md#list_end_user_sessions) | **GET** /auth/sessions | List active sessions
|
|
163
|
+
*Zyphr::AuthSessionsApi* | [**refresh_end_user_token**](docs/AuthSessionsApi.md#refresh_end_user_token) | **POST** /auth/sessions/refresh | Refresh access token
|
|
164
|
+
*Zyphr::AuthSessionsApi* | [**revoke_all_end_user_sessions**](docs/AuthSessionsApi.md#revoke_all_end_user_sessions) | **POST** /auth/sessions/revoke-all | Revoke all sessions
|
|
165
|
+
*Zyphr::AuthSessionsApi* | [**revoke_end_user_session**](docs/AuthSessionsApi.md#revoke_end_user_session) | **POST** /auth/sessions/revoke | Revoke a session
|
|
166
|
+
*Zyphr::AuthUserProfileApi* | [**delete_end_user**](docs/AuthUserProfileApi.md#delete_end_user) | **DELETE** /auth/users/me | Delete current end user account
|
|
167
|
+
*Zyphr::AuthUserProfileApi* | [**get_end_user**](docs/AuthUserProfileApi.md#get_end_user) | **GET** /auth/users/me | Get current end user profile
|
|
168
|
+
*Zyphr::AuthUserProfileApi* | [**update_end_user**](docs/AuthUserProfileApi.md#update_end_user) | **PATCH** /auth/users/me | Update current end user profile
|
|
169
|
+
*Zyphr::AuthWebAuthnApi* | [**delete_web_authn_credential**](docs/AuthWebAuthnApi.md#delete_web_authn_credential) | **DELETE** /auth/webauthn/credentials/{id} | Delete a WebAuthn credential
|
|
170
|
+
*Zyphr::AuthWebAuthnApi* | [**get_web_authn_status**](docs/AuthWebAuthnApi.md#get_web_authn_status) | **GET** /auth/webauthn/status | Get WebAuthn status
|
|
171
|
+
*Zyphr::AuthWebAuthnApi* | [**list_web_authn_credentials**](docs/AuthWebAuthnApi.md#list_web_authn_credentials) | **GET** /auth/webauthn/credentials | List WebAuthn credentials
|
|
172
|
+
*Zyphr::AuthWebAuthnApi* | [**rename_web_authn_credential**](docs/AuthWebAuthnApi.md#rename_web_authn_credential) | **PATCH** /auth/webauthn/credentials/{id} | Rename a WebAuthn credential
|
|
173
|
+
*Zyphr::AuthWebAuthnApi* | [**start_web_authn_authentication**](docs/AuthWebAuthnApi.md#start_web_authn_authentication) | **POST** /auth/webauthn/authentication/start | Start WebAuthn authentication
|
|
174
|
+
*Zyphr::AuthWebAuthnApi* | [**start_web_authn_registration**](docs/AuthWebAuthnApi.md#start_web_authn_registration) | **POST** /auth/webauthn/registration/start | Start WebAuthn registration
|
|
175
|
+
*Zyphr::AuthWebAuthnApi* | [**verify_web_authn_authentication**](docs/AuthWebAuthnApi.md#verify_web_authn_authentication) | **POST** /auth/webauthn/authentication/verify | Verify WebAuthn authentication
|
|
176
|
+
*Zyphr::AuthWebAuthnApi* | [**verify_web_authn_registration**](docs/AuthWebAuthnApi.md#verify_web_authn_registration) | **POST** /auth/webauthn/registration/verify | Verify WebAuthn registration
|
|
177
|
+
*Zyphr::DevicesApi* | [**delete_device**](docs/DevicesApi.md#delete_device) | **DELETE** /devices/{id} | Delete a device
|
|
178
|
+
*Zyphr::DevicesApi* | [**delete_user_devices**](docs/DevicesApi.md#delete_user_devices) | **DELETE** /devices/user/{user_id} | Delete all devices for a user
|
|
179
|
+
*Zyphr::DevicesApi* | [**get_device**](docs/DevicesApi.md#get_device) | **GET** /devices/{id} | Get device details
|
|
180
|
+
*Zyphr::DevicesApi* | [**get_device_stats**](docs/DevicesApi.md#get_device_stats) | **GET** /devices/stats | Get device statistics
|
|
181
|
+
*Zyphr::DevicesApi* | [**list_devices**](docs/DevicesApi.md#list_devices) | **GET** /devices | List devices
|
|
182
|
+
*Zyphr::DevicesApi* | [**register_device**](docs/DevicesApi.md#register_device) | **POST** /devices | Register a device
|
|
183
|
+
*Zyphr::EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Get email details
|
|
184
|
+
*Zyphr::EmailsApi* | [**get_email_events**](docs/EmailsApi.md#get_email_events) | **GET** /emails/{id}/events | Get email events
|
|
185
|
+
*Zyphr::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{id}/tracking | Get email tracking stats
|
|
186
|
+
*Zyphr::EmailsApi* | [**list_emails**](docs/EmailsApi.md#list_emails) | **GET** /emails | List emails
|
|
187
|
+
*Zyphr::EmailsApi* | [**send_batch_email**](docs/EmailsApi.md#send_batch_email) | **POST** /emails/batch | Send batch emails
|
|
188
|
+
*Zyphr::EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails | Send an email
|
|
189
|
+
*Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
|
|
190
|
+
*Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
|
|
191
|
+
*Zyphr::InboxApi* | [**get_inbox_notification**](docs/InboxApi.md#get_inbox_notification) | **GET** /inbox/{id} | Get a notification
|
|
192
|
+
*Zyphr::InboxApi* | [**get_unread_count**](docs/InboxApi.md#get_unread_count) | **GET** /inbox/unread-count | Get unread notification count
|
|
193
|
+
*Zyphr::InboxApi* | [**list_inbox**](docs/InboxApi.md#list_inbox) | **GET** /inbox | List inbox notifications
|
|
194
|
+
*Zyphr::InboxApi* | [**mark_all_inbox_read**](docs/InboxApi.md#mark_all_inbox_read) | **POST** /inbox/read-all | Mark all notifications as read
|
|
195
|
+
*Zyphr::InboxApi* | [**mark_inbox_read**](docs/InboxApi.md#mark_inbox_read) | **POST** /inbox/{id}/read | Mark notification as read
|
|
196
|
+
*Zyphr::InboxApi* | [**send_batch_in_app**](docs/InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications
|
|
197
|
+
*Zyphr::InboxApi* | [**send_in_app**](docs/InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification
|
|
198
|
+
*Zyphr::PushApi* | [**get_push**](docs/PushApi.md#get_push) | **GET** /push/{id} | Get push notification details
|
|
199
|
+
*Zyphr::PushApi* | [**get_push_stats**](docs/PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics
|
|
200
|
+
*Zyphr::PushApi* | [**list_device_push_topics**](docs/PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device
|
|
201
|
+
*Zyphr::PushApi* | [**list_push**](docs/PushApi.md#list_push) | **GET** /push | List push notifications
|
|
202
|
+
*Zyphr::PushApi* | [**list_push_topic_devices**](docs/PushApi.md#list_push_topic_devices) | **GET** /push/topics/{key}/devices | List devices subscribed to a topic
|
|
203
|
+
*Zyphr::PushApi* | [**send_push**](docs/PushApi.md#send_push) | **POST** /push | Send a push notification
|
|
204
|
+
*Zyphr::PushApi* | [**send_push_to_topic**](docs/PushApi.md#send_push_to_topic) | **POST** /push/topics/{key}/send | Send push notification to a topic
|
|
205
|
+
*Zyphr::PushApi* | [**subscribe_push_topic**](docs/PushApi.md#subscribe_push_topic) | **POST** /push/topics/{key}/subscribe | Subscribe devices to a push topic
|
|
206
|
+
*Zyphr::PushApi* | [**unsubscribe_push_topic**](docs/PushApi.md#unsubscribe_push_topic) | **POST** /push/topics/{key}/unsubscribe | Unsubscribe devices from a push topic
|
|
207
|
+
*Zyphr::SMSApi* | [**delete_sms_config**](docs/SMSApi.md#delete_sms_config) | **DELETE** /sms/config | Delete SMS configuration
|
|
208
|
+
*Zyphr::SMSApi* | [**get_sms**](docs/SMSApi.md#get_sms) | **GET** /sms/{id} | Get SMS message details
|
|
209
|
+
*Zyphr::SMSApi* | [**get_sms_config**](docs/SMSApi.md#get_sms_config) | **GET** /sms/config | Get SMS configuration
|
|
210
|
+
*Zyphr::SMSApi* | [**list_sms**](docs/SMSApi.md#list_sms) | **GET** /sms | List SMS messages
|
|
211
|
+
*Zyphr::SMSApi* | [**send_batch_sms**](docs/SMSApi.md#send_batch_sms) | **POST** /sms/batch | Send batch SMS messages
|
|
212
|
+
*Zyphr::SMSApi* | [**send_sms**](docs/SMSApi.md#send_sms) | **POST** /sms | Send an SMS message
|
|
213
|
+
*Zyphr::SMSApi* | [**send_test_sms**](docs/SMSApi.md#send_test_sms) | **POST** /sms/test | Send a test SMS
|
|
214
|
+
*Zyphr::SMSApi* | [**upsert_sms_config**](docs/SMSApi.md#upsert_sms_config) | **POST** /sms/config | Create or update SMS configuration
|
|
215
|
+
*Zyphr::SMSApi* | [**verify_sms_config**](docs/SMSApi.md#verify_sms_config) | **POST** /sms/config/verify | Verify SMS configuration
|
|
216
|
+
*Zyphr::SubscribersApi* | [**create_category**](docs/SubscribersApi.md#create_category) | **POST** /subscribers/categories | Create a notification category
|
|
217
|
+
*Zyphr::SubscribersApi* | [**create_subscriber**](docs/SubscribersApi.md#create_subscriber) | **POST** /subscribers | Create or update a subscriber
|
|
218
|
+
*Zyphr::SubscribersApi* | [**delete_category**](docs/SubscribersApi.md#delete_category) | **DELETE** /subscribers/categories/{id} | Delete a category
|
|
219
|
+
*Zyphr::SubscribersApi* | [**delete_subscriber**](docs/SubscribersApi.md#delete_subscriber) | **DELETE** /subscribers/{id} | Delete a subscriber
|
|
220
|
+
*Zyphr::SubscribersApi* | [**get_category**](docs/SubscribersApi.md#get_category) | **GET** /subscribers/categories/{idOrSlug} | Get a category by ID or slug
|
|
221
|
+
*Zyphr::SubscribersApi* | [**get_subscriber**](docs/SubscribersApi.md#get_subscriber) | **GET** /subscribers/{id} | Get a subscriber by ID
|
|
222
|
+
*Zyphr::SubscribersApi* | [**get_subscriber_by_external_id**](docs/SubscribersApi.md#get_subscriber_by_external_id) | **GET** /subscribers/by-external-id/{externalId} | Get subscriber by external ID
|
|
223
|
+
*Zyphr::SubscribersApi* | [**get_subscriber_consent**](docs/SubscribersApi.md#get_subscriber_consent) | **GET** /subscribers/{id}/consent | Get subscriber consent status
|
|
224
|
+
*Zyphr::SubscribersApi* | [**get_subscriber_consent_history**](docs/SubscribersApi.md#get_subscriber_consent_history) | **GET** /subscribers/{id}/consent/history | Get subscriber consent history
|
|
225
|
+
*Zyphr::SubscribersApi* | [**get_subscriber_preferences**](docs/SubscribersApi.md#get_subscriber_preferences) | **GET** /subscribers/{id}/preferences | Get subscriber preferences
|
|
226
|
+
*Zyphr::SubscribersApi* | [**get_subscriber_unsubscribes**](docs/SubscribersApi.md#get_subscriber_unsubscribes) | **GET** /subscribers/{id}/unsubscribes | Get subscriber unsubscribes
|
|
227
|
+
*Zyphr::SubscribersApi* | [**list_categories**](docs/SubscribersApi.md#list_categories) | **GET** /subscribers/categories | List notification categories
|
|
228
|
+
*Zyphr::SubscribersApi* | [**list_subscribers**](docs/SubscribersApi.md#list_subscribers) | **GET** /subscribers | List subscribers
|
|
229
|
+
*Zyphr::SubscribersApi* | [**record_subscriber_consent**](docs/SubscribersApi.md#record_subscriber_consent) | **POST** /subscribers/{id}/consent | Record subscriber consent
|
|
230
|
+
*Zyphr::SubscribersApi* | [**resubscribe_subscriber**](docs/SubscribersApi.md#resubscribe_subscriber) | **POST** /subscribers/{id}/resubscribe | Resubscribe to a channel
|
|
231
|
+
*Zyphr::SubscribersApi* | [**set_subscriber_preferences**](docs/SubscribersApi.md#set_subscriber_preferences) | **PUT** /subscribers/{id}/preferences | Set subscriber preferences
|
|
232
|
+
*Zyphr::SubscribersApi* | [**unsubscribe_subscriber**](docs/SubscribersApi.md#unsubscribe_subscriber) | **POST** /subscribers/{id}/unsubscribe | Unsubscribe from a channel
|
|
233
|
+
*Zyphr::SubscribersApi* | [**update_category**](docs/SubscribersApi.md#update_category) | **PATCH** /subscribers/categories/{id} | Update a category
|
|
234
|
+
*Zyphr::SubscribersApi* | [**update_subscriber**](docs/SubscribersApi.md#update_subscriber) | **PATCH** /subscribers/{id} | Update a subscriber
|
|
235
|
+
*Zyphr::SubscribersApi* | [**withdraw_subscriber_consent**](docs/SubscribersApi.md#withdraw_subscriber_consent) | **DELETE** /subscribers/{id}/consent | Withdraw subscriber consent
|
|
236
|
+
*Zyphr::TemplatesApi* | [**create_template**](docs/TemplatesApi.md#create_template) | **POST** /templates | Create template
|
|
237
|
+
*Zyphr::TemplatesApi* | [**delete_template**](docs/TemplatesApi.md#delete_template) | **DELETE** /templates/{id} | Delete template
|
|
238
|
+
*Zyphr::TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /templates/{id} | Get template
|
|
239
|
+
*Zyphr::TemplatesApi* | [**list_templates**](docs/TemplatesApi.md#list_templates) | **GET** /templates | List templates
|
|
240
|
+
*Zyphr::TemplatesApi* | [**render_template**](docs/TemplatesApi.md#render_template) | **POST** /templates/{id}/render | Render template
|
|
241
|
+
*Zyphr::TemplatesApi* | [**update_template**](docs/TemplatesApi.md#update_template) | **PUT** /templates/{id} | Update template
|
|
242
|
+
*Zyphr::TopicsApi* | [**add_topic_subscribers**](docs/TopicsApi.md#add_topic_subscribers) | **POST** /topics/{key}/subscribers | Add subscribers to a topic
|
|
243
|
+
*Zyphr::TopicsApi* | [**create_topic**](docs/TopicsApi.md#create_topic) | **POST** /topics | Create a new topic
|
|
244
|
+
*Zyphr::TopicsApi* | [**delete_topic**](docs/TopicsApi.md#delete_topic) | **DELETE** /topics/{key} | Delete a topic
|
|
245
|
+
*Zyphr::TopicsApi* | [**get_topic**](docs/TopicsApi.md#get_topic) | **GET** /topics/{key} | Get a topic
|
|
246
|
+
*Zyphr::TopicsApi* | [**get_topic_stats**](docs/TopicsApi.md#get_topic_stats) | **GET** /topics/stats | Get topic statistics
|
|
247
|
+
*Zyphr::TopicsApi* | [**list_topic_subscribers**](docs/TopicsApi.md#list_topic_subscribers) | **GET** /topics/{key}/subscribers | List topic subscribers
|
|
248
|
+
*Zyphr::TopicsApi* | [**list_topics**](docs/TopicsApi.md#list_topics) | **GET** /topics | List topics
|
|
249
|
+
*Zyphr::TopicsApi* | [**remove_topic_subscribers**](docs/TopicsApi.md#remove_topic_subscribers) | **DELETE** /topics/{key}/subscribers | Remove subscribers from a topic
|
|
250
|
+
*Zyphr::TopicsApi* | [**update_topic**](docs/TopicsApi.md#update_topic) | **PATCH** /topics/{key} | Update a topic
|
|
251
|
+
*Zyphr::UtilityApi* | [**get_password_requirements**](docs/UtilityApi.md#get_password_requirements) | **GET** /auth/password-requirements | Get password requirements
|
|
252
|
+
*Zyphr::WebhooksApi* | [**bulk_retry_webhook_deliveries**](docs/WebhooksApi.md#bulk_retry_webhook_deliveries) | **POST** /v1/webhooks/{id}/deliveries/bulk-retry | Bulk retry failed deliveries
|
|
253
|
+
*Zyphr::WebhooksApi* | [**close_webhook_circuit**](docs/WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker
|
|
254
|
+
*Zyphr::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook
|
|
255
|
+
*Zyphr::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete webhook
|
|
256
|
+
*Zyphr::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get webhook
|
|
257
|
+
*Zyphr::WebhooksApi* | [**get_webhook_circuit_state**](docs/WebhooksApi.md#get_webhook_circuit_state) | **GET** /v1/webhooks/{id}/circuit | Get circuit breaker state
|
|
258
|
+
*Zyphr::WebhooksApi* | [**get_webhook_delivery**](docs/WebhooksApi.md#get_webhook_delivery) | **GET** /v1/webhooks/{id}/deliveries/{deliveryId} | Get webhook delivery details
|
|
259
|
+
*Zyphr::WebhooksApi* | [**get_webhook_ips**](docs/WebhooksApi.md#get_webhook_ips) | **GET** /v1/webhooks/ips | Get static webhook IPs
|
|
260
|
+
*Zyphr::WebhooksApi* | [**get_webhook_job**](docs/WebhooksApi.md#get_webhook_job) | **GET** /v1/webhooks/jobs/{jobId} | Get replay/retry job status
|
|
261
|
+
*Zyphr::WebhooksApi* | [**get_webhook_metrics**](docs/WebhooksApi.md#get_webhook_metrics) | **GET** /v1/webhooks/{id}/metrics | Get webhook health metrics
|
|
262
|
+
*Zyphr::WebhooksApi* | [**get_webhook_regions**](docs/WebhooksApi.md#get_webhook_regions) | **GET** /v1/webhooks/regions | Get available webhook regions
|
|
263
|
+
*Zyphr::WebhooksApi* | [**get_webhook_usage**](docs/WebhooksApi.md#get_webhook_usage) | **GET** /v1/webhooks/usage | Get webhook usage metrics
|
|
264
|
+
*Zyphr::WebhooksApi* | [**get_workspace_webhook_metrics**](docs/WebhooksApi.md#get_workspace_webhook_metrics) | **GET** /v1/webhooks/metrics | Get workspace webhook metrics
|
|
265
|
+
*Zyphr::WebhooksApi* | [**list_webhook_deliveries**](docs/WebhooksApi.md#list_webhook_deliveries) | **GET** /v1/webhooks/{id}/deliveries | List webhook deliveries
|
|
266
|
+
*Zyphr::WebhooksApi* | [**list_webhook_event_types**](docs/WebhooksApi.md#list_webhook_event_types) | **GET** /v1/webhooks/events | List webhook event types
|
|
267
|
+
*Zyphr::WebhooksApi* | [**list_webhook_versions**](docs/WebhooksApi.md#list_webhook_versions) | **GET** /v1/webhooks/versions | List webhook API versions
|
|
268
|
+
*Zyphr::WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /v1/webhooks | List webhooks
|
|
269
|
+
*Zyphr::WebhooksApi* | [**replay_webhook_events**](docs/WebhooksApi.md#replay_webhook_events) | **POST** /v1/webhooks/{id}/replay | Replay webhook events
|
|
270
|
+
*Zyphr::WebhooksApi* | [**retry_webhook_delivery**](docs/WebhooksApi.md#retry_webhook_delivery) | **POST** /v1/webhooks/{id}/deliveries/{deliveryId}/retry | Retry webhook delivery
|
|
271
|
+
*Zyphr::WebhooksApi* | [**rotate_webhook_secret**](docs/WebhooksApi.md#rotate_webhook_secret) | **POST** /v1/webhooks/{id}/rotate-secret | Rotate webhook secret
|
|
272
|
+
*Zyphr::WebhooksApi* | [**send_webhook_test_event**](docs/WebhooksApi.md#send_webhook_test_event) | **POST** /v1/webhooks/{id}/test | Send test event
|
|
273
|
+
*Zyphr::WebhooksApi* | [**test_webhook_transform**](docs/WebhooksApi.md#test_webhook_transform) | **POST** /v1/webhooks/{id}/transform/test | Test payload transformation
|
|
274
|
+
*Zyphr::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /v1/webhooks/{id} | Update webhook
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
## Documentation for Models
|
|
278
|
+
|
|
279
|
+
- [Zyphr::AddTopicSubscribersRequest](docs/AddTopicSubscribersRequest.md)
|
|
280
|
+
- [Zyphr::ApiError](docs/ApiError.md)
|
|
281
|
+
- [Zyphr::ApiErrorError](docs/ApiErrorError.md)
|
|
282
|
+
- [Zyphr::ApiErrorMeta](docs/ApiErrorMeta.md)
|
|
283
|
+
- [Zyphr::AuthLoginResponse](docs/AuthLoginResponse.md)
|
|
284
|
+
- [Zyphr::AuthLoginResult](docs/AuthLoginResult.md)
|
|
285
|
+
- [Zyphr::AuthLoginResultMfaChallenge](docs/AuthLoginResultMfaChallenge.md)
|
|
286
|
+
- [Zyphr::AuthResult](docs/AuthResult.md)
|
|
287
|
+
- [Zyphr::AuthResultResponse](docs/AuthResultResponse.md)
|
|
288
|
+
- [Zyphr::AuthSession](docs/AuthSession.md)
|
|
289
|
+
- [Zyphr::AuthTokens](docs/AuthTokens.md)
|
|
290
|
+
- [Zyphr::AuthUser](docs/AuthUser.md)
|
|
291
|
+
- [Zyphr::AuthUserResponse](docs/AuthUserResponse.md)
|
|
292
|
+
- [Zyphr::AuthUserResponseData](docs/AuthUserResponseData.md)
|
|
293
|
+
- [Zyphr::BulkRetryWebhookDeliveriesRequest](docs/BulkRetryWebhookDeliveriesRequest.md)
|
|
294
|
+
- [Zyphr::Category](docs/Category.md)
|
|
295
|
+
- [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
|
|
296
|
+
- [Zyphr::CategoryResponse](docs/CategoryResponse.md)
|
|
297
|
+
- [Zyphr::ConfirmEmailVerificationRequest](docs/ConfirmEmailVerificationRequest.md)
|
|
298
|
+
- [Zyphr::ConfirmEmailVerificationResponse](docs/ConfirmEmailVerificationResponse.md)
|
|
299
|
+
- [Zyphr::ConfirmEmailVerificationResponseData](docs/ConfirmEmailVerificationResponseData.md)
|
|
300
|
+
- [Zyphr::ConsentHistoryEntry](docs/ConsentHistoryEntry.md)
|
|
301
|
+
- [Zyphr::ConsentHistoryResponse](docs/ConsentHistoryResponse.md)
|
|
302
|
+
- [Zyphr::ConsentRecordResponse](docs/ConsentRecordResponse.md)
|
|
303
|
+
- [Zyphr::ConsentRecordResponseData](docs/ConsentRecordResponseData.md)
|
|
304
|
+
- [Zyphr::ConsentStatus](docs/ConsentStatus.md)
|
|
305
|
+
- [Zyphr::ConsentStatusResponse](docs/ConsentStatusResponse.md)
|
|
306
|
+
- [Zyphr::ConsentWithdrawResponse](docs/ConsentWithdrawResponse.md)
|
|
307
|
+
- [Zyphr::CreateCategoryRequest](docs/CreateCategoryRequest.md)
|
|
308
|
+
- [Zyphr::CreateSubscriberRequest](docs/CreateSubscriberRequest.md)
|
|
309
|
+
- [Zyphr::CreateTemplateRequest](docs/CreateTemplateRequest.md)
|
|
310
|
+
- [Zyphr::CreateTopicRequest](docs/CreateTopicRequest.md)
|
|
311
|
+
- [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
|
312
|
+
- [Zyphr::DeleteResult](docs/DeleteResult.md)
|
|
313
|
+
- [Zyphr::DeleteResultData](docs/DeleteResultData.md)
|
|
314
|
+
- [Zyphr::Device](docs/Device.md)
|
|
315
|
+
- [Zyphr::DeviceListResponse](docs/DeviceListResponse.md)
|
|
316
|
+
- [Zyphr::DevicePushTopic](docs/DevicePushTopic.md)
|
|
317
|
+
- [Zyphr::DevicePushTopicListResponse](docs/DevicePushTopicListResponse.md)
|
|
318
|
+
- [Zyphr::DevicePushTopicListResponseMeta](docs/DevicePushTopicListResponseMeta.md)
|
|
319
|
+
- [Zyphr::DeviceResponse](docs/DeviceResponse.md)
|
|
320
|
+
- [Zyphr::DeviceStats](docs/DeviceStats.md)
|
|
321
|
+
- [Zyphr::DeviceStatsResponse](docs/DeviceStatsResponse.md)
|
|
322
|
+
- [Zyphr::EmailAddress](docs/EmailAddress.md)
|
|
323
|
+
- [Zyphr::EmailAttachment](docs/EmailAttachment.md)
|
|
324
|
+
- [Zyphr::EmailEvent](docs/EmailEvent.md)
|
|
325
|
+
- [Zyphr::EmailEventsResponse](docs/EmailEventsResponse.md)
|
|
326
|
+
- [Zyphr::EmailListResponse](docs/EmailListResponse.md)
|
|
327
|
+
- [Zyphr::EmailMessage](docs/EmailMessage.md)
|
|
328
|
+
- [Zyphr::EmailResponse](docs/EmailResponse.md)
|
|
329
|
+
- [Zyphr::EmailTrackingClickLink](docs/EmailTrackingClickLink.md)
|
|
330
|
+
- [Zyphr::EmailTrackingClicks](docs/EmailTrackingClicks.md)
|
|
331
|
+
- [Zyphr::EmailTrackingData](docs/EmailTrackingData.md)
|
|
332
|
+
- [Zyphr::EmailTrackingOpens](docs/EmailTrackingOpens.md)
|
|
333
|
+
- [Zyphr::EmailTrackingResponse](docs/EmailTrackingResponse.md)
|
|
334
|
+
- [Zyphr::EndUserDeleteResponse](docs/EndUserDeleteResponse.md)
|
|
335
|
+
- [Zyphr::EndUserDeleteResponseData](docs/EndUserDeleteResponseData.md)
|
|
336
|
+
- [Zyphr::ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
|
|
337
|
+
- [Zyphr::InAppNotification](docs/InAppNotification.md)
|
|
338
|
+
- [Zyphr::InboxListMeta](docs/InboxListMeta.md)
|
|
339
|
+
- [Zyphr::InboxListResponse](docs/InboxListResponse.md)
|
|
340
|
+
- [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
|
|
341
|
+
- [Zyphr::LoginRequest](docs/LoginRequest.md)
|
|
342
|
+
- [Zyphr::MagicLinkSendRequest](docs/MagicLinkSendRequest.md)
|
|
343
|
+
- [Zyphr::MagicLinkVerifyRequest](docs/MagicLinkVerifyRequest.md)
|
|
344
|
+
- [Zyphr::MagicLinkVerifyResponse](docs/MagicLinkVerifyResponse.md)
|
|
345
|
+
- [Zyphr::MagicLinkVerifyResponseData](docs/MagicLinkVerifyResponseData.md)
|
|
346
|
+
- [Zyphr::MarkAllInboxReadRequest](docs/MarkAllInboxReadRequest.md)
|
|
347
|
+
- [Zyphr::MarkAllReadData](docs/MarkAllReadData.md)
|
|
348
|
+
- [Zyphr::MarkAllReadResponse](docs/MarkAllReadResponse.md)
|
|
349
|
+
- [Zyphr::MarkInboxReadRequest](docs/MarkInboxReadRequest.md)
|
|
350
|
+
- [Zyphr::MfaBackupCodesResponse](docs/MfaBackupCodesResponse.md)
|
|
351
|
+
- [Zyphr::MfaBackupCodesResponseData](docs/MfaBackupCodesResponseData.md)
|
|
352
|
+
- [Zyphr::MfaDisableRequest](docs/MfaDisableRequest.md)
|
|
353
|
+
- [Zyphr::MfaDisableResponse](docs/MfaDisableResponse.md)
|
|
354
|
+
- [Zyphr::MfaDisableResponseData](docs/MfaDisableResponseData.md)
|
|
355
|
+
- [Zyphr::MfaEnrollRequest](docs/MfaEnrollRequest.md)
|
|
356
|
+
- [Zyphr::MfaEnrollmentResponse](docs/MfaEnrollmentResponse.md)
|
|
357
|
+
- [Zyphr::MfaEnrollmentResponseData](docs/MfaEnrollmentResponseData.md)
|
|
358
|
+
- [Zyphr::MfaRegenerateBackupCodesRequest](docs/MfaRegenerateBackupCodesRequest.md)
|
|
359
|
+
- [Zyphr::MfaStatusResponse](docs/MfaStatusResponse.md)
|
|
360
|
+
- [Zyphr::MfaStatusResponseData](docs/MfaStatusResponseData.md)
|
|
361
|
+
- [Zyphr::MfaVerifyBackupRequest](docs/MfaVerifyBackupRequest.md)
|
|
362
|
+
- [Zyphr::MfaVerifyBackupResponse](docs/MfaVerifyBackupResponse.md)
|
|
363
|
+
- [Zyphr::MfaVerifyBackupResponseData](docs/MfaVerifyBackupResponseData.md)
|
|
364
|
+
- [Zyphr::MfaVerifyEnrollmentRequest](docs/MfaVerifyEnrollmentRequest.md)
|
|
365
|
+
- [Zyphr::MfaVerifyEnrollmentResponse](docs/MfaVerifyEnrollmentResponse.md)
|
|
366
|
+
- [Zyphr::MfaVerifyEnrollmentResponseData](docs/MfaVerifyEnrollmentResponseData.md)
|
|
367
|
+
- [Zyphr::MfaVerifyRequest](docs/MfaVerifyRequest.md)
|
|
368
|
+
- [Zyphr::OAuthAuthorizationUrlResponse](docs/OAuthAuthorizationUrlResponse.md)
|
|
369
|
+
- [Zyphr::OAuthAuthorizationUrlResponseData](docs/OAuthAuthorizationUrlResponseData.md)
|
|
370
|
+
- [Zyphr::OAuthCallbackRequest](docs/OAuthCallbackRequest.md)
|
|
371
|
+
- [Zyphr::OAuthCallbackResponse](docs/OAuthCallbackResponse.md)
|
|
372
|
+
- [Zyphr::OAuthCallbackResponseData](docs/OAuthCallbackResponseData.md)
|
|
373
|
+
- [Zyphr::OAuthConnection](docs/OAuthConnection.md)
|
|
374
|
+
- [Zyphr::OAuthConnectionInfoResponse](docs/OAuthConnectionInfoResponse.md)
|
|
375
|
+
- [Zyphr::OAuthConnectionInfoResponseData](docs/OAuthConnectionInfoResponseData.md)
|
|
376
|
+
- [Zyphr::OAuthConnectionsResponse](docs/OAuthConnectionsResponse.md)
|
|
377
|
+
- [Zyphr::OAuthConnectionsResponseData](docs/OAuthConnectionsResponseData.md)
|
|
378
|
+
- [Zyphr::OAuthProvider](docs/OAuthProvider.md)
|
|
379
|
+
- [Zyphr::OAuthProviderInfo](docs/OAuthProviderInfo.md)
|
|
380
|
+
- [Zyphr::OAuthProvidersResponse](docs/OAuthProvidersResponse.md)
|
|
381
|
+
- [Zyphr::OAuthProvidersResponseData](docs/OAuthProvidersResponseData.md)
|
|
382
|
+
- [Zyphr::OAuthTokensRefreshResponse](docs/OAuthTokensRefreshResponse.md)
|
|
383
|
+
- [Zyphr::OAuthTokensRefreshResponseData](docs/OAuthTokensRefreshResponseData.md)
|
|
384
|
+
- [Zyphr::OAuthTokensResponse](docs/OAuthTokensResponse.md)
|
|
385
|
+
- [Zyphr::OAuthTokensResponseData](docs/OAuthTokensResponseData.md)
|
|
386
|
+
- [Zyphr::PaginationMeta](docs/PaginationMeta.md)
|
|
387
|
+
- [Zyphr::PasswordRequirements](docs/PasswordRequirements.md)
|
|
388
|
+
- [Zyphr::PasswordRequirementsResponse](docs/PasswordRequirementsResponse.md)
|
|
389
|
+
- [Zyphr::PasswordRequirementsResponseData](docs/PasswordRequirementsResponseData.md)
|
|
390
|
+
- [Zyphr::PhoneAuthAvailabilityResponse](docs/PhoneAuthAvailabilityResponse.md)
|
|
391
|
+
- [Zyphr::PhoneAuthAvailabilityResponseData](docs/PhoneAuthAvailabilityResponseData.md)
|
|
392
|
+
- [Zyphr::PhoneLoginVerifyRequest](docs/PhoneLoginVerifyRequest.md)
|
|
393
|
+
- [Zyphr::PhoneOtpSendRequest](docs/PhoneOtpSendRequest.md)
|
|
394
|
+
- [Zyphr::PhoneOtpSentResponse](docs/PhoneOtpSentResponse.md)
|
|
395
|
+
- [Zyphr::PhoneOtpSentResponseData](docs/PhoneOtpSentResponseData.md)
|
|
396
|
+
- [Zyphr::PhoneRegisterVerifyRequest](docs/PhoneRegisterVerifyRequest.md)
|
|
397
|
+
- [Zyphr::PreferenceListResponse](docs/PreferenceListResponse.md)
|
|
398
|
+
- [Zyphr::PushDetailResponse](docs/PushDetailResponse.md)
|
|
399
|
+
- [Zyphr::PushEvent](docs/PushEvent.md)
|
|
400
|
+
- [Zyphr::PushListResponse](docs/PushListResponse.md)
|
|
401
|
+
- [Zyphr::PushMessage](docs/PushMessage.md)
|
|
402
|
+
- [Zyphr::PushMessageDetail](docs/PushMessageDetail.md)
|
|
403
|
+
- [Zyphr::PushPayload](docs/PushPayload.md)
|
|
404
|
+
- [Zyphr::PushStatsData](docs/PushStatsData.md)
|
|
405
|
+
- [Zyphr::PushStatsResponse](docs/PushStatsResponse.md)
|
|
406
|
+
- [Zyphr::PushTopicDevice](docs/PushTopicDevice.md)
|
|
407
|
+
- [Zyphr::PushTopicDeviceListResponse](docs/PushTopicDeviceListResponse.md)
|
|
408
|
+
- [Zyphr::PushTopicSubscribeData](docs/PushTopicSubscribeData.md)
|
|
409
|
+
- [Zyphr::PushTopicSubscribeResponse](docs/PushTopicSubscribeResponse.md)
|
|
410
|
+
- [Zyphr::PushTopicUnsubscribeData](docs/PushTopicUnsubscribeData.md)
|
|
411
|
+
- [Zyphr::PushTopicUnsubscribeResponse](docs/PushTopicUnsubscribeResponse.md)
|
|
412
|
+
- [Zyphr::RefreshOAuthTokensRequest](docs/RefreshOAuthTokensRequest.md)
|
|
413
|
+
- [Zyphr::RefreshSessionRequest](docs/RefreshSessionRequest.md)
|
|
414
|
+
- [Zyphr::RefreshTokenResponse](docs/RefreshTokenResponse.md)
|
|
415
|
+
- [Zyphr::RefreshTokenResponseData](docs/RefreshTokenResponseData.md)
|
|
416
|
+
- [Zyphr::RegisterDeviceRequest](docs/RegisterDeviceRequest.md)
|
|
417
|
+
- [Zyphr::RegisterRequest](docs/RegisterRequest.md)
|
|
418
|
+
- [Zyphr::RemoveTopicSubscribersRequest](docs/RemoveTopicSubscribersRequest.md)
|
|
419
|
+
- [Zyphr::RenameWebAuthnCredentialRequest](docs/RenameWebAuthnCredentialRequest.md)
|
|
420
|
+
- [Zyphr::RenderTemplateRequest](docs/RenderTemplateRequest.md)
|
|
421
|
+
- [Zyphr::ReplayWebhookEventsRequest](docs/ReplayWebhookEventsRequest.md)
|
|
422
|
+
- [Zyphr::RequestMeta](docs/RequestMeta.md)
|
|
423
|
+
- [Zyphr::ResetPasswordRequest](docs/ResetPasswordRequest.md)
|
|
424
|
+
- [Zyphr::ResetPasswordResponse](docs/ResetPasswordResponse.md)
|
|
425
|
+
- [Zyphr::ResubscribeRequest](docs/ResubscribeRequest.md)
|
|
426
|
+
- [Zyphr::ResubscribeResponse](docs/ResubscribeResponse.md)
|
|
427
|
+
- [Zyphr::RevokeAllSessionsResponse](docs/RevokeAllSessionsResponse.md)
|
|
428
|
+
- [Zyphr::RevokeAllSessionsResponseData](docs/RevokeAllSessionsResponseData.md)
|
|
429
|
+
- [Zyphr::RevokeSessionRequest](docs/RevokeSessionRequest.md)
|
|
430
|
+
- [Zyphr::SendBatchEmailRequest](docs/SendBatchEmailRequest.md)
|
|
431
|
+
- [Zyphr::SendBatchEmailResponse](docs/SendBatchEmailResponse.md)
|
|
432
|
+
- [Zyphr::SendBatchEmailResult](docs/SendBatchEmailResult.md)
|
|
433
|
+
- [Zyphr::SendBatchEmailResultItem](docs/SendBatchEmailResultItem.md)
|
|
434
|
+
- [Zyphr::SendBatchInAppMeta](docs/SendBatchInAppMeta.md)
|
|
435
|
+
- [Zyphr::SendBatchInAppRequest](docs/SendBatchInAppRequest.md)
|
|
436
|
+
- [Zyphr::SendBatchInAppResponse](docs/SendBatchInAppResponse.md)
|
|
437
|
+
- [Zyphr::SendBatchSmsData](docs/SendBatchSmsData.md)
|
|
438
|
+
- [Zyphr::SendBatchSmsRequest](docs/SendBatchSmsRequest.md)
|
|
439
|
+
- [Zyphr::SendBatchSmsResponse](docs/SendBatchSmsResponse.md)
|
|
440
|
+
- [Zyphr::SendEmailRequest](docs/SendEmailRequest.md)
|
|
441
|
+
- [Zyphr::SendEmailResponse](docs/SendEmailResponse.md)
|
|
442
|
+
- [Zyphr::SendEmailResponseData](docs/SendEmailResponseData.md)
|
|
443
|
+
- [Zyphr::SendEmailResponseMeta](docs/SendEmailResponseMeta.md)
|
|
444
|
+
- [Zyphr::SendEmailVerificationRequest](docs/SendEmailVerificationRequest.md)
|
|
445
|
+
- [Zyphr::SendInAppMeta](docs/SendInAppMeta.md)
|
|
446
|
+
- [Zyphr::SendInAppRequest](docs/SendInAppRequest.md)
|
|
447
|
+
- [Zyphr::SendInAppResponse](docs/SendInAppResponse.md)
|
|
448
|
+
- [Zyphr::SendPushRequest](docs/SendPushRequest.md)
|
|
449
|
+
- [Zyphr::SendPushResponse](docs/SendPushResponse.md)
|
|
450
|
+
- [Zyphr::SendPushResponseData](docs/SendPushResponseData.md)
|
|
451
|
+
- [Zyphr::SendPushToTopicData](docs/SendPushToTopicData.md)
|
|
452
|
+
- [Zyphr::SendPushToTopicRequest](docs/SendPushToTopicRequest.md)
|
|
453
|
+
- [Zyphr::SendPushToTopicResponse](docs/SendPushToTopicResponse.md)
|
|
454
|
+
- [Zyphr::SendSmsData](docs/SendSmsData.md)
|
|
455
|
+
- [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
|
|
456
|
+
- [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
|
|
457
|
+
- [Zyphr::SendTestSmsData](docs/SendTestSmsData.md)
|
|
458
|
+
- [Zyphr::SendTestSmsRequest](docs/SendTestSmsRequest.md)
|
|
459
|
+
- [Zyphr::SendTestSmsResponse](docs/SendTestSmsResponse.md)
|
|
460
|
+
- [Zyphr::SendWebhookTestEventRequest](docs/SendWebhookTestEventRequest.md)
|
|
461
|
+
- [Zyphr::SessionListResponse](docs/SessionListResponse.md)
|
|
462
|
+
- [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
|
|
463
|
+
- [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
|
|
464
|
+
- [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
|
|
465
|
+
- [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
|
|
466
|
+
- [Zyphr::SmsBatchResultMessage](docs/SmsBatchResultMessage.md)
|
|
467
|
+
- [Zyphr::SmsBatchResultSummary](docs/SmsBatchResultSummary.md)
|
|
468
|
+
- [Zyphr::SmsConfig](docs/SmsConfig.md)
|
|
469
|
+
- [Zyphr::SmsConfigDeleteResponse](docs/SmsConfigDeleteResponse.md)
|
|
470
|
+
- [Zyphr::SmsConfigDeleteResponseData](docs/SmsConfigDeleteResponseData.md)
|
|
471
|
+
- [Zyphr::SmsConfigResponse](docs/SmsConfigResponse.md)
|
|
472
|
+
- [Zyphr::SmsDetailResponse](docs/SmsDetailResponse.md)
|
|
473
|
+
- [Zyphr::SmsListResponse](docs/SmsListResponse.md)
|
|
474
|
+
- [Zyphr::SmsListResponseMeta](docs/SmsListResponseMeta.md)
|
|
475
|
+
- [Zyphr::SmsMessage](docs/SmsMessage.md)
|
|
476
|
+
- [Zyphr::SmsMessageDetail](docs/SmsMessageDetail.md)
|
|
477
|
+
- [Zyphr::SubscribePushTopicRequest](docs/SubscribePushTopicRequest.md)
|
|
478
|
+
- [Zyphr::Subscriber](docs/Subscriber.md)
|
|
479
|
+
- [Zyphr::SubscriberListResponse](docs/SubscriberListResponse.md)
|
|
480
|
+
- [Zyphr::SubscriberPreference](docs/SubscriberPreference.md)
|
|
481
|
+
- [Zyphr::SubscriberResponse](docs/SubscriberResponse.md)
|
|
482
|
+
- [Zyphr::SuccessResult](docs/SuccessResult.md)
|
|
483
|
+
- [Zyphr::SuccessResultData](docs/SuccessResultData.md)
|
|
484
|
+
- [Zyphr::Template](docs/Template.md)
|
|
485
|
+
- [Zyphr::TemplateListResponse](docs/TemplateListResponse.md)
|
|
486
|
+
- [Zyphr::TemplateRenderResponse](docs/TemplateRenderResponse.md)
|
|
487
|
+
- [Zyphr::TemplateRenderedContent](docs/TemplateRenderedContent.md)
|
|
488
|
+
- [Zyphr::TemplateResponse](docs/TemplateResponse.md)
|
|
489
|
+
- [Zyphr::TestWebhookTransformRequest](docs/TestWebhookTransformRequest.md)
|
|
490
|
+
- [Zyphr::Topic](docs/Topic.md)
|
|
491
|
+
- [Zyphr::TopicDeleteResponse](docs/TopicDeleteResponse.md)
|
|
492
|
+
- [Zyphr::TopicDeleteResponseData](docs/TopicDeleteResponseData.md)
|
|
493
|
+
- [Zyphr::TopicListResponse](docs/TopicListResponse.md)
|
|
494
|
+
- [Zyphr::TopicResponse](docs/TopicResponse.md)
|
|
495
|
+
- [Zyphr::TopicStatsData](docs/TopicStatsData.md)
|
|
496
|
+
- [Zyphr::TopicStatsDataTopicsBySubscriberCountInner](docs/TopicStatsDataTopicsBySubscriberCountInner.md)
|
|
497
|
+
- [Zyphr::TopicStatsResponse](docs/TopicStatsResponse.md)
|
|
498
|
+
- [Zyphr::TopicSubscriber](docs/TopicSubscriber.md)
|
|
499
|
+
- [Zyphr::TopicSubscriberListResponse](docs/TopicSubscriberListResponse.md)
|
|
500
|
+
- [Zyphr::TopicSubscribersAddResponse](docs/TopicSubscribersAddResponse.md)
|
|
501
|
+
- [Zyphr::TopicSubscribersAddResult](docs/TopicSubscribersAddResult.md)
|
|
502
|
+
- [Zyphr::TopicSubscribersRemoveResponse](docs/TopicSubscribersRemoveResponse.md)
|
|
503
|
+
- [Zyphr::TopicSubscribersRemoveResult](docs/TopicSubscribersRemoveResult.md)
|
|
504
|
+
- [Zyphr::UnreadCountData](docs/UnreadCountData.md)
|
|
505
|
+
- [Zyphr::UnreadCountResponse](docs/UnreadCountResponse.md)
|
|
506
|
+
- [Zyphr::Unsubscribe](docs/Unsubscribe.md)
|
|
507
|
+
- [Zyphr::UnsubscribeListResponse](docs/UnsubscribeListResponse.md)
|
|
508
|
+
- [Zyphr::UnsubscribeRequest](docs/UnsubscribeRequest.md)
|
|
509
|
+
- [Zyphr::UnsubscribeResponse](docs/UnsubscribeResponse.md)
|
|
510
|
+
- [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
|
|
511
|
+
- [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
|
|
512
|
+
- [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
|
|
513
|
+
- [Zyphr::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
|
|
514
|
+
- [Zyphr::UpdateTopicRequest](docs/UpdateTopicRequest.md)
|
|
515
|
+
- [Zyphr::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
516
|
+
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
517
|
+
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
518
|
+
- [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
|
|
519
|
+
- [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
|
|
520
|
+
- [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
|
|
521
|
+
- [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
|
|
522
|
+
- [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
|
|
523
|
+
- [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
|
|
524
|
+
- [Zyphr::WebAuthnChallengeOptions](docs/WebAuthnChallengeOptions.md)
|
|
525
|
+
- [Zyphr::WebAuthnCredential](docs/WebAuthnCredential.md)
|
|
526
|
+
- [Zyphr::WebAuthnCredentialListResponse](docs/WebAuthnCredentialListResponse.md)
|
|
527
|
+
- [Zyphr::WebAuthnCredentialListResponseData](docs/WebAuthnCredentialListResponseData.md)
|
|
528
|
+
- [Zyphr::WebAuthnCredentialResponse](docs/WebAuthnCredentialResponse.md)
|
|
529
|
+
- [Zyphr::WebAuthnStartAuthRequest](docs/WebAuthnStartAuthRequest.md)
|
|
530
|
+
- [Zyphr::WebAuthnStartAuthResponse](docs/WebAuthnStartAuthResponse.md)
|
|
531
|
+
- [Zyphr::WebAuthnStartRegistrationRequest](docs/WebAuthnStartRegistrationRequest.md)
|
|
532
|
+
- [Zyphr::WebAuthnStartRegistrationResponse](docs/WebAuthnStartRegistrationResponse.md)
|
|
533
|
+
- [Zyphr::WebAuthnStatusResponse](docs/WebAuthnStatusResponse.md)
|
|
534
|
+
- [Zyphr::WebAuthnStatusResponseData](docs/WebAuthnStatusResponseData.md)
|
|
535
|
+
- [Zyphr::WebAuthnVerifyAuthRequest](docs/WebAuthnVerifyAuthRequest.md)
|
|
536
|
+
- [Zyphr::WebAuthnVerifyRegistrationRequest](docs/WebAuthnVerifyRegistrationRequest.md)
|
|
537
|
+
- [Zyphr::WebAuthnVerifyRegistrationResponse](docs/WebAuthnVerifyRegistrationResponse.md)
|
|
538
|
+
- [Zyphr::WebAuthnVerifyRegistrationResponseData](docs/WebAuthnVerifyRegistrationResponseData.md)
|
|
539
|
+
- [Zyphr::Webhook](docs/Webhook.md)
|
|
540
|
+
- [Zyphr::WebhookBulkRetryResponse](docs/WebhookBulkRetryResponse.md)
|
|
541
|
+
- [Zyphr::WebhookCircuitState](docs/WebhookCircuitState.md)
|
|
542
|
+
- [Zyphr::WebhookCircuitStateResponse](docs/WebhookCircuitStateResponse.md)
|
|
543
|
+
- [Zyphr::WebhookCreateResponse](docs/WebhookCreateResponse.md)
|
|
544
|
+
- [Zyphr::WebhookCreateResponseData](docs/WebhookCreateResponseData.md)
|
|
545
|
+
- [Zyphr::WebhookDeleteResponse](docs/WebhookDeleteResponse.md)
|
|
546
|
+
- [Zyphr::WebhookDeleteResponseData](docs/WebhookDeleteResponseData.md)
|
|
547
|
+
- [Zyphr::WebhookDelivery](docs/WebhookDelivery.md)
|
|
548
|
+
- [Zyphr::WebhookDeliveryDetail](docs/WebhookDeliveryDetail.md)
|
|
549
|
+
- [Zyphr::WebhookDeliveryListResponse](docs/WebhookDeliveryListResponse.md)
|
|
550
|
+
- [Zyphr::WebhookDeliveryResponse](docs/WebhookDeliveryResponse.md)
|
|
551
|
+
- [Zyphr::WebhookDeliveryRetryResponse](docs/WebhookDeliveryRetryResponse.md)
|
|
552
|
+
- [Zyphr::WebhookDeliveryRetryResponseData](docs/WebhookDeliveryRetryResponseData.md)
|
|
553
|
+
- [Zyphr::WebhookEventTypesResponse](docs/WebhookEventTypesResponse.md)
|
|
554
|
+
- [Zyphr::WebhookEventTypesResponseData](docs/WebhookEventTypesResponseData.md)
|
|
555
|
+
- [Zyphr::WebhookIpsResponse](docs/WebhookIpsResponse.md)
|
|
556
|
+
- [Zyphr::WebhookIpsResponseData](docs/WebhookIpsResponseData.md)
|
|
557
|
+
- [Zyphr::WebhookJobResponse](docs/WebhookJobResponse.md)
|
|
558
|
+
- [Zyphr::WebhookListResponse](docs/WebhookListResponse.md)
|
|
559
|
+
- [Zyphr::WebhookMetricsResponse](docs/WebhookMetricsResponse.md)
|
|
560
|
+
- [Zyphr::WebhookRegion](docs/WebhookRegion.md)
|
|
561
|
+
- [Zyphr::WebhookRegionsResponse](docs/WebhookRegionsResponse.md)
|
|
562
|
+
- [Zyphr::WebhookRegionsResponseData](docs/WebhookRegionsResponseData.md)
|
|
563
|
+
- [Zyphr::WebhookReplayResponse](docs/WebhookReplayResponse.md)
|
|
564
|
+
- [Zyphr::WebhookResponse](docs/WebhookResponse.md)
|
|
565
|
+
- [Zyphr::WebhookSecretRotateResponse](docs/WebhookSecretRotateResponse.md)
|
|
566
|
+
- [Zyphr::WebhookSecretRotateResponseData](docs/WebhookSecretRotateResponseData.md)
|
|
567
|
+
- [Zyphr::WebhookTestEventResponse](docs/WebhookTestEventResponse.md)
|
|
568
|
+
- [Zyphr::WebhookTestEventResponseData](docs/WebhookTestEventResponseData.md)
|
|
569
|
+
- [Zyphr::WebhookTransformTestResponse](docs/WebhookTransformTestResponse.md)
|
|
570
|
+
- [Zyphr::WebhookUsageResponse](docs/WebhookUsageResponse.md)
|
|
571
|
+
- [Zyphr::WebhookVersion](docs/WebhookVersion.md)
|
|
572
|
+
- [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
|
|
573
|
+
- [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
|
|
574
|
+
- [Zyphr::WebhookWorkspaceMetricsResponse](docs/WebhookWorkspaceMetricsResponse.md)
|
|
575
|
+
- [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
## Documentation for Authorization
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
Authentication schemes defined for the API:
|
|
582
|
+
### ApiKeyAuth
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
- **Type**: API key
|
|
586
|
+
- **API key parameter name**: X-API-Key
|
|
587
|
+
- **Location**: HTTP header
|
|
588
|
+
|
|
589
|
+
### ApplicationPublicKey
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
- **Type**: API key
|
|
593
|
+
- **API key parameter name**: X-Application-Key
|
|
594
|
+
- **Location**: HTTP header
|
|
595
|
+
|
|
596
|
+
### ApplicationSecret
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
- **Type**: API key
|
|
600
|
+
- **API key parameter name**: X-Application-Secret
|
|
601
|
+
- **Location**: HTTP header
|
|
602
|
+
|
|
603
|
+
### EndUserToken
|
|
604
|
+
|
|
605
|
+
- **Type**: Bearer authentication (JWT)
|
|
606
|
+
|
|
607
|
+
### AdminAuth
|
|
608
|
+
|
|
609
|
+
- **Type**: Bearer authentication (JWT)
|
|
610
|
+
|
|
611
|
+
### DashboardAuth
|
|
612
|
+
|
|
613
|
+
- **Type**: Bearer authentication (JWT)
|
|
614
|
+
|