telnyx 7.12.0 → 7.13.0

package/src/resources/email-inboxes/email-inboxes.ts

@@ -0,0 +1,276 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as DraftsAPI from './drafts';
+import {
+  DraftCreateParams,
+  DraftDeleteParams,
+  DraftListParams,
+  DraftListResponse,
+  DraftPatchParams,
+  DraftRetrieveParams,
+  DraftSendParams,
+  DraftUpdateParams,
+  Drafts,
+  EmailAddress,
+  EmailDraft,
+  EmailDraftRequest,
+  EmailDraftResponse,
+  EmailMessage,
+  EmailMessageResponse,
+} from './drafts';
+import * as FiltersAPI from './filters';
+import {
+  FilterAddParams,
+  FilterAddResponse,
+  FilterDeleteAllParams,
+  FilterDeleteAllResponse,
+  FilterListResponse,
+  FilterReplaceParams,
+  FilterReplaceResponse,
+  Filters,
+  MutateInboxFiltersRequest,
+} from './filters';
+import * as MessagesAPI from './messages/messages';
+import {
+  MessageDraftsParams,
+  MessageListParams,
+  MessageListResponse,
+  MessageUpdateParams,
+  MessageUpdateResponse,
+  Messages,
+} from './messages/messages';
+import * as ThreadsAPI from './threads/threads';
+import {
+  EmailPaginationMeta,
+  InboundEmailAddress,
+  InboundThread,
+  InboundThreadDetail,
+  InboundThreadListResponse,
+  ThreadListParams,
+  ThreadMessage,
+  ThreadRetrieveParams,
+  ThreadRetrieveResponse,
+  Threads,
+} from './threads/threads';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export class EmailInboxes extends APIResource {
+  drafts: DraftsAPI.Drafts = new DraftsAPI.Drafts(this._client);
+  filters: FiltersAPI.Filters = new FiltersAPI.Filters(this._client);
+  messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
+  threads: ThreadsAPI.Threads = new ThreadsAPI.Threads(this._client);
+
+  /**
+   * Lists the account's non-deleted inboxes newest first using stable cursor
+   * pagination.
+   *
+   * @example
+   * ```ts
+   * const emailInboxes = await client.emailInboxes.list();
+   * ```
+   */
+  list(
+    query: EmailInboxListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EmailInboxListResponse> {
+    return this._client.get('/email_inboxes', { query, ...options });
+  }
+
+  /**
+   * Creates an inbox on an inbound-enabled domain. When `domain_id` is omitted,
+   * Telnyx allocates the account's shared inbound subdomain so the inbox is
+   * immediately usable without customer DNS setup. When `username` is omitted, a
+   * unique username is generated.
+   *
+   * @example
+   * ```ts
+   * const emailInboxResponse =
+   *   await client.emailInboxes.create();
+   * ```
+   */
+  create(
+    body: EmailInboxCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EmailInboxResponse> {
+    return this._client.post('/email_inboxes', { body, ...options });
+  }
+
+  /**
+   * Soft-deletes an account-scoped inbox. Its address remains reserved and the inbox
+   * is no longer returned by list or get operations.
+   *
+   * @example
+   * ```ts
+   * await client.emailInboxes.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/email_inboxes/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Returns an account-scoped, non-deleted inbox. Missing and foreign inboxes are
+   * indistinguishable.
+   *
+   * @example
+   * ```ts
+   * const emailInboxResponse =
+   *   await client.emailInboxes.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EmailInboxResponse> {
+    return this._client.get(path`/email_inboxes/${id}`, options);
+  }
+}
+
+export interface EmailInbox {
+  id: string;
+
+  address: string;
+
+  created_at: string;
+
+  /**
+   * Domain name used by the inbox address.
+   */
+  domain: string;
+
+  domain_id: string;
+
+  record_type: 'email_inbox';
+
+  settings: { [key: string]: unknown };
+
+  status: 'active' | 'paused';
+
+  updated_at: string;
+}
+
+export interface EmailInboxResponse {
+  data: EmailInbox;
+}
+
+export interface EmailInboxListResponse {
+  data: Array<EmailInbox>;
+
+  meta: EmailInboxListResponse.Meta;
+}
+
+export namespace EmailInboxListResponse {
+  export interface Meta {
+    page_size: number;
+
+    /**
+     * Cursor for the next inbox page, when more results are available.
+     */
+    page_cursor?: string;
+  }
+}
+
+export interface EmailInboxListParams {
+  /**
+   * Opaque cursor returned by the previous inbox page.
+   */
+  page_cursor?: string;
+
+  /**
+   * Number of results to return. Defaults to 20; maximum is 250.
+   */
+  page_size?: number;
+}
+
+export interface EmailInboxCreateParams {
+  /**
+   * Account-owned, inbound-enabled domain UUID. The account's shared inbound
+   * subdomain is allocated when omitted.
+   */
+  domain_id?: string;
+
+  /**
+   * Inbox local part. Trimmed and lowercased before validation; the normalized value
+   * must be 1-64 characters, start and end with a letter or digit, and contain only
+   * letters, digits, dots, hyphens, and underscores. Generated when omitted.
+   */
+  username?: string;
+}
+
+EmailInboxes.Drafts = Drafts;
+EmailInboxes.Filters = Filters;
+EmailInboxes.Messages = Messages;
+EmailInboxes.Threads = Threads;
+
+export declare namespace EmailInboxes {
+  export {
+    type EmailInbox as EmailInbox,
+    type EmailInboxResponse as EmailInboxResponse,
+    type EmailInboxListResponse as EmailInboxListResponse,
+    type EmailInboxListParams as EmailInboxListParams,
+    type EmailInboxCreateParams as EmailInboxCreateParams,
+  };
+
+  export {
+    Drafts as Drafts,
+    type EmailAddress as EmailAddress,
+    type EmailDraft as EmailDraft,
+    type EmailDraftRequest as EmailDraftRequest,
+    type EmailDraftResponse as EmailDraftResponse,
+    type EmailMessage as EmailMessage,
+    type EmailMessageResponse as EmailMessageResponse,
+    type DraftListResponse as DraftListResponse,
+    type DraftListParams as DraftListParams,
+    type DraftCreateParams as DraftCreateParams,
+    type DraftDeleteParams as DraftDeleteParams,
+    type DraftRetrieveParams as DraftRetrieveParams,
+    type DraftUpdateParams as DraftUpdateParams,
+    type DraftPatchParams as DraftPatchParams,
+    type DraftSendParams as DraftSendParams,
+  };
+
+  export {
+    Filters as Filters,
+    type MutateInboxFiltersRequest as MutateInboxFiltersRequest,
+    type FilterListResponse as FilterListResponse,
+    type FilterAddResponse as FilterAddResponse,
+    type FilterDeleteAllResponse as FilterDeleteAllResponse,
+    type FilterReplaceResponse as FilterReplaceResponse,
+    type FilterDeleteAllParams as FilterDeleteAllParams,
+    type FilterAddParams as FilterAddParams,
+    type FilterReplaceParams as FilterReplaceParams,
+  };
+
+  export {
+    Messages as Messages,
+    type MessageUpdateResponse as MessageUpdateResponse,
+    type MessageListResponse as MessageListResponse,
+    type MessageListParams as MessageListParams,
+    type MessageUpdateParams as MessageUpdateParams,
+    type MessageDraftsParams as MessageDraftsParams,
+  };
+
+  export {
+    Threads as Threads,
+    type EmailPaginationMeta as EmailPaginationMeta,
+    type InboundEmailAddress as InboundEmailAddress,
+    type InboundThread as InboundThread,
+    type InboundThreadDetail as InboundThreadDetail,
+    type InboundThreadListResponse as InboundThreadListResponse,
+    type ThreadMessage as ThreadMessage,
+    type ThreadRetrieveResponse as ThreadRetrieveResponse,
+    type ThreadListParams as ThreadListParams,
+    type ThreadRetrieveParams as ThreadRetrieveParams,
+  };
+}

package/src/resources/email-inboxes/filters.ts

@@ -0,0 +1,193 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Create and manage agent inboxes, retrieve inbound messages and threads, and reply to or forward messages.
+ */
+export class Filters extends APIResource {
+  /**
+   * Removes entries from either the allowlist or blocklist. The operation is
+   * idempotent: removing an entry that is not present still returns the current
+   * filter lists.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.emailInboxes.filters.deleteAll(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       entries: ['former-partner@example.com'],
+   *       type: 'allowlist',
+   *     },
+   *   );
+   * ```
+   */
+  deleteAll(
+    inboxID: string,
+    body: FilterDeleteAllParams,
+    options?: RequestOptions,
+  ): APIPromise<FilterDeleteAllResponse> {
+    return this._client.delete(path`/email_inboxes/${inboxID}/filters`, { body, ...options });
+  }
+
+  /**
+   * Returns the inbox's sender allowlist and blocklist. Entries are normalized to
+   * lowercase. A blocklist match takes precedence over an allowlist match; when both
+   * lists are empty, all senders are accepted.
+   *
+   * @example
+   * ```ts
+   * const filters = await client.emailInboxes.filters.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  list(inboxID: string, options?: RequestOptions): APIPromise<FilterListResponse> {
+    return this._client.get(path`/email_inboxes/${inboxID}/filters`, options);
+  }
+
+  /**
+   * Adds entries to either the allowlist or blocklist. The operation is an
+   * idempotent set union: entries already present remain unchanged.
+   *
+   * @example
+   * ```ts
+   * const response = await client.emailInboxes.filters.add(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { entries: ['@spam.example'], type: 'blocklist' },
+   * );
+   * ```
+   */
+  add(inboxID: string, body: FilterAddParams, options?: RequestOptions): APIPromise<FilterAddResponse> {
+    return this._client.post(path`/email_inboxes/${inboxID}/filters`, { body, ...options });
+  }
+
+  /**
+   * Replaces both sender filter lists atomically. Omitting either list clears that
+   * list. Use `POST` or `DELETE` for incremental changes.
+   *
+   * @example
+   * ```ts
+   * const response = await client.emailInboxes.filters.replace(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     allowlist: ['trusted@example.com', '@partner.example'],
+   *     blocklist: ['@spam.example'],
+   *   },
+   * );
+   * ```
+   */
+  replace(
+    inboxID: string,
+    body: FilterReplaceParams,
+    options?: RequestOptions,
+  ): APIPromise<FilterReplaceResponse> {
+    return this._client.put(path`/email_inboxes/${inboxID}/filters`, { body, ...options });
+  }
+}
+
+export interface MutateInboxFiltersRequest {
+  entries: Array<string>;
+
+  /**
+   * The list to change.
+   */
+  type: 'allowlist' | 'blocklist';
+}
+
+export interface FilterListResponse {
+  data: FilterListResponse.Data;
+}
+
+export namespace FilterListResponse {
+  export interface Data {
+    allowlist: Array<string>;
+
+    blocklist: Array<string>;
+
+    record_type: 'email_inbox_filters';
+  }
+}
+
+export interface FilterAddResponse {
+  data: FilterAddResponse.Data;
+}
+
+export namespace FilterAddResponse {
+  export interface Data {
+    allowlist: Array<string>;
+
+    blocklist: Array<string>;
+
+    record_type: 'email_inbox_filters';
+  }
+}
+
+export interface FilterDeleteAllResponse {
+  data: FilterDeleteAllResponse.Data;
+}
+
+export namespace FilterDeleteAllResponse {
+  export interface Data {
+    allowlist: Array<string>;
+
+    blocklist: Array<string>;
+
+    record_type: 'email_inbox_filters';
+  }
+}
+
+export interface FilterReplaceResponse {
+  data: FilterReplaceResponse.Data;
+}
+
+export namespace FilterReplaceResponse {
+  export interface Data {
+    allowlist: Array<string>;
+
+    blocklist: Array<string>;
+
+    record_type: 'email_inbox_filters';
+  }
+}
+
+export interface FilterDeleteAllParams {
+  entries: Array<string>;
+
+  /**
+   * The list to change.
+   */
+  type: 'allowlist' | 'blocklist';
+}
+
+export interface FilterAddParams {
+  entries: Array<string>;
+
+  /**
+   * The list to change.
+   */
+  type: 'allowlist' | 'blocklist';
+}
+
+export interface FilterReplaceParams {
+  allowlist?: Array<string>;
+
+  blocklist?: Array<string>;
+}
+
+export declare namespace Filters {
+  export {
+    type MutateInboxFiltersRequest as MutateInboxFiltersRequest,
+    type FilterListResponse as FilterListResponse,
+    type FilterAddResponse as FilterAddResponse,
+    type FilterDeleteAllResponse as FilterDeleteAllResponse,
+    type FilterReplaceResponse as FilterReplaceResponse,
+    type FilterDeleteAllParams as FilterDeleteAllParams,
+    type FilterAddParams as FilterAddParams,
+    type FilterReplaceParams as FilterReplaceParams,
+  };
+}

package/src/resources/email-inboxes/index.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Drafts,
+  type EmailAddress,
+  type EmailDraft,
+  type EmailDraftRequest,
+  type EmailDraftResponse,
+  type EmailMessage,
+  type EmailMessageResponse,
+  type DraftListResponse,
+  type DraftListParams,
+  type DraftCreateParams,
+  type DraftDeleteParams,
+  type DraftRetrieveParams,
+  type DraftUpdateParams,
+  type DraftPatchParams,
+  type DraftSendParams,
+} from './drafts';
+export {
+  EmailInboxes,
+  type EmailInbox,
+  type EmailInboxResponse,
+  type EmailInboxListResponse,
+  type EmailInboxListParams,
+  type EmailInboxCreateParams,
+} from './email-inboxes';
+export {
+  Filters,
+  type MutateInboxFiltersRequest,
+  type FilterListResponse,
+  type FilterAddResponse,
+  type FilterDeleteAllResponse,
+  type FilterReplaceResponse,
+  type FilterDeleteAllParams,
+  type FilterAddParams,
+  type FilterReplaceParams,
+} from './filters';
+export {
+  Messages,
+  type MessageUpdateResponse,
+  type MessageListResponse,
+  type MessageListParams,
+  type MessageUpdateParams,
+  type MessageDraftsParams,
+} from './messages/index';
+export {
+  Threads,
+  type EmailPaginationMeta,
+  type InboundEmailAddress,
+  type InboundThread,
+  type InboundThreadDetail,
+  type InboundThreadListResponse,
+  type ThreadMessage,
+  type ThreadRetrieveResponse,
+  type ThreadListParams,
+  type ThreadRetrieveParams,
+} from './threads/index';