camara-sdk 0.1.1

package/resources/deviceroamingstatus/subscriptions.d.ts

@@ -0,0 +1,391 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Subscriptions extends APIResource {
+    /**
+     * Create a device roaming status event subscription for a device
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: {
+     *         device: { phoneNumber: '+123456789' },
+     *       },
+     *       subscriptionExpireTime: '2023-01-17T13:18:23.682Z',
+     *       subscriptionMaxEvents: 5,
+     *       initialEvent: true,
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'xxx',
+     *       accessTokenExpiresUtc: '2024-02-17T16:23:45Z',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params: SubscriptionCreateParams, options?: RequestOptions): APIPromise<DeviceRoamingStatusSubscription>;
+    /**
+     * retrieve device roaming status subscription information for a given
+     * subscription.
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DeviceRoamingStatusSubscription>;
+    /**
+     * Retrieve a list of device roaming status event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscriptions =
+     *   await client.deviceroamingstatus.subscriptions.list();
+     * ```
+     */
+    list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
+    /**
+     * Delete a given device-roaming-status subscription by ID
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.deviceroamingstatus.subscriptions.delete(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    delete(subscriptionID: string, params?: SubscriptionDeleteParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionDeleteResponse>;
+}
+/**
+ * Implementation-specific configuration parameters needed by the subscription
+ * manager for acquiring events. In CAMARA we have predefined attributes like
+ * `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent` Specific event
+ * type attributes must be defined in `subscriptionDetail` Note: if a request is
+ * performed for several event type, all subscribed event will use same `config`
+ * parameters.
+ */
+export interface DeviceRoamingStatusConfig {
+    /**
+     * The detail of the requested event subscription.
+     */
+    subscriptionDetail: DeviceRoamingStatusConfig.SubscriptionDetail;
+    /**
+     * Set to `true` by API consumer if consumer wants to get an event as soon as the
+     * subscription is created and current situation reflects event request. Example:
+     * Consumer request Roaming event. If consumer sets initialEvent to true and device
+     * is in roaming situation, an event is triggered.
+     */
+    initialEvent?: boolean;
+    /**
+     * The subscription expiration time (in date-time format) requested by the API
+     * consumer. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    subscriptionExpireTime?: string;
+    /**
+     * Identifies the maximum number of event reports to be generated (>=1) requested
+     * by the API consumer - Once this number is reached, the subscription ends.
+     */
+    subscriptionMaxEvents?: number;
+}
+export declare namespace DeviceRoamingStatusConfig {
+    /**
+     * The detail of the requested event subscription.
+     */
+    interface SubscriptionDetail {
+        /**
+         * End-user equipment able to connect to a mobile network. Examples of devices
+         * include smartphones or IoT sensors/actuators.
+         *
+         * The developer can choose to provide the below specified device identifiers:
+         *
+         * - `ipv4Address`
+         * - `ipv6Address`
+         * - `phoneNumber`
+         * - `networkAccessIdentifier`
+         *
+         * NOTE: the MNO might support only a subset of these options. The API invoker can
+         * provide multiple identifiers to be compatible across different MNOs. In this
+         * case the identifiers MUST belong to the same device.
+         */
+        device?: SubscriptionDetail.Device;
+    }
+    namespace SubscriptionDetail {
+        /**
+         * End-user equipment able to connect to a mobile network. Examples of devices
+         * include smartphones or IoT sensors/actuators.
+         *
+         * The developer can choose to provide the below specified device identifiers:
+         *
+         * - `ipv4Address`
+         * - `ipv6Address`
+         * - `phoneNumber`
+         * - `networkAccessIdentifier`
+         *
+         * NOTE: the MNO might support only a subset of these options. The API invoker can
+         * provide multiple identifiers to be compatible across different MNOs. In this
+         * case the identifiers MUST belong to the same device.
+         */
+        interface Device {
+            /**
+             * The device should be identified by either the public (observed) IP address and
+             * port as seen by the application server, or the private (local) and any public
+             * (observed) IP addresses in use by the device (this information can be obtained
+             * by various means, for example from some DNS servers).
+             *
+             * If the allocated and observed IP addresses are the same (i.e. NAT is not in use)
+             * then the same address should be specified for both publicAddress and
+             * privateAddress.
+             *
+             * If NAT64 is in use, the device should be identified by its publicAddress and
+             * publicPort, or separately by its allocated IPv6 address (field ipv6Address of
+             * the Device object)
+             *
+             * In all cases, publicAddress must be specified, along with at least one of either
+             * privateAddress or publicPort, dependent upon which is known. In general, mobile
+             * devices cannot be identified by their public IPv4 address alone.
+             */
+            ipv4Address?: Device.Ipv4Address;
+            /**
+             * The device should be identified by the observed IPv6 address, or by any single
+             * IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to
+             * the /64 prefix).
+             */
+            ipv6Address?: string;
+            /**
+             * A public identifier addressing a subscription in a mobile network. In 3GPP
+             * terminology, it corresponds to the GPSI formatted with the External Identifier
+             * ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the
+             * network access identifier is not subjected to portability ruling in force, and
+             * is individually managed by each operator.
+             */
+            networkAccessIdentifier?: string;
+            /**
+             * A public identifier addressing a telephone subscription. In mobile networks it
+             * corresponds to the MSISDN (Mobile Station International Subscriber Directory
+             * Number). In order to be globally unique it has to be formatted in international
+             * format, according to E.164 standard, prefixed with '+'.
+             */
+            phoneNumber?: string;
+        }
+        namespace Device {
+            /**
+             * The device should be identified by either the public (observed) IP address and
+             * port as seen by the application server, or the private (local) and any public
+             * (observed) IP addresses in use by the device (this information can be obtained
+             * by various means, for example from some DNS servers).
+             *
+             * If the allocated and observed IP addresses are the same (i.e. NAT is not in use)
+             * then the same address should be specified for both publicAddress and
+             * privateAddress.
+             *
+             * If NAT64 is in use, the device should be identified by its publicAddress and
+             * publicPort, or separately by its allocated IPv6 address (field ipv6Address of
+             * the Device object)
+             *
+             * In all cases, publicAddress must be specified, along with at least one of either
+             * privateAddress or publicPort, dependent upon which is known. In general, mobile
+             * devices cannot be identified by their public IPv4 address alone.
+             */
+            interface Ipv4Address {
+                /**
+                 * A single IPv4 address with no subnet mask
+                 */
+                privateAddress?: string;
+                /**
+                 * A single IPv4 address with no subnet mask
+                 */
+                publicAddress?: string;
+                /**
+                 * TCP or UDP port number
+                 */
+                publicPort?: number;
+            }
+        }
+    }
+}
+/**
+ * Identifier of a delivery protocol. Only HTTP is allowed for now
+ */
+export type DeviceRoamingStatusProtocol = 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA';
+/**
+ * Represents a event-type subscription.
+ */
+export interface DeviceRoamingStatusSubscription {
+    /**
+     * The unique identifier of the subscription in the scope of the subscription
+     * manager. When this information is contained within an event notification, this
+     * concept SHALL be referred as subscriptionId as per Commonalities Event
+     * Notification Model.
+     */
+    id: string;
+    /**
+     * Implementation-specific configuration parameters needed by the subscription
+     * manager for acquiring events. In CAMARA we have predefined attributes like
+     * `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent` Specific event
+     * type attributes must be defined in `subscriptionDetail` Note: if a request is
+     * performed for several event type, all subscribed event will use same `config`
+     * parameters.
+     */
+    config: DeviceRoamingStatusConfig;
+    /**
+     * Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: DeviceRoamingStatusProtocol;
+    /**
+     * The address to which events shall be delivered using the selected protocol.
+     */
+    sink: string;
+    /**
+     * Camara Event types eligible to be delivered by this subscription. Note: for the
+     * Commonalities meta-release v0.4 we enforce to have only event type per
+     * subscription then for following meta-release use of array MUST be decided at API
+     * project level.
+     */
+    types: Array<DeviceRoamingStatusSubscriptionEventType>;
+    /**
+     * Date when the event subscription will expire. Only provided when
+     * `subscriptionExpireTime` is indicated by API client or Telco Operator has
+     * specific policy about that. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    expiresAt?: string;
+    /**
+     * Date when the event subscription will begin/began It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    startsAt?: string;
+    /**
+     * Current status of the subscription - Management of Subscription State engine is
+     * not mandatory for now. Note not all statuses may be considered to be
+     * implemented. Details:
+     *
+     * - `ACTIVATION_REQUESTED`: Subscription creation (POST) is triggered but
+     *   subscription creation process is not finished yet.
+     * - `ACTIVE`: Subscription creation process is completed. Subscription is fully
+     *   operative.
+     * - `INACTIVE`: Subscription is temporarily inactive, but its workflow logic is
+     *   not deleted.
+     * - `EXPIRED`: Subscription is ended (no longer active). This status applies when
+     *   subscription is ended due to `SUBSCRIPTION_EXPIRED` or `ACCESS_TOKEN_EXPIRED`
+     *   event.
+     * - `DELETED`: Subscription is ended as deleted (no longer active). This status
+     *   applies when subscription information is kept (i.e. subscription workflow is
+     *   no longer active but its meta-information is kept).
+     */
+    status?: 'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'INACTIVE' | 'DELETED';
+}
+/**
+ * roaming-status - Event triggered when the device switch from roaming ON to
+ * roaming OFF and conversely
+ *
+ * roaming-on - Event triggered when the device switch from roaming OFF to roaming
+ * ON
+ *
+ * roaming-off - Event triggered when the device switch from roaming ON to roaming
+ * OFF
+ *
+ * roaming-change-country - Event triggered when the device in roaming change
+ * country code
+ */
+export type DeviceRoamingStatusSubscriptionEventType = 'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status' | 'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-on' | 'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-off' | 'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-change-country';
+export type SubscriptionListResponse = Array<DeviceRoamingStatusSubscription>;
+/**
+ * Response for a device reachability status operation managed asynchronously
+ * (Creation or Deletion)
+ */
+export interface SubscriptionDeleteResponse {
+    /**
+     * The unique identifier of the subscription in the scope of the subscription
+     * manager. When this information is contained within an event notification, this
+     * concept SHALL be referred as subscriptionId as per Commonalities Event
+     * Notification Model.
+     */
+    id: string;
+}
+export interface SubscriptionCreateParams {
+    /**
+     * Body param: Implementation-specific configuration parameters needed by the
+     * subscription manager for acquiring events. In CAMARA we have predefined
+     * attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`,
+     * `initialEvent` Specific event type attributes must be defined in
+     * `subscriptionDetail` Note: if a request is performed for several event type, all
+     * subscribed event will use same `config` parameters.
+     */
+    config: DeviceRoamingStatusConfig;
+    /**
+     * Body param: Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: DeviceRoamingStatusProtocol;
+    /**
+     * Body param: The address to which events shall be delivered using the selected
+     * protocol.
+     */
+    sink: string;
+    /**
+     * Body param: Camara Event types eligible to be delivered by this subscription.
+     * Note: for the current Commonalities version (v0.5) only one event type per
+     * subscription is allowed, yet in the following releases use of array of event
+     * types SHALL be specified without changing this definition.
+     */
+    types: Array<DeviceRoamingStatusSubscriptionEventType>;
+    /**
+     * Body param: A sink credential provides authentication or authorization
+     * information necessary to enable delivery of events to a target.
+     */
+    sinkCredential?: SubscriptionCreateParams.SinkCredential;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace SubscriptionCreateParams {
+    /**
+     * A sink credential provides authentication or authorization information necessary
+     * to enable delivery of events to a target.
+     */
+    interface SinkCredential {
+        /**
+         * The type of the credential. Note: Type of the credential - MUST be set to
+         * ACCESSTOKEN for now
+         */
+        credentialType: 'PLAIN' | 'ACCESSTOKEN' | 'REFRESHTOKEN';
+    }
+}
+export interface SubscriptionRetrieveParams {
+    /**
+     * Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface SubscriptionListParams {
+    /**
+     * Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface SubscriptionDeleteParams {
+    /**
+     * Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace Subscriptions {
+    export { type DeviceRoamingStatusConfig as DeviceRoamingStatusConfig, type DeviceRoamingStatusProtocol as DeviceRoamingStatusProtocol, type DeviceRoamingStatusSubscription as DeviceRoamingStatusSubscription, type DeviceRoamingStatusSubscriptionEventType as DeviceRoamingStatusSubscriptionEventType, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionDeleteResponse as SubscriptionDeleteResponse, type SubscriptionCreateParams as SubscriptionCreateParams, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionDeleteParams as SubscriptionDeleteParams, };
+}
+//# sourceMappingURL=subscriptions.d.ts.map

package/resources/deviceroamingstatus/subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/resources/deviceroamingstatus/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAY9C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAW9C;;;;;;;;OAQG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAWvC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAU1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,kBAAkB,EAAE,yBAAyB,CAAC,kBAAkB,CAAC;IAEjE;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;;;;;;;;;;;;;WAcG;QACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC;KACpC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;;;;;;;;;;;;;WAcG;QACH,UAAiB,MAAM;YACrB;;;;;;;;;;;;;;;;;eAiBG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YAEjC;;;;eAIG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;;;;eAMG;YACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;YAEjC;;;;;eAKG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,MAAM,CAAC;YACtB;;;;;;;;;;;;;;;;;eAiBG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,cAAc,CAAC,EAAE,MAAM,CAAC;gBAExB;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEvB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;aACrB;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;OAOG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;CACjF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,wCAAwC,GAChD,yEAAyE,GACzE,qEAAqE,GACrE,sEAAsE,GACtE,iFAAiF,CAAC;AAEtF,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,+BAA+B,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;;OAOG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAEvD;;;OAGG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC,cAAc,CAAC;IAEzD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,cAAc,EAAE,OAAO,GAAG,aAAa,GAAG,cAAc,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/deviceroamingstatus/subscriptions.js

@@ -0,0 +1,113 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscriptions = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Subscriptions extends resource_1.APIResource {
+    /**
+     * Create a device roaming status event subscription for a device
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: {
+     *         device: { phoneNumber: '+123456789' },
+     *       },
+     *       subscriptionExpireTime: '2023-01-17T13:18:23.682Z',
+     *       subscriptionMaxEvents: 5,
+     *       initialEvent: true,
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'xxx',
+     *       accessTokenExpiresUtc: '2024-02-17T16:23:45Z',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/deviceroamingstatus/subscriptions', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * retrieve device roaming status subscription information for a given
+     * subscription.
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get((0, path_1.path) `/deviceroamingstatus/subscriptions/${subscriptionID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieve a list of device roaming status event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscriptions =
+     *   await client.deviceroamingstatus.subscriptions.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get('/deviceroamingstatus/subscriptions', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Delete a given device-roaming-status subscription by ID
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.deviceroamingstatus.subscriptions.delete(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    delete(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.delete((0, path_1.path) `/deviceroamingstatus/subscriptions/${subscriptionID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Subscriptions = Subscriptions;
+//# sourceMappingURL=subscriptions.js.map

package/resources/deviceroamingstatus/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/resources/deviceroamingstatus/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,cAAsB,EACtB,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sCAAsC,cAAc,EAAE,EAAE;YAClF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,cAAsB,EACtB,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sCAAsC,cAAc,EAAE,EAAE;YACrF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxHD,sCAwHC"}

package/resources/deviceroamingstatus/subscriptions.mjs

@@ -0,0 +1,109 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Subscriptions extends APIResource {
+    /**
+     * Create a device roaming status event subscription for a device
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: {
+     *         device: { phoneNumber: '+123456789' },
+     *       },
+     *       subscriptionExpireTime: '2023-01-17T13:18:23.682Z',
+     *       subscriptionMaxEvents: 5,
+     *       initialEvent: true,
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'xxx',
+     *       accessTokenExpiresUtc: '2024-02-17T16:23:45Z',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/deviceroamingstatus/subscriptions', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * retrieve device roaming status subscription information for a given
+     * subscription.
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscription =
+     *   await client.deviceroamingstatus.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get(path `/deviceroamingstatus/subscriptions/${subscriptionID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieve a list of device roaming status event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const deviceRoamingStatusSubscriptions =
+     *   await client.deviceroamingstatus.subscriptions.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get('/deviceroamingstatus/subscriptions', {
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Delete a given device-roaming-status subscription by ID
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.deviceroamingstatus.subscriptions.delete(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    delete(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.delete(path `/deviceroamingstatus/subscriptions/${subscriptionID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=subscriptions.mjs.map

package/resources/deviceroamingstatus/subscriptions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../../src/resources/deviceroamingstatus/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,cAAsB,EACtB,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sCAAsC,cAAc,EAAE,EAAE;YAClF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,cAAsB,EACtB,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,sCAAsC,cAAc,EAAE,EAAE;YACrF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/deviceroamingstatus.d.mts

@@ -0,0 +1,2 @@
+export * from "./deviceroamingstatus/index.mjs";
+//# sourceMappingURL=deviceroamingstatus.d.mts.map

package/resources/deviceroamingstatus.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceroamingstatus.d.mts","sourceRoot":"","sources":["../src/resources/deviceroamingstatus.ts"],"names":[],"mappings":""}

package/resources/deviceroamingstatus.d.ts

@@ -0,0 +1,2 @@
+export * from "./deviceroamingstatus/index.js";
+//# sourceMappingURL=deviceroamingstatus.d.ts.map

package/resources/deviceroamingstatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceroamingstatus.d.ts","sourceRoot":"","sources":["../src/resources/deviceroamingstatus.ts"],"names":[],"mappings":""}

package/resources/deviceroamingstatus.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./deviceroamingstatus/index.js"), exports);
+//# sourceMappingURL=deviceroamingstatus.js.map

package/resources/deviceroamingstatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceroamingstatus.js","sourceRoot":"","sources":["../src/resources/deviceroamingstatus.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,yEAA4C"}

package/resources/deviceroamingstatus.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./deviceroamingstatus/index.mjs";
+//# sourceMappingURL=deviceroamingstatus.mjs.map

package/resources/deviceroamingstatus.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceroamingstatus.mjs","sourceRoot":"","sources":["../src/resources/deviceroamingstatus.ts"],"names":[],"mappings":"AAAA,sFAAsF"}