@mobilerun/sdk 5.4.0 → 5.5.0

package/src/resources/files.ts

@@ -97,6 +97,44 @@ export interface FileUpdateResponse {
   sizeBytes: number;
 
   zone: 'user' | 'agent' | 'workflow' | 'skills';
+
+  collectionStatus?: FileUpdateResponse.UnionMember0 | FileUpdateResponse.UnionMember1;
+}
+
+export namespace FileUpdateResponse {
+  export interface UnionMember0 {
+    completeness: 'complete' | 'partial' | 'none' | 'unknown';
+
+    coverage: 'exhaustive' | 'bounded' | 'unknown';
+
+    endReached: boolean;
+
+    records: UnionMember0.Records;
+
+    resumable: boolean;
+
+    version: 1;
+  }
+
+  export namespace UnionMember0 {
+    export interface Records {
+      reported: number;
+
+      unit: string;
+    }
+  }
+
+  export interface UnionMember1 {
+    completeness: 'unknown';
+
+    coverage: 'unknown';
+
+    endReached: false;
+
+    resumable: false;
+
+    version: 1;
+  }
 }
 
 export interface FileListResponse {
@@ -124,6 +162,44 @@ export namespace FileListResponse {
     sizeBytes: number;
 
     zone: 'user' | 'agent' | 'workflow' | 'skills';
+
+    collectionStatus?: File.UnionMember0 | File.UnionMember1;
+  }
+
+  export namespace File {
+    export interface UnionMember0 {
+      completeness: 'complete' | 'partial' | 'none' | 'unknown';
+
+      coverage: 'exhaustive' | 'bounded' | 'unknown';
+
+      endReached: boolean;
+
+      records: UnionMember0.Records;
+
+      resumable: boolean;
+
+      version: 1;
+    }
+
+    export namespace UnionMember0 {
+      export interface Records {
+        reported: number;
+
+        unit: string;
+      }
+    }
+
+    export interface UnionMember1 {
+      completeness: 'unknown';
+
+      coverage: 'unknown';
+
+      endReached: false;
+
+      resumable: false;
+
+      version: 1;
+    }
   }
 
   export interface Quota {
@@ -163,6 +239,44 @@ export interface FileConfirmResponse {
   state: 'ready';
 
   zone: 'user' | 'agent' | 'workflow' | 'skills';
+
+  collectionStatus?: FileConfirmResponse.UnionMember0 | FileConfirmResponse.UnionMember1;
+}
+
+export namespace FileConfirmResponse {
+  export interface UnionMember0 {
+    completeness: 'complete' | 'partial' | 'none' | 'unknown';
+
+    coverage: 'exhaustive' | 'bounded' | 'unknown';
+
+    endReached: boolean;
+
+    records: UnionMember0.Records;
+
+    resumable: boolean;
+
+    version: 1;
+  }
+
+  export namespace UnionMember0 {
+    export interface Records {
+      reported: number;
+
+      unit: string;
+    }
+  }
+
+  export interface UnionMember1 {
+    completeness: 'unknown';
+
+    coverage: 'unknown';
+
+    endReached: false;
+
+    resumable: false;
+
+    version: 1;
+  }
 }
 
 export interface FileUploadURLResponse {

package/src/resources/index.ts

@@ -56,25 +56,6 @@ export {
   type DeviceSetNameParams,
   type DeviceTerminateParams,
 } from './devices/devices';
-export {
-  Esims,
-  type EsimCreateResponse,
-  type EsimRetrieveResponse,
-  type EsimUpdateResponse,
-  type EsimListResponse,
-  type EsimCapacityResponse,
-  type EsimConfirmPaymentResponse,
-  type EsimImportResponse,
-  type EsimInstallResponse,
-  type EsimInstallStatusResponse,
-  type EsimSelectorResponse,
-  type EsimCreateParams,
-  type EsimUpdateParams,
-  type EsimListParams,
-  type EsimImportParams,
-  type EsimInstallParams,
-  type EsimSelectorParams,
-} from './esims/esims';
 export {
   Files,
   type FileUpdateResponse,
@@ -120,11 +101,13 @@ export {
   type NumberUpdateResponse,
   type NumberListResponse,
   type NumberDeleteResponse,
+  type NumberCapacityResponse,
   type NumberCountriesResponse,
   type NumberPurposesResponse,
   type NumberCreateParams,
   type NumberUpdateParams,
   type NumberListParams,
+  type NumberCapacityParams,
 } from './numbers/numbers';
 export {
   Profiles,

package/src/resources/mailboxes/mailboxes.ts

@@ -18,13 +18,10 @@ export class Mailboxes extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
   /**
-   * Reserves a permanently-allocated, individually-rented mailbox and starts an
-   * Autumn rental checkout. An optional localPart selects the full address local
-   * part; omitting it keeps the default random, non-guessable mx\_-prefixed address.
-   * The address is withheld until the first payment is confirmed. Idempotent on
-   * (owner, clientRequestId): same key + payload replays (200); a conflicting or
-   * already-held local part returns 409. 201 when the checkout URL is already
-   * persisted, otherwise 202 (poll GET for the URL).
+   * 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.
    *
    * @example
    * ```ts
@@ -86,10 +83,8 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * For paid rent, schedules end-of-cycle cancellation. For an included generation,
-   * archives immediately and releases its package seat. This never deletes the
-   * mailbox, its address, or its messages — the address is permanently reserved.
-   * Idempotent.
+   * Cancels a pending mailbox or schedules an active paid mailbox for cancellation.
+   * Existing addresses and messages are retained. Repeating the request is safe.
    *
    * @example
    * ```ts
@@ -103,8 +98,7 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * Returns the authoritative number of package-funded mailbox claims currently
-   * available after local reservations.
+   * Returns the number of mailboxes currently available through included capacity.
    *
    * @example
    * ```ts
@@ -116,9 +110,8 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * Returns the highest-confidence, most recent OTP for the mailbox, restricted to
-   * messages of completed/active paid intervals. Does not wait server-side (SDKs
-   * poll). 200 with the best code, 204 when none matches.
+   * Returns the most likely recent OTP for the mailbox. Returns 204 when no matching
+   * code is available.
    *
    * @example
    * ```ts
@@ -136,8 +129,8 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * Starts a new generation on an archived mailbox, reusing the same permanent
-   * address. Uses included capacity first unless paid rent is requested.
+   * Restarts an archived mailbox with the same address. Uses included capacity when
+   * available unless paid service is requested.
    *
    * @example
    * ```ts
@@ -155,8 +148,8 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * Retracts a scheduled end-of-cycle cancellation for the current generation. Only
-   * valid while cancellation is pending.
+   * Withdraws a scheduled cancellation. Only available while cancellation is
+   * pending.
    *
    * @example
    * ```ts
@@ -180,7 +173,7 @@ export namespace MailboxCreateResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -192,6 +185,8 @@ export namespace MailboxCreateResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -228,7 +223,7 @@ export namespace MailboxRetrieveResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -240,6 +235,8 @@ export namespace MailboxRetrieveResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -276,7 +273,7 @@ export namespace MailboxUpdateResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -288,6 +285,8 @@ export namespace MailboxUpdateResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -326,7 +325,7 @@ export namespace MailboxListResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -338,6 +337,8 @@ export namespace MailboxListResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Item.InboundMessages;
 
     label: string | null;
@@ -374,7 +375,7 @@ export namespace MailboxDeleteResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -386,6 +387,8 @@ export namespace MailboxDeleteResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -418,7 +421,13 @@ export interface MailboxCapacityResponse {
 
 export namespace MailboxCapacityResponse {
   export interface Data {
+    included: number;
+
     includedRemaining: number;
+
+    remaining: number;
+
+    status: 'available' | 'exhausted' | 'not_included';
   }
 }
 
@@ -429,7 +438,7 @@ export interface MailboxOtpResponse {
 export namespace MailboxOtpResponse {
   export interface Data {
     /**
-     * String to preserve leading zeros
+     * OTP code as text to preserve leading zeros.
      */
     code: string;
 
@@ -455,7 +464,7 @@ export namespace MailboxRestartResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -467,6 +476,8 @@ export namespace MailboxRestartResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -503,7 +514,7 @@ export namespace MailboxUncancelResponse {
 
     address: string | null;
 
-    billingMode: 'rent' | 'included';
+    billingMode: 'rent' | 'included' | 'domain';
 
     cancelAtPeriodEnd: boolean;
 
@@ -515,6 +526,8 @@ export namespace MailboxUncancelResponse {
 
     currentPeriodEnd: string | null;
 
+    domainId: string | null;
+
     inboundMessages: Data.InboundMessages;
 
     label: string | null;
@@ -545,17 +558,22 @@ export interface MailboxCreateParams {
   clientRequestId: string;
 
   /**
-   * Funding preference. Omit or use included for included-first activation; rent
-   * always preserves package capacity and starts paid checkout.
+   * included uses package capacity when available and otherwise starts paid
+   * checkout; included_only fails without creating a paid reservation when no
+   * included slot remains; rent always starts paid checkout.
+   */
+  billingPreference?: 'included' | 'included_only' | 'rent';
+
+  /**
+   * Optional active custom mailbox domain owned by the caller. Omit to use the
+   * system domain.
    */
-  billingPreference?: 'included' | 'rent';
+  domainId?: string;
 
   label?: string;
 
   /**
-   * Optional full mailbox local part (the address before "@"). Trimmed and
-   * lowercased before validation. Omit for a random, non-guessable mx\_-prefixed
-   * address.
+   * Optional mailbox name before the "@". Omit to generate a random address.
    */
   localPart?: string;
 }
@@ -582,10 +600,11 @@ export interface MailboxOtpParams {
 
 export interface MailboxRestartParams {
   /**
-   * Funding preference. Omit or use included for included-first activation; rent
-   * always preserves package capacity and starts paid checkout.
+   * included uses package capacity when available and otherwise starts paid
+   * checkout; included_only fails without creating a paid reservation when no
+   * included slot remains; rent always starts paid checkout.
    */
-  billingPreference?: 'included' | 'rent';
+  billingPreference?: 'included' | 'included_only' | 'rent';
 }
 
 Mailboxes.Messages = Messages;

package/src/resources/mailboxes/messages.ts

@@ -27,8 +27,8 @@ export class Messages extends APIResource {
   }
 
   /**
-   * Lists messages for a mailbox with keyset pagination and time/sender/hasOtp
-   * filters for polling.
+   * Lists mailbox messages with cursor pagination and optional time, sender, and OTP
+   * filters.
    *
    * @example
    * ```ts

package/src/resources/messages/conversations.ts

@@ -6,17 +6,8 @@ import { RequestOptions } from '../../internal/request-options';
 
 export class Conversations extends APIResource {
   /**
-   * Lists the caller's own SMS conversations, one row per thread. Each row includes
-   * the most recent message in the thread, its unread inbound count, and the eSIMs
-   * it was seen through. Optional `esimId` or `numberId` narrows to threads on one
-   * eSIM or number.
-   *
-   * Cursor-paginated via `limit` (default 20, max 100) and
-   * `cursorLastOccurredAt`/`cursorLastMessageId` (both required together, taken from
-   * a previous page's `nextCursor`). Pagination follows each thread's most recent
-   * activity rather than a fixed snapshot, so a thread with new activity can move
-   * ahead of an in-progress page fetch. Clients that need a stable ordering should
-   * snapshot their own view.
+   * Lists SMS conversations by recent activity. Use both cursor fields from
+   * `nextCursor` to fetch the next page.
    */
   list(
     query: ConversationListParams | null | undefined = {},
@@ -26,10 +17,8 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Marks the caller's own inbound messages in a conversation thread as read, up to
-   * and including the given `(upToOccurredAt, upToMessageId)` cursor — typically a
-   * conversation row's `lastMessage`. Idempotent: repeating the call with the same
-   * cursor updates 0 rows. Returns the number of rows updated.
+   * Marks inbound messages in a conversation as read through the supplied cursor.
+   * Repeating the request is safe.
    */
   markRead(
     body: ConversationMarkReadParams,

package/src/resources/messages/messages.ts

@@ -17,10 +17,8 @@ export class Messages extends APIResource {
   conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
 
   /**
-   * Lists the caller's own SMS messages, newest first. Supports filtering by
-   * direction, esimId, numberId, status, peerNumber (substring search, min 3
-   * characters), and peerKey (exact thread match). Each row includes its canonical
-   * thread key (`peerKey`).
+   * Lists SMS messages newest first, with filters for direction, eSIM, phone number,
+   * status, and conversation.
    */
   list(
     query: MessageListParams | null | undefined = {},

package/src/resources/numbers/index.ts

@@ -8,9 +8,11 @@ export {
   type NumberUpdateResponse,
   type NumberListResponse,
   type NumberDeleteResponse,
+  type NumberCapacityResponse,
   type NumberCountriesResponse,
   type NumberPurposesResponse,
   type NumberCreateParams,
   type NumberUpdateParams,
   type NumberListParams,
+  type NumberCapacityParams,
 } from './numbers';

package/src/resources/numbers/numbers.ts

@@ -13,9 +13,8 @@ export class Numbers extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
   /**
-   * Starts a Mobilerun Phone purchase for the authenticated owner. Accepted requests
-   * always return the same asynchronous envelope; poll GET /numbers/phones/{id} for
-   * its business state. `purpose` and `country` are mutually exclusive.
+   * Starts a phone-number purchase. Poll the returned phone number for status
+   * updates. `purpose` and `country` cannot be combined.
    *
    * @example
    * ```ts
@@ -52,11 +51,8 @@ export class Numbers extends APIResource {
   }
 
   /**
-   * Updates the phone number's user-defined display label. Omitting `label` leaves
-   * it unchanged; setting it to null or an empty string clears it. The label is
-   * capped at 100 characters, is display-only, and never affects routing. It also
-   * seeds the billing entity name when set at purchase time; a later change here
-   * does not rename the already-created billing entity.
+   * Updates the display label. Omitting `label` leaves it unchanged; null or an
+   * empty string clears it.
    *
    * @example
    * ```ts
@@ -74,8 +70,7 @@ export class Numbers extends APIResource {
   }
 
   /**
-   * Lists phone numbers owned by the authenticated user — both BYO (`user`) and
-   * provisioned (`mobilerun`) numbers.
+   * Lists the caller's phone numbers.
    *
    * @example
    * ```ts
@@ -90,23 +85,9 @@ export class Numbers extends APIResource {
   }
 
   /**
-   * Cancels a Mobilerun Phone. The outcome depends on the number's current state:
-   *
-   * - If the number is still awaiting payment and no payment for it is currently
-   *   being processed, the checkout is closed immediately and the number is retired.
-   * - If the number is on the standard paid plan and already paid and in service,
-   *   cancellation is scheduled for the end of the current billing period rather
-   *   than taking effect immediately. The number stays usable through the period
-   *   already paid for, with no partial refund. Calling this again while a
-   *   cancellation is already scheduled is a no-op that returns the same result. The
-   *   response's `state` reflects this as `cancel_scheduled` with
-   *   `cancelAtPeriodEnd: true`; `currentPeriodEnd` is populated once billing
-   *   confirms the cancellation.
-   *
-   * Any other state (already refunding, a permanent billing failure, a payment
-   * currently being processed, an included-plan number, or a non-hosted/BYO number)
-   * returns 409 `not_cancellable`. Returns 404 if the number doesn't exist or isn't
-   * owned by the caller.
+   * Cancels a pending purchase or schedules cancellation of an active paid phone
+   * number. Repeating a scheduled cancellation is safe. Returns 409 when
+   * cancellation is not available.
    *
    * @example
    * ```ts
@@ -120,8 +101,22 @@ export class Numbers extends APIResource {
   }
 
   /**
-   * Lists the countries currently offered for a dedicated Mobilerun Phone, with live
-   * stock status. Pass `country` as the `country` field on POST /numbers/phones.
+   * Returns included phone capacity for a country. Creating a phone is
+   * authoritative.
+   *
+   * @example
+   * ```ts
+   * const response = await client.numbers.capacity({
+   *   country: 'de',
+   * });
+   * ```
+   */
+  capacity(query: NumberCapacityParams, options?: RequestOptions): APIPromise<NumberCapacityResponse> {
+    return this._client.get('/numbers/phones/capacity', { query, ...options });
+  }
+
+  /**
+   * Lists available countries and current phone-number availability.
    *
    * @example
    * ```ts
@@ -305,6 +300,26 @@ export namespace NumberDeleteResponse {
   }
 }
 
+export interface NumberCapacityResponse {
+  data: NumberCapacityResponse.Data;
+}
+
+export namespace NumberCapacityResponse {
+  export interface Data {
+    included: number;
+
+    /**
+     * @deprecated Deprecated — always equal to `remaining`. Migrate to `remaining`;
+     * this field will be removed in a future revision.
+     */
+    includedRemaining: number;
+
+    remaining: number;
+
+    status: 'available' | 'exhausted' | 'not_included';
+  }
+}
+
 export interface NumberCountriesResponse {
   data: NumberCountriesResponse.Data;
 }
@@ -347,14 +362,14 @@ export namespace NumberPurposesResponse {
 
 export interface NumberCreateParams {
   /**
-   * Body param: Prefer a free package seat ('included', default) or force the paid
-   * checkout ('rent')
+   * Body param: Use included capacity when available, require included capacity
+   * without paid fallback (included_only), or start a paid checkout (rent).
    */
-  billingPreference?: 'included' | 'rent';
+  billingPreference?: 'included' | 'included_only' | 'rent';
 
   /**
    * Body param: Optional ISO 3166-1 alpha-2 country code from GET
-   * /numbers/countries. Cannot be combined with `purpose`.
+   * /numbers/phones/countries. Cannot be combined with `purpose`.
    */
   country?: string;
 
@@ -366,7 +381,7 @@ export interface NumberCreateParams {
   label?: string | null;
 
   /**
-   * Body param: Optional Mobilerun Phone purpose slug from GET /numbers/purposes.
+   * Body param: Optional purpose from GET /numbers/phones/purposes.
    */
   purpose?: string;
 
@@ -391,6 +406,13 @@ export interface NumberListParams {
   pageSize?: number;
 }
 
+export interface NumberCapacityParams {
+  /**
+   * ISO 3166-1 alpha-2 country code from GET /numbers/phones/countries.
+   */
+  country: string;
+}
+
 Numbers.Messages = Messages;
 
 export declare namespace Numbers {
@@ -400,11 +422,13 @@ export declare namespace Numbers {
     type NumberUpdateResponse as NumberUpdateResponse,
     type NumberListResponse as NumberListResponse,
     type NumberDeleteResponse as NumberDeleteResponse,
+    type NumberCapacityResponse as NumberCapacityResponse,
     type NumberCountriesResponse as NumberCountriesResponse,
     type NumberPurposesResponse as NumberPurposesResponse,
     type NumberCreateParams as NumberCreateParams,
     type NumberUpdateParams as NumberUpdateParams,
     type NumberListParams as NumberListParams,
+    type NumberCapacityParams as NumberCapacityParams,
   };
 
   export {