@epilot/sdk 2.18.5 → 2.18.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/email-settings-runtime.json +1 -1
- package/definitions/email-settings.json +50 -10
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-KHKNOPEX.js → chunk-7HQ3GMYQ.js} +1 -1
- package/dist/{chunk-YNJPE3SS.cjs → chunk-AWJHA3GG.cjs} +1 -1
- package/dist/{chunk-EWY5NKI7.cjs → chunk-MIKSJIFK.cjs} +2 -2
- package/dist/{chunk-5MIH4RZR.js → chunk-TAQOJW6T.js} +2 -2
- package/dist/email-settings-U753HXGA.js +7 -0
- package/dist/email-settings-Z5EBAELW.cjs +7 -0
- package/dist/{email-settings-runtime-J7JLYDMU.cjs → email-settings-runtime-IW2AT2RB.cjs} +2 -2
- package/dist/{email-settings-runtime-4BT72ADN.js → email-settings-runtime-YJYEC5AH.js} +1 -1
- package/dist/{email-settings.d-CR4lORuR.d.cts → email-settings.d-DViLYaOl.d.cts} +56 -14
- package/dist/{email-settings.d-CR4lORuR.d.ts → email-settings.d-DViLYaOl.d.ts} +56 -14
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/email-settings.md +17 -13
- package/package.json +1 -1
- package/dist/email-settings-ECSU7KWC.js +0 -7
- package/dist/email-settings-RHMYC2KT.cjs +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/email-settings.json
|
|
4
|
+
var email_settings_default = '# Messaging Settings API\n\n- **Base URL:** `https://email-settings.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/email-settings](https://docs.epilot.io/api/email-settings)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.emailSettings.provisionEpilotEmailAddress(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/email-settings\'\n\nconst emailSettingsClient = getClient()\nauthorize(emailSettingsClient, () => \'<token>\')\nconst { data } = await emailSettingsClient.provisionEpilotEmailAddress(...)\n```\n\n## Operations\n\n**Email addresses**\n- [`provisionEpilotEmailAddress`](#provisionepilotemailaddress)\n- [`setEmailAddressPrimary`](#setemailaddressprimary)\n- [`getEmailAddress`](#getemailaddress)\n- [`deleteEmailAddress`](#deleteemailaddress)\n- [`updateEmailAddress`](#updateemailaddress)\n- [`listEmailAddresses`](#listemailaddresses)\n- [`addEmailAddress`](#addemailaddress)\n\n**Shared inboxes**\n- [`getSharedInbox`](#getsharedinbox)\n- [`deleteSharedInbox`](#deletesharedinbox)\n- [`updateSharedInbox`](#updatesharedinbox)\n- [`listSharedInboxes`](#listsharedinboxes)\n- [`addSharedInbox`](#addsharedinbox)\n\n**Inbox buckets**\n- [`listInboxBuckets`](#listinboxbuckets)\n\n**O365 Outlook Connection**\n- [`connectOutlook`](#connectoutlook)\n- [`getOutlookConnectionStatus`](#getoutlookconnectionstatus)\n- [`getCalendarAdminConsentStatus`](#getcalendaradminconsentstatus)\n- [`getMyCalendarConnection`](#getmycalendarconnection)\n- [`disconnectMyCalendar`](#disconnectmycalendar)\n- [`disconnectOutlook`](#disconnectoutlook)\n- [`connectOutlookMailbox`](#connectoutlookmailbox)\n- [`disconnectOutlookMailbox`](#disconnectoutlookmailbox)\n- [`startMailboxSync`](#startmailboxsync)\n- [`getMailboxSyncStatus`](#getmailboxsyncstatus)\n- [`retryMailboxSync`](#retrymailboxsync)\n- [`getConnectedOutlookEmails`](#getconnectedoutlookemails)\n- [`outlookOAuthCallback`](#outlookoauthcallback)\n\n**Channels**\n- [`connectMsTeams`](#connectmsteams)\n- [`disconnectMsTeams`](#disconnectmsteams)\n- [`getMsTeamsStatus`](#getmsteamsstatus)\n\n**Custom SMTP**\n- [`listSmtpConnections`](#listsmtpconnections)\n- [`createSmtpConnection`](#createsmtpconnection)\n- [`getSmtpConnection`](#getsmtpconnection)\n- [`updateSmtpConnection`](#updatesmtpconnection)\n- [`deleteSmtpConnection`](#deletesmtpconnection)\n- [`testSmtpConnection`](#testsmtpconnection)\n- [`listSmtpSenders`](#listsmtpsenders)\n- [`connectSmtpSender`](#connectsmtpsender)\n- [`disconnectSmtpSender`](#disconnectsmtpsender)\n\n**Settings**\n- [`getSettings`](#getsettings)\n- [`addSetting`](#addsetting)\n- [`deleteSetting`](#deletesetting)\n- [`updateSetting`](#updatesetting)\n\n**Domains**\n- [`addDomain`](#adddomain)\n- [`deleteDomain`](#deletedomain)\n- [`getDomains`](#getdomains)\n- [`verifyNameServers`](#verifynameservers)\n- [`verifyDnsRecords`](#verifydnsrecords)\n- [`verifyDomain`](#verifydomain)\n\n**Schemas**\n- [`ConnectOutlookRequest`](#connectoutlookrequest)\n- [`MailboxSyncStatus`](#mailboxsyncstatus)\n- [`MailboxSyncStatuses`](#mailboxsyncstatuses)\n- [`MailboxSyncFolderStatuses`](#mailboxsyncfolderstatuses)\n- [`MailboxSyncTimeframePeriods`](#mailboxsynctimeframeperiods)\n- [`InboxBucketResponse`](#inboxbucketresponse)\n- [`ProvisionEpilotEmailAddressPayload`](#provisionepilotemailaddresspayload)\n- [`SetEmailAddressPrimaryPayload`](#setemailaddressprimarypayload)\n- [`UpdateEmailAddressPayload`](#updateemailaddresspayload)\n- [`CreateEmailAddressPayload`](#createemailaddresspayload)\n- [`EmailAddressResponse`](#emailaddressresponse)\n- [`ErrorResponse`](#errorresponse)\n- [`SettingMeta`](#settingmeta)\n- [`UpdateSharedInboxPayload`](#updatesharedinboxpayload)\n- [`CreateSharedInboxPayload`](#createsharedinboxpayload)\n- [`SharedInboxResponse`](#sharedinboxresponse)\n- [`SettingsResponse`](#settingsresponse)\n- [`ConnectedOutlookEmail`](#connectedoutlookemail)\n- [`OutlookConnectionError`](#outlookconnectionerror)\n- [`CalendarAdminConsentStatus`](#calendaradminconsentstatus)\n- [`MyCalendarConnectionResponse`](#mycalendarconnectionresponse)\n- [`CalendarConnectionInfo`](#calendarconnectioninfo)\n- [`OutlookConnectionStatus`](#outlookconnectionstatus)\n- [`SmtpConnection`](#smtpconnection)\n- [`CreateSmtpConnectionRequest`](#createsmtpconnectionrequest)\n- [`UpdateSmtpConnectionRequest`](#updatesmtpconnectionrequest)\n- [`SmtpSender`](#smtpsender)\n- [`ConnectSmtpSenderRequest`](#connectsmtpsenderrequest)\n- [`SmtpTestResult`](#smtptestresult)\n- [`SignatureSetting`](#signaturesetting)\n- [`EmailDomainSetting`](#emaildomainsetting)\n- [`EmailAddressSetting`](#emailaddresssetting)\n- [`WhitelistEmailAddressSetting`](#whitelistemailaddresssetting)\n- [`RestrictDuplicatesWithinSetting`](#restrictduplicateswithinsetting)\n- [`SettingType`](#settingtype)\n- [`Setting`](#setting)\n- [`Domain`](#domain)\n\n### `provisionEpilotEmailAddress`\n\nProvisions or reactivates an epilot-managed email address for the organization.\n\n`PUT /v2/email-settings/email-addresses/epilot:provision`\n\n```ts\nconst { data } = await client.provisionEpilotEmailAddress(\n null,\n {\n address: \'mycompany@epilot.cloud\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `setEmailAddressPrimary`\n\nSets the specified email address as the primary address for the organization.\n\n`POST /v2/email-settings/email-addresses/primary`\n\n```ts\nconst { data } = await client.setEmailAddressPrimary(\n null,\n {\n address: \'sales@yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getEmailAddress`\n\nRetrieves the details of a specific email address by its ID.\n\n`GET /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.getEmailAddress({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `deleteEmailAddress`\n\nPermanently deletes an email address from the organization.\n\n`DELETE /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.deleteEmailAddress({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateEmailAddress`\n\nUpdates the configuration of an existing email address.\n\n`PUT /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.updateEmailAddress(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n name: \'Sales Team\',\n user_ids: [\'user-123\', \'user-456\'],\n group_ids: [\'group-789\'],\n default_signature_id: \'sig-abc\',\n shared_inbox_id: \'inbox-xyz\',\n is_active: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `listEmailAddresses`\n\nRetrieves all email addresses configured for the organization.\n\n`GET /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.listEmailAddresses()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n }\n]\n```\n\n</details>\n\n---\n\n### `addEmailAddress`\n\nAdds a new email address to the organization.\n\n`POST /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.addEmailAddress(\n null,\n {\n address: \'support@yourcompany.com\',\n name: \'Customer Support\',\n user_ids: [\'user-123\'],\n group_ids: [\'group-456\'],\n default_signature_id: \'sig-789\',\n shared_inbox_id: \'inbox-abc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getSharedInbox`\n\nRetrieves the details of a specific shared inbox by its ID.\n\n`GET /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.getSharedInbox({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `deleteSharedInbox`\n\nDeletes a shared inbox and reroutes all associated emails to a successor inbox.\n\n`DELETE /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.deleteSharedInbox({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n successorInboxId: \'example\',\n})\n```\n\n---\n\n### `updateSharedInbox`\n\nUpdates the configuration of an existing shared inbox.\n\n`PUT /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.updateSharedInbox(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n color: \'#4CAF50\',\n name: \'Customer Support\',\n assignees: [\'user-123\', \'user-456\'],\n description: \'Incoming customer support requests\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listSharedInboxes`\n\nRetrieves all shared inboxes configured for the organization.\n\n`GET /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.listSharedInboxes()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n }\n]\n```\n\n</details>\n\n---\n\n### `addSharedInbox`\n\nCreates a new shared inbox for the organization.\n\n`POST /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.addSharedInbox(\n null,\n {\n id: \'support-inbox\',\n color: \'#2196F3\',\n name: \'Sales Inquiries\',\n assignees: [\'user-123\', \'user-456\'],\n description: \'Inbound sales and pricing requests\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listInboxBuckets`\n\nRetrieves all inbox buckets for the organization.\n\n`GET /v2/email-settings/inbox-buckets`\n\n```ts\nconst { data } = await client.listInboxBuckets()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "bucket-abc",\n "inbox_id": "inbox-xyz"\n }\n]\n```\n\n</details>\n\n---\n\n### `connectOutlook`\n\nReturns the Microsoft authorization URL for Outlook OAuth.\n\n`POST /v2/outlook/connect`\n\n```ts\nconst { data } = await client.connectOutlook(\n null,\n {\n mail: true,\n calendar: true,\n return_to: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "authorization_url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getOutlookConnectionStatus`\n\nReturns all Microsoft 365 / Outlook connections for the organization.\nSupports multiple connections (one per Azure AD tenant).\n\n`GET /v2/outlook/connection/status`\n\n```ts\nconst { data } = await client.getOutlookConnectionStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connections": [\n {\n "status": "connected",\n "action": "connect",\n "action_reason": "expired",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "tenant_id": "string",\n "scopes": ["string"],\n "expires_at": "1970-01-01T00:00:00.000Z",\n "is_token_valid": true\n }\n ],\n "has_connections": true,\n "teams_enabled": true\n}\n```\n\n</details>\n\n---\n\n### `getCalendarAdminConsentStatus`\n\nReports whether the caller\'s organization can connect personal Outlook\ncalendars.\n\n`GET /v2/outlook/calendar/admin-consent-status`\n\n```ts\nconst { data } = await client.getCalendarAdminConsentStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "admin_consented": true,\n "admin_consent_url": "https://example.com/path"\n}\n```\n\n</details>\n\n---\n\n### `getMyCalendarConnection`\n\nReturns the calling user\'s personal Outlook calendar connection,\nor null when the user hasn\'t connected yet.\n\n`GET /v2/outlook/calendar/me`\n\n```ts\nconst { data } = await client.getMyCalendarConnection()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connection": {\n "user_id": "string",\n "tenant_id": "string",\n "status": "connected",\n "scopes": ["string"],\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "expires_at": "1970-01-01T00:00:00.000Z"\n }\n}\n```\n\n</details>\n\n---\n\n### `disconnectMyCalendar`\n\nRemoves the calling user\'s personal calendar connection.\n\n`DELETE /v2/outlook/calendar/me`\n\n```ts\nconst { data } = await client.disconnectMyCalendar()\n```\n\n---\n\n### `disconnectOutlook`\n\nRemoves the Microsoft 365 / Outlook connection for a specific tenant.\nThis deletes the stored tokens and disconnects the integration.\n\n`POST /v2/outlook/connection/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlook(\n null,\n {\n tenant_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "tenant_id": "string",\n "affected_shared_inboxes": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `connectMsTeams`\n\nConnects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.\nRequires an active Microsoft 365 / Outlook connection.\n\n`POST /v2/channels/msteams/connect`\n\n```ts\nconst { data } = await client.connectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "connected_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `disconnectMsTeams`\n\nDisconnects Microsoft Teams channel for the organization.\n\n`POST /v2/channels/msteams/disconnect`\n\n```ts\nconst { data } = await client.disconnectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true\n}\n```\n\n</details>\n\n---\n\n### `getMsTeamsStatus`\n\nReturns the connection status of the Microsoft Teams channel for the organization.\n\n`GET /v2/channels/msteams/status`\n\n```ts\nconst { data } = await client.getMsTeamsStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `connectOutlookMailbox`\n\nConnects an Outlook mailbox:\n 1. Validates the user has access to the mailbox via Microsoft Graph API\n 2. Creates a mapping between the email address of the mailbox and the outlook connection\n 3. E\n\n`POST /v2/outlook/mailbox/connect`\n\n```ts\nconst { data } = await client.connectOutlookMailbox(\n null,\n {\n email: \'user@example.com\',\n shared_inbox_id: \'default\',\n name: \'string\',\n user_ids: [\'string\'],\n group_ids: [\'string\'],\n default_signature_id: \'string\',\n mailboxSyncTimeframe: \'5m\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email_address": {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n },\n "outlook_email": "user@example.com",\n "tenant_id": "string",\n "provider": "outlook"\n}\n```\n\n</details>\n\n---\n\n### `disconnectOutlookMailbox`\n\nDisconnect Outlook Mailbox\n\n`POST /v2/outlook/mailbox/{email}/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlookMailbox({\n email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "email": "user@example.com"\n}\n```\n\n</details>\n\n---\n\n### `startMailboxSync`\n\nStart Mailbox Sync\n\n`POST /v2/outlook/mailbox/{email}/sync`\n\n```ts\nconst { data } = await client.startMailboxSync(\n {\n email: \'example\',\n },\n {\n timeframe: \'5m\'\n },\n)\n```\n\n---\n\n### `getMailboxSyncStatus`\n\nGet Mailbox Sync Status\n\n`GET /v2/outlook/mailbox/{email}/sync/status`\n\n```ts\nconst { data } = await client.getMailboxSyncStatus({\n email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "execution_id": "string",\n "status": "RUNNING",\n "timeframe": "5m",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "inbox": {\n "status": "PENDING",\n "total_messages": 0,\n "processed_messages": 0,\n "failed_messages": 0\n },\n "sent_items": {\n "status": "PENDING",\n "total_messages": 0,\n "processed_messages": 0,\n "failed_messages": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `retryMailboxSync`\n\nRetry Failed Messages\n\n`POST /v2/outlook/mailbox/{email}/sync/retry`\n\n```ts\nconst { data } = await client.retryMailboxSync(\n {\n email: \'example\',\n },\n {\n sync_id: \'string\',\n scope: \'all_failed\',\n message_ids: [\'string\']\n },\n)\n```\n\n---\n\n### `getConnectedOutlookEmails`\n\nReturns all Outlook email addresses connected to the organization.\n\n`GET /v2/outlook/mailbox/mappings`\n\n```ts\nconst { data } = await client.getConnectedOutlookEmails()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "outlook_emails": [\n {\n "outlook_email": "user@example.com",\n "tenant_id": "string",\n "provider": "outlook",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n }\n ],\n "count": 0\n}\n```\n\n</details>\n\n---\n\n### `listSmtpConnections`\n\nReturns all custom SMTP connections configured for the organization.\nPasswords are never returned.\n\n`GET /v2/smtp/connections`\n\n```ts\nconst { data } = await client.listSmtpConnections()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connections": [\n {\n "connection_id": "string",\n "smtp_host": "string",\n "smtp_port": "string",\n "smtp_secure": "tls",\n "smtp_username": "string",\n "smtp_password": "string",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "last_tested_at": "1970-01-01T00:00:00.000Z",\n "last_test_status": "ok",\n "last_test_error": "string"\n }\n ],\n "has_connections": true\n}\n```\n\n</details>\n\n---\n\n### `createSmtpConnection`\n\nCreates a new custom SMTP connection. Runs a live verify against the SMTP server\nbefore persisting; on failure the request is rejected and nothing is saved. Pass\n`skip_test=true` to store the configur\n\n`POST /v2/smtp/connections`\n\n```ts\nconst { data } = await client.createSmtpConnection(\n {\n skip_test: true,\n },\n {\n smtp_host: \'string\',\n smtp_port: \'string\',\n smtp_secure: \'tls\',\n smtp_username: \'string\',\n smtp_password: \'{{ env.smtp_password }}\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connection_id": "string",\n "smtp_host": "string",\n "smtp_port": "string",\n "smtp_secure": "tls",\n "smtp_username": "string",\n "smtp_password": "string",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "last_tested_at": "1970-01-01T00:00:00.000Z",\n "last_test_status": "ok",\n "last_test_error": "string"\n}\n```\n\n</details>\n\n---\n\n### `getSmtpConnection`\n\nReturns a single custom SMTP connection by id. The password is never returned.\n\n`GET /v2/smtp/connections/{connectionId}`\n\n```ts\nconst { data } = await client.getSmtpConnection({\n connectionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connection_id": "string",\n "smtp_host": "string",\n "smtp_port": "string",\n "smtp_secure": "tls",\n "smtp_username": "string",\n "smtp_password": "string",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "last_tested_at": "1970-01-01T00:00:00.000Z",\n "last_test_status": "ok",\n "last_test_error": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateSmtpConnection`\n\nPartial update; omitted fields keep their existing values. The merged\nconfiguration is verified against the SMTP server before persisting. Pass\n`skip_test=true` to store it untested instead, which als\n\n`PUT /v2/smtp/connections/{connectionId}`\n\n```ts\nconst { data } = await client.updateSmtpConnection(\n {\n connectionId: \'example\',\n skip_test: true,\n },\n {\n smtp_host: \'string\',\n smtp_port: \'string\',\n smtp_secure: \'tls\',\n smtp_username: \'string\',\n smtp_password: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connection_id": "string",\n "smtp_host": "string",\n "smtp_port": "string",\n "smtp_secure": "tls",\n "smtp_username": "string",\n "smtp_password": "string",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "last_tested_at": "1970-01-01T00:00:00.000Z",\n "last_test_status": "ok",\n "last_test_error": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteSmtpConnection`\n\nDeletes a custom SMTP connection. Messages already sent are unaffected.\n\n`DELETE /v2/smtp/connections/{connectionId}`\n\n```ts\nconst { data } = await client.deleteSmtpConnection({\n connectionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "connection_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `testSmtpConnection`\n\nRe-runs a live SMTP verify against the saved configuration (EHLO + AUTH + NOOP + QUIT)\nand updates `last_test_status` / `last_tested_at` on the connection.\n\n`POST /v2/smtp/connections/{connectionId}/test`\n\n```ts\nconst { data } = await client.testSmtpConnection({\n connectionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status": "ok",\n "error": "string",\n "tested_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listSmtpSenders`\n\nReturns every address registered to send through a custom SMTP connection.\n\n`GET /v2/smtp/senders`\n\n```ts\nconst { data } = await client.listSmtpSenders()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "senders": [\n {\n "email": "user@example.com",\n "connection_id": "string",\n "reply_to_email": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `connectSmtpSender`\n\nRegisters an address as a sender on a custom SMTP connection:\n 1. Creates the email address so it can be picked in the composer\n 2. Binds it to the connection, so outgoing mail from it is routed the\n\n`POST /v2/smtp/senders`\n\n```ts\nconst { data } = await client.connectSmtpSender(\n null,\n {\n email: \'user@example.com\',\n connection_id: \'string\',\n name: \'string\',\n reply_to_email: \'string\',\n shared_inbox_id: \'default\',\n user_ids: [\'string\'],\n group_ids: [\'string\'],\n default_signature_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email_address": {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n },\n "sender": {\n "email": "user@example.com",\n "connection_id": "string",\n "reply_to_email": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n }\n}\n```\n\n</details>\n\n---\n\n### `disconnectSmtpSender`\n\nRemoves a sender address: deletes the email address and its binding to the SMTP\nconnection. The connection itself and messages already sent are unaffected.\n\n`DELETE /v2/smtp/senders/{email}`\n\n```ts\nconst { data } = await client.disconnectSmtpSender({\n email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "email": "user@example.com"\n}\n```\n\n</details>\n\n---\n\n### `outlookOAuthCallback`\n\nExchanges authorization code for tokens and stores them.\n\n`GET /v2/outlook/oauth/callback`\n\n```ts\nconst { data } = await client.outlookOAuthCallback({\n code: \'example\',\n state: \'example\',\n session_state: \'example\',\n error: \'example\',\n error_description: \'example\',\n error_subcode: \'example\',\n client_info: \'example\',\n error_uri: \'example\',\n admin_consent: \'example\',\n tenant: \'example\',\n clientdata: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "expires_at": "1970-01-01T00:00:00.000Z",\n "scope": "string"\n}\n```\n\n</details>\n\n---\n\n### `getSettings`\n\nRetrieves settings of a specific type for the organization.\n\n`GET /v1/email-settings`\n\n```ts\nconst { data } = await client.getSettings({\n type: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `addSetting`\n\nCreates a new setting of the specified type.\n\n`POST /v1/email-settings`\n\n```ts\nconst { data } = await client.addSetting(\n null,\n {\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n name: \'Default Signature\',\n org_id: \'org-123\',\n type: \'signature\',\n value: \'Best regards, The Team\',\n html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n created_at: \'2024-01-15T10:30:00Z\',\n updated_at: \'2024-01-20T14:45:00Z\',\n created_by: \'user-123\',\n updated_by: \'user-456\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `deleteSetting`\n\nDeletes a setting by its ID and type.\n\n`DELETE /v1/email-settings`\n\n```ts\nconst { data } = await client.deleteSetting(\n null,\n {\n type: \'signature\',\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `updateSetting`\n\nUpdates an existing setting identified by its ID.\n\n`POST /v1/email-settings/{id}`\n\n```ts\nconst { data } = await client.updateSetting(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n name: \'Default Signature\',\n org_id: \'org-123\',\n type: \'signature\',\n value: \'Best regards, The Team\',\n html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n created_at: \'2024-01-15T10:30:00Z\',\n updated_at: \'2024-01-20T14:45:00Z\',\n created_by: \'user-123\',\n updated_by: \'user-456\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `addDomain`\n\nAdds a custom email domain to the organization.\n\n`POST /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.addDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `deleteDomain`\n\nRemoves a custom email domain from the organization.\n\n`DELETE /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.deleteDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n---\n\n### `getDomains`\n\nRetrieves all custom email domains for the organization.\n\n`GET /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.getDomains()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["string"]\n```\n\n</details>\n\n---\n\n### `verifyNameServers`\n\nVerifies that the domain\'s name server (NS) records are correctly configured.\n\n`POST /v1/email-settings/domain/name-servers:verify`\n\n```ts\nconst { data } = await client.verifyNameServers(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `verifyDnsRecords`\n\nVerifies that the domain\'s DNS records (MX, TXT, CNAME) are correctly configured\nin the customer\'s DNS provider.\n\n`POST /v1/email-settings/domain/dns-records:verify`\n\n```ts\nconst { data } = await client.verifyDnsRecords(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `verifyDomain`\n\nVerifies ownership and configuration of a custom email domain.\n\n`POST /v1/email-settings/domain:verify`\n\n```ts\nconst { data } = await client.verifyDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConnectOutlookRequest`\n\nFeature flags selecting which Microsoft Graph scopes to request.\nAt least one flag must be true. Passing a superset of previously\ngranted features triggers incremental consent for the delta only.\n\n\n```ts\ntype ConnectOutlookRequest = {\n mail?: boolean\n calendar?: boolean\n return_to?: string\n}\n```\n\n### `MailboxSyncStatus`\n\n```ts\ntype MailboxSyncStatus = {\n execution_id: string\n status: "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n timeframe: "5m" | "1w" | "2w" | "1m"\n started_at: string // date-time\n completed_at?: string // date-time\n inbox?: {\n status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n total_messages?: number\n processed_messages?: number\n failed_messages?: number\n }\n sent_items?: {\n status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n total_messages?: number\n processed_messages?: number\n failed_messages?: number\n }\n}\n```\n\n### `MailboxSyncStatuses`\n\n```ts\ntype MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n```\n\n### `MailboxSyncFolderStatuses`\n\n```ts\ntype MailboxSyncFolderStatuses = "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n```\n\n### `MailboxSyncTimeframePeriods`\n\n```ts\ntype MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m"\n```\n\n### `InboxBucketResponse`\n\nInbox bucket representing the storage container for a shared inbox.\n\n```ts\ntype InboxBucketResponse = {\n id: string\n inbox_id: string\n}\n```\n\n### `ProvisionEpilotEmailAddressPayload`\n\nRequest payload for provisioning an epilot-managed email address.\n\n```ts\ntype ProvisionEpilotEmailAddressPayload = {\n address: string\n}\n```\n\n### `SetEmailAddressPrimaryPayload`\n\nRequest payload for setting an email address as the organization\'s primary address.\n\n```ts\ntype SetEmailAddressPrimaryPayload = {\n address: string\n}\n```\n\n### `UpdateEmailAddressPayload`\n\nRequest payload for updating an email address configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateEmailAddressPayload = {\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n is_active?: boolean\n}\n```\n\n### `CreateEmailAddressPayload`\n\nRequest payload for creating a new email address.\n\n```ts\ntype CreateEmailAddressPayload = {\n address: string\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n}\n```\n\n### `EmailAddressResponse`\n\nEmail address configuration with all associated metadata.\n\n```ts\ntype EmailAddressResponse = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n address: string\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n is_active?: boolean\n is_primary?: boolean\n is_epilot_email_address?: boolean\n}\n```\n\n### `ErrorResponse`\n\nStandard error response format for all API errors.\n\n```ts\ntype ErrorResponse = {\n error: string\n status: number\n}\n```\n\n### `SettingMeta`\n\nCommon metadata fields for all settings and resources.\n\n```ts\ntype SettingMeta = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n}\n```\n\n### `UpdateSharedInboxPayload`\n\nRequest payload for updating a shared inbox configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateSharedInboxPayload = {\n color?: string\n name?: string\n assignees?: string[]\n description?: string\n}\n```\n\n### `CreateSharedInboxPayload`\n\nRequest payload for creating a new shared inbox.\n\n```ts\ntype CreateSharedInboxPayload = {\n id?: string\n color: string\n name: string\n assignees?: string[]\n description?: string\n}\n```\n\n### `SharedInboxResponse`\n\nShared inbox configuration with all associated metadata.\n\n```ts\ntype SharedInboxResponse = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n name: string\n color: string\n assignees: string[]\n description?: string\n bucket_id: string\n}\n```\n\n### `SettingsResponse`\n\n```ts\ntype SettingsResponse = Array<{\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}> | {\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}\n```\n\n### `ConnectedOutlookEmail`\n\nMapping between an Outlook email and its Outlook Connection.\nThis tracks which provider/tenant provisions each Outlook email.\n\n\n```ts\ntype ConnectedOutlookEmail = {\n outlook_email: string // email\n tenant_id?: string\n provider?: "outlook"\n connected_at?: string // date-time\n connected_by_user_id?: string\n}\n```\n\n### `OutlookConnectionError`\n\n```ts\ntype OutlookConnectionError = {\n error: string\n error_description?: string\n admin_consent_url?: string // uri\n}\n```\n\n### `CalendarAdminConsentStatus`\n\n```ts\ntype CalendarAdminConsentStatus = {\n admin_consented: boolean\n admin_consent_url?: string // uri\n}\n```\n\n### `MyCalendarConnectionResponse`\n\nPer-user calendar connection metadata, or null when the caller has\nnot connected their personal calendar yet.\n\n\n```ts\ntype MyCalendarConnectionResponse = {\n connection?: {\n user_id: string\n tenant_id: string\n status: "connected" | "expired"\n scopes?: string[]\n connected_by_display_name?: string\n connected_by_email?: string // email\n connected_at?: string // date-time\n updated_at?: string // date-time\n expires_at?: string // date-time\n }\n}\n```\n\n### `CalendarConnectionInfo`\n\n```ts\ntype CalendarConnectionInfo = {\n user_id: string\n tenant_id: string\n status: "connected" | "expired"\n scopes?: string[]\n connected_by_display_name?: string\n connected_by_email?: string // email\n connected_at?: string // date-time\n updated_at?: string // date-time\n expires_at?: string // date-time\n}\n```\n\n### `OutlookConnectionStatus`\n\n```ts\ntype OutlookConnectionStatus = {\n status: "connected" | "expired" | "pending_auth" | "not_connected"\n action: "connect" | "authorize" | "reconnect" | "none"\n action_reason?: "expired" | "permission_update"\n connected_by_display_name?: string\n connected_by_email?: string // email\n connected_by_user_id?: string\n connected_at?: string // date-time\n updated_at?: string // date-time\n tenant_id: string\n scopes?: string[]\n expires_at?: string // date-time\n is_token_valid?: boolean\n}\n```\n\n### `SmtpConnection`\n\n```ts\ntype SmtpConnection = {\n connection_id: string\n smtp_host: string\n smtp_port: string\n smtp_secure: "tls" | "starttls"\n smtp_username: string\n smtp_password?: string\n connected_by_display_name?: string\n connected_by_email?: string // email\n connected_by_user_id?: string\n connected_at?: string // date-time\n updated_at?: string // date-time\n last_tested_at?: string // date-time\n last_test_status?: "ok" | "auth_failed" | "tls_failed" | "host_unreachable" | "timeout" | "secret_missing" | "unknown"\n last_test_error?: string\n}\n```\n\n### `CreateSmtpConnectionRequest`\n\n```ts\ntype CreateSmtpConnectionRequest = {\n smtp_host: string\n smtp_port: string | number\n smtp_secure: "tls" | "starttls"\n smtp_username: string\n smtp_password: string\n}\n```\n\n### `UpdateSmtpConnectionRequest`\n\nPartial update; omitted fields keep their existing values.\n\n```ts\ntype UpdateSmtpConnectionRequest = {\n smtp_host?: string\n smtp_port?: string | number\n smtp_secure?: "tls" | "starttls"\n smtp_username?: string\n smtp_password?: string\n}\n```\n\n### `SmtpSender`\n\nAn address allowed to send through a custom SMTP connection. Mirrors an Outlook\nmailbox: the address, its display name and its assignees live on the shared\nemail-address record, while this row binds it to a set of SMTP credentials.\n\n\n```ts\ntype SmtpSender = {\n email: string // email\n connection_id: string\n reply_to_email?: string\n connected_at?: string // date-time\n connected_by_user_id?: string\n}\n```\n\n### `ConnectSmtpSenderRequest`\n\n```ts\ntype ConnectSmtpSenderRequest = {\n email: string // email\n connection_id: string\n name?: string\n reply_to_email?: string\n shared_inbox_id?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n}\n```\n\n### `SmtpTestResult`\n\n```ts\ntype SmtpTestResult = {\n status: "ok" | "auth_failed" | "tls_failed" | "host_unreachable" | "timeout" | "secret_missing" | "unknown"\n error?: string\n tested_at: string // date-time\n}\n```\n\n### `SignatureSetting`\n\nSetting that allows to add a signature.\n\n```ts\ntype SignatureSetting = "signature"\n```\n\n### `EmailDomainSetting`\n\nSetting that allows to add a custom domain. For e.g; doe.com\n\n```ts\ntype EmailDomainSetting = "email_domain"\n```\n\n### `EmailAddressSetting`\n\nSetting that allows to add an email address on the custom domain. For e.g; john@doe.com\n\n```ts\ntype EmailAddressSetting = "email_address"\n```\n\n### `WhitelistEmailAddressSetting`\n\n- Setting that specifies a list of addresses exempt from being flagged as duplicate emails.\n- An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.\n\n\n```ts\ntype WhitelistEmailAddressSetting = "whitelist_email_address"\n```\n\n### `RestrictDuplicatesWithinSetting`\n\n- Restrict duplicates within:\n * 10s\n * 5m\n * 1d\n * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.\n- Defaults to 3 minutes\n- Negative values will be treated same as positive values\n- If not set, defaults to 3 min\n- If set as\n\n```ts\ntype RestrictDuplicatesWithinSetting = "restrict_duplicates_within"\n```\n\n### `SettingType`\n\n```ts\ntype SettingType = "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n```\n\n### `Setting`\n\nGeneric setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n-\n\n```ts\ntype Setting = {\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}\n```\n\n### `Domain`\n\nCustom email domain configuration.\n\n```ts\ntype Domain = {\n domain?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = email_settings_default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkAWJHA3GGcjs = require('./chunk-AWJHA3GG.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkAWJHA3GGcjs.require_email_settings_runtime.call(void 0, );
|
|
@@ -240,7 +240,19 @@ declare namespace Components {
|
|
|
240
240
|
}
|
|
241
241
|
export interface CreateSmtpConnectionRequest {
|
|
242
242
|
smtp_host: string;
|
|
243
|
-
|
|
243
|
+
/**
|
|
244
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
245
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
246
|
+
* keep working.
|
|
247
|
+
*
|
|
248
|
+
*/
|
|
249
|
+
smtp_port: /**
|
|
250
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
251
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
252
|
+
* keep working.
|
|
253
|
+
*
|
|
254
|
+
*/
|
|
255
|
+
string | number;
|
|
244
256
|
smtp_secure: "tls" | "starttls";
|
|
245
257
|
smtp_username: string;
|
|
246
258
|
/**
|
|
@@ -797,9 +809,11 @@ declare namespace Components {
|
|
|
797
809
|
*/
|
|
798
810
|
smtp_host: string;
|
|
799
811
|
/**
|
|
800
|
-
* SMTP port (typically 587 for STARTTLS or 465 for TLS)
|
|
812
|
+
* SMTP port (typically 587 for STARTTLS or 465 for TLS). A string, because it
|
|
813
|
+
* may hold a `{{ env.your_key }}` reference rather than a literal port.
|
|
814
|
+
*
|
|
801
815
|
*/
|
|
802
|
-
smtp_port:
|
|
816
|
+
smtp_port: string;
|
|
803
817
|
/**
|
|
804
818
|
* Connection security mode. Plaintext SMTP is not offered: it would put the
|
|
805
819
|
* SMTP password on the wire in the clear.
|
|
@@ -951,7 +965,19 @@ declare namespace Components {
|
|
|
951
965
|
*/
|
|
952
966
|
export interface UpdateSmtpConnectionRequest {
|
|
953
967
|
smtp_host?: string;
|
|
954
|
-
|
|
968
|
+
/**
|
|
969
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
970
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
971
|
+
* keep working.
|
|
972
|
+
*
|
|
973
|
+
*/
|
|
974
|
+
smtp_port?: /**
|
|
975
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
976
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
977
|
+
* keep working.
|
|
978
|
+
*
|
|
979
|
+
*/
|
|
980
|
+
string | number;
|
|
955
981
|
smtp_secure?: "tls" | "starttls";
|
|
956
982
|
smtp_username?: string;
|
|
957
983
|
smtp_password?: string;
|
|
@@ -1123,6 +1149,12 @@ declare namespace Paths {
|
|
|
1123
1149
|
}
|
|
1124
1150
|
}
|
|
1125
1151
|
namespace CreateSmtpConnection {
|
|
1152
|
+
namespace Parameters {
|
|
1153
|
+
export type SkipTest = boolean;
|
|
1154
|
+
}
|
|
1155
|
+
export interface QueryParameters {
|
|
1156
|
+
skip_test?: Parameters.SkipTest;
|
|
1157
|
+
}
|
|
1126
1158
|
export type RequestBody = Components.Schemas.CreateSmtpConnectionRequest;
|
|
1127
1159
|
namespace Responses {
|
|
1128
1160
|
export type $201 = Components.Schemas.SmtpConnection;
|
|
@@ -1702,6 +1734,12 @@ declare namespace Paths {
|
|
|
1702
1734
|
}
|
|
1703
1735
|
}
|
|
1704
1736
|
namespace UpdateSmtpConnection {
|
|
1737
|
+
namespace Parameters {
|
|
1738
|
+
export type SkipTest = boolean;
|
|
1739
|
+
}
|
|
1740
|
+
export interface QueryParameters {
|
|
1741
|
+
skip_test?: Parameters.SkipTest;
|
|
1742
|
+
}
|
|
1705
1743
|
export type RequestBody = /* Partial update; omitted fields keep their existing values. */ Components.Schemas.UpdateSmtpConnectionRequest;
|
|
1706
1744
|
namespace Responses {
|
|
1707
1745
|
export type $200 = Components.Schemas.SmtpConnection;
|
|
@@ -2176,12 +2214,12 @@ interface OperationMethods {
|
|
|
2176
2214
|
* createSmtpConnection - createSmtpConnection
|
|
2177
2215
|
*
|
|
2178
2216
|
* Creates a new custom SMTP connection. Runs a live verify against the SMTP server
|
|
2179
|
-
* before persisting; on failure the request is rejected and nothing is saved.
|
|
2180
|
-
*
|
|
2217
|
+
* before persisting; on failure the request is rejected and nothing is saved. Pass
|
|
2218
|
+
* `skip_test=true` to store the configuration untested instead.
|
|
2181
2219
|
*
|
|
2182
2220
|
*/
|
|
2183
2221
|
'createSmtpConnection'(
|
|
2184
|
-
parameters?: Parameters<
|
|
2222
|
+
parameters?: Parameters<Paths.CreateSmtpConnection.QueryParameters> | null,
|
|
2185
2223
|
data?: Paths.CreateSmtpConnection.RequestBody,
|
|
2186
2224
|
config?: AxiosRequestConfig
|
|
2187
2225
|
): OperationResponse<Paths.CreateSmtpConnection.Responses.$201>
|
|
@@ -2199,11 +2237,13 @@ interface OperationMethods {
|
|
|
2199
2237
|
* updateSmtpConnection - updateSmtpConnection
|
|
2200
2238
|
*
|
|
2201
2239
|
* Partial update; omitted fields keep their existing values. The merged
|
|
2202
|
-
* configuration is verified against the SMTP server before persisting.
|
|
2240
|
+
* configuration is verified against the SMTP server before persisting. Pass
|
|
2241
|
+
* `skip_test=true` to store it untested instead, which also clears any previous
|
|
2242
|
+
* test result — it described a configuration that no longer applies.
|
|
2203
2243
|
*
|
|
2204
2244
|
*/
|
|
2205
2245
|
'updateSmtpConnection'(
|
|
2206
|
-
parameters?: Parameters<Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2246
|
+
parameters?: Parameters<Paths.UpdateSmtpConnection.QueryParameters & Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2207
2247
|
data?: Paths.UpdateSmtpConnection.RequestBody,
|
|
2208
2248
|
config?: AxiosRequestConfig
|
|
2209
2249
|
): OperationResponse<Paths.UpdateSmtpConnection.Responses.$200>
|
|
@@ -2900,12 +2940,12 @@ interface PathsDictionary {
|
|
|
2900
2940
|
* createSmtpConnection - createSmtpConnection
|
|
2901
2941
|
*
|
|
2902
2942
|
* Creates a new custom SMTP connection. Runs a live verify against the SMTP server
|
|
2903
|
-
* before persisting; on failure the request is rejected and nothing is saved.
|
|
2904
|
-
*
|
|
2943
|
+
* before persisting; on failure the request is rejected and nothing is saved. Pass
|
|
2944
|
+
* `skip_test=true` to store the configuration untested instead.
|
|
2905
2945
|
*
|
|
2906
2946
|
*/
|
|
2907
2947
|
'post'(
|
|
2908
|
-
parameters?: Parameters<
|
|
2948
|
+
parameters?: Parameters<Paths.CreateSmtpConnection.QueryParameters> | null,
|
|
2909
2949
|
data?: Paths.CreateSmtpConnection.RequestBody,
|
|
2910
2950
|
config?: AxiosRequestConfig
|
|
2911
2951
|
): OperationResponse<Paths.CreateSmtpConnection.Responses.$201>
|
|
@@ -2925,11 +2965,13 @@ interface PathsDictionary {
|
|
|
2925
2965
|
* updateSmtpConnection - updateSmtpConnection
|
|
2926
2966
|
*
|
|
2927
2967
|
* Partial update; omitted fields keep their existing values. The merged
|
|
2928
|
-
* configuration is verified against the SMTP server before persisting.
|
|
2968
|
+
* configuration is verified against the SMTP server before persisting. Pass
|
|
2969
|
+
* `skip_test=true` to store it untested instead, which also clears any previous
|
|
2970
|
+
* test result — it described a configuration that no longer applies.
|
|
2929
2971
|
*
|
|
2930
2972
|
*/
|
|
2931
2973
|
'put'(
|
|
2932
|
-
parameters?: Parameters<Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2974
|
+
parameters?: Parameters<Paths.UpdateSmtpConnection.QueryParameters & Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2933
2975
|
data?: Paths.UpdateSmtpConnection.RequestBody,
|
|
2934
2976
|
config?: AxiosRequestConfig
|
|
2935
2977
|
): OperationResponse<Paths.UpdateSmtpConnection.Responses.$200>
|
|
@@ -240,7 +240,19 @@ declare namespace Components {
|
|
|
240
240
|
}
|
|
241
241
|
export interface CreateSmtpConnectionRequest {
|
|
242
242
|
smtp_host: string;
|
|
243
|
-
|
|
243
|
+
/**
|
|
244
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
245
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
246
|
+
* keep working.
|
|
247
|
+
*
|
|
248
|
+
*/
|
|
249
|
+
smtp_port: /**
|
|
250
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
251
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
252
|
+
* keep working.
|
|
253
|
+
*
|
|
254
|
+
*/
|
|
255
|
+
string | number;
|
|
244
256
|
smtp_secure: "tls" | "starttls";
|
|
245
257
|
smtp_username: string;
|
|
246
258
|
/**
|
|
@@ -797,9 +809,11 @@ declare namespace Components {
|
|
|
797
809
|
*/
|
|
798
810
|
smtp_host: string;
|
|
799
811
|
/**
|
|
800
|
-
* SMTP port (typically 587 for STARTTLS or 465 for TLS)
|
|
812
|
+
* SMTP port (typically 587 for STARTTLS or 465 for TLS). A string, because it
|
|
813
|
+
* may hold a `{{ env.your_key }}` reference rather than a literal port.
|
|
814
|
+
*
|
|
801
815
|
*/
|
|
802
|
-
smtp_port:
|
|
816
|
+
smtp_port: string;
|
|
803
817
|
/**
|
|
804
818
|
* Connection security mode. Plaintext SMTP is not offered: it would put the
|
|
805
819
|
* SMTP password on the wire in the clear.
|
|
@@ -951,7 +965,19 @@ declare namespace Components {
|
|
|
951
965
|
*/
|
|
952
966
|
export interface UpdateSmtpConnectionRequest {
|
|
953
967
|
smtp_host?: string;
|
|
954
|
-
|
|
968
|
+
/**
|
|
969
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
970
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
971
|
+
* keep working.
|
|
972
|
+
*
|
|
973
|
+
*/
|
|
974
|
+
smtp_port?: /**
|
|
975
|
+
* A port between 1 and 65535, or a `{{ env.your_key }}` template resolving to
|
|
976
|
+
* one. An integer is still accepted, so callers predating the template support
|
|
977
|
+
* keep working.
|
|
978
|
+
*
|
|
979
|
+
*/
|
|
980
|
+
string | number;
|
|
955
981
|
smtp_secure?: "tls" | "starttls";
|
|
956
982
|
smtp_username?: string;
|
|
957
983
|
smtp_password?: string;
|
|
@@ -1123,6 +1149,12 @@ declare namespace Paths {
|
|
|
1123
1149
|
}
|
|
1124
1150
|
}
|
|
1125
1151
|
namespace CreateSmtpConnection {
|
|
1152
|
+
namespace Parameters {
|
|
1153
|
+
export type SkipTest = boolean;
|
|
1154
|
+
}
|
|
1155
|
+
export interface QueryParameters {
|
|
1156
|
+
skip_test?: Parameters.SkipTest;
|
|
1157
|
+
}
|
|
1126
1158
|
export type RequestBody = Components.Schemas.CreateSmtpConnectionRequest;
|
|
1127
1159
|
namespace Responses {
|
|
1128
1160
|
export type $201 = Components.Schemas.SmtpConnection;
|
|
@@ -1702,6 +1734,12 @@ declare namespace Paths {
|
|
|
1702
1734
|
}
|
|
1703
1735
|
}
|
|
1704
1736
|
namespace UpdateSmtpConnection {
|
|
1737
|
+
namespace Parameters {
|
|
1738
|
+
export type SkipTest = boolean;
|
|
1739
|
+
}
|
|
1740
|
+
export interface QueryParameters {
|
|
1741
|
+
skip_test?: Parameters.SkipTest;
|
|
1742
|
+
}
|
|
1705
1743
|
export type RequestBody = /* Partial update; omitted fields keep their existing values. */ Components.Schemas.UpdateSmtpConnectionRequest;
|
|
1706
1744
|
namespace Responses {
|
|
1707
1745
|
export type $200 = Components.Schemas.SmtpConnection;
|
|
@@ -2176,12 +2214,12 @@ interface OperationMethods {
|
|
|
2176
2214
|
* createSmtpConnection - createSmtpConnection
|
|
2177
2215
|
*
|
|
2178
2216
|
* Creates a new custom SMTP connection. Runs a live verify against the SMTP server
|
|
2179
|
-
* before persisting; on failure the request is rejected and nothing is saved.
|
|
2180
|
-
*
|
|
2217
|
+
* before persisting; on failure the request is rejected and nothing is saved. Pass
|
|
2218
|
+
* `skip_test=true` to store the configuration untested instead.
|
|
2181
2219
|
*
|
|
2182
2220
|
*/
|
|
2183
2221
|
'createSmtpConnection'(
|
|
2184
|
-
parameters?: Parameters<
|
|
2222
|
+
parameters?: Parameters<Paths.CreateSmtpConnection.QueryParameters> | null,
|
|
2185
2223
|
data?: Paths.CreateSmtpConnection.RequestBody,
|
|
2186
2224
|
config?: AxiosRequestConfig
|
|
2187
2225
|
): OperationResponse<Paths.CreateSmtpConnection.Responses.$201>
|
|
@@ -2199,11 +2237,13 @@ interface OperationMethods {
|
|
|
2199
2237
|
* updateSmtpConnection - updateSmtpConnection
|
|
2200
2238
|
*
|
|
2201
2239
|
* Partial update; omitted fields keep their existing values. The merged
|
|
2202
|
-
* configuration is verified against the SMTP server before persisting.
|
|
2240
|
+
* configuration is verified against the SMTP server before persisting. Pass
|
|
2241
|
+
* `skip_test=true` to store it untested instead, which also clears any previous
|
|
2242
|
+
* test result — it described a configuration that no longer applies.
|
|
2203
2243
|
*
|
|
2204
2244
|
*/
|
|
2205
2245
|
'updateSmtpConnection'(
|
|
2206
|
-
parameters?: Parameters<Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2246
|
+
parameters?: Parameters<Paths.UpdateSmtpConnection.QueryParameters & Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2207
2247
|
data?: Paths.UpdateSmtpConnection.RequestBody,
|
|
2208
2248
|
config?: AxiosRequestConfig
|
|
2209
2249
|
): OperationResponse<Paths.UpdateSmtpConnection.Responses.$200>
|
|
@@ -2900,12 +2940,12 @@ interface PathsDictionary {
|
|
|
2900
2940
|
* createSmtpConnection - createSmtpConnection
|
|
2901
2941
|
*
|
|
2902
2942
|
* Creates a new custom SMTP connection. Runs a live verify against the SMTP server
|
|
2903
|
-
* before persisting; on failure the request is rejected and nothing is saved.
|
|
2904
|
-
*
|
|
2943
|
+
* before persisting; on failure the request is rejected and nothing is saved. Pass
|
|
2944
|
+
* `skip_test=true` to store the configuration untested instead.
|
|
2905
2945
|
*
|
|
2906
2946
|
*/
|
|
2907
2947
|
'post'(
|
|
2908
|
-
parameters?: Parameters<
|
|
2948
|
+
parameters?: Parameters<Paths.CreateSmtpConnection.QueryParameters> | null,
|
|
2909
2949
|
data?: Paths.CreateSmtpConnection.RequestBody,
|
|
2910
2950
|
config?: AxiosRequestConfig
|
|
2911
2951
|
): OperationResponse<Paths.CreateSmtpConnection.Responses.$201>
|
|
@@ -2925,11 +2965,13 @@ interface PathsDictionary {
|
|
|
2925
2965
|
* updateSmtpConnection - updateSmtpConnection
|
|
2926
2966
|
*
|
|
2927
2967
|
* Partial update; omitted fields keep their existing values. The merged
|
|
2928
|
-
* configuration is verified against the SMTP server before persisting.
|
|
2968
|
+
* configuration is verified against the SMTP server before persisting. Pass
|
|
2969
|
+
* `skip_test=true` to store it untested instead, which also clears any previous
|
|
2970
|
+
* test result — it described a configuration that no longer applies.
|
|
2929
2971
|
*
|
|
2930
2972
|
*/
|
|
2931
2973
|
'put'(
|
|
2932
|
-
parameters?: Parameters<Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2974
|
+
parameters?: Parameters<Paths.UpdateSmtpConnection.QueryParameters & Paths.V2SmtpConnections$ConnectionId.PathParameters> | null,
|
|
2933
2975
|
data?: Paths.UpdateSmtpConnection.RequestBody,
|
|
2934
2976
|
config?: AxiosRequestConfig
|
|
2935
2977
|
): OperationResponse<Paths.UpdateSmtpConnection.Responses.$200>
|
package/dist/index.cjs
CHANGED
|
@@ -93,7 +93,7 @@ var _chunk7P7O46NWcjs = require('./chunk-7P7O46NW.cjs');
|
|
|
93
93
|
var _chunkM56QQHVAcjs = require('./chunk-M56QQHVA.cjs');
|
|
94
94
|
|
|
95
95
|
|
|
96
|
-
var
|
|
96
|
+
var _chunkAWJHA3GGcjs = require('./chunk-AWJHA3GG.cjs');
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
var _chunkK2UZPY6Ucjs = require('./chunk-K2UZPY6U.cjs');
|
|
@@ -158,7 +158,7 @@ var _chunkADSWGLIVcjs = require('./chunk-ADSWGLIV.cjs');
|
|
|
158
158
|
|
|
159
159
|
|
|
160
160
|
|
|
161
|
-
var
|
|
161
|
+
var _chunkMIKSJIFKcjs = require('./chunk-MIKSJIFK.cjs');
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
|
|
|
225
225
|
}
|
|
226
226
|
if (!entry.instance) {
|
|
227
227
|
const definition = entry.loader();
|
|
228
|
-
entry.instance =
|
|
228
|
+
entry.instance = _chunkMIKSJIFKcjs.createApiClient.call(void 0, {
|
|
229
229
|
definition,
|
|
230
230
|
token: state.token,
|
|
231
231
|
headers: state.globalHeaders,
|
|
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
|
|
|
258
258
|
};
|
|
259
259
|
|
|
260
260
|
// src/apis/_registry.ts
|
|
261
|
-
var expandDef = (mod) =>
|
|
261
|
+
var expandDef = (mod) => _chunkMIKSJIFKcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
262
262
|
var registerBuiltinApis = (registry) => {
|
|
263
263
|
registerApi({
|
|
264
264
|
registry,
|
|
@@ -353,7 +353,7 @@ var registerBuiltinApis = (registry) => {
|
|
|
353
353
|
registerApi({
|
|
354
354
|
registry,
|
|
355
355
|
name: "emailSettings",
|
|
356
|
-
loader: () => expandDef(
|
|
356
|
+
loader: () => expandDef(_chunkAWJHA3GGcjs.require_email_settings_runtime.call(void 0, ))
|
|
357
357
|
});
|
|
358
358
|
registerApi({
|
|
359
359
|
registry,
|
|
@@ -601,9 +601,9 @@ var createSDK = () => {
|
|
|
601
601
|
const available = [...registry.keys()].join(", ");
|
|
602
602
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
603
603
|
}
|
|
604
|
-
return
|
|
604
|
+
return _chunkMIKSJIFKcjs.createApiHandle.call(void 0, {
|
|
605
605
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
606
|
-
createClient: () =>
|
|
606
|
+
createClient: () => _chunkMIKSJIFKcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
607
607
|
apiName: name
|
|
608
608
|
});
|
|
609
609
|
};
|
|
@@ -651,9 +651,9 @@ var createSDK = () => {
|
|
|
651
651
|
return interceptorUse;
|
|
652
652
|
}
|
|
653
653
|
case "help":
|
|
654
|
-
return (apiName) =>
|
|
654
|
+
return (apiName) => _chunkMIKSJIFKcjs.help.call(void 0, apiName);
|
|
655
655
|
case "openapi":
|
|
656
|
-
return (apiName) =>
|
|
656
|
+
return (apiName) => _chunkMIKSJIFKcjs.openapi.call(void 0, apiName);
|
|
657
657
|
case "then":
|
|
658
658
|
case "catch":
|
|
659
659
|
case "finally":
|
|
@@ -683,4 +683,4 @@ var epilot = createSDK();
|
|
|
683
683
|
|
|
684
684
|
|
|
685
685
|
|
|
686
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
686
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkMIKSJIFKcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkMIKSJIFKcjs.help; exports.openapi = _chunkMIKSJIFKcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -21,7 +21,7 @@ import { C as Client$e } from './data-governance.d-BbZ466j5.cjs';
|
|
|
21
21
|
import { C as Client$f } from './deduplication.d-Cueh8bDD.cjs';
|
|
22
22
|
import { C as Client$g } from './design.d-CYHbiaq_.cjs';
|
|
23
23
|
import { C as Client$h } from './document.d-DN37pjdx.cjs';
|
|
24
|
-
import { C as Client$i } from './email-settings.d-
|
|
24
|
+
import { C as Client$i } from './email-settings.d-DViLYaOl.cjs';
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.cjs';
|
|
26
26
|
import { C as Client$k } from './entity.d-BOpXYCU2.cjs';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-DKSW3sfy.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ import { C as Client$e } from './data-governance.d-BbZ466j5.js';
|
|
|
21
21
|
import { C as Client$f } from './deduplication.d-Cueh8bDD.js';
|
|
22
22
|
import { C as Client$g } from './design.d-CYHbiaq_.js';
|
|
23
23
|
import { C as Client$h } from './document.d-DN37pjdx.js';
|
|
24
|
-
import { C as Client$i } from './email-settings.d-
|
|
24
|
+
import { C as Client$i } from './email-settings.d-DViLYaOl.js';
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.js';
|
|
26
26
|
import { C as Client$k } from './entity.d-BOpXYCU2.js';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-DKSW3sfy.js';
|
package/dist/index.js
CHANGED
|
@@ -93,7 +93,7 @@ import {
|
|
|
93
93
|
} from "./chunk-75EI2Q64.js";
|
|
94
94
|
import {
|
|
95
95
|
require_email_settings_runtime
|
|
96
|
-
} from "./chunk-
|
|
96
|
+
} from "./chunk-7HQ3GMYQ.js";
|
|
97
97
|
import {
|
|
98
98
|
require_email_template_runtime
|
|
99
99
|
} from "./chunk-JJWJLY42.js";
|
|
@@ -158,7 +158,7 @@ import {
|
|
|
158
158
|
expand,
|
|
159
159
|
help,
|
|
160
160
|
openapi
|
|
161
|
-
} from "./chunk-
|
|
161
|
+
} from "./chunk-TAQOJW6T.js";
|
|
162
162
|
import {
|
|
163
163
|
__require
|
|
164
164
|
} from "./chunk-YPSWSI3M.js";
|