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
|
@@ -0,0 +1,226 @@
|
|
|
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 'cgi'
|
|
14
|
+
|
|
15
|
+
module Zyphr
|
|
16
|
+
class AuthPasswordResetApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Request a password reset
|
|
23
|
+
# Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
|
|
24
|
+
# @param forgot_password_request [ForgotPasswordRequest]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [SuccessResult]
|
|
27
|
+
def forgot_password(forgot_password_request, opts = {})
|
|
28
|
+
data, _status_code, _headers = forgot_password_with_http_info(forgot_password_request, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Request a password reset
|
|
33
|
+
# Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
|
|
34
|
+
# @param forgot_password_request [ForgotPasswordRequest]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
|
|
37
|
+
def forgot_password_with_http_info(forgot_password_request, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: AuthPasswordResetApi.forgot_password ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'forgot_password_request' is set
|
|
42
|
+
if @api_client.config.client_side_validation && forgot_password_request.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'forgot_password_request' when calling AuthPasswordResetApi.forgot_password"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/auth/forgot-password'
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
+
# HTTP header 'Content-Type'
|
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
57
|
+
if !content_type.nil?
|
|
58
|
+
header_params['Content-Type'] = content_type
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# form parameters
|
|
62
|
+
form_params = opts[:form_params] || {}
|
|
63
|
+
|
|
64
|
+
# http body (model)
|
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(forgot_password_request)
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type] || 'SuccessResult'
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"AuthPasswordResetApi.forgot_password",
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => return_type
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: AuthPasswordResetApi#forgot_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Reset password
|
|
91
|
+
# Reset a user's password using a valid reset token.
|
|
92
|
+
# @param reset_password_request [ResetPasswordRequest]
|
|
93
|
+
# @param [Hash] opts the optional parameters
|
|
94
|
+
# @return [ResetPasswordResponse]
|
|
95
|
+
def reset_end_user_password(reset_password_request, opts = {})
|
|
96
|
+
data, _status_code, _headers = reset_end_user_password_with_http_info(reset_password_request, opts)
|
|
97
|
+
data
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Reset password
|
|
101
|
+
# Reset a user's password using a valid reset token.
|
|
102
|
+
# @param reset_password_request [ResetPasswordRequest]
|
|
103
|
+
# @param [Hash] opts the optional parameters
|
|
104
|
+
# @return [Array<(ResetPasswordResponse, Integer, Hash)>] ResetPasswordResponse data, response status code and response headers
|
|
105
|
+
def reset_end_user_password_with_http_info(reset_password_request, opts = {})
|
|
106
|
+
if @api_client.config.debugging
|
|
107
|
+
@api_client.config.logger.debug 'Calling API: AuthPasswordResetApi.reset_end_user_password ...'
|
|
108
|
+
end
|
|
109
|
+
# verify the required parameter 'reset_password_request' is set
|
|
110
|
+
if @api_client.config.client_side_validation && reset_password_request.nil?
|
|
111
|
+
fail ArgumentError, "Missing the required parameter 'reset_password_request' when calling AuthPasswordResetApi.reset_end_user_password"
|
|
112
|
+
end
|
|
113
|
+
# resource path
|
|
114
|
+
local_var_path = '/auth/reset-password'
|
|
115
|
+
|
|
116
|
+
# query parameters
|
|
117
|
+
query_params = opts[:query_params] || {}
|
|
118
|
+
|
|
119
|
+
# header parameters
|
|
120
|
+
header_params = opts[:header_params] || {}
|
|
121
|
+
# HTTP header 'Accept' (if needed)
|
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
123
|
+
# HTTP header 'Content-Type'
|
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
125
|
+
if !content_type.nil?
|
|
126
|
+
header_params['Content-Type'] = content_type
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# form parameters
|
|
130
|
+
form_params = opts[:form_params] || {}
|
|
131
|
+
|
|
132
|
+
# http body (model)
|
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(reset_password_request)
|
|
134
|
+
|
|
135
|
+
# return_type
|
|
136
|
+
return_type = opts[:debug_return_type] || 'ResetPasswordResponse'
|
|
137
|
+
|
|
138
|
+
# auth_names
|
|
139
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
140
|
+
|
|
141
|
+
new_options = opts.merge(
|
|
142
|
+
:operation => :"AuthPasswordResetApi.reset_end_user_password",
|
|
143
|
+
:header_params => header_params,
|
|
144
|
+
:query_params => query_params,
|
|
145
|
+
:form_params => form_params,
|
|
146
|
+
:body => post_body,
|
|
147
|
+
:auth_names => auth_names,
|
|
148
|
+
:return_type => return_type
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
152
|
+
if @api_client.config.debugging
|
|
153
|
+
@api_client.config.logger.debug "API called: AuthPasswordResetApi#reset_end_user_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
+
end
|
|
155
|
+
return data, status_code, headers
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Validate a password reset token
|
|
159
|
+
# Validate a password reset token without consuming it. Useful for checking if a token is valid before showing the reset form.
|
|
160
|
+
# @param validate_reset_token_request [ValidateResetTokenRequest]
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @return [ValidateResetTokenResponse]
|
|
163
|
+
def validate_reset_token(validate_reset_token_request, opts = {})
|
|
164
|
+
data, _status_code, _headers = validate_reset_token_with_http_info(validate_reset_token_request, opts)
|
|
165
|
+
data
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Validate a password reset token
|
|
169
|
+
# Validate a password reset token without consuming it. Useful for checking if a token is valid before showing the reset form.
|
|
170
|
+
# @param validate_reset_token_request [ValidateResetTokenRequest]
|
|
171
|
+
# @param [Hash] opts the optional parameters
|
|
172
|
+
# @return [Array<(ValidateResetTokenResponse, Integer, Hash)>] ValidateResetTokenResponse data, response status code and response headers
|
|
173
|
+
def validate_reset_token_with_http_info(validate_reset_token_request, opts = {})
|
|
174
|
+
if @api_client.config.debugging
|
|
175
|
+
@api_client.config.logger.debug 'Calling API: AuthPasswordResetApi.validate_reset_token ...'
|
|
176
|
+
end
|
|
177
|
+
# verify the required parameter 'validate_reset_token_request' is set
|
|
178
|
+
if @api_client.config.client_side_validation && validate_reset_token_request.nil?
|
|
179
|
+
fail ArgumentError, "Missing the required parameter 'validate_reset_token_request' when calling AuthPasswordResetApi.validate_reset_token"
|
|
180
|
+
end
|
|
181
|
+
# resource path
|
|
182
|
+
local_var_path = '/auth/validate-reset-token'
|
|
183
|
+
|
|
184
|
+
# query parameters
|
|
185
|
+
query_params = opts[:query_params] || {}
|
|
186
|
+
|
|
187
|
+
# header parameters
|
|
188
|
+
header_params = opts[:header_params] || {}
|
|
189
|
+
# HTTP header 'Accept' (if needed)
|
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
191
|
+
# HTTP header 'Content-Type'
|
|
192
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
193
|
+
if !content_type.nil?
|
|
194
|
+
header_params['Content-Type'] = content_type
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
# form parameters
|
|
198
|
+
form_params = opts[:form_params] || {}
|
|
199
|
+
|
|
200
|
+
# http body (model)
|
|
201
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(validate_reset_token_request)
|
|
202
|
+
|
|
203
|
+
# return_type
|
|
204
|
+
return_type = opts[:debug_return_type] || 'ValidateResetTokenResponse'
|
|
205
|
+
|
|
206
|
+
# auth_names
|
|
207
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
208
|
+
|
|
209
|
+
new_options = opts.merge(
|
|
210
|
+
:operation => :"AuthPasswordResetApi.validate_reset_token",
|
|
211
|
+
:header_params => header_params,
|
|
212
|
+
:query_params => query_params,
|
|
213
|
+
:form_params => form_params,
|
|
214
|
+
:body => post_body,
|
|
215
|
+
:auth_names => auth_names,
|
|
216
|
+
:return_type => return_type
|
|
217
|
+
)
|
|
218
|
+
|
|
219
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
220
|
+
if @api_client.config.debugging
|
|
221
|
+
@api_client.config.logger.debug "API called: AuthPasswordResetApi#validate_reset_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
222
|
+
end
|
|
223
|
+
return data, status_code, headers
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
end
|
|
@@ -0,0 +1,351 @@
|
|
|
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 'cgi'
|
|
14
|
+
|
|
15
|
+
module Zyphr
|
|
16
|
+
class AuthPhoneApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Check phone auth availability
|
|
23
|
+
# Check if phone authentication is available for this application. Requires Twilio credentials to be configured.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [PhoneAuthAvailabilityResponse]
|
|
26
|
+
def check_phone_auth_availability(opts = {})
|
|
27
|
+
data, _status_code, _headers = check_phone_auth_availability_with_http_info(opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Check phone auth availability
|
|
32
|
+
# Check if phone authentication is available for this application. Requires Twilio credentials to be configured.
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(PhoneAuthAvailabilityResponse, Integer, Hash)>] PhoneAuthAvailabilityResponse data, response status code and response headers
|
|
35
|
+
def check_phone_auth_availability_with_http_info(opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: AuthPhoneApi.check_phone_auth_availability ...'
|
|
38
|
+
end
|
|
39
|
+
# resource path
|
|
40
|
+
local_var_path = '/auth/phone/available'
|
|
41
|
+
|
|
42
|
+
# query parameters
|
|
43
|
+
query_params = opts[:query_params] || {}
|
|
44
|
+
|
|
45
|
+
# header parameters
|
|
46
|
+
header_params = opts[:header_params] || {}
|
|
47
|
+
# HTTP header 'Accept' (if needed)
|
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
49
|
+
|
|
50
|
+
# form parameters
|
|
51
|
+
form_params = opts[:form_params] || {}
|
|
52
|
+
|
|
53
|
+
# http body (model)
|
|
54
|
+
post_body = opts[:debug_body]
|
|
55
|
+
|
|
56
|
+
# return_type
|
|
57
|
+
return_type = opts[:debug_return_type] || 'PhoneAuthAvailabilityResponse'
|
|
58
|
+
|
|
59
|
+
# auth_names
|
|
60
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationPublicKey']
|
|
61
|
+
|
|
62
|
+
new_options = opts.merge(
|
|
63
|
+
:operation => :"AuthPhoneApi.check_phone_auth_availability",
|
|
64
|
+
:header_params => header_params,
|
|
65
|
+
:query_params => query_params,
|
|
66
|
+
:form_params => form_params,
|
|
67
|
+
:body => post_body,
|
|
68
|
+
:auth_names => auth_names,
|
|
69
|
+
:return_type => return_type
|
|
70
|
+
)
|
|
71
|
+
|
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
73
|
+
if @api_client.config.debugging
|
|
74
|
+
@api_client.config.logger.debug "API called: AuthPhoneApi#check_phone_auth_availability\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
|
+
end
|
|
76
|
+
return data, status_code, headers
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Send phone login OTP
|
|
80
|
+
# Send an OTP to a phone number for an existing user login.
|
|
81
|
+
# @param phone_otp_send_request [PhoneOtpSendRequest]
|
|
82
|
+
# @param [Hash] opts the optional parameters
|
|
83
|
+
# @return [PhoneOtpSentResponse]
|
|
84
|
+
def send_phone_login_otp(phone_otp_send_request, opts = {})
|
|
85
|
+
data, _status_code, _headers = send_phone_login_otp_with_http_info(phone_otp_send_request, opts)
|
|
86
|
+
data
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Send phone login OTP
|
|
90
|
+
# Send an OTP to a phone number for an existing user login.
|
|
91
|
+
# @param phone_otp_send_request [PhoneOtpSendRequest]
|
|
92
|
+
# @param [Hash] opts the optional parameters
|
|
93
|
+
# @return [Array<(PhoneOtpSentResponse, Integer, Hash)>] PhoneOtpSentResponse data, response status code and response headers
|
|
94
|
+
def send_phone_login_otp_with_http_info(phone_otp_send_request, opts = {})
|
|
95
|
+
if @api_client.config.debugging
|
|
96
|
+
@api_client.config.logger.debug 'Calling API: AuthPhoneApi.send_phone_login_otp ...'
|
|
97
|
+
end
|
|
98
|
+
# verify the required parameter 'phone_otp_send_request' is set
|
|
99
|
+
if @api_client.config.client_side_validation && phone_otp_send_request.nil?
|
|
100
|
+
fail ArgumentError, "Missing the required parameter 'phone_otp_send_request' when calling AuthPhoneApi.send_phone_login_otp"
|
|
101
|
+
end
|
|
102
|
+
# resource path
|
|
103
|
+
local_var_path = '/auth/phone/login/send'
|
|
104
|
+
|
|
105
|
+
# query parameters
|
|
106
|
+
query_params = opts[:query_params] || {}
|
|
107
|
+
|
|
108
|
+
# header parameters
|
|
109
|
+
header_params = opts[:header_params] || {}
|
|
110
|
+
# HTTP header 'Accept' (if needed)
|
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
112
|
+
# HTTP header 'Content-Type'
|
|
113
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
114
|
+
if !content_type.nil?
|
|
115
|
+
header_params['Content-Type'] = content_type
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# form parameters
|
|
119
|
+
form_params = opts[:form_params] || {}
|
|
120
|
+
|
|
121
|
+
# http body (model)
|
|
122
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_otp_send_request)
|
|
123
|
+
|
|
124
|
+
# return_type
|
|
125
|
+
return_type = opts[:debug_return_type] || 'PhoneOtpSentResponse'
|
|
126
|
+
|
|
127
|
+
# auth_names
|
|
128
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
129
|
+
|
|
130
|
+
new_options = opts.merge(
|
|
131
|
+
:operation => :"AuthPhoneApi.send_phone_login_otp",
|
|
132
|
+
:header_params => header_params,
|
|
133
|
+
:query_params => query_params,
|
|
134
|
+
:form_params => form_params,
|
|
135
|
+
:body => post_body,
|
|
136
|
+
:auth_names => auth_names,
|
|
137
|
+
:return_type => return_type
|
|
138
|
+
)
|
|
139
|
+
|
|
140
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
141
|
+
if @api_client.config.debugging
|
|
142
|
+
@api_client.config.logger.debug "API called: AuthPhoneApi#send_phone_login_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
143
|
+
end
|
|
144
|
+
return data, status_code, headers
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Send phone registration OTP
|
|
148
|
+
# Send an OTP to a phone number for new user registration.
|
|
149
|
+
# @param phone_otp_send_request [PhoneOtpSendRequest]
|
|
150
|
+
# @param [Hash] opts the optional parameters
|
|
151
|
+
# @return [PhoneOtpSentResponse]
|
|
152
|
+
def send_phone_registration_otp(phone_otp_send_request, opts = {})
|
|
153
|
+
data, _status_code, _headers = send_phone_registration_otp_with_http_info(phone_otp_send_request, opts)
|
|
154
|
+
data
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# Send phone registration OTP
|
|
158
|
+
# Send an OTP to a phone number for new user registration.
|
|
159
|
+
# @param phone_otp_send_request [PhoneOtpSendRequest]
|
|
160
|
+
# @param [Hash] opts the optional parameters
|
|
161
|
+
# @return [Array<(PhoneOtpSentResponse, Integer, Hash)>] PhoneOtpSentResponse data, response status code and response headers
|
|
162
|
+
def send_phone_registration_otp_with_http_info(phone_otp_send_request, opts = {})
|
|
163
|
+
if @api_client.config.debugging
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: AuthPhoneApi.send_phone_registration_otp ...'
|
|
165
|
+
end
|
|
166
|
+
# verify the required parameter 'phone_otp_send_request' is set
|
|
167
|
+
if @api_client.config.client_side_validation && phone_otp_send_request.nil?
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'phone_otp_send_request' when calling AuthPhoneApi.send_phone_registration_otp"
|
|
169
|
+
end
|
|
170
|
+
# resource path
|
|
171
|
+
local_var_path = '/auth/phone/register/send'
|
|
172
|
+
|
|
173
|
+
# query parameters
|
|
174
|
+
query_params = opts[:query_params] || {}
|
|
175
|
+
|
|
176
|
+
# header parameters
|
|
177
|
+
header_params = opts[:header_params] || {}
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
180
|
+
# HTTP header 'Content-Type'
|
|
181
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
182
|
+
if !content_type.nil?
|
|
183
|
+
header_params['Content-Type'] = content_type
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# form parameters
|
|
187
|
+
form_params = opts[:form_params] || {}
|
|
188
|
+
|
|
189
|
+
# http body (model)
|
|
190
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_otp_send_request)
|
|
191
|
+
|
|
192
|
+
# return_type
|
|
193
|
+
return_type = opts[:debug_return_type] || 'PhoneOtpSentResponse'
|
|
194
|
+
|
|
195
|
+
# auth_names
|
|
196
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
197
|
+
|
|
198
|
+
new_options = opts.merge(
|
|
199
|
+
:operation => :"AuthPhoneApi.send_phone_registration_otp",
|
|
200
|
+
:header_params => header_params,
|
|
201
|
+
:query_params => query_params,
|
|
202
|
+
:form_params => form_params,
|
|
203
|
+
:body => post_body,
|
|
204
|
+
:auth_names => auth_names,
|
|
205
|
+
:return_type => return_type
|
|
206
|
+
)
|
|
207
|
+
|
|
208
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
209
|
+
if @api_client.config.debugging
|
|
210
|
+
@api_client.config.logger.debug "API called: AuthPhoneApi#send_phone_registration_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
211
|
+
end
|
|
212
|
+
return data, status_code, headers
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# Verify phone login OTP
|
|
216
|
+
# Verify the OTP and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
|
|
217
|
+
# @param phone_login_verify_request [PhoneLoginVerifyRequest]
|
|
218
|
+
# @param [Hash] opts the optional parameters
|
|
219
|
+
# @return [AuthLoginResponse]
|
|
220
|
+
def verify_phone_login(phone_login_verify_request, opts = {})
|
|
221
|
+
data, _status_code, _headers = verify_phone_login_with_http_info(phone_login_verify_request, opts)
|
|
222
|
+
data
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Verify phone login OTP
|
|
226
|
+
# Verify the OTP and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
|
|
227
|
+
# @param phone_login_verify_request [PhoneLoginVerifyRequest]
|
|
228
|
+
# @param [Hash] opts the optional parameters
|
|
229
|
+
# @return [Array<(AuthLoginResponse, Integer, Hash)>] AuthLoginResponse data, response status code and response headers
|
|
230
|
+
def verify_phone_login_with_http_info(phone_login_verify_request, opts = {})
|
|
231
|
+
if @api_client.config.debugging
|
|
232
|
+
@api_client.config.logger.debug 'Calling API: AuthPhoneApi.verify_phone_login ...'
|
|
233
|
+
end
|
|
234
|
+
# verify the required parameter 'phone_login_verify_request' is set
|
|
235
|
+
if @api_client.config.client_side_validation && phone_login_verify_request.nil?
|
|
236
|
+
fail ArgumentError, "Missing the required parameter 'phone_login_verify_request' when calling AuthPhoneApi.verify_phone_login"
|
|
237
|
+
end
|
|
238
|
+
# resource path
|
|
239
|
+
local_var_path = '/auth/phone/login/verify'
|
|
240
|
+
|
|
241
|
+
# query parameters
|
|
242
|
+
query_params = opts[:query_params] || {}
|
|
243
|
+
|
|
244
|
+
# header parameters
|
|
245
|
+
header_params = opts[:header_params] || {}
|
|
246
|
+
# HTTP header 'Accept' (if needed)
|
|
247
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
248
|
+
# HTTP header 'Content-Type'
|
|
249
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
250
|
+
if !content_type.nil?
|
|
251
|
+
header_params['Content-Type'] = content_type
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# form parameters
|
|
255
|
+
form_params = opts[:form_params] || {}
|
|
256
|
+
|
|
257
|
+
# http body (model)
|
|
258
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_login_verify_request)
|
|
259
|
+
|
|
260
|
+
# return_type
|
|
261
|
+
return_type = opts[:debug_return_type] || 'AuthLoginResponse'
|
|
262
|
+
|
|
263
|
+
# auth_names
|
|
264
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
265
|
+
|
|
266
|
+
new_options = opts.merge(
|
|
267
|
+
:operation => :"AuthPhoneApi.verify_phone_login",
|
|
268
|
+
:header_params => header_params,
|
|
269
|
+
:query_params => query_params,
|
|
270
|
+
:form_params => form_params,
|
|
271
|
+
:body => post_body,
|
|
272
|
+
:auth_names => auth_names,
|
|
273
|
+
:return_type => return_type
|
|
274
|
+
)
|
|
275
|
+
|
|
276
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
277
|
+
if @api_client.config.debugging
|
|
278
|
+
@api_client.config.logger.debug "API called: AuthPhoneApi#verify_phone_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
279
|
+
end
|
|
280
|
+
return data, status_code, headers
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
# Verify phone registration OTP
|
|
284
|
+
# Verify the OTP and create a new user account with the phone number.
|
|
285
|
+
# @param phone_register_verify_request [PhoneRegisterVerifyRequest]
|
|
286
|
+
# @param [Hash] opts the optional parameters
|
|
287
|
+
# @return [AuthResultResponse]
|
|
288
|
+
def verify_phone_registration(phone_register_verify_request, opts = {})
|
|
289
|
+
data, _status_code, _headers = verify_phone_registration_with_http_info(phone_register_verify_request, opts)
|
|
290
|
+
data
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
# Verify phone registration OTP
|
|
294
|
+
# Verify the OTP and create a new user account with the phone number.
|
|
295
|
+
# @param phone_register_verify_request [PhoneRegisterVerifyRequest]
|
|
296
|
+
# @param [Hash] opts the optional parameters
|
|
297
|
+
# @return [Array<(AuthResultResponse, Integer, Hash)>] AuthResultResponse data, response status code and response headers
|
|
298
|
+
def verify_phone_registration_with_http_info(phone_register_verify_request, opts = {})
|
|
299
|
+
if @api_client.config.debugging
|
|
300
|
+
@api_client.config.logger.debug 'Calling API: AuthPhoneApi.verify_phone_registration ...'
|
|
301
|
+
end
|
|
302
|
+
# verify the required parameter 'phone_register_verify_request' is set
|
|
303
|
+
if @api_client.config.client_side_validation && phone_register_verify_request.nil?
|
|
304
|
+
fail ArgumentError, "Missing the required parameter 'phone_register_verify_request' when calling AuthPhoneApi.verify_phone_registration"
|
|
305
|
+
end
|
|
306
|
+
# resource path
|
|
307
|
+
local_var_path = '/auth/phone/register/verify'
|
|
308
|
+
|
|
309
|
+
# query parameters
|
|
310
|
+
query_params = opts[:query_params] || {}
|
|
311
|
+
|
|
312
|
+
# header parameters
|
|
313
|
+
header_params = opts[:header_params] || {}
|
|
314
|
+
# HTTP header 'Accept' (if needed)
|
|
315
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
316
|
+
# HTTP header 'Content-Type'
|
|
317
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
318
|
+
if !content_type.nil?
|
|
319
|
+
header_params['Content-Type'] = content_type
|
|
320
|
+
end
|
|
321
|
+
|
|
322
|
+
# form parameters
|
|
323
|
+
form_params = opts[:form_params] || {}
|
|
324
|
+
|
|
325
|
+
# http body (model)
|
|
326
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_register_verify_request)
|
|
327
|
+
|
|
328
|
+
# return_type
|
|
329
|
+
return_type = opts[:debug_return_type] || 'AuthResultResponse'
|
|
330
|
+
|
|
331
|
+
# auth_names
|
|
332
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
333
|
+
|
|
334
|
+
new_options = opts.merge(
|
|
335
|
+
:operation => :"AuthPhoneApi.verify_phone_registration",
|
|
336
|
+
:header_params => header_params,
|
|
337
|
+
:query_params => query_params,
|
|
338
|
+
:form_params => form_params,
|
|
339
|
+
:body => post_body,
|
|
340
|
+
:auth_names => auth_names,
|
|
341
|
+
:return_type => return_type
|
|
342
|
+
)
|
|
343
|
+
|
|
344
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
345
|
+
if @api_client.config.debugging
|
|
346
|
+
@api_client.config.logger.debug "API called: AuthPhoneApi#verify_phone_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
347
|
+
end
|
|
348
|
+
return data, status_code, headers
|
|
349
|
+
end
|
|
350
|
+
end
|
|
351
|
+
end
|
|
@@ -0,0 +1,90 @@
|
|
|
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 'cgi'
|
|
14
|
+
|
|
15
|
+
module Zyphr
|
|
16
|
+
class AuthRegistrationApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Register a new end user
|
|
23
|
+
# Register a new end user with email and password.
|
|
24
|
+
# @param register_request [RegisterRequest]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [AuthResultResponse]
|
|
27
|
+
def register_end_user(register_request, opts = {})
|
|
28
|
+
data, _status_code, _headers = register_end_user_with_http_info(register_request, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Register a new end user
|
|
33
|
+
# Register a new end user with email and password.
|
|
34
|
+
# @param register_request [RegisterRequest]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(AuthResultResponse, Integer, Hash)>] AuthResultResponse data, response status code and response headers
|
|
37
|
+
def register_end_user_with_http_info(register_request, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: AuthRegistrationApi.register_end_user ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'register_request' is set
|
|
42
|
+
if @api_client.config.client_side_validation && register_request.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'register_request' when calling AuthRegistrationApi.register_end_user"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/auth/users/register'
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
+
# HTTP header 'Content-Type'
|
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
57
|
+
if !content_type.nil?
|
|
58
|
+
header_params['Content-Type'] = content_type
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# form parameters
|
|
62
|
+
form_params = opts[:form_params] || {}
|
|
63
|
+
|
|
64
|
+
# http body (model)
|
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(register_request)
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type] || 'AuthResultResponse'
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"AuthRegistrationApi.register_end_user",
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => return_type
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: AuthRegistrationApi#register_end_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|