@zyphr-dev/node-sdk 0.1.33 → 0.1.35

package/package.json

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

package/src/.openapi-generator/FILES

@@ -2,6 +2,7 @@
 .npmignore
 README.md
 package.json
+src/apis/AuthEmailOTPApi.ts
 src/apis/AuthEmailTemplatesApi.ts
 src/apis/AuthEmailVerificationApi.ts
 src/apis/AuthLoginApi.ts
@@ -19,6 +20,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
@@ -80,6 +82,8 @@ src/models/BulkUpsertAuthEmailTemplatesResponse.ts
 src/models/Category.ts
 src/models/CategoryListResponse.ts
 src/models/CategoryResponse.ts
+src/models/CheckEmailOtpAvailability200Response.ts
+src/models/CheckEmailOtpAvailability200ResponseData.ts
 src/models/ConfirmEmailVerificationRequest.ts
 src/models/ConfirmEmailVerificationResponse.ts
 src/models/ConfirmEmailVerificationResponseData.ts
@@ -153,6 +157,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
@@ -222,7 +234,6 @@ src/models/PayloadTooLargeError.ts
 src/models/PayloadTooLargeErrorError.ts
 src/models/PayloadTooLargeErrorErrorDetails.ts
 src/models/PhoneAuthAvailabilityResponse.ts
-src/models/PhoneAuthAvailabilityResponseData.ts
 src/models/PhoneLoginVerifyRequest.ts
 src/models/PhoneOtpSendRequest.ts
 src/models/PhoneOtpSentResponse.ts
@@ -272,6 +283,7 @@ src/models/SendBatchInAppResponse.ts
 src/models/SendBatchSmsData.ts
 src/models/SendBatchSmsRequest.ts
 src/models/SendBatchSmsResponse.ts
+src/models/SendEmailOtpRegistrationRequest.ts
 src/models/SendEmailRequest.ts
 src/models/SendEmailResponse.ts
 src/models/SendEmailResponseData.ts
@@ -300,6 +312,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
@@ -382,6 +395,8 @@ src/models/VerificationStatusResponse.ts
 src/models/VerificationStatusResponseData.ts
 src/models/VerifyDomainResponse.ts
 src/models/VerifyDomainResponseData.ts
+src/models/VerifyEmailOtpLoginRequest.ts
+src/models/VerifyEmailOtpRegistrationRequest.ts
 src/models/VerifySmsConfigData.ts
 src/models/VerifySmsConfigResponse.ts
 src/models/WaaSApplication.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/AuthEmailOTPApi.ts

@@ -0,0 +1,371 @@
+/* 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,
+  AuthLoginResponse,
+  AuthResultResponse,
+  CheckEmailOtpAvailability200Response,
+  PhoneOtpSentResponse,
+  SendEmailOtpRegistrationRequest,
+  VerifyEmailOtpLoginRequest,
+  VerifyEmailOtpRegistrationRequest,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    AuthLoginResponseFromJSON,
+    AuthLoginResponseToJSON,
+    AuthResultResponseFromJSON,
+    AuthResultResponseToJSON,
+    CheckEmailOtpAvailability200ResponseFromJSON,
+    CheckEmailOtpAvailability200ResponseToJSON,
+    PhoneOtpSentResponseFromJSON,
+    PhoneOtpSentResponseToJSON,
+    SendEmailOtpRegistrationRequestFromJSON,
+    SendEmailOtpRegistrationRequestToJSON,
+    VerifyEmailOtpLoginRequestFromJSON,
+    VerifyEmailOtpLoginRequestToJSON,
+    VerifyEmailOtpRegistrationRequestFromJSON,
+    VerifyEmailOtpRegistrationRequestToJSON,
+} from '../models/index';
+
+export interface AuthEmailOTPApiSendEmailOtpLoginRequest {
+    sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest;
+}
+
+export interface AuthEmailOTPApiSendEmailOtpRegistrationOperationRequest {
+    sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest;
+}
+
+export interface AuthEmailOTPApiVerifyEmailOtpLoginOperationRequest {
+    verifyEmailOtpLoginRequest: VerifyEmailOtpLoginRequest;
+}
+
+export interface AuthEmailOTPApiVerifyEmailOtpRegistrationOperationRequest {
+    verifyEmailOtpRegistrationRequest: VerifyEmailOtpRegistrationRequest;
+}
+
+/**
+ * AuthEmailOTPApi - interface
+ * 
+ * @export
+ * @interface AuthEmailOTPApiInterface
+ */
+export interface AuthEmailOTPApiInterface {
+    /**
+     * Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+     * @summary Check email OTP availability
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthEmailOTPApiInterface
+     */
+    checkEmailOtpAvailabilityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckEmailOtpAvailability200Response>>;
+
+    /**
+     * Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+     * Check email OTP availability
+     */
+    checkEmailOtpAvailability(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckEmailOtpAvailability200Response>;
+
+    /**
+     * Send a numeric verification code to an existing user\'s email address for login.
+     * @summary Send email OTP for login
+     * @param {SendEmailOtpRegistrationRequest} sendEmailOtpRegistrationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthEmailOTPApiInterface
+     */
+    sendEmailOtpLoginRaw(requestParameters: AuthEmailOTPApiSendEmailOtpLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneOtpSentResponse>>;
+
+    /**
+     * Send a numeric verification code to an existing user\'s email address for login.
+     * Send email OTP for login
+     */
+    sendEmailOtpLogin(sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneOtpSentResponse>;
+
+    /**
+     * Send a numeric verification code to an email address for new user registration.
+     * @summary Send email OTP for registration
+     * @param {SendEmailOtpRegistrationRequest} sendEmailOtpRegistrationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthEmailOTPApiInterface
+     */
+    sendEmailOtpRegistrationRaw(requestParameters: AuthEmailOTPApiSendEmailOtpRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneOtpSentResponse>>;
+
+    /**
+     * Send a numeric verification code to an email address for new user registration.
+     * Send email OTP for registration
+     */
+    sendEmailOtpRegistration(sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneOtpSentResponse>;
+
+    /**
+     * Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+     * @summary Verify email OTP login
+     * @param {VerifyEmailOtpLoginRequest} verifyEmailOtpLoginRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthEmailOTPApiInterface
+     */
+    verifyEmailOtpLoginRaw(requestParameters: AuthEmailOTPApiVerifyEmailOtpLoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthLoginResponse>>;
+
+    /**
+     * Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+     * Verify email OTP login
+     */
+    verifyEmailOtpLogin(verifyEmailOtpLoginRequest: VerifyEmailOtpLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthLoginResponse>;
+
+    /**
+     * Verify the numeric code and create a new user account with the email address.
+     * @summary Verify email OTP registration
+     * @param {VerifyEmailOtpRegistrationRequest} verifyEmailOtpRegistrationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthEmailOTPApiInterface
+     */
+    verifyEmailOtpRegistrationRaw(requestParameters: AuthEmailOTPApiVerifyEmailOtpRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>>;
+
+    /**
+     * Verify the numeric code and create a new user account with the email address.
+     * Verify email OTP registration
+     */
+    verifyEmailOtpRegistration(verifyEmailOtpRegistrationRequest: VerifyEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AuthEmailOTPApi extends runtime.BaseAPI implements AuthEmailOTPApiInterface {
+
+    /**
+     * Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+     * Check email OTP availability
+     */
+    async checkEmailOtpAvailabilityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckEmailOtpAvailability200Response>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auth/email-otp/available`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CheckEmailOtpAvailability200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+     * Check email OTP availability
+     */
+    async checkEmailOtpAvailability(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckEmailOtpAvailability200Response> {
+        const response = await this.checkEmailOtpAvailabilityRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Send a numeric verification code to an existing user\'s email address for login.
+     * Send email OTP for login
+     */
+    async sendEmailOtpLoginRaw(requestParameters: AuthEmailOTPApiSendEmailOtpLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneOtpSentResponse>> {
+        if (requestParameters['sendEmailOtpRegistrationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'sendEmailOtpRegistrationRequest',
+                'Required parameter "sendEmailOtpRegistrationRequest" was null or undefined when calling sendEmailOtpLogin().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Secret"] = await this.configuration.apiKey("X-Application-Secret"); // ApplicationSecret authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auth/email-otp/login/send`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SendEmailOtpRegistrationRequestToJSON(requestParameters['sendEmailOtpRegistrationRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PhoneOtpSentResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Send a numeric verification code to an existing user\'s email address for login.
+     * Send email OTP for login
+     */
+    async sendEmailOtpLogin(sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneOtpSentResponse> {
+        const response = await this.sendEmailOtpLoginRaw({ sendEmailOtpRegistrationRequest: sendEmailOtpRegistrationRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Send a numeric verification code to an email address for new user registration.
+     * Send email OTP for registration
+     */
+    async sendEmailOtpRegistrationRaw(requestParameters: AuthEmailOTPApiSendEmailOtpRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneOtpSentResponse>> {
+        if (requestParameters['sendEmailOtpRegistrationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'sendEmailOtpRegistrationRequest',
+                'Required parameter "sendEmailOtpRegistrationRequest" was null or undefined when calling sendEmailOtpRegistration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Secret"] = await this.configuration.apiKey("X-Application-Secret"); // ApplicationSecret authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auth/email-otp/register/send`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SendEmailOtpRegistrationRequestToJSON(requestParameters['sendEmailOtpRegistrationRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PhoneOtpSentResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Send a numeric verification code to an email address for new user registration.
+     * Send email OTP for registration
+     */
+    async sendEmailOtpRegistration(sendEmailOtpRegistrationRequest: SendEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneOtpSentResponse> {
+        const response = await this.sendEmailOtpRegistrationRaw({ sendEmailOtpRegistrationRequest: sendEmailOtpRegistrationRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+     * Verify email OTP login
+     */
+    async verifyEmailOtpLoginRaw(requestParameters: AuthEmailOTPApiVerifyEmailOtpLoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthLoginResponse>> {
+        if (requestParameters['verifyEmailOtpLoginRequest'] == null) {
+            throw new runtime.RequiredError(
+                'verifyEmailOtpLoginRequest',
+                'Required parameter "verifyEmailOtpLoginRequest" was null or undefined when calling verifyEmailOtpLogin().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Secret"] = await this.configuration.apiKey("X-Application-Secret"); // ApplicationSecret authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auth/email-otp/login/verify`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: VerifyEmailOtpLoginRequestToJSON(requestParameters['verifyEmailOtpLoginRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AuthLoginResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+     * Verify email OTP login
+     */
+    async verifyEmailOtpLogin(verifyEmailOtpLoginRequest: VerifyEmailOtpLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthLoginResponse> {
+        const response = await this.verifyEmailOtpLoginRaw({ verifyEmailOtpLoginRequest: verifyEmailOtpLoginRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Verify the numeric code and create a new user account with the email address.
+     * Verify email OTP registration
+     */
+    async verifyEmailOtpRegistrationRaw(requestParameters: AuthEmailOTPApiVerifyEmailOtpRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthResultResponse>> {
+        if (requestParameters['verifyEmailOtpRegistrationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'verifyEmailOtpRegistrationRequest',
+                'Required parameter "verifyEmailOtpRegistrationRequest" was null or undefined when calling verifyEmailOtpRegistration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Secret"] = await this.configuration.apiKey("X-Application-Secret"); // ApplicationSecret authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key"); // ApplicationPublicKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auth/email-otp/register/verify`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: VerifyEmailOtpRegistrationRequestToJSON(requestParameters['verifyEmailOtpRegistrationRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AuthResultResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Verify the numeric code and create a new user account with the email address.
+     * Verify email OTP registration
+     */
+    async verifyEmailOtpRegistration(verifyEmailOtpRegistrationRequest: VerifyEmailOtpRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthResultResponse> {
+        const response = await this.verifyEmailOtpRegistrationRaw({ verifyEmailOtpRegistrationRequest: verifyEmailOtpRegistrationRequest }, initOverrides);
+        return await response.value();
+    }
+
+}

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