@zyphr-dev/node-sdk 0.1.18 → 0.1.20

package/src/src/models/SlackMessageListResponseMeta.ts

@@ -0,0 +1,89 @@
+/* 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 SlackMessageListResponseMeta
+ */
+export interface SlackMessageListResponseMeta {
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageListResponseMeta
+     */
+    requestId?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlackMessageListResponseMeta
+     */
+    total?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlackMessageListResponseMeta
+     */
+    limit?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlackMessageListResponseMeta
+     */
+    offset?: number;
+}
+
+/**
+ * Check if a given object implements the SlackMessageListResponseMeta interface.
+ */
+export function instanceOfSlackMessageListResponseMeta(value: object): value is SlackMessageListResponseMeta {
+    return true;
+}
+
+export function SlackMessageListResponseMetaFromJSON(json: any): SlackMessageListResponseMeta {
+    return SlackMessageListResponseMetaFromJSONTyped(json, false);
+}
+
+export function SlackMessageListResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlackMessageListResponseMeta {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+        'total': json['total'] == null ? undefined : json['total'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+        'offset': json['offset'] == null ? undefined : json['offset'],
+    };
+}
+
+export function SlackMessageListResponseMetaToJSON(json: any): SlackMessageListResponseMeta {
+    return SlackMessageListResponseMetaToJSONTyped(json, false);
+}
+
+export function SlackMessageListResponseMetaToJSONTyped(value?: SlackMessageListResponseMeta | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'request_id': value['requestId'],
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+

package/src/src/models/SlackMessageResponse.ts

@@ -0,0 +1,88 @@
+/* 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 { RequestMeta } from './RequestMeta';
+import {
+    RequestMetaFromJSON,
+    RequestMetaFromJSONTyped,
+    RequestMetaToJSON,
+    RequestMetaToJSONTyped,
+} from './RequestMeta';
+import type { SlackMessage } from './SlackMessage';
+import {
+    SlackMessageFromJSON,
+    SlackMessageFromJSONTyped,
+    SlackMessageToJSON,
+    SlackMessageToJSONTyped,
+} from './SlackMessage';
+
+/**
+ * 
+ * @export
+ * @interface SlackMessageResponse
+ */
+export interface SlackMessageResponse {
+    /**
+     * 
+     * @type {SlackMessage}
+     * @memberof SlackMessageResponse
+     */
+    data?: SlackMessage;
+    /**
+     * 
+     * @type {RequestMeta}
+     * @memberof SlackMessageResponse
+     */
+    meta?: RequestMeta;
+}
+
+/**
+ * Check if a given object implements the SlackMessageResponse interface.
+ */
+export function instanceOfSlackMessageResponse(value: object): value is SlackMessageResponse {
+    return true;
+}
+
+export function SlackMessageResponseFromJSON(json: any): SlackMessageResponse {
+    return SlackMessageResponseFromJSONTyped(json, false);
+}
+
+export function SlackMessageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlackMessageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : SlackMessageFromJSON(json['data']),
+        'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
+    };
+}
+
+export function SlackMessageResponseToJSON(json: any): SlackMessageResponse {
+    return SlackMessageResponseToJSONTyped(json, false);
+}
+
+export function SlackMessageResponseToJSONTyped(value?: SlackMessageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': SlackMessageToJSON(value['data']),
+        'meta': RequestMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/SlackMessageStatus.ts

@@ -0,0 +1,56 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const SlackMessageStatus = {
+    QUEUED: 'queued',
+    SENDING: 'sending',
+    SENT: 'sent',
+    DELIVERED: 'delivered',
+    FAILED: 'failed'
+} as const;
+export type SlackMessageStatus = typeof SlackMessageStatus[keyof typeof SlackMessageStatus];
+
+
+export function instanceOfSlackMessageStatus(value: any): boolean {
+    for (const key in SlackMessageStatus) {
+        if (Object.prototype.hasOwnProperty.call(SlackMessageStatus, key)) {
+            if (SlackMessageStatus[key as keyof typeof SlackMessageStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SlackMessageStatusFromJSON(json: any): SlackMessageStatus {
+    return SlackMessageStatusFromJSONTyped(json, false);
+}
+
+export function SlackMessageStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlackMessageStatus {
+    return json as SlackMessageStatus;
+}
+
+export function SlackMessageStatusToJSON(value?: SlackMessageStatus | null): any {
+    return value as any;
+}
+
+export function SlackMessageStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): SlackMessageStatus {
+    return value as SlackMessageStatus;
+}
+

package/src/src/models/SlackMessageSummary.ts

@@ -0,0 +1,155 @@
+/* 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 { SlackMessageStatus } from './SlackMessageStatus';
+import {
+    SlackMessageStatusFromJSON,
+    SlackMessageStatusFromJSONTyped,
+    SlackMessageStatusToJSON,
+    SlackMessageStatusToJSONTyped,
+} from './SlackMessageStatus';
+
+/**
+ * 
+ * @export
+ * @interface SlackMessageSummary
+ */
+export interface SlackMessageSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    slackConnectionId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    channelId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    channelName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    text?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    messageTs?: string | null;
+    /**
+     * 
+     * @type {SlackMessageStatus}
+     * @memberof SlackMessageSummary
+     */
+    status?: SlackMessageStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlackMessageSummary
+     */
+    statusReason?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof SlackMessageSummary
+     */
+    tags?: Array<string> | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SlackMessageSummary
+     */
+    createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SlackMessageSummary
+     */
+    sentAt?: Date | null;
+}
+
+
+
+/**
+ * Check if a given object implements the SlackMessageSummary interface.
+ */
+export function instanceOfSlackMessageSummary(value: object): value is SlackMessageSummary {
+    return true;
+}
+
+export function SlackMessageSummaryFromJSON(json: any): SlackMessageSummary {
+    return SlackMessageSummaryFromJSONTyped(json, false);
+}
+
+export function SlackMessageSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlackMessageSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'slackConnectionId': json['slack_connection_id'] == null ? undefined : json['slack_connection_id'],
+        'channelId': json['channel_id'] == null ? undefined : json['channel_id'],
+        'channelName': json['channel_name'] == null ? undefined : json['channel_name'],
+        'text': json['text'] == null ? undefined : json['text'],
+        'messageTs': json['message_ts'] == null ? undefined : json['message_ts'],
+        'status': json['status'] == null ? undefined : SlackMessageStatusFromJSON(json['status']),
+        'statusReason': json['status_reason'] == null ? undefined : json['status_reason'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'sentAt': json['sent_at'] == null ? undefined : (new Date(json['sent_at'])),
+    };
+}
+
+export function SlackMessageSummaryToJSON(json: any): SlackMessageSummary {
+    return SlackMessageSummaryToJSONTyped(json, false);
+}
+
+export function SlackMessageSummaryToJSONTyped(value?: SlackMessageSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'slack_connection_id': value['slackConnectionId'],
+        'channel_id': value['channelId'],
+        'channel_name': value['channelName'],
+        'text': value['text'],
+        'message_ts': value['messageTs'],
+        'status': SlackMessageStatusToJSON(value['status']),
+        'status_reason': value['statusReason'],
+        'tags': value['tags'],
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'sent_at': value['sentAt'] == null ? undefined : ((value['sentAt'] as any).toISOString()),
+    };
+}
+

package/src/src/models/SuccessResult.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SuccessResultData } from './SuccessResultData';
+import type { AuthEmailTemplateDeleteResponseData } from './AuthEmailTemplateDeleteResponseData';
 import {
-    SuccessResultDataFromJSON,
-    SuccessResultDataFromJSONTyped,
-    SuccessResultDataToJSON,
-    SuccessResultDataToJSONTyped,
-} from './SuccessResultData';
+    AuthEmailTemplateDeleteResponseDataFromJSON,
+    AuthEmailTemplateDeleteResponseDataFromJSONTyped,
+    AuthEmailTemplateDeleteResponseDataToJSON,
+    AuthEmailTemplateDeleteResponseDataToJSONTyped,
+} from './AuthEmailTemplateDeleteResponseData';
 import type { RequestMeta } from './RequestMeta';
 import {
     RequestMetaFromJSON,
@@ -36,10 +36,10 @@ import {
 export interface SuccessResult {
     /**
      * 
-     * @type {SuccessResultData}
+     * @type {AuthEmailTemplateDeleteResponseData}
      * @memberof SuccessResult
      */
-    data?: SuccessResultData;
+    data?: AuthEmailTemplateDeleteResponseData;
     /**
      * 
      * @type {RequestMeta}
@@ -65,7 +65,7 @@ export function SuccessResultFromJSONTyped(json: any, ignoreDiscriminator: boole
     }
     return {
         
-        'data': json['data'] == null ? undefined : SuccessResultDataFromJSON(json['data']),
+        'data': json['data'] == null ? undefined : AuthEmailTemplateDeleteResponseDataFromJSON(json['data']),
         'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
     };
 }
@@ -81,7 +81,7 @@ export function SuccessResultToJSONTyped(value?: SuccessResult | null, ignoreDis
 
     return {
         
-        'data': SuccessResultDataToJSON(value['data']),
+        'data': AuthEmailTemplateDeleteResponseDataToJSON(value['data']),
         'meta': RequestMetaToJSON(value['meta']),
     };
 }

package/src/src/models/UpsertAuthEmailTemplateRequest.ts

@@ -0,0 +1,143 @@
+/* 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';
+/**
+ * Subject is required. Provide one of `html`, `mjml_source`, or `design_json`.
+ * MJML sources are compiled to HTML on save.
+ * 
+ * @export
+ * @interface UpsertAuthEmailTemplateRequest
+ */
+export interface UpsertAuthEmailTemplateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    subject?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    html?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    text?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    mjmlSource?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    designJson?: { [key: string]: any; } | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    editorType?: UpsertAuthEmailTemplateRequestEditorTypeEnum | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    fromName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    replyTo?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpsertAuthEmailTemplateRequest
+     */
+    isEnabled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const UpsertAuthEmailTemplateRequestEditorTypeEnum = {
+    CODE: 'code',
+    MJML: 'mjml',
+    DESIGN: 'design'
+} as const;
+export type UpsertAuthEmailTemplateRequestEditorTypeEnum = typeof UpsertAuthEmailTemplateRequestEditorTypeEnum[keyof typeof UpsertAuthEmailTemplateRequestEditorTypeEnum];
+
+
+/**
+ * Check if a given object implements the UpsertAuthEmailTemplateRequest interface.
+ */
+export function instanceOfUpsertAuthEmailTemplateRequest(value: object): value is UpsertAuthEmailTemplateRequest {
+    return true;
+}
+
+export function UpsertAuthEmailTemplateRequestFromJSON(json: any): UpsertAuthEmailTemplateRequest {
+    return UpsertAuthEmailTemplateRequestFromJSONTyped(json, false);
+}
+
+export function UpsertAuthEmailTemplateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertAuthEmailTemplateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subject': json['subject'] == null ? undefined : json['subject'],
+        'html': json['html'] == null ? undefined : json['html'],
+        'text': json['text'] == null ? undefined : json['text'],
+        'mjmlSource': json['mjml_source'] == null ? undefined : json['mjml_source'],
+        'designJson': json['design_json'] == null ? undefined : json['design_json'],
+        'editorType': json['editor_type'] == null ? undefined : json['editor_type'],
+        'fromName': json['from_name'] == null ? undefined : json['from_name'],
+        'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
+        'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
+    };
+}
+
+export function UpsertAuthEmailTemplateRequestToJSON(json: any): UpsertAuthEmailTemplateRequest {
+    return UpsertAuthEmailTemplateRequestToJSONTyped(json, false);
+}
+
+export function UpsertAuthEmailTemplateRequestToJSONTyped(value?: UpsertAuthEmailTemplateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subject': value['subject'],
+        'html': value['html'],
+        'text': value['text'],
+        'mjml_source': value['mjmlSource'],
+        'design_json': value['designJson'],
+        'editor_type': value['editorType'],
+        'from_name': value['fromName'],
+        'reply_to': value['replyTo'],
+        'is_enabled': value['isEnabled'],
+    };
+}
+