@zyphr-dev/node-sdk 0.1.44 → 0.1.46

package/src/src/models/WebhookEventType.ts

@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * 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\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Canonical webhook event type. Matches the event `type` field on the webhook delivery envelope and the values returned by `GET /v1/webhooks/event-types`. Source of truth: packages/shared/src/constants/webhookEventRegistry.ts.
+ * @export
+ */
+export const WebhookEventType = {
+    EMAIL_QUEUED: 'email.queued',
+    EMAIL_SENT: 'email.sent',
+    EMAIL_DELIVERED: 'email.delivered',
+    EMAIL_BOUNCED: 'email.bounced',
+    EMAIL_SOFT_BOUNCED: 'email.soft_bounced',
+    EMAIL_COMPLAINED: 'email.complained',
+    EMAIL_OPENED: 'email.opened',
+    EMAIL_CLICKED: 'email.clicked',
+    EMAIL_FAILED: 'email.failed',
+    EMAIL_SUPPRESSED: 'email.suppressed',
+    EMAIL_RECEIVED: 'email.received',
+    PUSH_SENT: 'push.sent',
+    PUSH_DELIVERED: 'push.delivered',
+    PUSH_FAILED: 'push.failed',
+    PUSH_EXPIRED: 'push.expired',
+    USER_CREATED: 'user.created',
+    USER_LOGIN: 'user.login',
+    USER_LOGOUT: 'user.logout',
+    USER_PASSWORD_CHANGED: 'user.password_changed',
+    USER_PASSWORD_RESET_REQUESTED: 'user.password_reset_requested',
+    USER_EMAIL_VERIFIED: 'user.email_verified',
+    USER_PHONE_VERIFIED: 'user.phone_verified',
+    USER_DELETED: 'user.deleted',
+    USER_SESSION_REVOKED: 'user.session_revoked',
+    USER_MFA_ENABLED: 'user.mfa_enabled',
+    USER_MFA_DISABLED: 'user.mfa_disabled',
+    USER_IMPERSONATED: 'user.impersonated',
+    DOMAIN_VERIFIED: 'domain.verified',
+    DOMAIN_VERIFICATION_FAILED: 'domain.verification_failed'
+} as const;
+export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
+
+
+export function instanceOfWebhookEventType(value: any): boolean {
+    for (const key in WebhookEventType) {
+        if (Object.prototype.hasOwnProperty.call(WebhookEventType, key)) {
+            if (WebhookEventType[key as keyof typeof WebhookEventType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function WebhookEventTypeFromJSON(json: any): WebhookEventType {
+    return WebhookEventTypeFromJSONTyped(json, false);
+}
+
+export function WebhookEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventType {
+    return json as WebhookEventType;
+}
+
+export function WebhookEventTypeToJSON(value?: WebhookEventType | null): any {
+    return value as any;
+}
+
+export function WebhookEventTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WebhookEventType {
+    return value as WebhookEventType;
+}
+

package/src/src/models/WebhookEventTypesResponseData.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { WebhookEventType } from './WebhookEventType';
+import {
+    WebhookEventTypeFromJSON,
+    WebhookEventTypeFromJSONTyped,
+    WebhookEventTypeToJSON,
+    WebhookEventTypeToJSONTyped,
+} from './WebhookEventType';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface WebhookEventTypesResponseData {
     /**
      * 
-     * @type {Array<string>}
+     * @type {Array<WebhookEventType>}
      * @memberof WebhookEventTypesResponseData
      */
-    eventTypes?: Array<string>;
+    eventTypes?: Array<WebhookEventType>;
     /**
      * 
      * @type {Array<object>}
@@ -62,7 +70,7 @@ export function WebhookEventTypesResponseDataFromJSONTyped(json: any, ignoreDisc
     }
     return {
         
-        'eventTypes': json['event_types'] == null ? undefined : json['event_types'],
+        'eventTypes': json['event_types'] == null ? undefined : ((json['event_types'] as Array<any>).map(WebhookEventTypeFromJSON)),
         'registry': json['registry'] == null ? undefined : json['registry'],
         'categories': json['categories'] == null ? undefined : json['categories'],
         'apiVersion': json['api_version'] == null ? undefined : json['api_version'],
@@ -80,7 +88,7 @@ export function WebhookEventTypesResponseDataToJSONTyped(value?: WebhookEventTyp
 
     return {
         
-        'event_types': value['eventTypes'],
+        'event_types': value['eventTypes'] == null ? undefined : ((value['eventTypes'] as Array<any>).map(WebhookEventTypeToJSON)),
         'registry': value['registry'],
         'categories': value['categories'],
         'api_version': value['apiVersion'],

package/src/src/models/WebhookTestEventResponseData.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { WebhookEventType } from './WebhookEventType';
+import {
+    WebhookEventTypeFromJSON,
+    WebhookEventTypeFromJSONTyped,
+    WebhookEventTypeToJSON,
+    WebhookEventTypeToJSONTyped,
+} from './WebhookEventType';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface WebhookTestEventResponseData {
     deliveryId?: string;
     /**
      * 
-     * @type {string}
+     * @type {WebhookEventType}
      * @memberof WebhookTestEventResponseData
      */
-    eventType?: string;
+    eventType?: WebhookEventType;
     /**
      * 
      * @type {object}
@@ -45,6 +53,8 @@ export interface WebhookTestEventResponseData {
     status?: string;
 }
 
+
+
 /**
  * Check if a given object implements the WebhookTestEventResponseData interface.
  */
@@ -63,7 +73,7 @@ export function WebhookTestEventResponseDataFromJSONTyped(json: any, ignoreDiscr
     return {
         
         'deliveryId': json['delivery_id'] == null ? undefined : json['delivery_id'],
-        'eventType': json['event_type'] == null ? undefined : json['event_type'],
+        'eventType': json['event_type'] == null ? undefined : WebhookEventTypeFromJSON(json['event_type']),
         'payload': json['payload'] == null ? undefined : json['payload'],
         'status': json['status'] == null ? undefined : json['status'],
     };
@@ -81,7 +91,7 @@ export function WebhookTestEventResponseDataToJSONTyped(value?: WebhookTestEvent
     return {
         
         'delivery_id': value['deliveryId'],
-        'event_type': value['eventType'],
+        'event_type': WebhookEventTypeToJSON(value['eventType']),
         'payload': value['payload'],
         'status': value['status'],
     };

package/src/src/models/index.ts

@@ -48,6 +48,7 @@ export * from './BulkUpsertAuthEmailTemplatesResponse';
 export * from './Category';
 export * from './CategoryListResponse';
 export * from './CategoryResponse';
+export * from './ChangePasswordRequest';
 export * from './CloseWaaSEndpointCircuit200Response';
 export * from './CloseWaaSEndpointCircuit200ResponseData';
 export * from './ConfirmEmailVerificationRequest';
@@ -327,6 +328,7 @@ export * from './SetEndUserClaims200ResponseData';
 export * from './SetEndUserClaimsRequest';
 export * from './SetPreferencesRequest';
 export * from './SetPreferencesRequestPreferencesInner';
+export * from './SetSelfApplicationTestRecipientsRequest';
 export * from './SignInAnonymouslyRequest';
 export * from './SignInWithGameCenterRequest';
 export * from './SignInWithGooglePlayGamesRequest';
@@ -464,6 +466,7 @@ export * from './WebhookDeliveryListResponse';
 export * from './WebhookDeliveryResponse';
 export * from './WebhookDeliveryRetryResponse';
 export * from './WebhookDeliveryRetryResponseData';
+export * from './WebhookEventType';
 export * from './WebhookEventTypesResponse';
 export * from './WebhookEventTypesResponseData';
 export * from './WebhookIpsResponse';