@zyphr-dev/node-sdk 0.1.33 → 0.1.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyphr-dev/node-sdk",
-  "version": "0.1.33",
+  "version": "0.1.34",
   "description": "Official Zyphr SDK for Node.js, React, and React Native",
   "type": "module",
   "main": "./dist/index.cjs",

package/src/.openapi-generator/FILES

@@ -19,6 +19,7 @@ src/apis/DevicesApi.ts
 src/apis/DomainsApi.ts
 src/apis/EmailsApi.ts
 src/apis/ExecutionsApi.ts
+src/apis/InboundEmailApi.ts
 src/apis/InboxApi.ts
 src/apis/MuseApi.ts
 src/apis/PushApi.ts
@@ -153,6 +154,14 @@ src/models/GetDomain200ResponseMeta.ts
 src/models/GetWaaSEndpoint200Response.ts
 src/models/GetWaaSUsage200Response.ts
 src/models/InAppNotification.ts
+src/models/InboundAttachmentUrlResponse.ts
+src/models/InboundAttachmentUrlResponseData.ts
+src/models/InboundEmail.ts
+src/models/InboundEmailAttachment.ts
+src/models/InboundEmailFrom.ts
+src/models/InboundEmailListResponse.ts
+src/models/InboundEmailListResponseMeta.ts
+src/models/InboundEmailResponse.ts
 src/models/InboxListMeta.ts
 src/models/InboxListResponse.ts
 src/models/InboxNotificationResponse.ts
@@ -300,6 +309,7 @@ src/models/SendWebhookTestEventRequest.ts
 src/models/SessionListResponse.ts
 src/models/SessionListResponseData.ts
 src/models/SessionListResponseDataSessionInfo.ts
+src/models/SetDomainInboundRequest.ts
 src/models/SetPreferencesRequest.ts
 src/models/SetPreferencesRequestPreferencesInner.ts
 src/models/SignInAnonymouslyRequest.ts

package/src/client.ts

@@ -31,6 +31,7 @@ import {
   DevicesApi,
   DomainsApi,
   EmailsApi,
+  InboundEmailApi,
   InboxApi,
   PushApi,
   SlackApi,
@@ -84,6 +85,8 @@ export class Zyphr {
   readonly topics: TopicsApi;
   readonly devices: DevicesApi;
   readonly domains: DomainsApi;
+  /** Inbound (received) email — read access. Requires the `email:read` scope. */
+  readonly inbound: InboundEmailApi;
 
   readonly waas: {
     readonly applications: WaaSApplicationsApi;
@@ -135,6 +138,7 @@ export class Zyphr {
     this.topics = new TopicsApi(config);
     this.devices = new DevicesApi(config);
     this.domains = new DomainsApi(config);
+    this.inbound = new InboundEmailApi(config);
 
     this.waas = {
       applications: new WaaSApplicationsApi(config),

package/src/src/apis/DomainsApi.ts

@@ -21,6 +21,7 @@ import type {
   DeleteDomainResponse,
   DomainListResponse,
   GetDomain200Response,
+  SetDomainInboundRequest,
   VerificationStatusResponse,
   VerifyDomainResponse,
 } from '../models/index';
@@ -37,6 +38,8 @@ import {
     DomainListResponseToJSON,
     GetDomain200ResponseFromJSON,
     GetDomain200ResponseToJSON,
+    SetDomainInboundRequestFromJSON,
+    SetDomainInboundRequestToJSON,
     VerificationStatusResponseFromJSON,
     VerificationStatusResponseToJSON,
     VerifyDomainResponseFromJSON,
@@ -59,6 +62,11 @@ export interface DomainsApiGetDomainVerificationStatusRequest {
     id: string;
 }
 
+export interface DomainsApiSetDomainInboundOperationRequest {
+    id: string;
+    setDomainInboundRequest: SetDomainInboundRequest;
+}
+
 export interface DomainsApiVerifyDomainRequest {
     id: string;
 }
@@ -149,6 +157,23 @@ export interface DomainsApiInterface {
      */
     listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainListResponse>;
 
+    /**
+     * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+     * @summary Enable or disable inbound email for a domain
+     * @param {string} id 
+     * @param {SetDomainInboundRequest} setDomainInboundRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DomainsApiInterface
+     */
+    setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+     * Enable or disable inbound email for a domain
+     */
+    setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships.  Returns 409 if a verification is already in progress for this domain (within the last 2 minutes). 
      * @summary Trigger domain verification
@@ -363,6 +388,54 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+     * Enable or disable inbound email for a domain
+     */
+    async setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling setDomainInbound().'
+            );
+        }
+
+        if (requestParameters['setDomainInboundRequest'] == null) {
+            throw new runtime.RequiredError(
+                'setDomainInboundRequest',
+                'Required parameter "setDomainInboundRequest" was null or undefined when calling setDomainInbound().'
+            );
+        }
+
+        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: `/domains/{id}/inbound`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SetDomainInboundRequestToJSON(requestParameters['setDomainInboundRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+     * Enable or disable inbound email for a domain
+     */
+    async setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.setDomainInboundRaw({ id: id, setDomainInboundRequest: setDomainInboundRequest }, initOverrides);
+    }
+
     /**
      * Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships.  Returns 409 if a verification is already in progress for this domain (within the last 2 minutes). 
      * Trigger domain verification

package/src/src/apis/InboundEmailApi.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 {
+  InboundAttachmentUrlResponse,
+  InboundEmailListResponse,
+  InboundEmailResponse,
+} from '../models/index';
+import {
+    InboundAttachmentUrlResponseFromJSON,
+    InboundAttachmentUrlResponseToJSON,
+    InboundEmailListResponseFromJSON,
+    InboundEmailListResponseToJSON,
+    InboundEmailResponseFromJSON,
+    InboundEmailResponseToJSON,
+} from '../models/index';
+
+export interface InboundEmailApiGetInboundAttachmentUrlRequest {
+    id: string;
+    attachmentId: string;
+}
+
+export interface InboundEmailApiGetInboundEmailRequest {
+    id: string;
+}
+
+export interface InboundEmailApiListInboundEmailsRequest {
+    status?: ListInboundEmailsStatusEnum;
+    to?: string;
+    includeWithheld?: boolean;
+    limit?: number;
+    offset?: number;
+}
+
+/**
+ * InboundEmailApi - interface
+ * 
+ * @export
+ * @interface InboundEmailApiInterface
+ */
+export interface InboundEmailApiInterface {
+    /**
+     * Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array. 
+     * @summary Get an attachment download URL
+     * @param {string} id 
+     * @param {string} attachmentId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InboundEmailApiInterface
+     */
+    getInboundAttachmentUrlRaw(requestParameters: InboundEmailApiGetInboundAttachmentUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundAttachmentUrlResponse>>;
+
+    /**
+     * Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array. 
+     * Get an attachment download URL
+     */
+    getInboundAttachmentUrl(id: string, attachmentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundAttachmentUrlResponse>;
+
+    /**
+     * Retrieve a single inbound email by id (scoped to the project).
+     * @summary Get a received email
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InboundEmailApiInterface
+     */
+    getInboundEmailRaw(requestParameters: InboundEmailApiGetInboundEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundEmailResponse>>;
+
+    /**
+     * Retrieve a single inbound email by id (scoped to the project).
+     * Get a received email
+     */
+    getInboundEmail(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundEmailResponse>;
+
+    /**
+     * List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
+     * @summary List received emails
+     * @param {'received' | 'processed' | 'quarantined' | 'dropped' | 'failed'} [status] 
+     * @param {string} [to] Filter by receiving address
+     * @param {boolean} [includeWithheld] Include quarantined/dropped mail
+     * @param {number} [limit] 
+     * @param {number} [offset] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InboundEmailApiInterface
+     */
+    listInboundEmailsRaw(requestParameters: InboundEmailApiListInboundEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundEmailListResponse>>;
+
+    /**
+     * List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
+     * List received emails
+     */
+    listInboundEmails(status?: ListInboundEmailsStatusEnum, to?: string, includeWithheld?: boolean, limit?: number, offset?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundEmailListResponse>;
+
+}
+
+/**
+ * 
+ */
+export class InboundEmailApi extends runtime.BaseAPI implements InboundEmailApiInterface {
+
+    /**
+     * Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array. 
+     * Get an attachment download URL
+     */
+    async getInboundAttachmentUrlRaw(requestParameters: InboundEmailApiGetInboundAttachmentUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundAttachmentUrlResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getInboundAttachmentUrl().'
+            );
+        }
+
+        if (requestParameters['attachmentId'] == null) {
+            throw new runtime.RequiredError(
+                'attachmentId',
+                'Required parameter "attachmentId" was null or undefined when calling getInboundAttachmentUrl().'
+            );
+        }
+
+        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: `/inbound-emails/{id}/attachments/{attachmentId}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))).replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters['attachmentId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InboundAttachmentUrlResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array. 
+     * Get an attachment download URL
+     */
+    async getInboundAttachmentUrl(id: string, attachmentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundAttachmentUrlResponse> {
+        const response = await this.getInboundAttachmentUrlRaw({ id: id, attachmentId: attachmentId }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a single inbound email by id (scoped to the project).
+     * Get a received email
+     */
+    async getInboundEmailRaw(requestParameters: InboundEmailApiGetInboundEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundEmailResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getInboundEmail().'
+            );
+        }
+
+        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: `/inbound-emails/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InboundEmailResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a single inbound email by id (scoped to the project).
+     * Get a received email
+     */
+    async getInboundEmail(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundEmailResponse> {
+        const response = await this.getInboundEmailRaw({ id: id }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
+     * List received emails
+     */
+    async listInboundEmailsRaw(requestParameters: InboundEmailApiListInboundEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundEmailListResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = requestParameters['to'];
+        }
+
+        if (requestParameters['includeWithheld'] != null) {
+            queryParameters['include_withheld'] = requestParameters['includeWithheld'];
+        }
+
+        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: `/inbound-emails`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InboundEmailListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
+     * List received emails
+     */
+    async listInboundEmails(status?: ListInboundEmailsStatusEnum, to?: string, includeWithheld?: boolean, limit?: number, offset?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundEmailListResponse> {
+        const response = await this.listInboundEmailsRaw({ status: status, to: to, includeWithheld: includeWithheld, limit: limit, offset: offset }, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListInboundEmailsStatusEnum = {
+    RECEIVED: 'received',
+    PROCESSED: 'processed',
+    QUARANTINED: 'quarantined',
+    DROPPED: 'dropped',
+    FAILED: 'failed'
+} as const;
+export type ListInboundEmailsStatusEnum = typeof ListInboundEmailsStatusEnum[keyof typeof ListInboundEmailsStatusEnum];

package/src/src/apis/index.ts

@@ -17,6 +17,7 @@ export * from './DevicesApi';
 export * from './DomainsApi';
 export * from './EmailsApi';
 export * from './ExecutionsApi';
+export * from './InboundEmailApi';
 export * from './InboxApi';
 export * from './MuseApi';
 export * from './PushApi';

package/src/src/models/InboundAttachmentUrlResponse.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 { InboundAttachmentUrlResponseData } from './InboundAttachmentUrlResponseData';
+import {
+    InboundAttachmentUrlResponseDataFromJSON,
+    InboundAttachmentUrlResponseDataFromJSONTyped,
+    InboundAttachmentUrlResponseDataToJSON,
+    InboundAttachmentUrlResponseDataToJSONTyped,
+} from './InboundAttachmentUrlResponseData';
+import type { RequestMeta } from './RequestMeta';
+import {
+    RequestMetaFromJSON,
+    RequestMetaFromJSONTyped,
+    RequestMetaToJSON,
+    RequestMetaToJSONTyped,
+} from './RequestMeta';
+
+/**
+ * 
+ * @export
+ * @interface InboundAttachmentUrlResponse
+ */
+export interface InboundAttachmentUrlResponse {
+    /**
+     * 
+     * @type {InboundAttachmentUrlResponseData}
+     * @memberof InboundAttachmentUrlResponse
+     */
+    data?: InboundAttachmentUrlResponseData;
+    /**
+     * 
+     * @type {RequestMeta}
+     * @memberof InboundAttachmentUrlResponse
+     */
+    meta?: RequestMeta;
+}
+
+/**
+ * Check if a given object implements the InboundAttachmentUrlResponse interface.
+ */
+export function instanceOfInboundAttachmentUrlResponse(value: object): value is InboundAttachmentUrlResponse {
+    return true;
+}
+
+export function InboundAttachmentUrlResponseFromJSON(json: any): InboundAttachmentUrlResponse {
+    return InboundAttachmentUrlResponseFromJSONTyped(json, false);
+}
+
+export function InboundAttachmentUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): InboundAttachmentUrlResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : InboundAttachmentUrlResponseDataFromJSON(json['data']),
+        'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
+    };
+}
+
+export function InboundAttachmentUrlResponseToJSON(json: any): InboundAttachmentUrlResponse {
+    return InboundAttachmentUrlResponseToJSONTyped(json, false);
+}
+
+export function InboundAttachmentUrlResponseToJSONTyped(value?: InboundAttachmentUrlResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': InboundAttachmentUrlResponseDataToJSON(value['data']),
+        'meta': RequestMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/InboundAttachmentUrlResponseData.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 InboundAttachmentUrlResponseData
+ */
+export interface InboundAttachmentUrlResponseData {
+    /**
+     * Short-lived presigned S3 download URL
+     * @type {string}
+     * @memberof InboundAttachmentUrlResponseData
+     */
+    downloadUrl?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof InboundAttachmentUrlResponseData
+     */
+    filename?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof InboundAttachmentUrlResponseData
+     */
+    contentType?: string;
+}
+
+/**
+ * Check if a given object implements the InboundAttachmentUrlResponseData interface.
+ */
+export function instanceOfInboundAttachmentUrlResponseData(value: object): value is InboundAttachmentUrlResponseData {
+    return true;
+}
+
+export function InboundAttachmentUrlResponseDataFromJSON(json: any): InboundAttachmentUrlResponseData {
+    return InboundAttachmentUrlResponseDataFromJSONTyped(json, false);
+}
+
+export function InboundAttachmentUrlResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): InboundAttachmentUrlResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
+        'filename': json['filename'] == null ? undefined : json['filename'],
+        'contentType': json['content_type'] == null ? undefined : json['content_type'],
+    };
+}
+
+export function InboundAttachmentUrlResponseDataToJSON(json: any): InboundAttachmentUrlResponseData {
+    return InboundAttachmentUrlResponseDataToJSONTyped(json, false);
+}
+
+export function InboundAttachmentUrlResponseDataToJSONTyped(value?: InboundAttachmentUrlResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'download_url': value['downloadUrl'],
+        'filename': value['filename'],
+        'content_type': value['contentType'],
+    };
+}
+