@zyphr-dev/node-sdk 0.1.18 → 0.1.20

package/src/src/apis/ExecutionsApi.ts

@@ -0,0 +1,225 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ApiError,
+  ExecutionCancelResponse,
+  ExecutionResponse,
+  ExecutionRetryResponse,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    ExecutionCancelResponseFromJSON,
+    ExecutionCancelResponseToJSON,
+    ExecutionResponseFromJSON,
+    ExecutionResponseToJSON,
+    ExecutionRetryResponseFromJSON,
+    ExecutionRetryResponseToJSON,
+} from '../models/index';
+
+export interface ExecutionsApiCancelExecutionRequest {
+    id: string;
+}
+
+export interface ExecutionsApiGetExecutionRequest {
+    id: string;
+}
+
+export interface ExecutionsApiRetryExecutionRequest {
+    id: string;
+}
+
+/**
+ * ExecutionsApi - interface
+ * 
+ * @export
+ * @interface ExecutionsApiInterface
+ */
+export interface ExecutionsApiInterface {
+    /**
+     * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+     * @summary Cancel a running execution
+     * @param {string} id Execution ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExecutionsApiInterface
+     */
+    cancelExecutionRaw(requestParameters: ExecutionsApiCancelExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionCancelResponse>>;
+
+    /**
+     * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+     * Cancel a running execution
+     */
+    cancelExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionCancelResponse>;
+
+    /**
+     * Retrieve a workflow execution by ID, including its step execution details.
+     * @summary Get a workflow execution
+     * @param {string} id Execution ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExecutionsApiInterface
+     */
+    getExecutionRaw(requestParameters: ExecutionsApiGetExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionResponse>>;
+
+    /**
+     * Retrieve a workflow execution by ID, including its step execution details.
+     * Get a workflow execution
+     */
+    getExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionResponse>;
+
+    /**
+     * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+     * @summary Retry a failed or cancelled execution
+     * @param {string} id ID of the execution to retry
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExecutionsApiInterface
+     */
+    retryExecutionRaw(requestParameters: ExecutionsApiRetryExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionRetryResponse>>;
+
+    /**
+     * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+     * Retry a failed or cancelled execution
+     */
+    retryExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionRetryResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ExecutionsApi extends runtime.BaseAPI implements ExecutionsApiInterface {
+
+    /**
+     * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+     * Cancel a running execution
+     */
+    async cancelExecutionRaw(requestParameters: ExecutionsApiCancelExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionCancelResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling cancelExecution().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/executions/{id}/cancel`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExecutionCancelResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+     * Cancel a running execution
+     */
+    async cancelExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionCancelResponse> {
+        const response = await this.cancelExecutionRaw({ id: id }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a workflow execution by ID, including its step execution details.
+     * Get a workflow execution
+     */
+    async getExecutionRaw(requestParameters: ExecutionsApiGetExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getExecution().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/executions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExecutionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a workflow execution by ID, including its step execution details.
+     * Get a workflow execution
+     */
+    async getExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionResponse> {
+        const response = await this.getExecutionRaw({ id: id }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+     * Retry a failed or cancelled execution
+     */
+    async retryExecutionRaw(requestParameters: ExecutionsApiRetryExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExecutionRetryResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling retryExecution().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/executions/{id}/retry`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExecutionRetryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+     * Retry a failed or cancelled execution
+     */
+    async retryExecution(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExecutionRetryResponse> {
+        const response = await this.retryExecutionRaw({ id: id }, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/src/apis/SlackApi.ts

@@ -0,0 +1,264 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ApiError,
+  SendSlackMessageRequest,
+  SendSlackMessageResponse,
+  SlackMessageListResponse,
+  SlackMessageResponse,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    SendSlackMessageRequestFromJSON,
+    SendSlackMessageRequestToJSON,
+    SendSlackMessageResponseFromJSON,
+    SendSlackMessageResponseToJSON,
+    SlackMessageListResponseFromJSON,
+    SlackMessageListResponseToJSON,
+    SlackMessageResponseFromJSON,
+    SlackMessageResponseToJSON,
+} from '../models/index';
+
+export interface SlackApiGetSlackMessageRequest {
+    id: string;
+}
+
+export interface SlackApiListSlackMessagesRequest {
+    connectionId?: string;
+    channelId?: string;
+    status?: ListSlackMessagesStatusEnum;
+    limit?: number;
+    offset?: number;
+}
+
+export interface SlackApiSendSlackMessageOperationRequest {
+    sendSlackMessageRequest: SendSlackMessageRequest;
+}
+
+/**
+ * SlackApi - interface
+ * 
+ * @export
+ * @interface SlackApiInterface
+ */
+export interface SlackApiInterface {
+    /**
+     * Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+     * @summary Get a Slack message
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SlackApiInterface
+     */
+    getSlackMessageRaw(requestParameters: SlackApiGetSlackMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SlackMessageResponse>>;
+
+    /**
+     * Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+     * Get a Slack message
+     */
+    getSlackMessage(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SlackMessageResponse>;
+
+    /**
+     * List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+     * @summary List Slack messages
+     * @param {string} [connectionId] Filter by Slack connection ID.
+     * @param {string} [channelId] Filter by Slack channel ID.
+     * @param {'queued' | 'sending' | 'sent' | 'delivered' | 'failed'} [status] Filter by message status.
+     * @param {number} [limit] 
+     * @param {number} [offset] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SlackApiInterface
+     */
+    listSlackMessagesRaw(requestParameters: SlackApiListSlackMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SlackMessageListResponse>>;
+
+    /**
+     * List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+     * List Slack messages
+     */
+    listSlackMessages(connectionId?: string, channelId?: string, status?: ListSlackMessagesStatusEnum, limit?: number, offset?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SlackMessageListResponse>;
+
+    /**
+     * Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project\'s active Slack connection is used. If `channel` is omitted, the connection\'s default channel is used. 
+     * @summary Send a Slack message
+     * @param {SendSlackMessageRequest} sendSlackMessageRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SlackApiInterface
+     */
+    sendSlackMessageRaw(requestParameters: SlackApiSendSlackMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSlackMessageResponse>>;
+
+    /**
+     * Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project\'s active Slack connection is used. If `channel` is omitted, the connection\'s default channel is used. 
+     * Send a Slack message
+     */
+    sendSlackMessage(sendSlackMessageRequest: SendSlackMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSlackMessageResponse>;
+
+}
+
+/**
+ * 
+ */
+export class SlackApi extends runtime.BaseAPI implements SlackApiInterface {
+
+    /**
+     * Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+     * Get a Slack message
+     */
+    async getSlackMessageRaw(requestParameters: SlackApiGetSlackMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SlackMessageResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getSlackMessage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/slack/messages/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SlackMessageResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+     * Get a Slack message
+     */
+    async getSlackMessage(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SlackMessageResponse> {
+        const response = await this.getSlackMessageRaw({ id: id }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+     * List Slack messages
+     */
+    async listSlackMessagesRaw(requestParameters: SlackApiListSlackMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SlackMessageListResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['connectionId'] != null) {
+            queryParameters['connection_id'] = requestParameters['connectionId'];
+        }
+
+        if (requestParameters['channelId'] != null) {
+            queryParameters['channel_id'] = requestParameters['channelId'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/slack/messages`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SlackMessageListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+     * List Slack messages
+     */
+    async listSlackMessages(connectionId?: string, channelId?: string, status?: ListSlackMessagesStatusEnum, limit?: number, offset?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SlackMessageListResponse> {
+        const response = await this.listSlackMessagesRaw({ connectionId: connectionId, channelId: channelId, status: status, limit: limit, offset: offset }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project\'s active Slack connection is used. If `channel` is omitted, the connection\'s default channel is used. 
+     * Send a Slack message
+     */
+    async sendSlackMessageRaw(requestParameters: SlackApiSendSlackMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSlackMessageResponse>> {
+        if (requestParameters['sendSlackMessageRequest'] == null) {
+            throw new runtime.RequiredError(
+                'sendSlackMessageRequest',
+                'Required parameter "sendSlackMessageRequest" was null or undefined when calling sendSlackMessage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/slack/send`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SendSlackMessageRequestToJSON(requestParameters['sendSlackMessageRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SendSlackMessageResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project\'s active Slack connection is used. If `channel` is omitted, the connection\'s default channel is used. 
+     * Send a Slack message
+     */
+    async sendSlackMessage(sendSlackMessageRequest: SendSlackMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSlackMessageResponse> {
+        const response = await this.sendSlackMessageRaw({ sendSlackMessageRequest: sendSlackMessageRequest }, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListSlackMessagesStatusEnum = {
+    QUEUED: 'queued',
+    SENDING: 'sending',
+    SENT: 'sent',
+    DELIVERED: 'delivered',
+    FAILED: 'failed'
+} as const;
+export type ListSlackMessagesStatusEnum = typeof ListSlackMessagesStatusEnum[keyof typeof ListSlackMessagesStatusEnum];

package/src/src/apis/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AuthEmailTemplatesApi';
 export * from './AuthEmailVerificationApi';
 export * from './AuthLoginApi';
 export * from './AuthMFAApi';
@@ -13,9 +14,11 @@ export * from './AuthUserProfileApi';
 export * from './AuthWebAuthnApi';
 export * from './DevicesApi';
 export * from './EmailsApi';
+export * from './ExecutionsApi';
 export * from './InboxApi';
 export * from './PushApi';
 export * from './SMSApi';
+export * from './SlackApi';
 export * from './SubscribersApi';
 export * from './TemplatesApi';
 export * from './TopicsApi';

package/src/src/models/AuthEmailTemplate.ts

@@ -0,0 +1,181 @@
+/* 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 { AuthEmailType } from './AuthEmailType';
+import {
+    AuthEmailTypeFromJSON,
+    AuthEmailTypeFromJSONTyped,
+    AuthEmailTypeToJSON,
+    AuthEmailTypeToJSONTyped,
+} from './AuthEmailType';
+
+/**
+ * 
+ * @export
+ * @interface AuthEmailTemplate
+ */
+export interface AuthEmailTemplate {
+    /**
+     * 
+     * @type {AuthEmailType}
+     * @memberof AuthEmailTemplate
+     */
+    emailType?: AuthEmailType;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    subject?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    html?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    text?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    mjmlSource?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof AuthEmailTemplate
+     */
+    designJson?: { [key: string]: any; } | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    editorType?: AuthEmailTemplateEditorTypeEnum | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    fromName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthEmailTemplate
+     */
+    replyTo?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AuthEmailTemplate
+     */
+    isEnabled?: boolean;
+    /**
+     * True when the system default is being returned (no override exists)
+     * @type {boolean}
+     * @memberof AuthEmailTemplate
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AuthEmailTemplate
+     */
+    hasOverride?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof AuthEmailTemplate
+     */
+    version?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const AuthEmailTemplateEditorTypeEnum = {
+    CODE: 'code',
+    MJML: 'mjml',
+    DESIGN: 'design'
+} as const;
+export type AuthEmailTemplateEditorTypeEnum = typeof AuthEmailTemplateEditorTypeEnum[keyof typeof AuthEmailTemplateEditorTypeEnum];
+
+
+/**
+ * Check if a given object implements the AuthEmailTemplate interface.
+ */
+export function instanceOfAuthEmailTemplate(value: object): value is AuthEmailTemplate {
+    return true;
+}
+
+export function AuthEmailTemplateFromJSON(json: any): AuthEmailTemplate {
+    return AuthEmailTemplateFromJSONTyped(json, false);
+}
+
+export function AuthEmailTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthEmailTemplate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'emailType': json['email_type'] == null ? undefined : AuthEmailTypeFromJSON(json['email_type']),
+        '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'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'hasOverride': json['has_override'] == null ? undefined : json['has_override'],
+        'version': json['version'] == null ? undefined : json['version'],
+    };
+}
+
+export function AuthEmailTemplateToJSON(json: any): AuthEmailTemplate {
+    return AuthEmailTemplateToJSONTyped(json, false);
+}
+
+export function AuthEmailTemplateToJSONTyped(value?: AuthEmailTemplate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email_type': AuthEmailTypeToJSON(value['emailType']),
+        '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'],
+        'is_default': value['isDefault'],
+        'has_override': value['hasOverride'],
+        'version': value['version'],
+    };
+}
+