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
data/lib/zyphr.rb
ADDED
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
# Common files
|
|
14
|
+
require 'zyphr/api_client'
|
|
15
|
+
require 'zyphr/api_error'
|
|
16
|
+
require 'zyphr/version'
|
|
17
|
+
require 'zyphr/configuration'
|
|
18
|
+
|
|
19
|
+
# Models
|
|
20
|
+
require 'zyphr/models/add_topic_subscribers_request'
|
|
21
|
+
require 'zyphr/models/api_error'
|
|
22
|
+
require 'zyphr/models/api_error_error'
|
|
23
|
+
require 'zyphr/models/api_error_meta'
|
|
24
|
+
require 'zyphr/models/auth_login_response'
|
|
25
|
+
require 'zyphr/models/auth_login_result'
|
|
26
|
+
require 'zyphr/models/auth_login_result_mfa_challenge'
|
|
27
|
+
require 'zyphr/models/auth_result'
|
|
28
|
+
require 'zyphr/models/auth_result_response'
|
|
29
|
+
require 'zyphr/models/auth_session'
|
|
30
|
+
require 'zyphr/models/auth_tokens'
|
|
31
|
+
require 'zyphr/models/auth_user'
|
|
32
|
+
require 'zyphr/models/auth_user_response'
|
|
33
|
+
require 'zyphr/models/auth_user_response_data'
|
|
34
|
+
require 'zyphr/models/bulk_retry_webhook_deliveries_request'
|
|
35
|
+
require 'zyphr/models/category'
|
|
36
|
+
require 'zyphr/models/category_list_response'
|
|
37
|
+
require 'zyphr/models/category_response'
|
|
38
|
+
require 'zyphr/models/confirm_email_verification_request'
|
|
39
|
+
require 'zyphr/models/confirm_email_verification_response'
|
|
40
|
+
require 'zyphr/models/confirm_email_verification_response_data'
|
|
41
|
+
require 'zyphr/models/consent_history_entry'
|
|
42
|
+
require 'zyphr/models/consent_history_response'
|
|
43
|
+
require 'zyphr/models/consent_record_response'
|
|
44
|
+
require 'zyphr/models/consent_record_response_data'
|
|
45
|
+
require 'zyphr/models/consent_status'
|
|
46
|
+
require 'zyphr/models/consent_status_response'
|
|
47
|
+
require 'zyphr/models/consent_withdraw_response'
|
|
48
|
+
require 'zyphr/models/create_category_request'
|
|
49
|
+
require 'zyphr/models/create_subscriber_request'
|
|
50
|
+
require 'zyphr/models/create_template_request'
|
|
51
|
+
require 'zyphr/models/create_topic_request'
|
|
52
|
+
require 'zyphr/models/create_webhook_request'
|
|
53
|
+
require 'zyphr/models/delete_result'
|
|
54
|
+
require 'zyphr/models/delete_result_data'
|
|
55
|
+
require 'zyphr/models/device'
|
|
56
|
+
require 'zyphr/models/device_list_response'
|
|
57
|
+
require 'zyphr/models/device_push_topic'
|
|
58
|
+
require 'zyphr/models/device_push_topic_list_response'
|
|
59
|
+
require 'zyphr/models/device_push_topic_list_response_meta'
|
|
60
|
+
require 'zyphr/models/device_response'
|
|
61
|
+
require 'zyphr/models/device_stats'
|
|
62
|
+
require 'zyphr/models/device_stats_response'
|
|
63
|
+
require 'zyphr/models/email_address'
|
|
64
|
+
require 'zyphr/models/email_attachment'
|
|
65
|
+
require 'zyphr/models/email_event'
|
|
66
|
+
require 'zyphr/models/email_events_response'
|
|
67
|
+
require 'zyphr/models/email_list_response'
|
|
68
|
+
require 'zyphr/models/email_message'
|
|
69
|
+
require 'zyphr/models/email_response'
|
|
70
|
+
require 'zyphr/models/email_tracking_click_link'
|
|
71
|
+
require 'zyphr/models/email_tracking_clicks'
|
|
72
|
+
require 'zyphr/models/email_tracking_data'
|
|
73
|
+
require 'zyphr/models/email_tracking_opens'
|
|
74
|
+
require 'zyphr/models/email_tracking_response'
|
|
75
|
+
require 'zyphr/models/end_user_delete_response'
|
|
76
|
+
require 'zyphr/models/end_user_delete_response_data'
|
|
77
|
+
require 'zyphr/models/forgot_password_request'
|
|
78
|
+
require 'zyphr/models/in_app_notification'
|
|
79
|
+
require 'zyphr/models/inbox_list_meta'
|
|
80
|
+
require 'zyphr/models/inbox_list_response'
|
|
81
|
+
require 'zyphr/models/inbox_notification_response'
|
|
82
|
+
require 'zyphr/models/login_request'
|
|
83
|
+
require 'zyphr/models/magic_link_send_request'
|
|
84
|
+
require 'zyphr/models/magic_link_verify_request'
|
|
85
|
+
require 'zyphr/models/magic_link_verify_response'
|
|
86
|
+
require 'zyphr/models/magic_link_verify_response_data'
|
|
87
|
+
require 'zyphr/models/mark_all_inbox_read_request'
|
|
88
|
+
require 'zyphr/models/mark_all_read_data'
|
|
89
|
+
require 'zyphr/models/mark_all_read_response'
|
|
90
|
+
require 'zyphr/models/mark_inbox_read_request'
|
|
91
|
+
require 'zyphr/models/mfa_backup_codes_response'
|
|
92
|
+
require 'zyphr/models/mfa_backup_codes_response_data'
|
|
93
|
+
require 'zyphr/models/mfa_disable_request'
|
|
94
|
+
require 'zyphr/models/mfa_disable_response'
|
|
95
|
+
require 'zyphr/models/mfa_disable_response_data'
|
|
96
|
+
require 'zyphr/models/mfa_enroll_request'
|
|
97
|
+
require 'zyphr/models/mfa_enrollment_response'
|
|
98
|
+
require 'zyphr/models/mfa_enrollment_response_data'
|
|
99
|
+
require 'zyphr/models/mfa_regenerate_backup_codes_request'
|
|
100
|
+
require 'zyphr/models/mfa_status_response'
|
|
101
|
+
require 'zyphr/models/mfa_status_response_data'
|
|
102
|
+
require 'zyphr/models/mfa_verify_backup_request'
|
|
103
|
+
require 'zyphr/models/mfa_verify_backup_response'
|
|
104
|
+
require 'zyphr/models/mfa_verify_backup_response_data'
|
|
105
|
+
require 'zyphr/models/mfa_verify_enrollment_request'
|
|
106
|
+
require 'zyphr/models/mfa_verify_enrollment_response'
|
|
107
|
+
require 'zyphr/models/mfa_verify_enrollment_response_data'
|
|
108
|
+
require 'zyphr/models/mfa_verify_request'
|
|
109
|
+
require 'zyphr/models/o_auth_authorization_url_response'
|
|
110
|
+
require 'zyphr/models/o_auth_authorization_url_response_data'
|
|
111
|
+
require 'zyphr/models/o_auth_callback_request'
|
|
112
|
+
require 'zyphr/models/o_auth_callback_response'
|
|
113
|
+
require 'zyphr/models/o_auth_callback_response_data'
|
|
114
|
+
require 'zyphr/models/o_auth_connection'
|
|
115
|
+
require 'zyphr/models/o_auth_connection_info_response'
|
|
116
|
+
require 'zyphr/models/o_auth_connection_info_response_data'
|
|
117
|
+
require 'zyphr/models/o_auth_connections_response'
|
|
118
|
+
require 'zyphr/models/o_auth_connections_response_data'
|
|
119
|
+
require 'zyphr/models/o_auth_provider'
|
|
120
|
+
require 'zyphr/models/o_auth_provider_info'
|
|
121
|
+
require 'zyphr/models/o_auth_providers_response'
|
|
122
|
+
require 'zyphr/models/o_auth_providers_response_data'
|
|
123
|
+
require 'zyphr/models/o_auth_tokens_refresh_response'
|
|
124
|
+
require 'zyphr/models/o_auth_tokens_refresh_response_data'
|
|
125
|
+
require 'zyphr/models/o_auth_tokens_response'
|
|
126
|
+
require 'zyphr/models/o_auth_tokens_response_data'
|
|
127
|
+
require 'zyphr/models/pagination_meta'
|
|
128
|
+
require 'zyphr/models/password_requirements'
|
|
129
|
+
require 'zyphr/models/password_requirements_response'
|
|
130
|
+
require 'zyphr/models/password_requirements_response_data'
|
|
131
|
+
require 'zyphr/models/phone_auth_availability_response'
|
|
132
|
+
require 'zyphr/models/phone_auth_availability_response_data'
|
|
133
|
+
require 'zyphr/models/phone_login_verify_request'
|
|
134
|
+
require 'zyphr/models/phone_otp_send_request'
|
|
135
|
+
require 'zyphr/models/phone_otp_sent_response'
|
|
136
|
+
require 'zyphr/models/phone_otp_sent_response_data'
|
|
137
|
+
require 'zyphr/models/phone_register_verify_request'
|
|
138
|
+
require 'zyphr/models/preference_list_response'
|
|
139
|
+
require 'zyphr/models/push_detail_response'
|
|
140
|
+
require 'zyphr/models/push_event'
|
|
141
|
+
require 'zyphr/models/push_list_response'
|
|
142
|
+
require 'zyphr/models/push_message'
|
|
143
|
+
require 'zyphr/models/push_message_detail'
|
|
144
|
+
require 'zyphr/models/push_payload'
|
|
145
|
+
require 'zyphr/models/push_stats_data'
|
|
146
|
+
require 'zyphr/models/push_stats_response'
|
|
147
|
+
require 'zyphr/models/push_topic_device'
|
|
148
|
+
require 'zyphr/models/push_topic_device_list_response'
|
|
149
|
+
require 'zyphr/models/push_topic_subscribe_data'
|
|
150
|
+
require 'zyphr/models/push_topic_subscribe_response'
|
|
151
|
+
require 'zyphr/models/push_topic_unsubscribe_data'
|
|
152
|
+
require 'zyphr/models/push_topic_unsubscribe_response'
|
|
153
|
+
require 'zyphr/models/refresh_o_auth_tokens_request'
|
|
154
|
+
require 'zyphr/models/refresh_session_request'
|
|
155
|
+
require 'zyphr/models/refresh_token_response'
|
|
156
|
+
require 'zyphr/models/refresh_token_response_data'
|
|
157
|
+
require 'zyphr/models/register_device_request'
|
|
158
|
+
require 'zyphr/models/register_request'
|
|
159
|
+
require 'zyphr/models/remove_topic_subscribers_request'
|
|
160
|
+
require 'zyphr/models/rename_web_authn_credential_request'
|
|
161
|
+
require 'zyphr/models/render_template_request'
|
|
162
|
+
require 'zyphr/models/replay_webhook_events_request'
|
|
163
|
+
require 'zyphr/models/request_meta'
|
|
164
|
+
require 'zyphr/models/reset_password_request'
|
|
165
|
+
require 'zyphr/models/reset_password_response'
|
|
166
|
+
require 'zyphr/models/resubscribe_request'
|
|
167
|
+
require 'zyphr/models/resubscribe_response'
|
|
168
|
+
require 'zyphr/models/revoke_all_sessions_response'
|
|
169
|
+
require 'zyphr/models/revoke_all_sessions_response_data'
|
|
170
|
+
require 'zyphr/models/revoke_session_request'
|
|
171
|
+
require 'zyphr/models/send_batch_email_request'
|
|
172
|
+
require 'zyphr/models/send_batch_email_response'
|
|
173
|
+
require 'zyphr/models/send_batch_email_result'
|
|
174
|
+
require 'zyphr/models/send_batch_email_result_item'
|
|
175
|
+
require 'zyphr/models/send_batch_in_app_meta'
|
|
176
|
+
require 'zyphr/models/send_batch_in_app_request'
|
|
177
|
+
require 'zyphr/models/send_batch_in_app_response'
|
|
178
|
+
require 'zyphr/models/send_batch_sms_data'
|
|
179
|
+
require 'zyphr/models/send_batch_sms_request'
|
|
180
|
+
require 'zyphr/models/send_batch_sms_response'
|
|
181
|
+
require 'zyphr/models/send_email_request'
|
|
182
|
+
require 'zyphr/models/send_email_response'
|
|
183
|
+
require 'zyphr/models/send_email_response_data'
|
|
184
|
+
require 'zyphr/models/send_email_response_meta'
|
|
185
|
+
require 'zyphr/models/send_email_verification_request'
|
|
186
|
+
require 'zyphr/models/send_in_app_meta'
|
|
187
|
+
require 'zyphr/models/send_in_app_request'
|
|
188
|
+
require 'zyphr/models/send_in_app_response'
|
|
189
|
+
require 'zyphr/models/send_push_request'
|
|
190
|
+
require 'zyphr/models/send_push_response'
|
|
191
|
+
require 'zyphr/models/send_push_response_data'
|
|
192
|
+
require 'zyphr/models/send_push_to_topic_data'
|
|
193
|
+
require 'zyphr/models/send_push_to_topic_request'
|
|
194
|
+
require 'zyphr/models/send_push_to_topic_response'
|
|
195
|
+
require 'zyphr/models/send_sms_data'
|
|
196
|
+
require 'zyphr/models/send_sms_request'
|
|
197
|
+
require 'zyphr/models/send_sms_response'
|
|
198
|
+
require 'zyphr/models/send_test_sms_data'
|
|
199
|
+
require 'zyphr/models/send_test_sms_request'
|
|
200
|
+
require 'zyphr/models/send_test_sms_response'
|
|
201
|
+
require 'zyphr/models/send_webhook_test_event_request'
|
|
202
|
+
require 'zyphr/models/session_list_response'
|
|
203
|
+
require 'zyphr/models/session_list_response_data'
|
|
204
|
+
require 'zyphr/models/session_list_response_data_session_info'
|
|
205
|
+
require 'zyphr/models/set_preferences_request'
|
|
206
|
+
require 'zyphr/models/set_preferences_request_preferences_inner'
|
|
207
|
+
require 'zyphr/models/sms_batch_result_message'
|
|
208
|
+
require 'zyphr/models/sms_batch_result_summary'
|
|
209
|
+
require 'zyphr/models/sms_config'
|
|
210
|
+
require 'zyphr/models/sms_config_delete_response'
|
|
211
|
+
require 'zyphr/models/sms_config_delete_response_data'
|
|
212
|
+
require 'zyphr/models/sms_config_response'
|
|
213
|
+
require 'zyphr/models/sms_detail_response'
|
|
214
|
+
require 'zyphr/models/sms_list_response'
|
|
215
|
+
require 'zyphr/models/sms_list_response_meta'
|
|
216
|
+
require 'zyphr/models/sms_message'
|
|
217
|
+
require 'zyphr/models/sms_message_detail'
|
|
218
|
+
require 'zyphr/models/subscribe_push_topic_request'
|
|
219
|
+
require 'zyphr/models/subscriber'
|
|
220
|
+
require 'zyphr/models/subscriber_list_response'
|
|
221
|
+
require 'zyphr/models/subscriber_preference'
|
|
222
|
+
require 'zyphr/models/subscriber_response'
|
|
223
|
+
require 'zyphr/models/success_result'
|
|
224
|
+
require 'zyphr/models/success_result_data'
|
|
225
|
+
require 'zyphr/models/template'
|
|
226
|
+
require 'zyphr/models/template_list_response'
|
|
227
|
+
require 'zyphr/models/template_render_response'
|
|
228
|
+
require 'zyphr/models/template_rendered_content'
|
|
229
|
+
require 'zyphr/models/template_response'
|
|
230
|
+
require 'zyphr/models/test_webhook_transform_request'
|
|
231
|
+
require 'zyphr/models/topic'
|
|
232
|
+
require 'zyphr/models/topic_delete_response'
|
|
233
|
+
require 'zyphr/models/topic_delete_response_data'
|
|
234
|
+
require 'zyphr/models/topic_list_response'
|
|
235
|
+
require 'zyphr/models/topic_response'
|
|
236
|
+
require 'zyphr/models/topic_stats_data'
|
|
237
|
+
require 'zyphr/models/topic_stats_data_topics_by_subscriber_count_inner'
|
|
238
|
+
require 'zyphr/models/topic_stats_response'
|
|
239
|
+
require 'zyphr/models/topic_subscriber'
|
|
240
|
+
require 'zyphr/models/topic_subscriber_list_response'
|
|
241
|
+
require 'zyphr/models/topic_subscribers_add_response'
|
|
242
|
+
require 'zyphr/models/topic_subscribers_add_result'
|
|
243
|
+
require 'zyphr/models/topic_subscribers_remove_response'
|
|
244
|
+
require 'zyphr/models/topic_subscribers_remove_result'
|
|
245
|
+
require 'zyphr/models/unread_count_data'
|
|
246
|
+
require 'zyphr/models/unread_count_response'
|
|
247
|
+
require 'zyphr/models/unsubscribe'
|
|
248
|
+
require 'zyphr/models/unsubscribe_list_response'
|
|
249
|
+
require 'zyphr/models/unsubscribe_request'
|
|
250
|
+
require 'zyphr/models/unsubscribe_response'
|
|
251
|
+
require 'zyphr/models/update_category_request'
|
|
252
|
+
require 'zyphr/models/update_end_user_request'
|
|
253
|
+
require 'zyphr/models/update_subscriber_request'
|
|
254
|
+
require 'zyphr/models/update_template_request'
|
|
255
|
+
require 'zyphr/models/update_topic_request'
|
|
256
|
+
require 'zyphr/models/update_webhook_request'
|
|
257
|
+
require 'zyphr/models/upsert_sms_config_request'
|
|
258
|
+
require 'zyphr/models/user_devices_delete_response'
|
|
259
|
+
require 'zyphr/models/user_devices_delete_response_data'
|
|
260
|
+
require 'zyphr/models/validate_reset_token_request'
|
|
261
|
+
require 'zyphr/models/validate_reset_token_response'
|
|
262
|
+
require 'zyphr/models/validate_reset_token_response_data'
|
|
263
|
+
require 'zyphr/models/verify_sms_config_data'
|
|
264
|
+
require 'zyphr/models/verify_sms_config_response'
|
|
265
|
+
require 'zyphr/models/web_authn_challenge_options'
|
|
266
|
+
require 'zyphr/models/web_authn_credential'
|
|
267
|
+
require 'zyphr/models/web_authn_credential_list_response'
|
|
268
|
+
require 'zyphr/models/web_authn_credential_list_response_data'
|
|
269
|
+
require 'zyphr/models/web_authn_credential_response'
|
|
270
|
+
require 'zyphr/models/web_authn_start_auth_request'
|
|
271
|
+
require 'zyphr/models/web_authn_start_auth_response'
|
|
272
|
+
require 'zyphr/models/web_authn_start_registration_request'
|
|
273
|
+
require 'zyphr/models/web_authn_start_registration_response'
|
|
274
|
+
require 'zyphr/models/web_authn_status_response'
|
|
275
|
+
require 'zyphr/models/web_authn_status_response_data'
|
|
276
|
+
require 'zyphr/models/web_authn_verify_auth_request'
|
|
277
|
+
require 'zyphr/models/web_authn_verify_registration_request'
|
|
278
|
+
require 'zyphr/models/web_authn_verify_registration_response'
|
|
279
|
+
require 'zyphr/models/web_authn_verify_registration_response_data'
|
|
280
|
+
require 'zyphr/models/webhook'
|
|
281
|
+
require 'zyphr/models/webhook_bulk_retry_response'
|
|
282
|
+
require 'zyphr/models/webhook_circuit_state'
|
|
283
|
+
require 'zyphr/models/webhook_circuit_state_response'
|
|
284
|
+
require 'zyphr/models/webhook_create_response'
|
|
285
|
+
require 'zyphr/models/webhook_create_response_data'
|
|
286
|
+
require 'zyphr/models/webhook_delete_response'
|
|
287
|
+
require 'zyphr/models/webhook_delete_response_data'
|
|
288
|
+
require 'zyphr/models/webhook_delivery'
|
|
289
|
+
require 'zyphr/models/webhook_delivery_detail'
|
|
290
|
+
require 'zyphr/models/webhook_delivery_list_response'
|
|
291
|
+
require 'zyphr/models/webhook_delivery_response'
|
|
292
|
+
require 'zyphr/models/webhook_delivery_retry_response'
|
|
293
|
+
require 'zyphr/models/webhook_delivery_retry_response_data'
|
|
294
|
+
require 'zyphr/models/webhook_event_types_response'
|
|
295
|
+
require 'zyphr/models/webhook_event_types_response_data'
|
|
296
|
+
require 'zyphr/models/webhook_ips_response'
|
|
297
|
+
require 'zyphr/models/webhook_ips_response_data'
|
|
298
|
+
require 'zyphr/models/webhook_job_response'
|
|
299
|
+
require 'zyphr/models/webhook_list_response'
|
|
300
|
+
require 'zyphr/models/webhook_metrics_response'
|
|
301
|
+
require 'zyphr/models/webhook_region'
|
|
302
|
+
require 'zyphr/models/webhook_regions_response'
|
|
303
|
+
require 'zyphr/models/webhook_regions_response_data'
|
|
304
|
+
require 'zyphr/models/webhook_replay_response'
|
|
305
|
+
require 'zyphr/models/webhook_response'
|
|
306
|
+
require 'zyphr/models/webhook_secret_rotate_response'
|
|
307
|
+
require 'zyphr/models/webhook_secret_rotate_response_data'
|
|
308
|
+
require 'zyphr/models/webhook_test_event_response'
|
|
309
|
+
require 'zyphr/models/webhook_test_event_response_data'
|
|
310
|
+
require 'zyphr/models/webhook_transform_test_response'
|
|
311
|
+
require 'zyphr/models/webhook_usage_response'
|
|
312
|
+
require 'zyphr/models/webhook_version'
|
|
313
|
+
require 'zyphr/models/webhook_versions_response'
|
|
314
|
+
require 'zyphr/models/webhook_versions_response_data'
|
|
315
|
+
require 'zyphr/models/webhook_workspace_metrics_response'
|
|
316
|
+
require 'zyphr/models/withdraw_subscriber_consent_request'
|
|
317
|
+
|
|
318
|
+
# APIs
|
|
319
|
+
require 'zyphr/api/auth_email_verification_api'
|
|
320
|
+
require 'zyphr/api/auth_login_api'
|
|
321
|
+
require 'zyphr/api/auth_mfa_api'
|
|
322
|
+
require 'zyphr/api/auth_magic_links_api'
|
|
323
|
+
require 'zyphr/api/auth_o_auth_api'
|
|
324
|
+
require 'zyphr/api/auth_password_reset_api'
|
|
325
|
+
require 'zyphr/api/auth_phone_api'
|
|
326
|
+
require 'zyphr/api/auth_registration_api'
|
|
327
|
+
require 'zyphr/api/auth_sessions_api'
|
|
328
|
+
require 'zyphr/api/auth_user_profile_api'
|
|
329
|
+
require 'zyphr/api/auth_web_authn_api'
|
|
330
|
+
require 'zyphr/api/devices_api'
|
|
331
|
+
require 'zyphr/api/emails_api'
|
|
332
|
+
require 'zyphr/api/inbox_api'
|
|
333
|
+
require 'zyphr/api/push_api'
|
|
334
|
+
require 'zyphr/api/sms_api'
|
|
335
|
+
require 'zyphr/api/subscribers_api'
|
|
336
|
+
require 'zyphr/api/templates_api'
|
|
337
|
+
require 'zyphr/api/topics_api'
|
|
338
|
+
require 'zyphr/api/utility_api'
|
|
339
|
+
require 'zyphr/api/webhooks_api'
|
|
340
|
+
|
|
341
|
+
module Zyphr
|
|
342
|
+
class << self
|
|
343
|
+
# Customize default settings for the SDK using block.
|
|
344
|
+
# Zyphr.configure do |config|
|
|
345
|
+
# config.username = "xxx"
|
|
346
|
+
# config.password = "xxx"
|
|
347
|
+
# end
|
|
348
|
+
# If no block given, return the default Configuration object.
|
|
349
|
+
def configure
|
|
350
|
+
if block_given?
|
|
351
|
+
yield(Configuration.default)
|
|
352
|
+
else
|
|
353
|
+
Configuration.default
|
|
354
|
+
end
|
|
355
|
+
end
|
|
356
|
+
end
|
|
357
|
+
end
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Zyphr::AuthEmailVerificationApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'AuthEmailVerificationApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Zyphr::AuthEmailVerificationApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of AuthEmailVerificationApi' do
|
|
30
|
+
it 'should create an instance of AuthEmailVerificationApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Zyphr::AuthEmailVerificationApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for confirm_email_verification
|
|
36
|
+
# Confirm email verification
|
|
37
|
+
# Verify the user's email using the token from the verification email.
|
|
38
|
+
# @param confirm_email_verification_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [ConfirmEmailVerificationResponse]
|
|
41
|
+
describe 'confirm_email_verification test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# unit tests for resend_email_verification
|
|
48
|
+
# Resend email verification
|
|
49
|
+
# Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
|
|
50
|
+
# @param [Hash] opts the optional parameters
|
|
51
|
+
# @option opts [SendEmailVerificationRequest] :send_email_verification_request
|
|
52
|
+
# @return [SuccessResult]
|
|
53
|
+
describe 'resend_email_verification test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# unit tests for send_email_verification
|
|
60
|
+
# Send email verification
|
|
61
|
+
# Send an email verification link to the authenticated user.
|
|
62
|
+
# @param [Hash] opts the optional parameters
|
|
63
|
+
# @option opts [SendEmailVerificationRequest] :send_email_verification_request
|
|
64
|
+
# @return [SuccessResult]
|
|
65
|
+
describe 'send_email_verification test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Zyphr::AuthLoginApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'AuthLoginApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Zyphr::AuthLoginApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of AuthLoginApi' do
|
|
30
|
+
it 'should create an instance of AuthLoginApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Zyphr::AuthLoginApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for login_end_user
|
|
36
|
+
# Login end user
|
|
37
|
+
# Login end user with email and password. Accepts optional custom_claims to embed in JWT (max 4KB). If MFA is enabled for the user, returns mfa_required: true with a challenge token. The user must then call POST /v1/auth/mfa/verify with the challenge token and TOTP code.
|
|
38
|
+
# @param login_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [AuthLoginResponse]
|
|
41
|
+
describe 'login_end_user test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
end
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Zyphr::AuthMagicLinksApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'AuthMagicLinksApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Zyphr::AuthMagicLinksApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of AuthMagicLinksApi' do
|
|
30
|
+
it 'should create an instance of AuthMagicLinksApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Zyphr::AuthMagicLinksApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for send_magic_link
|
|
36
|
+
# Send a magic link
|
|
37
|
+
# Send a magic link email for passwordless authentication.
|
|
38
|
+
# @param magic_link_send_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [SuccessResult]
|
|
41
|
+
describe 'send_magic_link test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# unit tests for verify_magic_link
|
|
48
|
+
# Verify a magic link
|
|
49
|
+
# Verify a magic link token and authenticate the user. Returns auth result with is_new_user flag.
|
|
50
|
+
# @param magic_link_verify_request
|
|
51
|
+
# @param [Hash] opts the optional parameters
|
|
52
|
+
# @return [MagicLinkVerifyResponse]
|
|
53
|
+
describe 'verify_magic_link test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
end
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Zyphr::AuthMFAApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'AuthMFAApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Zyphr::AuthMFAApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of AuthMFAApi' do
|
|
30
|
+
it 'should create an instance of AuthMFAApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Zyphr::AuthMFAApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for disable_mfa
|
|
36
|
+
# Disable MFA for a user
|
|
37
|
+
# Disables MFA for a user after verifying their identity with a TOTP code or backup code. Removes the TOTP secret and all backup codes.
|
|
38
|
+
# @param mfa_disable_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [MfaDisableResponse]
|
|
41
|
+
describe 'disable_mfa test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# unit tests for get_mfa_status
|
|
48
|
+
# Get MFA status for a user
|
|
49
|
+
# Returns the current MFA enrollment status for a user, including whether MFA is enabled, the enrollment status, when it was enabled, and the number of remaining backup codes.
|
|
50
|
+
# @param user_id The end user's ID
|
|
51
|
+
# @param [Hash] opts the optional parameters
|
|
52
|
+
# @return [MfaStatusResponse]
|
|
53
|
+
describe 'get_mfa_status test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# unit tests for regenerate_backup_codes
|
|
60
|
+
# Regenerate MFA backup codes
|
|
61
|
+
# Generates a new set of one-time backup codes for a user, invalidating all previous codes. Requires a valid TOTP code to authorize the regeneration.
|
|
62
|
+
# @param mfa_regenerate_backup_codes_request
|
|
63
|
+
# @param [Hash] opts the optional parameters
|
|
64
|
+
# @return [MfaBackupCodesResponse]
|
|
65
|
+
describe 'regenerate_backup_codes test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# unit tests for start_mfa_enrollment
|
|
72
|
+
# Start MFA enrollment
|
|
73
|
+
# Begins TOTP-based MFA enrollment for a user. Returns the TOTP secret, a QR code data URL for scanning with an authenticator app, and a set of one-time backup codes.
|
|
74
|
+
# @param mfa_enroll_request
|
|
75
|
+
# @param [Hash] opts the optional parameters
|
|
76
|
+
# @return [MfaEnrollmentResponse]
|
|
77
|
+
describe 'start_mfa_enrollment test' do
|
|
78
|
+
it 'should work' do
|
|
79
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# unit tests for verify_mfa_challenge
|
|
84
|
+
# Verify MFA challenge with TOTP code
|
|
85
|
+
# Verifies a TOTP code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data with access and refresh tokens.
|
|
86
|
+
# @param mfa_verify_request
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [AuthResultResponse]
|
|
89
|
+
describe 'verify_mfa_challenge test' do
|
|
90
|
+
it 'should work' do
|
|
91
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# unit tests for verify_mfa_challenge_with_backup_code
|
|
96
|
+
# Verify MFA challenge with backup code
|
|
97
|
+
# Verifies a one-time backup code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data, tokens, and the count of remaining backup codes.
|
|
98
|
+
# @param mfa_verify_backup_request
|
|
99
|
+
# @param [Hash] opts the optional parameters
|
|
100
|
+
# @return [MfaVerifyBackupResponse]
|
|
101
|
+
describe 'verify_mfa_challenge_with_backup_code test' do
|
|
102
|
+
it 'should work' do
|
|
103
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# unit tests for verify_mfa_enrollment
|
|
108
|
+
# Verify MFA enrollment
|
|
109
|
+
# Completes MFA enrollment by verifying a TOTP code from the user's authenticator app. On success, MFA is permanently enabled for the user.
|
|
110
|
+
# @param mfa_verify_enrollment_request
|
|
111
|
+
# @param [Hash] opts the optional parameters
|
|
112
|
+
# @return [MfaVerifyEnrollmentResponse]
|
|
113
|
+
describe 'verify_mfa_enrollment test' do
|
|
114
|
+
it 'should work' do
|
|
115
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
end
|