@mobilerun/sdk 6.0.1 → 6.1.0

package/src/resources/credentials/packages/links.ts

@@ -0,0 +1,122 @@
+// 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';
+
+export class Links extends APIResource {
+  /**
+   * Link a 1Password item to a credential
+   */
+  create(
+    packageName: string,
+    body: LinkCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<LinkCreateResponse> {
+    return this._client.post(path`/credentials/packages/${packageName}/links`, { body, ...options });
+  }
+}
+
+export interface LinkCreateResponse {
+  data: LinkCreateResponse.Data;
+}
+
+export namespace LinkCreateResponse {
+  export interface Data {
+    createdBy: string | null;
+
+    credentialName: string;
+
+    fields: Array<Data.Field>;
+
+    ownerId: string;
+
+    packageName: string;
+
+    secretPath: string;
+
+    /**
+     * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+     * for credentials created before rollout.
+     */
+    userId: string | null;
+
+    link?: Data.Link;
+
+    source?: 'mobilerun' | 'onepassword';
+  }
+
+  export namespace Data {
+    export interface Field {
+      fieldType:
+        | 'email'
+        | 'username'
+        | 'password'
+        | 'api_token'
+        | 'phone_number'
+        | 'two_factor_secret'
+        | 'backup_codes';
+
+      value: string;
+    }
+
+    export interface Link {
+      fieldMap: Array<Link.FieldMap>;
+
+      itemId: string;
+
+      itemTitle: string;
+
+      provider: 'onepassword';
+
+      vaultId: string;
+
+      vaultName: string;
+    }
+
+    export namespace Link {
+      export interface FieldMap {
+        fieldId: string;
+
+        fieldType:
+          | 'email'
+          | 'username'
+          | 'password'
+          | 'api_token'
+          | 'phone_number'
+          | 'two_factor_secret'
+          | 'backup_codes';
+      }
+    }
+  }
+}
+
+export interface LinkCreateParams {
+  credentialName: string;
+
+  fieldMap: Array<LinkCreateParams.FieldMap>;
+
+  itemId: string;
+
+  vaultId: string;
+}
+
+export namespace LinkCreateParams {
+  export interface FieldMap {
+    fieldId: string;
+
+    fieldType:
+      | 'email'
+      | 'username'
+      | 'password'
+      | 'api_token'
+      | 'phone_number'
+      | 'two_factor_secret'
+      | 'backup_codes';
+  }
+}
+
+export declare namespace Links {
+  export { type LinkCreateResponse as LinkCreateResponse, type LinkCreateParams as LinkCreateParams };
+}

package/src/resources/credentials/packages/packages.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as LinksAPI from './links';
+import { LinkCreateParams, LinkCreateResponse, Links } from './links';
 import * as CredentialsAPI from './credentials/credentials';
 import {
   CredentialCreateParams,
   CredentialCreateResponse,
   CredentialDeleteParams,
   CredentialDeleteResponse,
-  CredentialRetrieveParams,
-  CredentialRetrieveResponse,
   Credentials,
 } from './credentials/credentials';
 import { APIPromise } from '../../../core/api-promise';
@@ -17,6 +17,7 @@ import { path } from '../../../internal/utils/path';
 
 export class Packages extends APIResource {
   credentials: CredentialsAPI.Credentials = new CredentialsAPI.Credentials(this._client);
+  links: LinksAPI.Links = new LinksAPI.Links(this._client);
 
   /**
    * Creates a new package (identified by `packageName`) under which credentials can
@@ -82,6 +83,10 @@ export namespace PackageListResponse {
      * for credentials created before rollout.
      */
     userId: string | null;
+
+    link?: Data.Link;
+
+    source?: 'mobilerun' | 'onepassword';
   }
 
   export namespace Data {
@@ -97,6 +102,35 @@ export namespace PackageListResponse {
 
       value: string;
     }
+
+    export interface Link {
+      fieldMap: Array<Link.FieldMap>;
+
+      itemId: string;
+
+      itemTitle: string;
+
+      provider: 'onepassword';
+
+      vaultId: string;
+
+      vaultName: string;
+    }
+
+    export namespace Link {
+      export interface FieldMap {
+        fieldId: string;
+
+        fieldType:
+          | 'email'
+          | 'username'
+          | 'password'
+          | 'api_token'
+          | 'phone_number'
+          | 'two_factor_secret'
+          | 'backup_codes';
+      }
+    }
   }
 }
 
@@ -115,6 +149,7 @@ export interface PackageCreateParams {
 }
 
 Packages.Credentials = Credentials;
+Packages.Links = Links;
 
 export declare namespace Packages {
   export {
@@ -127,10 +162,14 @@ export declare namespace Packages {
   export {
     Credentials as Credentials,
     type CredentialCreateResponse as CredentialCreateResponse,
-    type CredentialRetrieveResponse as CredentialRetrieveResponse,
     type CredentialDeleteResponse as CredentialDeleteResponse,
     type CredentialCreateParams as CredentialCreateParams,
-    type CredentialRetrieveParams as CredentialRetrieveParams,
     type CredentialDeleteParams as CredentialDeleteParams,
   };
+
+  export {
+    Links as Links,
+    type LinkCreateResponse as LinkCreateResponse,
+    type LinkCreateParams as LinkCreateParams,
+  };
 }

package/src/resources/devices/apps.ts

@@ -256,8 +256,8 @@ export namespace AppListInstallsResponse {
     startedAt: string;
 
     /**
-     * On iOS MDM devices, succeeded means the install command was accepted by the
-     * device's MDM channel, not that the install finished on-device.
+     * On some iOS devices, succeeded means the device accepted the install command;
+     * the install may still be running on the device.
      */
     status: 'running' | 'succeeded' | 'failed';
 

package/src/resources/devices/devices.ts

@@ -163,9 +163,9 @@ export class Devices extends APIResource {
    * token.
    */
   create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<DeviceCreateResponse> {
-    const { billing, query_country, deviceType, profileId, ...body } = params;
+    const { billing, query_country, deviceType, profileId, template, ...body } = params;
     return this._client.post('/devices', {
-      query: { billing, country: query_country, deviceType, profileId },
+      query: { billing, country: query_country, deviceType, profileId, template },
       body,
       ...options,
     });
@@ -231,7 +231,10 @@ export class Devices extends APIResource {
 
   /**
    * Triggers a reboot of the device. The device transitions through its reboot
-   * lifecycle and becomes ready again once the restart completes.
+   * lifecycle and becomes ready again once the restart completes. Only devices whose
+   * capabilities report `reboot=true` can be rebooted. Personal (BYOD) devices
+   * cannot be rebooted remotely: the request is refused with 400
+   * `DEVICE_TOOL_UNSUPPORTED` and nothing happens on the device.
    */
   reboot(deviceID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/reboot`, {
@@ -241,16 +244,13 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Resets the device. The optional body `mode` selects what is erased: `full` is a
-   * factory reset that erases installed apps, accounts and storage and gives the
-   * device a new identity; `identity` gives the device a new fingerprint and keeps
-   * its apps and data. When `mode` is omitted the reset is `full`, or `identity` on
-   * devices whose capabilities report `factoryReset=false`. A mode the device does
-   * not support (see `factoryReset` / `identityReset` in the device capabilities) is
-   * refused with 400 `DEVICE_TOOL_UNSUPPORTED`; legacy devices accept an explicit
-   * mode only when it is the one their capabilities advertise, and always accept a
-   * reset without a mode. The device transitions through its reset lifecycle before
-   * becoming ready again.
+   * Resets the device. `mode` selects what is erased: `full` (factory reset: apps,
+   * accounts, storage, new identity) or `identity` (new fingerprint, apps and data
+   * kept). Without `mode` the reset is `full`, or `identity` on devices with
+   * `factoryReset=false`. A mode or `preserve` value the device does not support is
+   * refused with 400 `DEVICE_TOOL_UNSUPPORTED`. `preserve` restores the latest
+   * proxy, location, locale or timezone set through the API after the reset; omitted
+   * or empty preserves nothing. The device becomes ready again after the reset.
    */
   reset(
     deviceID: string,
@@ -265,9 +265,9 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Wakes a parked device: backend readiness and any required capacity are
-   * preflighted, the same device starts running again, and per-minute billing
-   * resumes. On a device that is not parked this is a no-op ready transition.
+   * Wakes a parked device: it first checks that the device can run again, then the
+   * same device starts and per-minute billing resumes. On a device that is not
+   * parked, the request does nothing.
    */
   resume(deviceID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/resume`, {
@@ -323,9 +323,13 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Terminates the device and releases its resources. The optional `terminateAt` and
-   * `previousDeviceId` body fields are not available to API-key callers; requests
-   * that set them are rejected with 401.
+   * Terminates the device and releases its resources. For a personal (BYOD) device
+   * the owner (API key or user) can instead remove the phone from the account so
+   * anyone can pair it again; the phone must be disconnected first, otherwise the
+   * request is rejected with 409 BYOD_DEVICE_CONNECTED. Other subscription-billed
+   * devices cannot be terminated with this request; it is rejected with 401. The
+   * `terminateAt` and `previousDeviceId` body fields are reserved for internal use;
+   * requests that set them are rejected with 401.
    */
   terminate(
     deviceID: string,
@@ -550,8 +554,6 @@ export namespace DeviceFingerprintResponse {
 
     hardware?: string;
 
-    imageRepository?: string;
-
     manufacturer?: string;
 
     model?: string;
@@ -607,6 +609,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     proxy: boolean;
 
+    reboot: boolean;
+
     recording: boolean;
 
     reset: boolean;
@@ -761,18 +765,27 @@ export interface DeviceCreateParams {
   query_country?: string;
 
   /**
-   * Query param: Use android*cloud_phone for a cloud Android phone. Only canonical
-   * identifiers are accepted. Other backends are deployment-specific; recognized but
-   * unavailable types return DEVICE_TYPE_UNAVAILABLE (422). Retired dedicated*\*
-   * aliases are rejected with a canonical replacement.
+   * Query param: Device type: android_cloud_phone (cloud Android phone), ios_phone
+   * or device_slot. Any other value is rejected with 422. Not every device type is
+   * available for creation; an unavailable type returns DEVICE_TYPE_UNAVAILABLE
+   * (422).
    */
-  deviceType?: string;
+  deviceType?: 'android_cloud_phone' | 'ios_phone' | 'device_slot';
 
   /**
    * Query param: Profile ID to use as device spec
    */
   profileId?: string;
 
+  /**
+   * Query param: Optional device template, e.g. onboarding. The device gets the
+   * template's Android version and preinstalled apps and is ready in seconds when a
+   * prepared phone is available; otherwise it boots with the same setup. Country,
+   * name and proxy still come from this request. Cannot be combined with profileId,
+   * apps or androidVersion. Omit it to create from the request alone.
+   */
+  template?: string;
+
   /**
    * Body param
    */
@@ -901,8 +914,7 @@ export interface DeviceListParams {
   pageSize?: number;
 
   /**
-   * Filter by the device's platform as served in the platform field (runtime,
-   * announced, else type-derived).
+   * Filter by the device's platform as served in the platform field.
    */
   platform?: 'android' | 'ios';
 
@@ -933,16 +945,9 @@ export interface DeviceListParams {
   > | null;
 
   /**
-   * Canonical device type. Retired dedicated\_\* aliases are no longer accepted.
-   * Availability depends on the deployment.
+   * Filter by device type.
    */
-  type?:
-    | 'android_cloud_phone'
-    | 'android_physical_phone'
-    | 'ios_stealth_phone'
-    | 'android_emulator'
-    | 'ios_simulator'
-    | 'device_slot';
+  type?: 'android_cloud_phone' | 'ios_phone' | 'device_slot';
 }
 
 export interface DeviceFingerprintParams {
@@ -957,6 +962,12 @@ export interface DeviceResetParams {
    * capabilities report factoryReset=false.
    */
   mode?: 'full' | 'identity';
+
+  /**
+   * Device configuration to restore after the reset: the latest value set through
+   * the API. Omitted, null or empty preserves nothing.
+   */
+  preserve?: Array<'proxy' | 'location' | 'locale' | 'timezone'> | null;
 }
 
 export interface DeviceSetNameParams {

package/src/resources/devices/keyboard.ts

@@ -108,7 +108,7 @@ export interface KeyboardWriteParams {
   completionMode?: 'accepted' | 'committed';
 
   /**
-   * Body param: Per-character mistake rate for humantouch typing. -1 uses server
+   * Body param: Per-character mistake rate for humanized typing. -1 uses server
    * default.
    */
   errorRate?: number;

package/src/resources/devices/language.ts

@@ -31,8 +31,9 @@ export class Language extends APIResource {
 
   /**
    * Sets the device language/locale to the BCP-47 locale in the request body. An
-   * optional restart flag applies the change immediately by restarting the zygote
-   * instead of waiting for the next reboot.
+   * optional restart flag applies the change immediately by restarting the Android
+   * system framework (open apps are closed) instead of waiting for the next reboot;
+   * some devices ignore it.
    */
   set(deviceID: string, params: LanguageSetParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -73,8 +74,9 @@ export interface LanguageSetParams {
   locale: string;
 
   /**
-   * Body param: Restart zygote so the locale change takes full effect immediately.
-   * Without it, the locale is written but won't fully apply until the next reboot.
+   * Body param: Restart the Android system framework so the locale change takes full
+   * effect immediately; open apps are closed. Without it, the change may not fully
+   * apply until the next reboot. Some devices ignore this flag.
    */
   restart?: boolean;
 

package/src/resources/devices/state.ts

@@ -117,6 +117,8 @@ export interface A11YNode {
 
   text: string;
 
+  hint?: string;
+
   isVisibleToUser?: boolean;
 }
 

package/src/resources/mailboxes/messages.ts

@@ -22,8 +22,8 @@ export class Messages extends APIResource {
     params: MessageRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<MessageRetrieveResponse> {
-    const { mailboxId } = params;
-    return this._client.get(path`/mailboxes/${mailboxId}/messages/${messageID}`, options);
+    const { mailboxId, ...query } = params;
+    return this._client.get(path`/mailboxes/${mailboxId}/messages/${messageID}`, { query, ...options });
   }
 
   /**
@@ -71,6 +71,13 @@ export namespace MessageRetrieveResponse {
     subject: string | null;
 
     textBody: string | null;
+
+    /**
+     * Raw HTML part as received. Present only with includeHtml=true; null when the
+     * mail has no HTML part or it exceeds 1 MiB (UTF-8 bytes). Untrusted content:
+     * render only in an isolated sandboxed frame, never inline.
+     */
+    htmlBody?: string | null;
   }
 
   export namespace Data {
@@ -109,7 +116,15 @@ export namespace MessageListResponse {
 }
 
 export interface MessageRetrieveParams {
+  /**
+   * Path param
+   */
   mailboxId: string;
+
+  /**
+   * Query param: Return the raw HTML part as htmlBody (untrusted; render isolated).
+   */
+  includeHtml?: 'true' | 'false';
 }
 
 export interface MessageListParams {

package/src/resources/messages/conversations.ts

@@ -55,6 +55,12 @@ export namespace ConversationListResponse {
 
       occurredAt: string;
 
+      /**
+       * Message status. Outbound messages move queued → sending → sent, or end at
+       * failed. `sent` means the mobile network accepted the message and is the final
+       * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+       * current lines return no carrier delivery report, so neither is emitted.
+       */
       status:
         | 'received'
         | 'queued'

package/src/resources/messages/messages.ts

@@ -68,6 +68,12 @@ export namespace MessageRetrieveResponse {
 
     providerCode: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -118,6 +124,12 @@ export namespace MessageListResponse {
 
     providerCode: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -151,6 +163,10 @@ export interface MessageListParams {
 
   peerNumber?: string;
 
+  /**
+   * Filter by message status. `delivered` and `sent_unconfirmed` are kept for
+   * compatibility and are not emitted on current lines.
+   */
   status?:
     | 'all'
     | 'received'

package/src/resources/numbers/messages.ts

@@ -82,6 +82,12 @@ export namespace MessageListResponse {
 
     peerNumber: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -128,6 +134,12 @@ export namespace MessageSendResponse {
 
     peerNumber: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -171,7 +183,9 @@ export interface MessageSendParams {
   to: string;
 
   /**
-   * Request a delivery report. Defaults to false.
+   * @deprecated Deprecated: best effort and ignored on most lines. Hosted SIM
+   * numbers return no carrier delivery report, so their messages end at `sent` and
+   * no `sms.send.delivered` event follows. Defaults to false.
    */
   deliveryReport?: boolean;
 }

package/src/resources/tasks/tasks.ts

@@ -1096,7 +1096,8 @@ export interface TaskRunParams {
 
   /**
    * The LLM model identifier to use for the task (e.g.
-   * 'mobilerun/mobile-agent-fast')
+   * 'mobilerun/mobile-agent-fast'). When omitted with reasoning=false, the fast-mode
+   * default model is used.
    */
   llmModel?: string;
 
@@ -1183,7 +1184,8 @@ export interface TaskRunStreamedParams {
 
   /**
    * The LLM model identifier to use for the task (e.g.
-   * 'mobilerun/mobile-agent-fast')
+   * 'mobilerun/mobile-agent-fast'). When omitted with reasoning=false, the fast-mode
+   * default model is used.
    */
   llmModel?: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.0.1'; // x-release-please-version
+export const VERSION = '6.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.0.1";
+export declare const VERSION = "6.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.0.1";
+export declare const VERSION = "6.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.0.1'; // x-release-please-version
+exports.VERSION = '6.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.0.1'; // x-release-please-version
+export const VERSION = '6.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map