@mobilerun/sdk 5.1.0 → 5.2.1

package/src/resources/devices/esim/apn.ts

@@ -0,0 +1,178 @@
+// 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 { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Apn extends APIResource {
+  /**
+   * Returns the access point names (APNs) configured for the device's active eSIM
+   * subscriptions.
+   */
+  list(
+    deviceID: string,
+    params: ApnListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApnListResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/esim/apn`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Marks an existing APN, identified by apnId, as the preferred APN for the given
+   * eSIM subscription in the request body.
+   */
+  select(deviceID: string, params: ApnSelectParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/esim/apn`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Creates an access point name (APN) from the request body and applies it to the
+   * given eSIM subscription. Type, protocol, and roaming protocol default to common
+   * values when omitted.
+   */
+  set(deviceID: string, params: ApnSetParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/esim/apn`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type ApnListResponse = Array<ApnListResponse.ApnListResponseItem>;
+
+export namespace ApnListResponse {
+  export interface ApnListResponseItem {
+    id: number;
+
+    apn: string;
+
+    isPreferred: boolean;
+
+    mcc: string;
+
+    mnc: string;
+
+    name: string;
+
+    protocol: string;
+
+    roamingProtocol: string;
+
+    subId: number;
+
+    type: string;
+  }
+}
+
+export interface ApnListParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface ApnSelectParams {
+  /**
+   * Body param
+   */
+  apnId: number;
+
+  /**
+   * Body param
+   */
+  subId: number;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface ApnSetParams {
+  /**
+   * Body param
+   */
+  apn: string;
+
+  /**
+   * Body param
+   */
+  mcc: string;
+
+  /**
+   * Body param
+   */
+  mnc: string;
+
+  /**
+   * Body param
+   */
+  name: string;
+
+  /**
+   * Body param
+   */
+  protocol: string;
+
+  /**
+   * Body param
+   */
+  roamingProtocol: string;
+
+  /**
+   * Body param
+   */
+  subId: number;
+
+  /**
+   * Body param
+   */
+  type: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Apn {
+  export {
+    type ApnListResponse as ApnListResponse,
+    type ApnListParams as ApnListParams,
+    type ApnSelectParams as ApnSelectParams,
+    type ApnSetParams as ApnSetParams,
+  };
+}

package/src/resources/devices/esim/esim.ts

@@ -0,0 +1,312 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ApnAPI from './apn';
+import { Apn, ApnListParams, ApnListResponse, ApnSelectParams, ApnSetParams } from './apn';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Esim extends APIResource {
+  apn: ApnAPI.Apn = new ApnAPI.Apn(this._client);
+
+  /**
+   * Returns the eSIM subscriptions currently provisioned on the device.
+   */
+  list(
+    deviceID: string,
+    params: EsimListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EsimListResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/esim`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Download profile and/or enable subscription.
+   */
+  activate(
+    deviceID: string,
+    params: EsimActivateParams,
+    options?: RequestOptions,
+  ): APIPromise<EsimActivateResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/esim`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Enables the eSIM subscription identified by the subId in the request body so it
+   * becomes the active subscription.
+   */
+  enable(deviceID: string, params: EsimEnableParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/esim`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Deletes the eSIM subscription identified by the subId query parameter from the
+   * device.
+   */
+  remove(deviceID: string, params: EsimRemoveParams, options?: RequestOptions): APIPromise<void> {
+    const { subId, 'X-Device-Display-ID': xDeviceDisplayID } = params;
+    return this._client.delete(path`/devices/${deviceID}/esim`, {
+      query: { subId },
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Enables or disables data roaming for the device's eSIM based on the enabled flag
+   * in the request body.
+   */
+  setRoaming(deviceID: string, params: EsimSetRoamingParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/esim/roaming`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns the connectivity status of the device's eSIM subscriptions.
+   */
+  status(
+    deviceID: string,
+    params: EsimStatusParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EsimStatusResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/esim/status`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type EsimListResponse = Array<EsimListResponse.EsimListResponseItem>;
+
+export namespace EsimListResponse {
+  export interface EsimListResponseItem {
+    carrier: string;
+
+    displayName: string;
+
+    iccid: string;
+
+    isEmbedded: boolean;
+
+    slot: number;
+
+    subId: number;
+
+    type: string;
+
+    /**
+     * A URL to the JSON Schema for this object.
+     */
+    $schema?: string;
+  }
+}
+
+export interface EsimActivateResponse {
+  carrier: string;
+
+  displayName: string;
+
+  iccid: string;
+
+  isEmbedded: boolean;
+
+  slot: number;
+
+  subId: number;
+
+  type: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export type EsimStatusResponse = Array<EsimStatusResponse.EsimStatusResponseItem>;
+
+export namespace EsimStatusResponse {
+  export interface EsimStatusResponseItem {
+    carrier: string;
+
+    dataRoamingEnabled: boolean;
+
+    dataState: string;
+
+    isRoaming: boolean;
+
+    mobileDataEnabled: boolean;
+
+    networkType: string;
+
+    operator: string;
+
+    phoneType: string;
+
+    simState: string;
+
+    subId: number;
+  }
+}
+
+export interface EsimListParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimActivateParams {
+  /**
+   * Body param
+   */
+  enable: boolean;
+
+  /**
+   * Body param
+   */
+  smDpAddr: string;
+
+  /**
+   * Body param: Optional carrier-issued confirmation code (the 4th LPA segment).
+   * Required only for plans whose SM-DP+ challenges the device for one. Requires
+   * matchingId — the LPA spec only interprets segment 4 when segment 3 is present.
+   */
+  confirmationCode?: string;
+
+  /**
+   * Body param
+   */
+  matchingId?: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimEnableParams {
+  /**
+   * Body param
+   */
+  subId: number;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimRemoveParams {
+  /**
+   * Query param
+   */
+  subId: number;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimSetRoamingParams {
+  /**
+   * Body param
+   */
+  enabled: boolean;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimStatusParams {
+  'X-Device-Display-ID'?: number;
+}
+
+Esim.Apn = Apn;
+
+export declare namespace Esim {
+  export {
+    type EsimListResponse as EsimListResponse,
+    type EsimActivateResponse as EsimActivateResponse,
+    type EsimStatusResponse as EsimStatusResponse,
+    type EsimListParams as EsimListParams,
+    type EsimActivateParams as EsimActivateParams,
+    type EsimEnableParams as EsimEnableParams,
+    type EsimRemoveParams as EsimRemoveParams,
+    type EsimSetRoamingParams as EsimSetRoamingParams,
+    type EsimStatusParams as EsimStatusParams,
+  };
+
+  export {
+    Apn as Apn,
+    type ApnListResponse as ApnListResponse,
+    type ApnListParams as ApnListParams,
+    type ApnSelectParams as ApnSelectParams,
+    type ApnSetParams as ApnSetParams,
+  };
+}

package/src/resources/devices/esim/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Apn,
+  type ApnListResponse,
+  type ApnListParams,
+  type ApnSelectParams,
+  type ApnSetParams,
+} from './apn';
+export {
+  Esim,
+  type EsimListResponse,
+  type EsimActivateResponse,
+  type EsimStatusResponse,
+  type EsimListParams,
+  type EsimActivateParams,
+  type EsimEnableParams,
+  type EsimRemoveParams,
+  type EsimSetRoamingParams,
+  type EsimStatusParams,
+} from './esim';

package/src/resources/devices/esim.ts

@@ -1,208 +1,3 @@
 // 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 { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-export class Esim extends APIResource {
-  /**
-   * List eSIM subscriptions
-   */
-  list(
-    deviceID: string,
-    params: EsimListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<EsimListResponse | null> {
-    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
-    return this._client.get(path`/devices/${deviceID}/esim`, {
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(xDeviceDisplayID?.toString() != null ?
-            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Configure eSIM (download profile and/or enable subscription)
-   */
-  activate(
-    deviceID: string,
-    params: EsimActivateParams,
-    options?: RequestOptions,
-  ): APIPromise<EsimActivateResponse> {
-    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
-    return this._client.post(path`/devices/${deviceID}/esim`, {
-      body,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(xDeviceDisplayID?.toString() != null ?
-            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Enable an eSIM subscription
-   */
-  enable(deviceID: string, params: EsimEnableParams, options?: RequestOptions): APIPromise<void> {
-    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
-    return this._client.put(path`/devices/${deviceID}/esim`, {
-      body,
-      ...options,
-      headers: buildHeaders([
-        {
-          Accept: '*/*',
-          ...(xDeviceDisplayID?.toString() != null ?
-            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Delete eSIM subscription
-   */
-  remove(deviceID: string, params: EsimRemoveParams, options?: RequestOptions): APIPromise<void> {
-    const { subId, 'X-Device-Display-ID': xDeviceDisplayID } = params;
-    return this._client.delete(path`/devices/${deviceID}/esim`, {
-      query: { subId },
-      ...options,
-      headers: buildHeaders([
-        {
-          Accept: '*/*',
-          ...(xDeviceDisplayID?.toString() != null ?
-            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-}
-
-export type EsimListResponse = Array<EsimListResponse.EsimListResponseItem>;
-
-export namespace EsimListResponse {
-  export interface EsimListResponseItem {
-    carrier: string;
-
-    displayName: string;
-
-    iccid: string;
-
-    isEmbedded: boolean;
-
-    slot: number;
-
-    subId: number;
-
-    type: string;
-
-    /**
-     * A URL to the JSON Schema for this object.
-     */
-    $schema?: string;
-  }
-}
-
-export interface EsimActivateResponse {
-  carrier: string;
-
-  displayName: string;
-
-  iccid: string;
-
-  isEmbedded: boolean;
-
-  slot: number;
-
-  subId: number;
-
-  type: string;
-
-  /**
-   * A URL to the JSON Schema for this object.
-   */
-  $schema?: string;
-}
-
-export interface EsimListParams {
-  'X-Device-Display-ID'?: number;
-}
-
-export interface EsimActivateParams {
-  /**
-   * Body param
-   */
-  enable: boolean;
-
-  /**
-   * Body param
-   */
-  smDpAddr: string;
-
-  /**
-   * Body param: Optional carrier-issued confirmation code (the 4th LPA segment).
-   * Required only for plans whose SM-DP+ challenges the device for one. Requires
-   * matchingId — the LPA spec only interprets segment 4 when segment 3 is present.
-   */
-  confirmationCode?: string;
-
-  /**
-   * Body param
-   */
-  matchingId?: string;
-
-  /**
-   * Header param
-   */
-  'X-Device-Display-ID'?: number;
-}
-
-export interface EsimEnableParams {
-  /**
-   * Body param
-   */
-  subId: number;
-
-  /**
-   * Header param
-   */
-  'X-Device-Display-ID'?: number;
-}
-
-export interface EsimRemoveParams {
-  /**
-   * Query param
-   */
-  subId: number;
-
-  /**
-   * Header param
-   */
-  'X-Device-Display-ID'?: number;
-}
-
-export declare namespace Esim {
-  export {
-    type EsimListResponse as EsimListResponse,
-    type EsimActivateResponse as EsimActivateResponse,
-    type EsimListParams as EsimListParams,
-    type EsimActivateParams as EsimActivateParams,
-    type EsimEnableParams as EsimEnableParams,
-    type EsimRemoveParams as EsimRemoveParams,
-  };
-}
+export * from './esim/index';