@augno/sdk 0.7.0 → 0.7.1

package/resources/messaging/email-inboxes.d.mts

@@ -0,0 +1,327 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.mjs";
+import * as ConversationsAPI from "./conversations/conversations.mjs";
+import * as EmailDomainsAPI from "./email-domains/email-domains.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Provision and manage routable email inboxes that bind inbound mail to chat conversations and send agent replies.
+ */
+export declare class EmailInboxes extends APIResource {
+    /**
+     * Provisions a routable inbox address on a verified domain.
+     *
+     * This endpoint requires the permission: `messaging:create`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.create({
+     *     address: 'support@acme.com',
+     *     email_domain_id: 'emdom_018e88072d1320808dc9aaa01',
+     *   });
+     * ```
+     */
+    create(params: EmailInboxCreateParams, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Returns the account's email inboxes.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listEmailInbox =
+     *   await client.messaging.emailInboxes.list();
+     * ```
+     */
+    list(query?: EmailInboxListParams | null | undefined, options?: RequestOptions): APIPromise<ListEmailInbox>;
+    /**
+     * Returns a single email inbox owned by the account.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.retrieve(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: EmailInboxRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Edits an email inbox's from-name, status, and default agent trigger config.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.update(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *     { status: 'active' },
+     *   );
+     * ```
+     */
+    update(id: string, params: EmailInboxUpdateParams, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Removes an email inbox.
+     *
+     * Inbound mail to its address is no longer routed.
+     *
+     * This endpoint requires the permission: `messaging:delete`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.delete(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<EmailInboxDeleteResponse>;
+}
+/**
+ * Request to provision a routable inbox on a verified domain.
+ */
+export interface CreateEmailInboxRequest {
+    /**
+     * The full inbox address (e.g. `support@acme.com`).
+     *
+     * Its domain part must match the selected domain, which must already be verified.
+     */
+    address: string;
+    /**
+     * The verified domain this inbox belongs to.
+     */
+    email_domain_id: string;
+    /**
+     * The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+/**
+ * A routable email inbox on a verified domain.
+ *
+ * Inbound mail to this address is threaded into a chat conversation, and outbound
+ * replies may be sent from this identity. The optional agent trigger config
+ * controls whether the bound agent runs automatically on incoming mail.
+ */
+export interface EmailInbox {
+    /**
+     * Email inbox ID.
+     */
+    id: string;
+    /**
+     * The full inbox address (e.g. `support@acme.com`).
+     */
+    address: string;
+    /**
+     * An AI agent available to the account.
+     *
+     * The definition describes what the agent does, how its runs are triggered, the
+     * tools it can use, and whether it is currently enabled for the account.
+     */
+    agent_config: ConversationsAPI.AgentDefinition | null;
+    /**
+     * Keywords that fire the agent when `agent_trigger_policy` is `keyword`.
+     */
+    agent_trigger_keywords: Array<string>;
+    /**
+     * When the bound agent runs on incoming mail.
+     *
+     * - `mention`: only when the agent is @mentioned, matched against its trigger
+     *   keywords.
+     * - `keyword`: when the mail contains any of the configured trigger keywords.
+     * - `always`: on every incoming message.
+     */
+    agent_trigger_policy: string | null;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * A domain registered with the email bridge for sending and receiving mail.
+     *
+     * After registration the domain starts in `pending`; publish the returned DKIM
+     * records, then poll the verify action until it flips to `verified`.
+     */
+    email_domain: EmailDomainsAPI.EmailDomain | null;
+    /**
+     * The display name used in the `From` header of outbound mail.
+     */
+    from_name: string | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'email_inbox';
+    /**
+     * Whether the inbox is currently routing mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox is provisioned but drops inbound mail and does not send
+     *   replies.
+     */
+    status: string;
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListEmailInbox {
+    /**
+     * Resources in this page.
+     */
+    data: Array<EmailInbox>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * Request to edit an email inbox's from-name, status, and default agent trigger
+ * config.
+ */
+export interface UpdateEmailInboxRequest {
+    /**
+     * Whether the inbox routes mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox stays provisioned but does not route mail.
+     */
+    status: string;
+    /**
+     * The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export interface EmailInboxDeleteResponse {
+}
+export interface EmailInboxCreateParams {
+    /**
+     * Body param: The full inbox address (e.g. `support@acme.com`).
+     *
+     * Its domain part must match the selected domain, which must already be verified.
+     */
+    address: string;
+    /**
+     * Body param: The verified domain this inbox belongs to.
+     */
+    email_domain_id: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+    /**
+     * Body param: The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Body param: Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * Body param: How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Body param: Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export interface EmailInboxListParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+}
+export interface EmailInboxRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+}
+export interface EmailInboxUpdateParams {
+    /**
+     * Body param: Whether the inbox routes mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox stays provisioned but does not route mail.
+     */
+    status: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+    /**
+     * Body param: The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Body param: Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * Body param: How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Body param: Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export declare namespace EmailInboxes {
+    export { type CreateEmailInboxRequest as CreateEmailInboxRequest, type EmailInbox as EmailInbox, type ListEmailInbox as ListEmailInbox, type UpdateEmailInboxRequest as UpdateEmailInboxRequest, type EmailInboxDeleteResponse as EmailInboxDeleteResponse, type EmailInboxCreateParams as EmailInboxCreateParams, type EmailInboxListParams as EmailInboxListParams, type EmailInboxRetrieveParams as EmailInboxRetrieveParams, type EmailInboxUpdateParams as EmailInboxUpdateParams, };
+}
+//# sourceMappingURL=email-inboxes.d.mts.map

package/resources/messaging/email-inboxes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-inboxes.d.mts","sourceRoot":"","sources":["../../src/resources/messaging/email-inboxes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,gBAAgB;OACrB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAKxF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAIzB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IASpG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,YAAY,EAAE,gBAAgB,CAAC,eAAe,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/messaging/email-inboxes.d.ts

@@ -0,0 +1,327 @@
+import { APIResource } from "../../core/resource.js";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
+import * as ConversationsAPI from "./conversations/conversations.js";
+import * as EmailDomainsAPI from "./email-domains/email-domains.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Provision and manage routable email inboxes that bind inbound mail to chat conversations and send agent replies.
+ */
+export declare class EmailInboxes extends APIResource {
+    /**
+     * Provisions a routable inbox address on a verified domain.
+     *
+     * This endpoint requires the permission: `messaging:create`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.create({
+     *     address: 'support@acme.com',
+     *     email_domain_id: 'emdom_018e88072d1320808dc9aaa01',
+     *   });
+     * ```
+     */
+    create(params: EmailInboxCreateParams, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Returns the account's email inboxes.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listEmailInbox =
+     *   await client.messaging.emailInboxes.list();
+     * ```
+     */
+    list(query?: EmailInboxListParams | null | undefined, options?: RequestOptions): APIPromise<ListEmailInbox>;
+    /**
+     * Returns a single email inbox owned by the account.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.retrieve(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: EmailInboxRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Edits an email inbox's from-name, status, and default agent trigger config.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.update(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *     { status: 'active' },
+     *   );
+     * ```
+     */
+    update(id: string, params: EmailInboxUpdateParams, options?: RequestOptions): APIPromise<EmailInbox>;
+    /**
+     * Removes an email inbox.
+     *
+     * Inbound mail to its address is no longer routed.
+     *
+     * This endpoint requires the permission: `messaging:delete`.
+     *
+     * @example
+     * ```ts
+     * const emailInbox =
+     *   await client.messaging.emailInboxes.delete(
+     *     'eminb_018e88072d1320808dc9bbb02',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<EmailInboxDeleteResponse>;
+}
+/**
+ * Request to provision a routable inbox on a verified domain.
+ */
+export interface CreateEmailInboxRequest {
+    /**
+     * The full inbox address (e.g. `support@acme.com`).
+     *
+     * Its domain part must match the selected domain, which must already be verified.
+     */
+    address: string;
+    /**
+     * The verified domain this inbox belongs to.
+     */
+    email_domain_id: string;
+    /**
+     * The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+/**
+ * A routable email inbox on a verified domain.
+ *
+ * Inbound mail to this address is threaded into a chat conversation, and outbound
+ * replies may be sent from this identity. The optional agent trigger config
+ * controls whether the bound agent runs automatically on incoming mail.
+ */
+export interface EmailInbox {
+    /**
+     * Email inbox ID.
+     */
+    id: string;
+    /**
+     * The full inbox address (e.g. `support@acme.com`).
+     */
+    address: string;
+    /**
+     * An AI agent available to the account.
+     *
+     * The definition describes what the agent does, how its runs are triggered, the
+     * tools it can use, and whether it is currently enabled for the account.
+     */
+    agent_config: ConversationsAPI.AgentDefinition | null;
+    /**
+     * Keywords that fire the agent when `agent_trigger_policy` is `keyword`.
+     */
+    agent_trigger_keywords: Array<string>;
+    /**
+     * When the bound agent runs on incoming mail.
+     *
+     * - `mention`: only when the agent is @mentioned, matched against its trigger
+     *   keywords.
+     * - `keyword`: when the mail contains any of the configured trigger keywords.
+     * - `always`: on every incoming message.
+     */
+    agent_trigger_policy: string | null;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * A domain registered with the email bridge for sending and receiving mail.
+     *
+     * After registration the domain starts in `pending`; publish the returned DKIM
+     * records, then poll the verify action until it flips to `verified`.
+     */
+    email_domain: EmailDomainsAPI.EmailDomain | null;
+    /**
+     * The display name used in the `From` header of outbound mail.
+     */
+    from_name: string | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'email_inbox';
+    /**
+     * Whether the inbox is currently routing mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox is provisioned but drops inbound mail and does not send
+     *   replies.
+     */
+    status: string;
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListEmailInbox {
+    /**
+     * Resources in this page.
+     */
+    data: Array<EmailInbox>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * Request to edit an email inbox's from-name, status, and default agent trigger
+ * config.
+ */
+export interface UpdateEmailInboxRequest {
+    /**
+     * Whether the inbox routes mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox stays provisioned but does not route mail.
+     */
+    status: string;
+    /**
+     * The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export interface EmailInboxDeleteResponse {
+}
+export interface EmailInboxCreateParams {
+    /**
+     * Body param: The full inbox address (e.g. `support@acme.com`).
+     *
+     * Its domain part must match the selected domain, which must already be verified.
+     */
+    address: string;
+    /**
+     * Body param: The verified domain this inbox belongs to.
+     */
+    email_domain_id: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+    /**
+     * Body param: The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Body param: Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * Body param: How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Body param: Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export interface EmailInboxListParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+}
+export interface EmailInboxRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+}
+export interface EmailInboxUpdateParams {
+    /**
+     * Body param: Whether the inbox routes mail.
+     *
+     * - `active`: inbound mail is threaded and outbound replies are allowed.
+     * - `disabled`: the inbox stays provisioned but does not route mail.
+     */
+    status: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'email_domain' | 'agent_config'>;
+    /**
+     * Body param: The agent to bind to this inbox to handle incoming mail.
+     */
+    agent_config_id?: string;
+    /**
+     * Body param: Keywords that fire the agent when the trigger policy is `keyword`.
+     */
+    agent_trigger_keywords?: Array<string>;
+    /**
+     * Body param: How the bound agent decides whether to run on incoming mail.
+     *
+     * - `mention`: runs only when the agent is @mentioned in the message.
+     * - `keyword`: runs when the message contains any of the trigger keywords.
+     * - `always`: runs on every incoming message.
+     */
+    agent_trigger_policy?: string;
+    /**
+     * Body param: Display name for the `From` header of outbound mail.
+     */
+    from_name?: string;
+}
+export declare namespace EmailInboxes {
+    export { type CreateEmailInboxRequest as CreateEmailInboxRequest, type EmailInbox as EmailInbox, type ListEmailInbox as ListEmailInbox, type UpdateEmailInboxRequest as UpdateEmailInboxRequest, type EmailInboxDeleteResponse as EmailInboxDeleteResponse, type EmailInboxCreateParams as EmailInboxCreateParams, type EmailInboxListParams as EmailInboxListParams, type EmailInboxRetrieveParams as EmailInboxRetrieveParams, type EmailInboxUpdateParams as EmailInboxUpdateParams, };
+}
+//# sourceMappingURL=email-inboxes.d.ts.map

package/resources/messaging/email-inboxes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-inboxes.d.ts","sourceRoot":"","sources":["../../src/resources/messaging/email-inboxes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,gBAAgB;OACrB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAKxF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAIzB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IASpG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,YAAY,EAAE,gBAAgB,CAAC,eAAe,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}