@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
|
|
@@ -31,10 +31,6 @@ import {
|
|
|
31
31
|
UpdateEndUserRequestToJSON,
|
|
32
32
|
} from '../models/index';
|
|
33
33
|
|
|
34
|
-
export interface AuthUserProfileApiDeleteEndUserByApplicationRequest {
|
|
35
|
-
userId: string;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
34
|
export interface AuthUserProfileApiUpdateEndUserOperationRequest {
|
|
39
35
|
updateEndUserRequest: UpdateEndUserRequest;
|
|
40
36
|
}
|
|
@@ -61,22 +57,6 @@ export interface AuthUserProfileApiInterface {
|
|
|
61
57
|
*/
|
|
62
58
|
deleteEndUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EndUserDeleteResponse>;
|
|
63
59
|
|
|
64
|
-
/**
|
|
65
|
-
* App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status=\'deleted\'), and emits a `user.deleted` webhook with `method=\'application_admin\'`. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user\'s own session or the dashboard.
|
|
66
|
-
* @summary Delete an end user (test environment only)
|
|
67
|
-
* @param {string} userId
|
|
68
|
-
* @param {*} [options] Override http request option.
|
|
69
|
-
* @throws {RequiredError}
|
|
70
|
-
* @memberof AuthUserProfileApiInterface
|
|
71
|
-
*/
|
|
72
|
-
deleteEndUserByApplicationRaw(requestParameters: AuthUserProfileApiDeleteEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status=\'deleted\'), and emits a `user.deleted` webhook with `method=\'application_admin\'`. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user\'s own session or the dashboard.
|
|
76
|
-
* Delete an end user (test environment only)
|
|
77
|
-
*/
|
|
78
|
-
deleteEndUserByApplication(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
79
|
-
|
|
80
60
|
/**
|
|
81
61
|
* Retrieve the profile of the currently authenticated end user.
|
|
82
62
|
* @summary Get current end user profile
|
|
@@ -155,48 +135,6 @@ export class AuthUserProfileApi extends runtime.BaseAPI implements AuthUserProfi
|
|
|
155
135
|
return await response.value();
|
|
156
136
|
}
|
|
157
137
|
|
|
158
|
-
/**
|
|
159
|
-
* App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status=\'deleted\'), and emits a `user.deleted` webhook with `method=\'application_admin\'`. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user\'s own session or the dashboard.
|
|
160
|
-
* Delete an end user (test environment only)
|
|
161
|
-
*/
|
|
162
|
-
async deleteEndUserByApplicationRaw(requestParameters: AuthUserProfileApiDeleteEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
163
|
-
if (requestParameters['userId'] == null) {
|
|
164
|
-
throw new runtime.RequiredError(
|
|
165
|
-
'userId',
|
|
166
|
-
'Required parameter "userId" was null or undefined when calling deleteEndUserByApplication().'
|
|
167
|
-
);
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
const queryParameters: any = {};
|
|
171
|
-
|
|
172
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
173
|
-
|
|
174
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
175
|
-
headerParameters["X-Application-Secret"] = await this.configuration.apiKey("X-Application-Secret"); // ApplicationSecret authentication
|
|
176
|
-
}
|
|
177
|
-
|
|
178
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
179
|
-
headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
const response = await this.request({
|
|
183
|
-
path: `/auth/users/{user_id}`.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters['userId']))),
|
|
184
|
-
method: 'DELETE',
|
|
185
|
-
headers: headerParameters,
|
|
186
|
-
query: queryParameters,
|
|
187
|
-
}, initOverrides);
|
|
188
|
-
|
|
189
|
-
return new runtime.VoidApiResponse(response);
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
/**
|
|
193
|
-
* App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status=\'deleted\'), and emits a `user.deleted` webhook with `method=\'application_admin\'`. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user\'s own session or the dashboard.
|
|
194
|
-
* Delete an end user (test environment only)
|
|
195
|
-
*/
|
|
196
|
-
async deleteEndUserByApplication(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
197
|
-
await this.deleteEndUserByApplicationRaw({ userId: userId }, initOverrides);
|
|
198
|
-
}
|
|
199
|
-
|
|
200
138
|
/**
|
|
201
139
|
* Retrieve the profile of the currently authenticated end user.
|
|
202
140
|
* Get current end user profile
|
|
@@ -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
|
|
@@ -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
|
package/src/src/apis/InboxApi.ts
CHANGED
|
@@ -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
|
package/src/src/apis/MuseApi.ts
CHANGED
|
@@ -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
|
package/src/src/apis/PushApi.ts
CHANGED
|
@@ -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
|
package/src/src/apis/SMSApi.ts
CHANGED
|
@@ -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
|
package/src/src/apis/SlackApi.ts
CHANGED
|
@@ -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
|
DeleteResult,
|
|
21
21
|
PayloadTooLargeError,
|
|
22
22
|
RenderTemplateRequest,
|
|
23
|
+
SendTemplateTestEmailRequest,
|
|
23
24
|
TemplateListResponse,
|
|
24
25
|
TemplateRenderResponse,
|
|
25
26
|
TemplateResponse,
|
|
@@ -36,6 +37,8 @@ import {
|
|
|
36
37
|
PayloadTooLargeErrorToJSON,
|
|
37
38
|
RenderTemplateRequestFromJSON,
|
|
38
39
|
RenderTemplateRequestToJSON,
|
|
40
|
+
SendTemplateTestEmailRequestFromJSON,
|
|
41
|
+
SendTemplateTestEmailRequestToJSON,
|
|
39
42
|
TemplateListResponseFromJSON,
|
|
40
43
|
TemplateListResponseToJSON,
|
|
41
44
|
TemplateRenderResponseFromJSON,
|
|
@@ -68,6 +71,11 @@ export interface TemplatesApiRenderTemplateOperationRequest {
|
|
|
68
71
|
renderTemplateRequest: RenderTemplateRequest;
|
|
69
72
|
}
|
|
70
73
|
|
|
74
|
+
export interface TemplatesApiSendTemplateTestEmailOperationRequest {
|
|
75
|
+
id: string;
|
|
76
|
+
sendTemplateTestEmailRequest: SendTemplateTestEmailRequest;
|
|
77
|
+
}
|
|
78
|
+
|
|
71
79
|
export interface TemplatesApiUpdateTemplateOperationRequest {
|
|
72
80
|
id: string;
|
|
73
81
|
updateTemplateRequest: UpdateTemplateRequest;
|
|
@@ -162,6 +170,23 @@ export interface TemplatesApiInterface {
|
|
|
162
170
|
*/
|
|
163
171
|
renderTemplate(id: string, renderTemplateRequest: RenderTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemplateRenderResponse>;
|
|
164
172
|
|
|
173
|
+
/**
|
|
174
|
+
* Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`.
|
|
175
|
+
* @summary Send a test email using a template
|
|
176
|
+
* @param {string} id
|
|
177
|
+
* @param {SendTemplateTestEmailRequest} sendTemplateTestEmailRequest
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
* @memberof TemplatesApiInterface
|
|
181
|
+
*/
|
|
182
|
+
sendTemplateTestEmailRaw(requestParameters: TemplatesApiSendTemplateTestEmailOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`.
|
|
186
|
+
* Send a test email using a template
|
|
187
|
+
*/
|
|
188
|
+
sendTemplateTestEmail(id: string, sendTemplateTestEmailRequest: SendTemplateTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
189
|
+
|
|
165
190
|
/**
|
|
166
191
|
* Update an existing template. Only provided fields are changed.
|
|
167
192
|
* @summary Update template
|
|
@@ -395,6 +420,58 @@ export class TemplatesApi extends runtime.BaseAPI implements TemplatesApiInterfa
|
|
|
395
420
|
return await response.value();
|
|
396
421
|
}
|
|
397
422
|
|
|
423
|
+
/**
|
|
424
|
+
* Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`.
|
|
425
|
+
* Send a test email using a template
|
|
426
|
+
*/
|
|
427
|
+
async sendTemplateTestEmailRaw(requestParameters: TemplatesApiSendTemplateTestEmailOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
428
|
+
if (requestParameters['id'] == null) {
|
|
429
|
+
throw new runtime.RequiredError(
|
|
430
|
+
'id',
|
|
431
|
+
'Required parameter "id" was null or undefined when calling sendTemplateTestEmail().'
|
|
432
|
+
);
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
if (requestParameters['sendTemplateTestEmailRequest'] == null) {
|
|
436
|
+
throw new runtime.RequiredError(
|
|
437
|
+
'sendTemplateTestEmailRequest',
|
|
438
|
+
'Required parameter "sendTemplateTestEmailRequest" was null or undefined when calling sendTemplateTestEmail().'
|
|
439
|
+
);
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
const queryParameters: any = {};
|
|
443
|
+
|
|
444
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
445
|
+
|
|
446
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
447
|
+
|
|
448
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
449
|
+
const token = this.configuration.accessToken;
|
|
450
|
+
const tokenString = await token("DashboardAuth", []);
|
|
451
|
+
|
|
452
|
+
if (tokenString) {
|
|
453
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
const response = await this.request({
|
|
457
|
+
path: `/templates/{id}/test`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
|
|
458
|
+
method: 'POST',
|
|
459
|
+
headers: headerParameters,
|
|
460
|
+
query: queryParameters,
|
|
461
|
+
body: SendTemplateTestEmailRequestToJSON(requestParameters['sendTemplateTestEmailRequest']),
|
|
462
|
+
}, initOverrides);
|
|
463
|
+
|
|
464
|
+
return new runtime.VoidApiResponse(response);
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
/**
|
|
468
|
+
* Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`.
|
|
469
|
+
* Send a test email using a template
|
|
470
|
+
*/
|
|
471
|
+
async sendTemplateTestEmail(id: string, sendTemplateTestEmailRequest: SendTemplateTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
472
|
+
await this.sendTemplateTestEmailRaw({ id: id, sendTemplateTestEmailRequest: sendTemplateTestEmailRequest }, initOverrides);
|
|
473
|
+
}
|
|
474
|
+
|
|
398
475
|
/**
|
|
399
476
|
* Update an existing template. Only provided fields are changed.
|
|
400
477
|
* Update template
|
|
@@ -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
|
|
@@ -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
|
|
@@ -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
|
package/src/src/apis/index.ts
CHANGED
|
@@ -12,6 +12,7 @@ export * from './AuthPasswordResetApi';
|
|
|
12
12
|
export * from './AuthPhoneApi';
|
|
13
13
|
export * from './AuthRegistrationApi';
|
|
14
14
|
export * from './AuthSessionsApi';
|
|
15
|
+
export * from './AuthUserDirectoryApi';
|
|
15
16
|
export * from './AuthUserProfileApi';
|
|
16
17
|
export * from './AuthWebAuthnApi';
|
|
17
18
|
export * from './DevicesApi';
|
|
@@ -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
|