@mobilerun/sdk 5.5.0 → 5.6.0

package/src/resources/mailboxes/mailboxes.ts

@@ -2,6 +2,13 @@
 
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import * as ConnectionsAPI from './connections';
+import {
+  ConnectionCreateParams,
+  ConnectionCreateResponse,
+  ConnectionRetrieveResponse,
+  Connections,
+} from './connections';
 import * as MessagesAPI from './messages';
 import {
   MessageListParams,
@@ -15,22 +22,25 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Mailboxes extends APIResource {
+  connections: ConnectionsAPI.Connections = new ConnectionsAPI.Connections(this._client);
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
   /**
    * Creates a mailbox on the default domain or a connected custom domain. An
-   * optional `localPart` selects the address. Replaying the same `clientRequestId`
-   * and payload returns the original mailbox. Poll the mailbox when a 202 response
-   * does not yet include a checkout URL.
+   * optional `localPart` selects the address. Replaying the same Idempotency-Key
+   * (or, during migration, the deprecated `clientRequestId` body field) and payload
+   * returns the original mailbox. Poll the mailbox when a 202 response does not yet
+   * include a checkout URL.
    *
    * @example
    * ```ts
-   * const mailbox = await client.mailboxes.create({
-   *   clientRequestId: 'x',
-   * });
+   * const mailbox = await client.mailboxes.create();
    * ```
    */
-  create(body: MailboxCreateParams, options?: RequestOptions): APIPromise<MailboxCreateResponse> {
+  create(
+    body: MailboxCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MailboxCreateResponse> {
     return this._client.post('/mailboxes', { body, ...options });
   }
 
@@ -84,7 +94,8 @@ export class Mailboxes extends APIResource {
 
   /**
    * Cancels a pending mailbox or schedules an active paid mailbox for cancellation.
-   * Existing addresses and messages are retained. Repeating the request is safe.
+   * Existing addresses and messages are retained. Repeating the request is safe. An
+   * external inbox (Gmail) cannot be cancelled here; disconnect the link instead.
    *
    * @example
    * ```ts
@@ -109,6 +120,20 @@ export class Mailboxes extends APIResource {
     return this._client.get('/mailboxes/capacity', options);
   }
 
+  /**
+   * Removes only this mailbox link. The agent Composio connection stays in place.
+   *
+   * @example
+   * ```ts
+   * const response = await client.mailboxes.disconnect(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  disconnect(mailboxID: string, options?: RequestOptions): APIPromise<MailboxDisconnectResponse> {
+    return this._client.post(path`/mailboxes/${mailboxID}/disconnect`, options);
+  }
+
   /**
    * Returns the most likely recent OTP for the mailbox. Returns 204 when no matching
    * code is available.
@@ -173,7 +198,7 @@ export namespace MailboxCreateResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -191,13 +216,18 @@ export namespace MailboxCreateResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -223,7 +253,7 @@ export namespace MailboxRetrieveResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -241,13 +271,18 @@ export namespace MailboxRetrieveResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -273,7 +308,7 @@ export namespace MailboxUpdateResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -291,13 +326,18 @@ export namespace MailboxUpdateResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -325,7 +365,7 @@ export namespace MailboxListResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -343,13 +383,18 @@ export namespace MailboxListResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Item {
@@ -375,7 +420,7 @@ export namespace MailboxDeleteResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -393,13 +438,18 @@ export namespace MailboxDeleteResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -431,6 +481,61 @@ export namespace MailboxCapacityResponse {
   }
 }
 
+export interface MailboxDisconnectResponse {
+  data: MailboxDisconnectResponse.Data;
+}
+
+export namespace MailboxDisconnectResponse {
+  export interface Data {
+    id: string;
+
+    address: string | null;
+
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
+
+    cancelAtPeriodEnd: boolean;
+
+    checkoutExpiresAt: string | null;
+
+    checkoutUrl: string | null;
+
+    createdAt: string;
+
+    currentPeriodEnd: string | null;
+
+    domainId: string | null;
+
+    inboundMessages: Data.InboundMessages;
+
+    label: string | null;
+
+    provider: 'matix' | 'gmail';
+
+    status:
+      | 'provisioning'
+      | 'awaiting_payment'
+      | 'active'
+      | 'cancel_scheduled'
+      | 'archived'
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
+  }
+
+  export namespace Data {
+    export interface InboundMessages {
+      exhausted: boolean;
+
+      included: number;
+
+      resetsAt: string | null;
+
+      used: number;
+    }
+  }
+}
+
 export interface MailboxOtpResponse {
   data: MailboxOtpResponse.Data;
 }
@@ -464,7 +569,7 @@ export namespace MailboxRestartResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -482,13 +587,18 @@ export namespace MailboxRestartResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -514,7 +624,7 @@ export namespace MailboxUncancelResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included' | 'domain';
+    billingMode: 'rent' | 'included' | 'domain' | 'external';
 
     cancelAtPeriodEnd: boolean;
 
@@ -532,13 +642,18 @@ export namespace MailboxUncancelResponse {
 
     label: string | null;
 
+    provider: 'matix' | 'gmail';
+
     status:
       | 'provisioning'
       | 'awaiting_payment'
       | 'active'
       | 'cancel_scheduled'
       | 'archived'
-      | 'billing_error';
+      | 'billing_error'
+      | 'pending_connection'
+      | 'connection_expired'
+      | 'connection_removed';
   }
 
   export namespace Data {
@@ -555,8 +670,6 @@ export namespace MailboxUncancelResponse {
 }
 
 export interface MailboxCreateParams {
-  clientRequestId: string;
-
   /**
    * included uses package capacity when available and otherwise starts paid
    * checkout; included_only fails without creating a paid reservation when no
@@ -607,6 +720,7 @@ export interface MailboxRestartParams {
   billingPreference?: 'included' | 'included_only' | 'rent';
 }
 
+Mailboxes.Connections = Connections;
 Mailboxes.Messages = Messages;
 
 export declare namespace Mailboxes {
@@ -617,6 +731,7 @@ export declare namespace Mailboxes {
     type MailboxListResponse as MailboxListResponse,
     type MailboxDeleteResponse as MailboxDeleteResponse,
     type MailboxCapacityResponse as MailboxCapacityResponse,
+    type MailboxDisconnectResponse as MailboxDisconnectResponse,
     type MailboxOtpResponse as MailboxOtpResponse,
     type MailboxRestartResponse as MailboxRestartResponse,
     type MailboxUncancelResponse as MailboxUncancelResponse,
@@ -627,6 +742,13 @@ export declare namespace Mailboxes {
     type MailboxRestartParams as MailboxRestartParams,
   };
 
+  export {
+    Connections as Connections,
+    type ConnectionCreateResponse as ConnectionCreateResponse,
+    type ConnectionRetrieveResponse as ConnectionRetrieveResponse,
+    type ConnectionCreateParams as ConnectionCreateParams,
+  };
+
   export {
     Messages as Messages,
     type MessageRetrieveResponse as MessageRetrieveResponse,

package/src/resources/messages/index.ts

@@ -7,4 +7,9 @@ export {
   type ConversationListParams,
   type ConversationMarkReadParams,
 } from './conversations';
-export { Messages, type MessageListResponse, type MessageListParams } from './messages';
+export {
+  Messages,
+  type MessageRetrieveResponse,
+  type MessageListResponse,
+  type MessageListParams,
+} from './messages';

package/src/resources/messages/messages.ts

@@ -12,10 +12,20 @@ import {
 } from './conversations';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Messages extends APIResource {
   conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
 
+  /**
+   * Returns one message. For an outbound message that is not yet final, the status
+   * may be refreshed once (at most every 30 s) before it is returned; a failed
+   * refresh returns the stored message.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
+    return this._client.get(path`/numbers/messages/${id}`, options);
+  }
+
   /**
    * Lists SMS messages newest first, with filters for direction, eSIM, phone number,
    * status, and conversation.
@@ -28,6 +38,46 @@ export class Messages extends APIResource {
   }
 }
 
+export interface MessageRetrieveResponse {
+  data: MessageRetrieveResponse.Data;
+}
+
+export namespace MessageRetrieveResponse {
+  export interface Data {
+    id: string;
+
+    body: string | null;
+
+    createdAt: string;
+
+    deliveryStatus: string | null;
+
+    detectedSender: string | null;
+
+    direction: 'inbound' | 'outbound';
+
+    esimId: string | null;
+
+    occurredAt: string;
+
+    peerKey: string | null;
+
+    peerNumber: string | null;
+
+    providerCode: string | null;
+
+    status:
+      | 'received'
+      | 'queued'
+      | 'claimed'
+      | 'sending'
+      | 'sent'
+      | 'sent_unconfirmed'
+      | 'delivered'
+      | 'failed';
+  }
+}
+
 export interface MessageListResponse {
   items: Array<MessageListResponse.Item>;
 
@@ -100,7 +150,11 @@ export interface MessageListParams {
 Messages.Conversations = Conversations;
 
 export declare namespace Messages {
-  export { type MessageListResponse as MessageListResponse, type MessageListParams as MessageListParams };
+  export {
+    type MessageRetrieveResponse as MessageRetrieveResponse,
+    type MessageListResponse as MessageListResponse,
+    type MessageListParams as MessageListParams,
+  };
 
   export {
     Conversations as Conversations,

package/src/resources/notifications.ts

@@ -5,6 +5,27 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 export class Notifications extends APIResource {
+  /**
+   * Replaces your muted event types with a server-computed preset: `recommended`
+   * mutes the mobilerun-default noisy lifecycle/progress events, `failures` mutes
+   * everything except failures/timeouts/invalid runs, and `everything` unmutes all.
+   * The response returns the muted types that were actually stored.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.notifications.applyPreferencesPreset({
+   *     preset: 'recommended',
+   *   });
+   * ```
+   */
+  applyPreferencesPreset(
+    body: NotificationApplyPreferencesPresetParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationApplyPreferencesPresetResponse> {
+    return this._client.post('/notifications/preferences/apply-preset', { body, ...options });
+  }
+
   /**
    * Returns the catalog of notifiable event types grouped by source category. Each
    * event lists its type identifier, label, and description, which can be referenced
@@ -58,6 +79,16 @@ export class Notifications extends APIResource {
   }
 }
 
+export interface NotificationApplyPreferencesPresetResponse {
+  data: NotificationApplyPreferencesPresetResponse.Data;
+}
+
+export namespace NotificationApplyPreferencesPresetResponse {
+  export interface Data {
+    mutedTypes: Array<string>;
+  }
+}
+
 export interface NotificationCatalogResponse {
   data: Array<NotificationCatalogResponse.Data>;
 }
@@ -104,15 +135,21 @@ export namespace NotificationUpdatePreferencesResponse {
   }
 }
 
+export interface NotificationApplyPreferencesPresetParams {
+  preset: 'recommended' | 'failures' | 'everything';
+}
+
 export interface NotificationUpdatePreferencesParams {
   mutedTypes: Array<string>;
 }
 
 export declare namespace Notifications {
   export {
+    type NotificationApplyPreferencesPresetResponse as NotificationApplyPreferencesPresetResponse,
     type NotificationCatalogResponse as NotificationCatalogResponse,
     type NotificationGetPreferencesResponse as NotificationGetPreferencesResponse,
     type NotificationUpdatePreferencesResponse as NotificationUpdatePreferencesResponse,
+    type NotificationApplyPreferencesPresetParams as NotificationApplyPreferencesPresetParams,
     type NotificationUpdatePreferencesParams as NotificationUpdatePreferencesParams,
   };
 }

package/src/resources/numbers/index.ts

@@ -1,6 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Messages, type MessageListResponse, type MessageListParams } from './messages';
+export {
+  Messages,
+  type MessageListResponse,
+  type MessageSendResponse,
+  type MessageListParams,
+  type MessageSendParams,
+} from './messages';
 export {
   Numbers,
   type NumberCreateResponse,

package/src/resources/numbers/messages.ts

@@ -26,6 +26,28 @@ export class Messages extends APIResource {
   ): APIPromise<MessageListResponse> {
     return this._client.get(path`/numbers/phones/${id}/messages`, { query, ...options });
   }
+
+  /**
+   * Queues an SMS from one of the caller's numbers that can send. Same idempotency
+   * contract as the eSIM send: replaying an Idempotency-Key with the same payload
+   * returns the original message, reusing it with a different payload returns 422.
+   * 409 capability_unavailable: this number cannot send right now. 422
+   * invalid_recipient / unsupported_destination / body_too_long: the recipient or
+   * text does not fit the number. 429 daily_limit_reached: the rolling 24 h limit
+   * for the account is used up; 429 rate_limited: too many sends in a short window.
+   * 403 send_disabled: self-service SMS send is switched off.
+   *
+   * @example
+   * ```ts
+   * const response = await client.numbers.messages.send(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   *   { body: 'x', to: '+15551230001' },
+   * );
+   * ```
+   */
+  send(id: string, body: MessageSendParams, options?: RequestOptions): APIPromise<MessageSendResponse> {
+    return this._client.post(path`/numbers/phones/${id}/messages`, { body, ...options });
+  }
 }
 
 export interface MessageListResponse {
@@ -68,6 +90,44 @@ export namespace MessageListResponse {
   }
 }
 
+export interface MessageSendResponse {
+  data: MessageSendResponse.Data;
+}
+
+export namespace MessageSendResponse {
+  export interface Data {
+    id: string;
+
+    body: string | null;
+
+    createdAt: string;
+
+    deliveryStatus: string | null;
+
+    detectedSender: string | null;
+
+    direction: 'inbound' | 'outbound';
+
+    esimId: string | null;
+
+    occurredAt: string;
+
+    peerKey: string | null;
+
+    peerNumber: string | null;
+
+    status:
+      | 'received'
+      | 'queued'
+      | 'claimed'
+      | 'sending'
+      | 'sent'
+      | 'sent_unconfirmed'
+      | 'delivered'
+      | 'failed';
+  }
+}
+
 export interface MessageListParams {
   direction?: 'all' | 'inbound' | 'outbound';
 
@@ -78,6 +138,37 @@ export interface MessageListParams {
   since?: string;
 }
 
+export interface MessageSendParams {
+  /**
+   * SMS body text, up to 1600 characters (rejected with 400 beyond that, before
+   * hashing). A number's own limit may be lower and is answered 422 body_too_long.
+   */
+  body: string;
+
+  /**
+   * Recipient phone number, as E.164 or a US 10/11-digit number. Destinations the
+   * number cannot send to are rejected with 422 unsupported_destination, non-numbers
+   * with 422 invalid_recipient.
+   */
+  to: string;
+
+  /**
+   * @deprecated Deprecated: use the Idempotency-Key header instead. Optional
+   * idempotency key. Replaying the same key and payload returns the original send.
+   */
+  clientRequestId?: string;
+
+  /**
+   * Request a delivery report. Defaults to false.
+   */
+  deliveryReport?: boolean;
+}
+
 export declare namespace Messages {
-  export { type MessageListResponse as MessageListResponse, type MessageListParams as MessageListParams };
+  export {
+    type MessageListResponse as MessageListResponse,
+    type MessageSendResponse as MessageSendResponse,
+    type MessageListParams as MessageListParams,
+    type MessageSendParams as MessageSendParams,
+  };
 }