@zyphr-dev/node-sdk 0.1.0 → 0.1.1

package/src/src/models/WaaSBatchPublishResponse.ts

@@ -0,0 +1,81 @@
+/* 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  ## 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WaaSBatchPublishResponse
+ */
+export interface WaaSBatchPublishResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof WaaSBatchPublishResponse
+     */
+    published?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaaSBatchPublishResponse
+     */
+    failed?: number;
+    /**
+     * 
+     * @type {Array<object>}
+     * @memberof WaaSBatchPublishResponse
+     */
+    results?: Array<object>;
+}
+
+/**
+ * Check if a given object implements the WaaSBatchPublishResponse interface.
+ */
+export function instanceOfWaaSBatchPublishResponse(value: object): value is WaaSBatchPublishResponse {
+    return true;
+}
+
+export function WaaSBatchPublishResponseFromJSON(json: any): WaaSBatchPublishResponse {
+    return WaaSBatchPublishResponseFromJSONTyped(json, false);
+}
+
+export function WaaSBatchPublishResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSBatchPublishResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'published': json['published'] == null ? undefined : json['published'],
+        'failed': json['failed'] == null ? undefined : json['failed'],
+        'results': json['results'] == null ? undefined : json['results'],
+    };
+}
+
+export function WaaSBatchPublishResponseToJSON(json: any): WaaSBatchPublishResponse {
+    return WaaSBatchPublishResponseToJSONTyped(json, false);
+}
+
+export function WaaSBatchPublishResponseToJSONTyped(value?: WaaSBatchPublishResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'published': value['published'],
+        'failed': value['failed'],
+        'results': value['results'],
+    };
+}
+

package/src/src/models/WaaSDelivery.ts

@@ -0,0 +1,160 @@
+/* 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  ## 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WaaSDelivery
+ */
+export interface WaaSDelivery {
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    applicationId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    endpointId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    eventId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    eventType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    tenantId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSDelivery
+     */
+    status?: WaaSDeliveryStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaaSDelivery
+     */
+    attempts?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSDelivery
+     */
+    lastAttemptAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSDelivery
+     */
+    nextRetryAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSDelivery
+     */
+    createdAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const WaaSDeliveryStatusEnum = {
+    PENDING: 'pending',
+    DELIVERING: 'delivering',
+    DELIVERED: 'delivered',
+    FAILED: 'failed',
+    RETRYING: 'retrying',
+    EXHAUSTED: 'exhausted'
+} as const;
+export type WaaSDeliveryStatusEnum = typeof WaaSDeliveryStatusEnum[keyof typeof WaaSDeliveryStatusEnum];
+
+
+/**
+ * Check if a given object implements the WaaSDelivery interface.
+ */
+export function instanceOfWaaSDelivery(value: object): value is WaaSDelivery {
+    return true;
+}
+
+export function WaaSDeliveryFromJSON(json: any): WaaSDelivery {
+    return WaaSDeliveryFromJSONTyped(json, false);
+}
+
+export function WaaSDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSDelivery {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'applicationId': json['application_id'] == null ? undefined : json['application_id'],
+        'endpointId': json['endpoint_id'] == null ? undefined : json['endpoint_id'],
+        'eventId': json['event_id'] == null ? undefined : json['event_id'],
+        'eventType': json['event_type'] == null ? undefined : json['event_type'],
+        'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'attempts': json['attempts'] == null ? undefined : json['attempts'],
+        'lastAttemptAt': json['last_attempt_at'] == null ? undefined : (new Date(json['last_attempt_at'])),
+        'nextRetryAt': json['next_retry_at'] == null ? undefined : (new Date(json['next_retry_at'])),
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+    };
+}
+
+export function WaaSDeliveryToJSON(json: any): WaaSDelivery {
+    return WaaSDeliveryToJSONTyped(json, false);
+}
+
+export function WaaSDeliveryToJSONTyped(value?: WaaSDelivery | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'application_id': value['applicationId'],
+        'endpoint_id': value['endpointId'],
+        'event_id': value['eventId'],
+        'event_type': value['eventType'],
+        'tenant_id': value['tenantId'],
+        'status': value['status'],
+        'attempts': value['attempts'],
+        'last_attempt_at': value['lastAttemptAt'] == null ? undefined : ((value['lastAttemptAt']).toISOString()),
+        'next_retry_at': value['nextRetryAt'] == null ? undefined : ((value['nextRetryAt']).toISOString()),
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+    };
+}
+

package/src/src/models/WaaSEndpoint.ts

@@ -0,0 +1,133 @@
+/* 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  ## 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WaaSEndpoint
+ */
+export interface WaaSEndpoint {
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEndpoint
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEndpoint
+     */
+    applicationId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEndpoint
+     */
+    tenantId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEndpoint
+     */
+    url?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WaaSEndpoint
+     */
+    events?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEndpoint
+     */
+    status?: WaaSEndpointStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSEndpoint
+     */
+    createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSEndpoint
+     */
+    updatedAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const WaaSEndpointStatusEnum = {
+    ACTIVE: 'active',
+    PAUSED: 'paused',
+    DISABLED: 'disabled'
+} as const;
+export type WaaSEndpointStatusEnum = typeof WaaSEndpointStatusEnum[keyof typeof WaaSEndpointStatusEnum];
+
+
+/**
+ * Check if a given object implements the WaaSEndpoint interface.
+ */
+export function instanceOfWaaSEndpoint(value: object): value is WaaSEndpoint {
+    return true;
+}
+
+export function WaaSEndpointFromJSON(json: any): WaaSEndpoint {
+    return WaaSEndpointFromJSONTyped(json, false);
+}
+
+export function WaaSEndpointFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSEndpoint {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'applicationId': json['application_id'] == null ? undefined : json['application_id'],
+        'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'events': json['events'] == null ? undefined : json['events'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+    };
+}
+
+export function WaaSEndpointToJSON(json: any): WaaSEndpoint {
+    return WaaSEndpointToJSONTyped(json, false);
+}
+
+export function WaaSEndpointToJSONTyped(value?: WaaSEndpoint | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'application_id': value['applicationId'],
+        'tenant_id': value['tenantId'],
+        'url': value['url'],
+        'events': value['events'],
+        'status': value['status'],
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'updated_at': value['updatedAt'] == null ? undefined : ((value['updatedAt']).toISOString()),
+    };
+}
+

package/src/src/models/WaaSEventType.ts

@@ -0,0 +1,148 @@
+/* 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  ## 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WaaSEventType
+ */
+export interface WaaSEventType {
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    applicationId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    eventType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    category?: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof WaaSEventType
+     */
+    examplePayload?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSEventType
+     */
+    status?: WaaSEventTypeStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSEventType
+     */
+    createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSEventType
+     */
+    updatedAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const WaaSEventTypeStatusEnum = {
+    ACTIVE: 'active',
+    DEPRECATED: 'deprecated'
+} as const;
+export type WaaSEventTypeStatusEnum = typeof WaaSEventTypeStatusEnum[keyof typeof WaaSEventTypeStatusEnum];
+
+
+/**
+ * Check if a given object implements the WaaSEventType interface.
+ */
+export function instanceOfWaaSEventType(value: object): value is WaaSEventType {
+    return true;
+}
+
+export function WaaSEventTypeFromJSON(json: any): WaaSEventType {
+    return WaaSEventTypeFromJSONTyped(json, false);
+}
+
+export function WaaSEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSEventType {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'applicationId': json['application_id'] == null ? undefined : json['application_id'],
+        'eventType': json['event_type'] == null ? undefined : json['event_type'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'category': json['category'] == null ? undefined : json['category'],
+        'examplePayload': json['example_payload'] == null ? undefined : json['example_payload'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+    };
+}
+
+export function WaaSEventTypeToJSON(json: any): WaaSEventType {
+    return WaaSEventTypeToJSONTyped(json, false);
+}
+
+export function WaaSEventTypeToJSONTyped(value?: WaaSEventType | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'application_id': value['applicationId'],
+        'event_type': value['eventType'],
+        'name': value['name'],
+        'description': value['description'],
+        'category': value['category'],
+        'example_payload': value['examplePayload'],
+        'status': value['status'],
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'updated_at': value['updatedAt'] == null ? undefined : ((value['updatedAt']).toISOString()),
+    };
+}
+

package/src/src/models/WaaSPortalTokenRequest.ts

@@ -0,0 +1,98 @@
+/* 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  ## 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { WaaSPortalTokenRequestTheme } from './WaaSPortalTokenRequestTheme';
+import {
+    WaaSPortalTokenRequestThemeFromJSON,
+    WaaSPortalTokenRequestThemeFromJSONTyped,
+    WaaSPortalTokenRequestThemeToJSON,
+    WaaSPortalTokenRequestThemeToJSONTyped,
+} from './WaaSPortalTokenRequestTheme';
+
+/**
+ * 
+ * @export
+ * @interface WaaSPortalTokenRequest
+ */
+export interface WaaSPortalTokenRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSPortalTokenRequest
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WaaSPortalTokenRequest
+     */
+    allowedEventTypes?: Array<string>;
+    /**
+     * Token TTL in seconds (default 3600)
+     * @type {number}
+     * @memberof WaaSPortalTokenRequest
+     */
+    expiresIn?: number;
+    /**
+     * 
+     * @type {WaaSPortalTokenRequestTheme}
+     * @memberof WaaSPortalTokenRequest
+     */
+    theme?: WaaSPortalTokenRequestTheme;
+}
+
+/**
+ * Check if a given object implements the WaaSPortalTokenRequest interface.
+ */
+export function instanceOfWaaSPortalTokenRequest(value: object): value is WaaSPortalTokenRequest {
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    return true;
+}
+
+export function WaaSPortalTokenRequestFromJSON(json: any): WaaSPortalTokenRequest {
+    return WaaSPortalTokenRequestFromJSONTyped(json, false);
+}
+
+export function WaaSPortalTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSPortalTokenRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tenantId': json['tenant_id'],
+        'allowedEventTypes': json['allowed_event_types'] == null ? undefined : json['allowed_event_types'],
+        'expiresIn': json['expires_in'] == null ? undefined : json['expires_in'],
+        'theme': json['theme'] == null ? undefined : WaaSPortalTokenRequestThemeFromJSON(json['theme']),
+    };
+}
+
+export function WaaSPortalTokenRequestToJSON(json: any): WaaSPortalTokenRequest {
+    return WaaSPortalTokenRequestToJSONTyped(json, false);
+}
+
+export function WaaSPortalTokenRequestToJSONTyped(value?: WaaSPortalTokenRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tenant_id': value['tenantId'],
+        'allowed_event_types': value['allowedEventTypes'],
+        'expires_in': value['expiresIn'],
+        'theme': WaaSPortalTokenRequestThemeToJSON(value['theme']),
+    };
+}
+