@zyphr-dev/node-sdk 0.1.36 → 0.1.38
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.
- package/README.md +39 -0
- package/dist/index.cjs +773 -47
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1193 -522
- package/dist/index.d.ts +1193 -522
- package/dist/index.js +737 -47
- package/dist/index.js.map +1 -1
- package/package.json +8 -3
- package/src/.openapi-generator/FILES +7 -0
- package/src/clientAuth.ts +182 -0
- package/src/errors.ts +29 -16
- package/src/index.ts +4 -1
- package/src/src/apis/AuthEmailOTPApi.ts +1 -1
- package/src/src/apis/AuthEmailTemplatesApi.ts +1 -1
- package/src/src/apis/AuthEmailVerificationApi.ts +1 -1
- package/src/src/apis/AuthLoginApi.ts +1 -1
- package/src/src/apis/AuthMFAApi.ts +1 -1
- package/src/src/apis/AuthMagicLinksApi.ts +1 -1
- package/src/src/apis/AuthOAuthApi.ts +28 -25
- package/src/src/apis/AuthOrganizationsApi.ts +1 -1
- package/src/src/apis/AuthPasswordResetApi.ts +1 -1
- package/src/src/apis/AuthPhoneApi.ts +1 -1
- package/src/src/apis/AuthRegistrationApi.ts +70 -5
- package/src/src/apis/AuthSessionsApi.ts +1 -1
- package/src/src/apis/AuthUserDirectoryApi.ts +596 -0
- package/src/src/apis/AuthUserProfileApi.ts +1 -63
- package/src/src/apis/AuthWebAuthnApi.ts +1 -1
- package/src/src/apis/DevicesApi.ts +1 -1
- package/src/src/apis/DomainsApi.ts +1 -1
- package/src/src/apis/EmailsApi.ts +1 -1
- package/src/src/apis/ExecutionsApi.ts +1 -1
- package/src/src/apis/InboundEmailApi.ts +1 -1
- package/src/src/apis/InboxApi.ts +1 -1
- package/src/src/apis/MuseApi.ts +1 -1
- package/src/src/apis/PushApi.ts +1 -1
- package/src/src/apis/SMSApi.ts +1 -1
- package/src/src/apis/SlackApi.ts +1 -1
- package/src/src/apis/SubscribersApi.ts +1 -1
- package/src/src/apis/TemplatesApi.ts +78 -1
- package/src/src/apis/TopicsApi.ts +1 -1
- package/src/src/apis/UtilityApi.ts +1 -1
- package/src/src/apis/WaaSApplicationsApi.ts +1 -1
- package/src/src/apis/WaaSDeliveriesApi.ts +1 -1
- package/src/src/apis/WaaSEndpointsApi.ts +1 -1
- package/src/src/apis/WaaSEventTypesApi.ts +1 -1
- package/src/src/apis/WaaSEventsApi.ts +1 -1
- package/src/src/apis/WaaSPortalApi.ts +1 -1
- package/src/src/apis/WebhooksApi.ts +1 -1
- package/src/src/apis/index.ts +1 -0
- package/src/src/models/AddDomain200Response.ts +1 -1
- package/src/src/models/AddDomain200ResponseMeta.ts +1 -1
- package/src/src/models/AddDomainRequest.ts +1 -1
- package/src/src/models/AddOrganizationMemberRequest.ts +1 -1
- package/src/src/models/AddTopicSubscribersRequest.ts +1 -1
- package/src/src/models/ApiError.ts +1 -1
- package/src/src/models/ApiErrorError.ts +1 -1
- package/src/src/models/ApiErrorMeta.ts +1 -1
- package/src/src/models/AuthEmailTemplate.ts +1 -1
- package/src/src/models/AuthEmailTemplateDefault.ts +1 -1
- package/src/src/models/AuthEmailTemplateDefaultResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplateDeleteResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplateDeleteResponseData.ts +1 -1
- package/src/src/models/AuthEmailTemplateListResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplatePreviewDraft.ts +1 -1
- package/src/src/models/AuthEmailTemplatePreviewRequest.ts +1 -1
- package/src/src/models/AuthEmailTemplatePreviewResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplatePreviewResult.ts +1 -1
- package/src/src/models/AuthEmailTemplateResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplateTestRequest.ts +1 -1
- package/src/src/models/AuthEmailTemplateTestResponse.ts +1 -1
- package/src/src/models/AuthEmailTemplateTestResult.ts +1 -1
- package/src/src/models/AuthEmailTemplateVersion.ts +1 -1
- package/src/src/models/AuthEmailTemplateVersionsResponse.ts +1 -1
- package/src/src/models/AuthEmailType.ts +1 -1
- package/src/src/models/AuthLoginResponse.ts +1 -1
- package/src/src/models/AuthLoginResult.ts +1 -1
- package/src/src/models/AuthLoginResultMfaChallenge.ts +1 -1
- package/src/src/models/AuthResult.ts +1 -1
- package/src/src/models/AuthResultResponse.ts +1 -1
- package/src/src/models/AuthSession.ts +1 -1
- package/src/src/models/AuthTokens.ts +1 -1
- package/src/src/models/AuthUser.ts +1 -1
- package/src/src/models/AuthUserResponse.ts +1 -1
- package/src/src/models/AuthUserResponseData.ts +1 -1
- package/src/src/models/BatchPublishWaaSEvents201Response.ts +1 -1
- package/src/src/models/BatchRecipient.ts +1 -1
- package/src/src/models/BulkRetryWebhookDeliveriesRequest.ts +1 -1
- package/src/src/models/BulkUpsertAuthEmailTemplatesRequest.ts +1 -1
- package/src/src/models/BulkUpsertAuthEmailTemplatesResponse.ts +1 -1
- package/src/src/models/Category.ts +1 -1
- package/src/src/models/CategoryListResponse.ts +1 -1
- package/src/src/models/CategoryResponse.ts +1 -1
- package/src/src/models/ConfirmEmailVerificationRequest.ts +1 -1
- package/src/src/models/ConfirmEmailVerificationResponse.ts +1 -1
- package/src/src/models/ConfirmEmailVerificationResponseData.ts +1 -1
- package/src/src/models/ConsentHistoryEntry.ts +1 -1
- package/src/src/models/ConsentHistoryResponse.ts +1 -1
- package/src/src/models/ConsentRecordResponse.ts +1 -1
- package/src/src/models/ConsentRecordResponseData.ts +1 -1
- package/src/src/models/ConsentStatus.ts +1 -1
- package/src/src/models/ConsentStatusResponse.ts +1 -1
- package/src/src/models/ConsentWithdrawResponse.ts +1 -1
- package/src/src/models/ConvertAnonymousUserRequest.ts +1 -1
- package/src/src/models/ConvertAnonymousUserRequestOneOf.ts +1 -1
- package/src/src/models/ConvertAnonymousUserRequestOneOf1.ts +1 -1
- package/src/src/models/ConvertAnonymousUserRequestOneOf1AppleUser.ts +1 -1
- package/src/src/models/ConvertAnonymousUserRequestOneOf1AppleUserName.ts +1 -1
- package/src/src/models/CreateCategoryRequest.ts +1 -1
- package/src/src/models/CreateOrganizationRequest.ts +1 -1
- package/src/src/models/CreateSubscriberRequest.ts +1 -1
- package/src/src/models/CreateTemplateRequest.ts +1 -1
- package/src/src/models/CreateTopicRequest.ts +1 -1
- package/src/src/models/CreateWaaSApplication201Response.ts +1 -1
- package/src/src/models/CreateWaaSApplicationRequest.ts +1 -1
- package/src/src/models/CreateWaaSEndpoint201Response.ts +1 -1
- package/src/src/models/CreateWaaSEndpointRequest.ts +1 -1
- package/src/src/models/CreateWaaSEndpointResponse.ts +1 -1
- package/src/src/models/CreateWaaSEventType201Response.ts +1 -1
- package/src/src/models/CreateWaaSEventTypeRequest.ts +1 -1
- package/src/src/models/CreateWebhookRequest.ts +1 -1
- package/src/src/models/DeleteDomainResponse.ts +1 -1
- package/src/src/models/DeleteDomainResponseData.ts +1 -1
- package/src/src/models/DeleteResult.ts +1 -1
- package/src/src/models/DeleteResultData.ts +1 -1
- package/src/src/models/Device.ts +1 -1
- package/src/src/models/DeviceListResponse.ts +1 -1
- package/src/src/models/DevicePushTopic.ts +1 -1
- package/src/src/models/DevicePushTopicListResponse.ts +1 -1
- package/src/src/models/DevicePushTopicListResponseMeta.ts +1 -1
- package/src/src/models/DeviceResponse.ts +1 -1
- package/src/src/models/DeviceStats.ts +1 -1
- package/src/src/models/DeviceStatsResponse.ts +1 -1
- package/src/src/models/DnsRecord.ts +1 -1
- package/src/src/models/DomainListResponse.ts +1 -1
- package/src/src/models/DomainListResponseMeta.ts +1 -1
- package/src/src/models/DomainResponse.ts +1 -1
- package/src/src/models/EmailAddress.ts +1 -1
- package/src/src/models/EmailAttachment.ts +1 -1
- package/src/src/models/EmailEvent.ts +1 -1
- package/src/src/models/EmailEventsResponse.ts +1 -1
- package/src/src/models/EmailListResponse.ts +1 -1
- package/src/src/models/EmailMessage.ts +1 -1
- package/src/src/models/EmailResponse.ts +1 -1
- package/src/src/models/EmailTrackingClickLink.ts +1 -1
- package/src/src/models/EmailTrackingClicks.ts +1 -1
- package/src/src/models/EmailTrackingData.ts +1 -1
- package/src/src/models/EmailTrackingOpens.ts +1 -1
- package/src/src/models/EmailTrackingResponse.ts +1 -1
- package/src/src/models/EndUserDeleteResponse.ts +1 -1
- package/src/src/models/EndUserDeleteResponseData.ts +1 -1
- package/src/src/models/ExecutionCancelResponse.ts +1 -1
- package/src/src/models/ExecutionCancelResponseData.ts +1 -1
- package/src/src/models/ExecutionResponse.ts +1 -1
- package/src/src/models/ExecutionRetryResponse.ts +1 -1
- package/src/src/models/ExecutionRetryResponseData.ts +1 -1
- package/src/src/models/ForgotPasswordRequest.ts +1 -1
- package/src/src/models/GenerateSubscriberToken200Response.ts +1 -1
- package/src/src/models/GenerateSubscriberToken200ResponseData.ts +1 -1
- package/src/src/models/GenerateSubscriberTokenRequest.ts +1 -1
- package/src/src/models/GenerateWaaSPortalToken201Response.ts +1 -1
- package/src/src/models/GetDomain200Response.ts +1 -1
- package/src/src/models/GetDomain200ResponseMeta.ts +1 -1
- package/src/src/models/GetWaaSEndpoint200Response.ts +1 -1
- package/src/src/models/GetWaaSUsage200Response.ts +1 -1
- package/src/src/models/InAppNotification.ts +1 -1
- package/src/src/models/InboundAttachmentUrlResponse.ts +1 -1
- package/src/src/models/InboundAttachmentUrlResponseData.ts +1 -1
- package/src/src/models/InboundEmail.ts +1 -1
- package/src/src/models/InboundEmailAttachment.ts +1 -1
- package/src/src/models/InboundEmailFrom.ts +1 -1
- package/src/src/models/InboundEmailListResponse.ts +1 -1
- package/src/src/models/InboundEmailListResponseMeta.ts +1 -1
- package/src/src/models/InboundEmailResponse.ts +1 -1
- package/src/src/models/InboxListMeta.ts +1 -1
- package/src/src/models/InboxListResponse.ts +1 -1
- package/src/src/models/InboxNotificationResponse.ts +1 -1
- package/src/src/models/InviteEndUserRequest.ts +110 -0
- package/src/src/models/ListWaaSApplications200Response.ts +1 -1
- package/src/src/models/ListWaaSEndpointDeliveries200Response.ts +1 -1
- package/src/src/models/ListWaaSEndpoints200Response.ts +1 -1
- package/src/src/models/ListWaaSEventTypes200Response.ts +1 -1
- package/src/src/models/LoginRequest.ts +1 -1
- package/src/src/models/MagicLinkSendRequest.ts +1 -1
- package/src/src/models/MagicLinkVerifyRequest.ts +1 -1
- package/src/src/models/MagicLinkVerifyResponse.ts +1 -1
- package/src/src/models/MagicLinkVerifyResponseData.ts +1 -1
- package/src/src/models/MarkAllInboxReadRequest.ts +1 -1
- package/src/src/models/MarkAllReadData.ts +1 -1
- package/src/src/models/MarkAllReadResponse.ts +1 -1
- package/src/src/models/MarkAllSubscriberNotificationsReadRequest.ts +1 -1
- package/src/src/models/MarkInboxReadRequest.ts +1 -1
- package/src/src/models/MfaBackupCodesResponse.ts +1 -1
- package/src/src/models/MfaBackupCodesResponseData.ts +1 -1
- package/src/src/models/MfaDisableRequest.ts +1 -1
- package/src/src/models/MfaDisableResponse.ts +1 -1
- package/src/src/models/MfaDisableResponseData.ts +1 -1
- package/src/src/models/MfaEnrollRequest.ts +1 -1
- package/src/src/models/MfaEnrollmentResponse.ts +1 -1
- package/src/src/models/MfaEnrollmentResponseData.ts +1 -1
- package/src/src/models/MfaRegenerateBackupCodesRequest.ts +1 -1
- package/src/src/models/MfaStatusResponse.ts +1 -1
- package/src/src/models/MfaStatusResponseData.ts +1 -1
- package/src/src/models/MfaVerifyBackupRequest.ts +1 -1
- package/src/src/models/MfaVerifyBackupResponse.ts +1 -1
- package/src/src/models/MfaVerifyBackupResponseData.ts +1 -1
- package/src/src/models/MfaVerifyEnrollmentRequest.ts +1 -1
- package/src/src/models/MfaVerifyEnrollmentResponse.ts +1 -1
- package/src/src/models/MfaVerifyEnrollmentResponseData.ts +1 -1
- package/src/src/models/MfaVerifyRequest.ts +1 -1
- package/src/src/models/OAuthAuthorizationUrlResponse.ts +1 -1
- package/src/src/models/OAuthAuthorizationUrlResponseData.ts +1 -1
- package/src/src/models/OAuthCallbackRequest.ts +1 -1
- package/src/src/models/OAuthCallbackResponse.ts +1 -1
- package/src/src/models/OAuthCallbackResponseData.ts +1 -1
- package/src/src/models/OAuthConnection.ts +1 -1
- package/src/src/models/OAuthConnectionInfoResponse.ts +1 -1
- package/src/src/models/OAuthConnectionInfoResponseData.ts +1 -1
- package/src/src/models/OAuthConnectionsResponse.ts +1 -1
- package/src/src/models/OAuthConnectionsResponseData.ts +1 -1
- package/src/src/models/OAuthProvider.ts +1 -1
- package/src/src/models/OAuthProviderInfo.ts +1 -1
- package/src/src/models/OAuthProviderName.ts +56 -0
- package/src/src/models/OAuthProvidersResponse.ts +1 -1
- package/src/src/models/OAuthProvidersResponseData.ts +1 -1
- package/src/src/models/OAuthTokensRefreshResponse.ts +1 -1
- package/src/src/models/OAuthTokensRefreshResponseData.ts +1 -1
- package/src/src/models/OAuthTokensResponse.ts +1 -1
- package/src/src/models/OAuthTokensResponseData.ts +1 -1
- package/src/src/models/Organization.ts +1 -1
- package/src/src/models/OrganizationListResponse.ts +1 -1
- package/src/src/models/OrganizationListResponseMeta.ts +1 -1
- package/src/src/models/OrganizationMembersListResponse.ts +1 -1
- package/src/src/models/OrganizationMembership.ts +1 -1
- package/src/src/models/OrganizationMembershipResponse.ts +1 -1
- package/src/src/models/OrganizationMembershipWithUser.ts +1 -1
- package/src/src/models/OrganizationResponse.ts +1 -1
- package/src/src/models/PaginationMeta.ts +1 -1
- package/src/src/models/PasswordRequirements.ts +1 -1
- package/src/src/models/PasswordRequirementsResponse.ts +1 -1
- package/src/src/models/PasswordRequirementsResponseData.ts +1 -1
- package/src/src/models/PayloadTooLargeError.ts +1 -1
- package/src/src/models/PayloadTooLargeErrorError.ts +1 -1
- package/src/src/models/PayloadTooLargeErrorErrorDetails.ts +1 -1
- package/src/src/models/PhoneAuthAvailabilityResponse.ts +1 -1
- package/src/src/models/PhoneAuthAvailabilityResponseData.ts +1 -1
- package/src/src/models/PhoneLoginVerifyRequest.ts +1 -1
- package/src/src/models/PhoneOtpSendRequest.ts +1 -1
- package/src/src/models/PhoneOtpSentResponse.ts +1 -1
- package/src/src/models/PhoneOtpSentResponseData.ts +1 -1
- package/src/src/models/PhoneRegisterVerifyRequest.ts +1 -1
- package/src/src/models/PreferenceListResponse.ts +1 -1
- package/src/src/models/PublishWaaSEvent201Response.ts +1 -1
- package/src/src/models/PushDetailResponse.ts +1 -1
- package/src/src/models/PushEvent.ts +1 -1
- package/src/src/models/PushListResponse.ts +1 -1
- package/src/src/models/PushMessage.ts +1 -1
- package/src/src/models/PushMessageDetail.ts +1 -1
- package/src/src/models/PushMessageDetailAllOfActionButtons.ts +1 -1
- package/src/src/models/PushStatsData.ts +1 -1
- package/src/src/models/PushStatsResponse.ts +1 -1
- package/src/src/models/PushTopicDevice.ts +1 -1
- package/src/src/models/PushTopicDeviceListResponse.ts +1 -1
- package/src/src/models/PushTopicSubscribeData.ts +1 -1
- package/src/src/models/PushTopicSubscribeResponse.ts +1 -1
- package/src/src/models/PushTopicUnsubscribeData.ts +1 -1
- package/src/src/models/PushTopicUnsubscribeResponse.ts +1 -1
- package/src/src/models/RefreshOAuthTokensRequest.ts +1 -1
- package/src/src/models/RefreshSessionRequest.ts +1 -1
- package/src/src/models/RefreshTokenResponse.ts +1 -1
- package/src/src/models/RefreshTokenResponseData.ts +1 -1
- package/src/src/models/RegisterDeviceRequest.ts +1 -1
- package/src/src/models/RegisterRequest.ts +1 -1
- package/src/src/models/RemoveTopicSubscribersRequest.ts +1 -1
- package/src/src/models/RenameWebAuthnCredentialRequest.ts +1 -1
- package/src/src/models/RenderTemplateRequest.ts +1 -1
- package/src/src/models/ReplayWebhookEventsRequest.ts +1 -1
- package/src/src/models/RequestMeta.ts +1 -1
- package/src/src/models/ResetPasswordRequest.ts +1 -1
- package/src/src/models/ResetPasswordResponse.ts +1 -1
- package/src/src/models/ResubscribeRequest.ts +1 -1
- package/src/src/models/ResubscribeResponse.ts +1 -1
- package/src/src/models/RevokeAllSessionsResponse.ts +1 -1
- package/src/src/models/RevokeAllSessionsResponseData.ts +1 -1
- package/src/src/models/RevokeSessionRequest.ts +1 -1
- package/src/src/models/SendBatchEmailRequest.ts +1 -1
- package/src/src/models/SendBatchEmailResponse.ts +1 -1
- package/src/src/models/SendBatchEmailResult.ts +1 -1
- package/src/src/models/SendBatchEmailResultItem.ts +1 -1
- package/src/src/models/SendBatchInAppMeta.ts +1 -1
- package/src/src/models/SendBatchInAppRequest.ts +1 -1
- package/src/src/models/SendBatchInAppResponse.ts +1 -1
- package/src/src/models/SendBatchSmsData.ts +1 -1
- package/src/src/models/SendBatchSmsRequest.ts +1 -1
- package/src/src/models/SendBatchSmsResponse.ts +1 -1
- package/src/src/models/SendEmailOtpRegistrationRequest.ts +1 -1
- package/src/src/models/SendEmailRequest.ts +1 -1
- package/src/src/models/SendEmailResponse.ts +1 -1
- package/src/src/models/SendEmailResponseData.ts +1 -1
- package/src/src/models/SendEmailResponseMeta.ts +1 -1
- package/src/src/models/SendEmailVerificationRequest.ts +1 -1
- package/src/src/models/SendInAppMeta.ts +1 -1
- package/src/src/models/SendInAppRequest.ts +1 -1
- package/src/src/models/SendInAppResponse.ts +1 -1
- package/src/src/models/SendPushRequest.ts +1 -1
- package/src/src/models/SendPushRequestActionButtonsInner.ts +1 -1
- package/src/src/models/SendPushResponse.ts +1 -1
- package/src/src/models/SendPushResponseData.ts +1 -1
- package/src/src/models/SendPushToTopicData.ts +1 -1
- package/src/src/models/SendPushToTopicRequest.ts +1 -1
- package/src/src/models/SendPushToTopicResponse.ts +1 -1
- package/src/src/models/SendSlackMessageRequest.ts +1 -1
- package/src/src/models/SendSlackMessageResponse.ts +1 -1
- package/src/src/models/SendSlackMessageResult.ts +1 -1
- package/src/src/models/SendSmsData.ts +1 -1
- package/src/src/models/SendSmsRequest.ts +1 -1
- package/src/src/models/SendSmsResponse.ts +1 -1
- package/src/src/models/SendTemplateTestEmailRequest.ts +74 -0
- package/src/src/models/SendTestSmsData.ts +1 -1
- package/src/src/models/SendTestSmsRequest.ts +1 -1
- package/src/src/models/SendTestSmsResponse.ts +1 -1
- package/src/src/models/SendWebhookTestEventRequest.ts +1 -1
- package/src/src/models/SessionListResponse.ts +1 -1
- package/src/src/models/SessionListResponseData.ts +1 -1
- package/src/src/models/SessionListResponseDataSessionInfo.ts +1 -1
- package/src/src/models/SetDomainInboundRequest.ts +1 -1
- package/src/src/models/SetEndUserClaimsRequest.ts +65 -0
- package/src/src/models/SetPreferencesRequest.ts +1 -1
- package/src/src/models/SetPreferencesRequestPreferencesInner.ts +1 -1
- package/src/src/models/SignInAnonymouslyRequest.ts +17 -1
- package/src/src/models/SignInWithGameCenterRequest.ts +111 -0
- package/src/src/models/SlackMessage.ts +1 -1
- package/src/src/models/SlackMessageListResponse.ts +1 -1
- package/src/src/models/SlackMessageListResponseMeta.ts +1 -1
- package/src/src/models/SlackMessageResponse.ts +1 -1
- package/src/src/models/SlackMessageStatus.ts +1 -1
- package/src/src/models/SlackMessageSummary.ts +1 -1
- package/src/src/models/SmsBatchResultMessage.ts +1 -1
- package/src/src/models/SmsBatchResultSummary.ts +1 -1
- package/src/src/models/SmsConfig.ts +1 -1
- package/src/src/models/SmsConfigDeleteResponse.ts +1 -1
- package/src/src/models/SmsConfigDeleteResponseData.ts +1 -1
- package/src/src/models/SmsConfigResponse.ts +1 -1
- package/src/src/models/SmsDetailResponse.ts +1 -1
- package/src/src/models/SmsListResponse.ts +1 -1
- package/src/src/models/SmsListResponseMeta.ts +1 -1
- package/src/src/models/SmsMessage.ts +1 -1
- package/src/src/models/SmsMessageDetail.ts +1 -1
- package/src/src/models/SubscribePushTopicRequest.ts +1 -1
- package/src/src/models/Subscriber.ts +1 -1
- package/src/src/models/SubscriberListResponse.ts +1 -1
- package/src/src/models/SubscriberPreference.ts +1 -1
- package/src/src/models/SubscriberResponse.ts +1 -1
- package/src/src/models/SuccessResult.ts +1 -1
- package/src/src/models/SwitchOrganizationRequest.ts +1 -1
- package/src/src/models/SwitchOrganizationResponse.ts +1 -1
- package/src/src/models/SwitchOrganizationResponseData.ts +1 -1
- package/src/src/models/SwitchOrganizationResponseDataTokens.ts +1 -1
- package/src/src/models/SwitchOrganizationResponseDataUser.ts +1 -1
- package/src/src/models/Template.ts +1 -1
- package/src/src/models/TemplateListResponse.ts +1 -1
- package/src/src/models/TemplateRenderResponse.ts +1 -1
- package/src/src/models/TemplateRenderedContent.ts +1 -1
- package/src/src/models/TemplateResponse.ts +1 -1
- package/src/src/models/TestWebhookTransformRequest.ts +1 -1
- package/src/src/models/Topic.ts +1 -1
- package/src/src/models/TopicDeleteResponse.ts +1 -1
- package/src/src/models/TopicDeleteResponseData.ts +1 -1
- package/src/src/models/TopicListResponse.ts +1 -1
- package/src/src/models/TopicResponse.ts +1 -1
- package/src/src/models/TopicStatsData.ts +1 -1
- package/src/src/models/TopicStatsDataTopicsBySubscriberCountInner.ts +1 -1
- package/src/src/models/TopicStatsResponse.ts +1 -1
- package/src/src/models/TopicSubscriber.ts +1 -1
- package/src/src/models/TopicSubscriberListResponse.ts +1 -1
- package/src/src/models/TopicSubscribersAddResponse.ts +1 -1
- package/src/src/models/TopicSubscribersAddResult.ts +1 -1
- package/src/src/models/TopicSubscribersRemoveResponse.ts +1 -1
- package/src/src/models/TopicSubscribersRemoveResult.ts +1 -1
- package/src/src/models/UnreadCountData.ts +1 -1
- package/src/src/models/UnreadCountResponse.ts +1 -1
- package/src/src/models/Unsubscribe.ts +1 -1
- package/src/src/models/UnsubscribeListResponse.ts +1 -1
- package/src/src/models/UnsubscribeRequest.ts +1 -1
- package/src/src/models/UnsubscribeResponse.ts +1 -1
- package/src/src/models/UpdateCategoryRequest.ts +1 -1
- package/src/src/models/UpdateEndUserByApplicationRequest.ts +97 -0
- package/src/src/models/UpdateEndUserRequest.ts +1 -1
- package/src/src/models/UpdateOrganizationMemberRoleRequest.ts +1 -1
- package/src/src/models/UpdateOrganizationRequest.ts +1 -1
- package/src/src/models/UpdateSubscriberPreferencesRequest.ts +1 -1
- package/src/src/models/UpdateSubscriberPreferencesRequestPreferencesInner.ts +1 -1
- package/src/src/models/UpdateSubscriberRequest.ts +1 -1
- package/src/src/models/UpdateTemplateRequest.ts +1 -1
- package/src/src/models/UpdateTopicRequest.ts +1 -1
- package/src/src/models/UpdateWaaSApplicationRequest.ts +1 -1
- package/src/src/models/UpdateWaaSEndpointRequest.ts +1 -1
- package/src/src/models/UpdateWaaSEventTypeRequest.ts +1 -1
- package/src/src/models/UpdateWebhookRequest.ts +1 -1
- package/src/src/models/UpsertAuthEmailTemplateRequest.ts +1 -1
- package/src/src/models/UpsertSmsConfigRequest.ts +1 -1
- package/src/src/models/UserDevicesDeleteResponse.ts +1 -1
- package/src/src/models/UserDevicesDeleteResponseData.ts +1 -1
- package/src/src/models/V1MuseSubjectsSuggestPostRequest.ts +1 -1
- package/src/src/models/ValidateResetTokenRequest.ts +1 -1
- package/src/src/models/ValidateResetTokenResponse.ts +1 -1
- package/src/src/models/ValidateResetTokenResponseData.ts +1 -1
- package/src/src/models/VerificationStatusResponse.ts +1 -1
- package/src/src/models/VerificationStatusResponseData.ts +1 -1
- package/src/src/models/VerifyDomainResponse.ts +1 -1
- package/src/src/models/VerifyDomainResponseData.ts +1 -1
- package/src/src/models/VerifyEmailOtpLoginRequest.ts +1 -1
- package/src/src/models/VerifyEmailOtpRegistrationRequest.ts +1 -1
- package/src/src/models/VerifySmsConfigData.ts +1 -1
- package/src/src/models/VerifySmsConfigResponse.ts +1 -1
- package/src/src/models/WaaSApplication.ts +1 -1
- package/src/src/models/WaaSBatchPublishRequest.ts +1 -1
- package/src/src/models/WaaSBatchPublishResponse.ts +1 -1
- package/src/src/models/WaaSDelivery.ts +1 -1
- package/src/src/models/WaaSEndpoint.ts +1 -1
- package/src/src/models/WaaSEventType.ts +1 -1
- package/src/src/models/WaaSPortalTokenRequest.ts +1 -1
- package/src/src/models/WaaSPortalTokenRequestTheme.ts +1 -1
- package/src/src/models/WaaSPortalTokenResponse.ts +1 -1
- package/src/src/models/WaaSPublishEventRequest.ts +1 -1
- package/src/src/models/WaaSPublishEventResponse.ts +1 -1
- package/src/src/models/WaaSUsageResponse.ts +1 -1
- package/src/src/models/WebAuthnChallengeOptions.ts +1 -1
- package/src/src/models/WebAuthnCredential.ts +1 -1
- package/src/src/models/WebAuthnCredentialListResponse.ts +1 -1
- package/src/src/models/WebAuthnCredentialListResponseData.ts +1 -1
- package/src/src/models/WebAuthnCredentialResponse.ts +1 -1
- package/src/src/models/WebAuthnStartAuthRequest.ts +1 -1
- package/src/src/models/WebAuthnStartAuthResponse.ts +1 -1
- package/src/src/models/WebAuthnStartRegistrationRequest.ts +1 -1
- package/src/src/models/WebAuthnStartRegistrationResponse.ts +1 -1
- package/src/src/models/WebAuthnStatusResponse.ts +1 -1
- package/src/src/models/WebAuthnStatusResponseData.ts +1 -1
- package/src/src/models/WebAuthnVerifyAuthRequest.ts +1 -1
- package/src/src/models/WebAuthnVerifyRegistrationRequest.ts +1 -1
- package/src/src/models/WebAuthnVerifyRegistrationResponse.ts +1 -1
- package/src/src/models/WebAuthnVerifyRegistrationResponseData.ts +1 -1
- package/src/src/models/Webhook.ts +1 -1
- package/src/src/models/WebhookAccountMetricsResponse.ts +1 -1
- package/src/src/models/WebhookBulkRetryResponse.ts +1 -1
- package/src/src/models/WebhookCircuitState.ts +1 -1
- package/src/src/models/WebhookCircuitStateResponse.ts +1 -1
- package/src/src/models/WebhookCreateResponse.ts +1 -1
- package/src/src/models/WebhookCreateResponseData.ts +1 -1
- package/src/src/models/WebhookDeleteResponse.ts +1 -1
- package/src/src/models/WebhookDeleteResponseData.ts +1 -1
- package/src/src/models/WebhookDelivery.ts +1 -1
- package/src/src/models/WebhookDeliveryDetail.ts +1 -1
- package/src/src/models/WebhookDeliveryListResponse.ts +1 -1
- package/src/src/models/WebhookDeliveryResponse.ts +1 -1
- package/src/src/models/WebhookDeliveryRetryResponse.ts +1 -1
- package/src/src/models/WebhookDeliveryRetryResponseData.ts +1 -1
- package/src/src/models/WebhookEventTypesResponse.ts +1 -1
- package/src/src/models/WebhookEventTypesResponseData.ts +1 -1
- package/src/src/models/WebhookIpsResponse.ts +1 -1
- package/src/src/models/WebhookIpsResponseData.ts +1 -1
- package/src/src/models/WebhookJobResponse.ts +1 -1
- package/src/src/models/WebhookListResponse.ts +1 -1
- package/src/src/models/WebhookMetricsResponse.ts +1 -1
- package/src/src/models/WebhookRegion.ts +1 -1
- package/src/src/models/WebhookRegionsResponse.ts +1 -1
- package/src/src/models/WebhookRegionsResponseData.ts +1 -1
- package/src/src/models/WebhookReplayResponse.ts +1 -1
- package/src/src/models/WebhookResponse.ts +1 -1
- package/src/src/models/WebhookSecretRotateResponse.ts +1 -1
- package/src/src/models/WebhookSecretRotateResponseData.ts +1 -1
- package/src/src/models/WebhookTestEventResponse.ts +1 -1
- package/src/src/models/WebhookTestEventResponseData.ts +1 -1
- package/src/src/models/WebhookTransformTestResponse.ts +1 -1
- package/src/src/models/WebhookUsageResponse.ts +1 -1
- package/src/src/models/WebhookVersion.ts +1 -1
- package/src/src/models/WebhookVersionsResponse.ts +1 -1
- package/src/src/models/WebhookVersionsResponseData.ts +1 -1
- package/src/src/models/WithdrawSubscriberConsentRequest.ts +1 -1
- package/src/src/models/WorkflowExecution.ts +1 -1
- package/src/src/models/WorkflowExecutionStatus.ts +1 -1
- package/src/src/models/WorkflowStepExecution.ts +1 -1
- package/src/src/models/WorkflowStepExecutionStatus.ts +1 -1
- package/src/src/models/index.ts +6 -0
- package/src/src/runtime.ts +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|
|
@@ -21,6 +21,7 @@ import type {
|
|
|
21
21
|
OAuthCallbackResponse,
|
|
22
22
|
OAuthConnectionInfoResponse,
|
|
23
23
|
OAuthConnectionsResponse,
|
|
24
|
+
OAuthProviderName,
|
|
24
25
|
OAuthProvidersResponse,
|
|
25
26
|
OAuthTokensRefreshResponse,
|
|
26
27
|
OAuthTokensResponse,
|
|
@@ -40,6 +41,8 @@ import {
|
|
|
40
41
|
OAuthConnectionInfoResponseToJSON,
|
|
41
42
|
OAuthConnectionsResponseFromJSON,
|
|
42
43
|
OAuthConnectionsResponseToJSON,
|
|
44
|
+
OAuthProviderNameFromJSON,
|
|
45
|
+
OAuthProviderNameToJSON,
|
|
43
46
|
OAuthProvidersResponseFromJSON,
|
|
44
47
|
OAuthProvidersResponseToJSON,
|
|
45
48
|
OAuthTokensRefreshResponseFromJSON,
|
|
@@ -53,30 +56,30 @@ import {
|
|
|
53
56
|
} from '../models/index';
|
|
54
57
|
|
|
55
58
|
export interface AuthOAuthApiDisconnectOAuthProviderRequest {
|
|
56
|
-
provider:
|
|
59
|
+
provider: OAuthProviderName;
|
|
57
60
|
}
|
|
58
61
|
|
|
59
62
|
export interface AuthOAuthApiGetOAuthAuthorizationUrlRequest {
|
|
60
|
-
provider:
|
|
63
|
+
provider: OAuthProviderName;
|
|
61
64
|
redirectUri: string;
|
|
62
65
|
}
|
|
63
66
|
|
|
64
67
|
export interface AuthOAuthApiGetOAuthConnectionInfoRequest {
|
|
65
|
-
provider:
|
|
68
|
+
provider: OAuthProviderName;
|
|
66
69
|
}
|
|
67
70
|
|
|
68
71
|
export interface AuthOAuthApiGetOAuthTokensRequest {
|
|
69
|
-
provider:
|
|
72
|
+
provider: OAuthProviderName;
|
|
70
73
|
userId: string;
|
|
71
74
|
}
|
|
72
75
|
|
|
73
76
|
export interface AuthOAuthApiHandleOAuthCallbackRequest {
|
|
74
|
-
provider:
|
|
77
|
+
provider: OAuthProviderName;
|
|
75
78
|
oAuthCallbackRequest: OAuthCallbackRequest;
|
|
76
79
|
}
|
|
77
80
|
|
|
78
81
|
export interface AuthOAuthApiRefreshOAuthTokensOperationRequest {
|
|
79
|
-
provider:
|
|
82
|
+
provider: OAuthProviderName;
|
|
80
83
|
refreshOAuthTokensRequest: RefreshOAuthTokensRequest;
|
|
81
84
|
}
|
|
82
85
|
|
|
@@ -90,7 +93,7 @@ export interface AuthOAuthApiInterface {
|
|
|
90
93
|
/**
|
|
91
94
|
* Disconnect an OAuth provider from the current user.
|
|
92
95
|
* @summary Disconnect OAuth provider
|
|
93
|
-
* @param {
|
|
96
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
94
97
|
* @param {*} [options] Override http request option.
|
|
95
98
|
* @throws {RequiredError}
|
|
96
99
|
* @memberof AuthOAuthApiInterface
|
|
@@ -101,12 +104,12 @@ export interface AuthOAuthApiInterface {
|
|
|
101
104
|
* Disconnect an OAuth provider from the current user.
|
|
102
105
|
* Disconnect OAuth provider
|
|
103
106
|
*/
|
|
104
|
-
disconnectOAuthProvider(provider:
|
|
107
|
+
disconnectOAuthProvider(provider: OAuthProviderName, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult>;
|
|
105
108
|
|
|
106
109
|
/**
|
|
107
110
|
* Generate an OAuth authorization URL for the specified provider.
|
|
108
111
|
* @summary Get OAuth authorization URL
|
|
109
|
-
* @param {
|
|
112
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
110
113
|
* @param {string} redirectUri Redirect URI after authorization
|
|
111
114
|
* @param {*} [options] Override http request option.
|
|
112
115
|
* @throws {RequiredError}
|
|
@@ -118,12 +121,12 @@ export interface AuthOAuthApiInterface {
|
|
|
118
121
|
* Generate an OAuth authorization URL for the specified provider.
|
|
119
122
|
* Get OAuth authorization URL
|
|
120
123
|
*/
|
|
121
|
-
getOAuthAuthorizationUrl(provider:
|
|
124
|
+
getOAuthAuthorizationUrl(provider: OAuthProviderName, redirectUri: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthAuthorizationUrlResponse>;
|
|
122
125
|
|
|
123
126
|
/**
|
|
124
127
|
* Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
|
|
125
128
|
* @summary Get OAuth connection info
|
|
126
|
-
* @param {
|
|
129
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
127
130
|
* @param {*} [options] Override http request option.
|
|
128
131
|
* @throws {RequiredError}
|
|
129
132
|
* @memberof AuthOAuthApiInterface
|
|
@@ -134,12 +137,12 @@ export interface AuthOAuthApiInterface {
|
|
|
134
137
|
* Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
|
|
135
138
|
* Get OAuth connection info
|
|
136
139
|
*/
|
|
137
|
-
getOAuthConnectionInfo(provider:
|
|
140
|
+
getOAuthConnectionInfo(provider: OAuthProviderName, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthConnectionInfoResponse>;
|
|
138
141
|
|
|
139
142
|
/**
|
|
140
143
|
* Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users.
|
|
141
144
|
* @summary Get OAuth provider tokens
|
|
142
|
-
* @param {
|
|
145
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
143
146
|
* @param {string} userId End user ID
|
|
144
147
|
* @param {*} [options] Override http request option.
|
|
145
148
|
* @throws {RequiredError}
|
|
@@ -151,12 +154,12 @@ export interface AuthOAuthApiInterface {
|
|
|
151
154
|
* Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users.
|
|
152
155
|
* Get OAuth provider tokens
|
|
153
156
|
*/
|
|
154
|
-
getOAuthTokens(provider:
|
|
157
|
+
getOAuthTokens(provider: OAuthProviderName, userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokensResponse>;
|
|
155
158
|
|
|
156
159
|
/**
|
|
157
160
|
* Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
|
|
158
161
|
* @summary Handle OAuth callback
|
|
159
|
-
* @param {
|
|
162
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
160
163
|
* @param {OAuthCallbackRequest} oAuthCallbackRequest
|
|
161
164
|
* @param {*} [options] Override http request option.
|
|
162
165
|
* @throws {RequiredError}
|
|
@@ -168,7 +171,7 @@ export interface AuthOAuthApiInterface {
|
|
|
168
171
|
* Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
|
|
169
172
|
* Handle OAuth callback
|
|
170
173
|
*/
|
|
171
|
-
handleOAuthCallback(provider:
|
|
174
|
+
handleOAuthCallback(provider: OAuthProviderName, oAuthCallbackRequest: OAuthCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthCallbackResponse>;
|
|
172
175
|
|
|
173
176
|
/**
|
|
174
177
|
* Get OAuth connections for the current user with metadata.
|
|
@@ -203,7 +206,7 @@ export interface AuthOAuthApiInterface {
|
|
|
203
206
|
/**
|
|
204
207
|
* Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft).
|
|
205
208
|
* @summary Refresh OAuth provider tokens
|
|
206
|
-
* @param {
|
|
209
|
+
* @param {OAuthProviderName} provider OAuth provider name
|
|
207
210
|
* @param {RefreshOAuthTokensRequest} refreshOAuthTokensRequest
|
|
208
211
|
* @param {*} [options] Override http request option.
|
|
209
212
|
* @throws {RequiredError}
|
|
@@ -215,7 +218,7 @@ export interface AuthOAuthApiInterface {
|
|
|
215
218
|
* Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft).
|
|
216
219
|
* Refresh OAuth provider tokens
|
|
217
220
|
*/
|
|
218
|
-
refreshOAuthTokens(provider:
|
|
221
|
+
refreshOAuthTokens(provider: OAuthProviderName, refreshOAuthTokensRequest: RefreshOAuthTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokensRefreshResponse>;
|
|
219
222
|
|
|
220
223
|
}
|
|
221
224
|
|
|
@@ -266,7 +269,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
266
269
|
* Disconnect an OAuth provider from the current user.
|
|
267
270
|
* Disconnect OAuth provider
|
|
268
271
|
*/
|
|
269
|
-
async disconnectOAuthProvider(provider:
|
|
272
|
+
async disconnectOAuthProvider(provider: OAuthProviderName, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult> {
|
|
270
273
|
const response = await this.disconnectOAuthProviderRaw({ provider: provider }, initOverrides);
|
|
271
274
|
return await response.value();
|
|
272
275
|
}
|
|
@@ -316,7 +319,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
316
319
|
* Generate an OAuth authorization URL for the specified provider.
|
|
317
320
|
* Get OAuth authorization URL
|
|
318
321
|
*/
|
|
319
|
-
async getOAuthAuthorizationUrl(provider:
|
|
322
|
+
async getOAuthAuthorizationUrl(provider: OAuthProviderName, redirectUri: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthAuthorizationUrlResponse> {
|
|
320
323
|
const response = await this.getOAuthAuthorizationUrlRaw({ provider: provider, redirectUri: redirectUri }, initOverrides);
|
|
321
324
|
return await response.value();
|
|
322
325
|
}
|
|
@@ -363,7 +366,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
363
366
|
* Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
|
|
364
367
|
* Get OAuth connection info
|
|
365
368
|
*/
|
|
366
|
-
async getOAuthConnectionInfo(provider:
|
|
369
|
+
async getOAuthConnectionInfo(provider: OAuthProviderName, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthConnectionInfoResponse> {
|
|
367
370
|
const response = await this.getOAuthConnectionInfoRaw({ provider: provider }, initOverrides);
|
|
368
371
|
return await response.value();
|
|
369
372
|
}
|
|
@@ -417,7 +420,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
417
420
|
* Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users.
|
|
418
421
|
* Get OAuth provider tokens
|
|
419
422
|
*/
|
|
420
|
-
async getOAuthTokens(provider:
|
|
423
|
+
async getOAuthTokens(provider: OAuthProviderName, userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokensResponse> {
|
|
421
424
|
const response = await this.getOAuthTokensRaw({ provider: provider, userId: userId }, initOverrides);
|
|
422
425
|
return await response.value();
|
|
423
426
|
}
|
|
@@ -462,7 +465,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
462
465
|
* Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
|
|
463
466
|
* Handle OAuth callback
|
|
464
467
|
*/
|
|
465
|
-
async handleOAuthCallback(provider:
|
|
468
|
+
async handleOAuthCallback(provider: OAuthProviderName, oAuthCallbackRequest: OAuthCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthCallbackResponse> {
|
|
466
469
|
const response = await this.handleOAuthCallbackRaw({ provider: provider, oAuthCallbackRequest: oAuthCallbackRequest }, initOverrides);
|
|
467
470
|
return await response.value();
|
|
468
471
|
}
|
|
@@ -587,7 +590,7 @@ export class AuthOAuthApi extends runtime.BaseAPI implements AuthOAuthApiInterfa
|
|
|
587
590
|
* Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft).
|
|
588
591
|
* Refresh OAuth provider tokens
|
|
589
592
|
*/
|
|
590
|
-
async refreshOAuthTokens(provider:
|
|
593
|
+
async refreshOAuthTokens(provider: OAuthProviderName, refreshOAuthTokensRequest: RefreshOAuthTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokensRefreshResponse> {
|
|
591
594
|
const response = await this.refreshOAuthTokensRaw({ provider: provider, refreshOAuthTokensRequest: refreshOAuthTokensRequest }, initOverrides);
|
|
592
595
|
return await response.value();
|
|
593
596
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|
|
@@ -20,6 +20,7 @@ import type {
|
|
|
20
20
|
ConvertAnonymousUserRequest,
|
|
21
21
|
RegisterRequest,
|
|
22
22
|
SignInAnonymouslyRequest,
|
|
23
|
+
SignInWithGameCenterRequest,
|
|
23
24
|
} from '../models/index';
|
|
24
25
|
import {
|
|
25
26
|
ApiErrorFromJSON,
|
|
@@ -32,6 +33,8 @@ import {
|
|
|
32
33
|
RegisterRequestToJSON,
|
|
33
34
|
SignInAnonymouslyRequestFromJSON,
|
|
34
35
|
SignInAnonymouslyRequestToJSON,
|
|
36
|
+
SignInWithGameCenterRequestFromJSON,
|
|
37
|
+
SignInWithGameCenterRequestToJSON,
|
|
35
38
|
} from '../models/index';
|
|
36
39
|
|
|
37
40
|
export interface AuthRegistrationApiConvertAnonymousUserOperationRequest {
|
|
@@ -46,6 +49,10 @@ export interface AuthRegistrationApiSignInAnonymouslyOperationRequest {
|
|
|
46
49
|
signInAnonymouslyRequest: SignInAnonymouslyRequest;
|
|
47
50
|
}
|
|
48
51
|
|
|
52
|
+
export interface AuthRegistrationApiSignInWithGameCenterOperationRequest {
|
|
53
|
+
signInWithGameCenterRequest: SignInWithGameCenterRequest;
|
|
54
|
+
}
|
|
55
|
+
|
|
49
56
|
/**
|
|
50
57
|
* AuthRegistrationApi - interface
|
|
51
58
|
*
|
|
@@ -86,7 +93,7 @@ export interface AuthRegistrationApiInterface {
|
|
|
86
93
|
registerEndUser(registerRequest: RegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
|
|
87
94
|
|
|
88
95
|
/**
|
|
89
|
-
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert.
|
|
96
|
+
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert. Pass an optional `organization_id` to create the anonymous user directly in an organization; the returned access token then carries `org_id` (and `orgs`), matching the org-scoped register/login flow.
|
|
90
97
|
* @summary Sign in anonymously
|
|
91
98
|
* @param {SignInAnonymouslyRequest} signInAnonymouslyRequest
|
|
92
99
|
* @param {*} [options] Override http request option.
|
|
@@ -96,11 +103,27 @@ export interface AuthRegistrationApiInterface {
|
|
|
96
103
|
signInAnonymouslyRaw(requestParameters: AuthRegistrationApiSignInAnonymouslyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>>;
|
|
97
104
|
|
|
98
105
|
/**
|
|
99
|
-
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert.
|
|
106
|
+
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert. Pass an optional `organization_id` to create the anonymous user directly in an organization; the returned access token then carries `org_id` (and `orgs`), matching the org-scoped register/login flow.
|
|
100
107
|
* Sign in anonymously
|
|
101
108
|
*/
|
|
102
109
|
signInAnonymously(signInAnonymouslyRequest: SignInAnonymouslyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
|
|
103
110
|
|
|
111
|
+
/**
|
|
112
|
+
* Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID). ## Producing the assertion (Integration) The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit\'s `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player\'s `gamePlayerID` and the app\'s bundle identifier and submit them here. Two integration shapes are supported: - **client-direct** — the iOS app holds the Zyphr application public key and calls this endpoint itself. - **backend-relayed** — the app forwards the fetched assertion fields to the customer\'s own backend, which relays them to this endpoint; the app never holds Zyphr keys. (This is the common shape for games.) On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
|
|
113
|
+
* @summary Sign in with Apple Game Center
|
|
114
|
+
* @param {SignInWithGameCenterRequest} signInWithGameCenterRequest
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
* @memberof AuthRegistrationApiInterface
|
|
118
|
+
*/
|
|
119
|
+
signInWithGameCenterRaw(requestParameters: AuthRegistrationApiSignInWithGameCenterOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>>;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID). ## Producing the assertion (Integration) The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit\'s `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player\'s `gamePlayerID` and the app\'s bundle identifier and submit them here. Two integration shapes are supported: - **client-direct** — the iOS app holds the Zyphr application public key and calls this endpoint itself. - **backend-relayed** — the app forwards the fetched assertion fields to the customer\'s own backend, which relays them to this endpoint; the app never holds Zyphr keys. (This is the common shape for games.) On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
|
|
123
|
+
* Sign in with Apple Game Center
|
|
124
|
+
*/
|
|
125
|
+
signInWithGameCenter(signInWithGameCenterRequest: SignInWithGameCenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
|
|
126
|
+
|
|
104
127
|
}
|
|
105
128
|
|
|
106
129
|
/**
|
|
@@ -193,7 +216,7 @@ export class AuthRegistrationApi extends runtime.BaseAPI implements AuthRegistra
|
|
|
193
216
|
}
|
|
194
217
|
|
|
195
218
|
/**
|
|
196
|
-
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert.
|
|
219
|
+
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert. Pass an optional `organization_id` to create the anonymous user directly in an organization; the returned access token then carries `org_id` (and `orgs`), matching the org-scoped register/login flow.
|
|
197
220
|
* Sign in anonymously
|
|
198
221
|
*/
|
|
199
222
|
async signInAnonymouslyRaw(requestParameters: AuthRegistrationApiSignInAnonymouslyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>> {
|
|
@@ -226,7 +249,7 @@ export class AuthRegistrationApi extends runtime.BaseAPI implements AuthRegistra
|
|
|
226
249
|
}
|
|
227
250
|
|
|
228
251
|
/**
|
|
229
|
-
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert.
|
|
252
|
+
* Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry. Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh). Convert an anonymous user to a full account via POST /v1/auth/users/convert. Pass an optional `organization_id` to create the anonymous user directly in an organization; the returned access token then carries `org_id` (and `orgs`), matching the org-scoped register/login flow.
|
|
230
253
|
* Sign in anonymously
|
|
231
254
|
*/
|
|
232
255
|
async signInAnonymously(signInAnonymouslyRequest: SignInAnonymouslyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse> {
|
|
@@ -234,4 +257,46 @@ export class AuthRegistrationApi extends runtime.BaseAPI implements AuthRegistra
|
|
|
234
257
|
return await response.value();
|
|
235
258
|
}
|
|
236
259
|
|
|
260
|
+
/**
|
|
261
|
+
* Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID). ## Producing the assertion (Integration) The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit\'s `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player\'s `gamePlayerID` and the app\'s bundle identifier and submit them here. Two integration shapes are supported: - **client-direct** — the iOS app holds the Zyphr application public key and calls this endpoint itself. - **backend-relayed** — the app forwards the fetched assertion fields to the customer\'s own backend, which relays them to this endpoint; the app never holds Zyphr keys. (This is the common shape for games.) On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
|
|
262
|
+
* Sign in with Apple Game Center
|
|
263
|
+
*/
|
|
264
|
+
async signInWithGameCenterRaw(requestParameters: AuthRegistrationApiSignInWithGameCenterOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>> {
|
|
265
|
+
if (requestParameters['signInWithGameCenterRequest'] == null) {
|
|
266
|
+
throw new runtime.RequiredError(
|
|
267
|
+
'signInWithGameCenterRequest',
|
|
268
|
+
'Required parameter "signInWithGameCenterRequest" was null or undefined when calling signInWithGameCenter().'
|
|
269
|
+
);
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
const queryParameters: any = {};
|
|
273
|
+
|
|
274
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
275
|
+
|
|
276
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
277
|
+
|
|
278
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
279
|
+
headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
const response = await this.request({
|
|
283
|
+
path: `/auth/game-center`,
|
|
284
|
+
method: 'POST',
|
|
285
|
+
headers: headerParameters,
|
|
286
|
+
query: queryParameters,
|
|
287
|
+
body: SignInWithGameCenterRequestToJSON(requestParameters['signInWithGameCenterRequest']),
|
|
288
|
+
}, initOverrides);
|
|
289
|
+
|
|
290
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AuthResultResponseFromJSON(jsonValue));
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID). ## Producing the assertion (Integration) The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit\'s `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player\'s `gamePlayerID` and the app\'s bundle identifier and submit them here. Two integration shapes are supported: - **client-direct** — the iOS app holds the Zyphr application public key and calls this endpoint itself. - **backend-relayed** — the app forwards the fetched assertion fields to the customer\'s own backend, which relays them to this endpoint; the app never holds Zyphr keys. (This is the common shape for games.) On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
|
|
295
|
+
* Sign in with Apple Game Center
|
|
296
|
+
*/
|
|
297
|
+
async signInWithGameCenter(signInWithGameCenterRequest: SignInWithGameCenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse> {
|
|
298
|
+
const response = await this.signInWithGameCenterRaw({ signInWithGameCenterRequest: signInWithGameCenterRequest }, initOverrides);
|
|
299
|
+
return await response.value();
|
|
300
|
+
}
|
|
301
|
+
|
|
237
302
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zyphr API
|
|
5
|
-
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## 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
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Account Sending Status Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call: - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`) This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message. ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zyphr.dev
|