camara-sdk 0.1.1

package/resources/simswap/subscriptions.d.mts

@@ -0,0 +1,264 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Subscriptions extends APIResource {
+    /**
+     * Create a sim swap event subscription for a phone number
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: { phoneNumber: '+123456789' },
+     *       subscriptionMaxEvents: 10,
+     *       subscriptionExpireTime: '2025-01-17T13:18:23.682Z',
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.sim-swap-subscriptions.v0.swapped',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'yJ2ZXIiOiIxLjAiLCJ0eXAiO...',
+     *       accessTokenExpiresUtc: '1717753038',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params: SubscriptionCreateParams, options?: RequestOptions): APIPromise<SimSwapSubscription>;
+    /**
+     * retrieve event subscription information for a given subscription.
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SimSwapSubscription>;
+    /**
+     * Retrieve a list of sim swap event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscriptions =
+     *   await client.simswap.subscriptions.list();
+     * ```
+     */
+    list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
+    /**
+     * delete a given event subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.simswap.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` or `subscriptionMaxEvents` to limit subscription
+ * lifetime. Event type attributes must be defined in `subscriptionDetail`
+ */
+export interface SimSwapConfig {
+    /**
+     * The detail of the requested event subscription
+     */
+    subscriptionDetail: SimSwapConfig.SubscriptionDetail;
+    /**
+     * 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 SimSwapConfig {
+    /**
+     * The detail of the requested event subscription
+     */
+    interface SubscriptionDetail {
+        /**
+         * 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;
+    }
+}
+/**
+ * Identifier of a delivery protocol. Only HTTP is allowed for now
+ */
+export type SimSwapProtocol = 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA';
+/**
+ * Represents a event-type subscription.
+ */
+export interface SimSwapSubscription {
+    /**
+     * 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` or `subscriptionMaxEvents` to limit subscription
+     * lifetime. Event type attributes must be defined in `subscriptionDetail`
+     */
+    config: SimSwapConfig;
+    /**
+     * Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: SimSwapProtocol;
+    /**
+     * The address to which events shall be delivered using the selected protocol.
+     */
+    sink: string;
+    /**
+     * Camara Event types eligible for subscription:
+     *
+     * - org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification
+     *   when a sim swap is performed on the line. 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<SimSwapSubscriptionEventType>;
+    /**
+     * 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` 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 metainformation is kept).
+     */
+    status?: 'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'INACTIVE' | 'DELETED';
+}
+/**
+ * swapped - Event triggered when a sim swap occurs on the line
+ */
+export type SimSwapSubscriptionEventType = 'org.camaraproject.sim-swap-subscriptions.v0.swapped';
+export type SubscriptionListResponse = Array<SimSwapSubscription>;
+/**
+ * Response for a event-type subscription request 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` or `subscriptionMaxEvents` to limit
+     * subscription lifetime. Event type attributes must be defined in
+     * `subscriptionDetail`
+     */
+    config: SimSwapConfig;
+    /**
+     * Body param: Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: SimSwapProtocol;
+    /**
+     * Body param: The address to which events shall be delivered using the selected
+     * protocol.
+     */
+    sink: string;
+    /**
+     * Body param: Camara Event types eligible for subscription:
+     *
+     * - org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification
+     *   when a sim swap is performed on the line.
+     */
+    types: Array<SimSwapSubscriptionEventType>;
+    /**
+     * 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. With the current API version the type MUST be set to
+         * ACCESSTOKEN.
+         */
+        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 SimSwapConfig as SimSwapConfig, type SimSwapProtocol as SimSwapProtocol, type SimSwapSubscription as SimSwapSubscription, type SimSwapSubscriptionEventType as SimSwapSubscriptionEventType, 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.mts.map

package/resources/simswap/subscriptions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../../src/resources/simswap/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAYnG;;;;;;;;;;OAUG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAWlC;;;;;;;;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;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAErD;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;;;;WAKG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;CACjF;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,qDAAqD,CAAC;AAEjG,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAE1B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;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,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,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/simswap/subscriptions.d.ts

@@ -0,0 +1,264 @@
+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 sim swap event subscription for a phone number
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: { phoneNumber: '+123456789' },
+     *       subscriptionMaxEvents: 10,
+     *       subscriptionExpireTime: '2025-01-17T13:18:23.682Z',
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.sim-swap-subscriptions.v0.swapped',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'yJ2ZXIiOiIxLjAiLCJ0eXAiO...',
+     *       accessTokenExpiresUtc: '1717753038',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params: SubscriptionCreateParams, options?: RequestOptions): APIPromise<SimSwapSubscription>;
+    /**
+     * retrieve event subscription information for a given subscription.
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SimSwapSubscription>;
+    /**
+     * Retrieve a list of sim swap event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscriptions =
+     *   await client.simswap.subscriptions.list();
+     * ```
+     */
+    list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
+    /**
+     * delete a given event subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.simswap.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` or `subscriptionMaxEvents` to limit subscription
+ * lifetime. Event type attributes must be defined in `subscriptionDetail`
+ */
+export interface SimSwapConfig {
+    /**
+     * The detail of the requested event subscription
+     */
+    subscriptionDetail: SimSwapConfig.SubscriptionDetail;
+    /**
+     * 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 SimSwapConfig {
+    /**
+     * The detail of the requested event subscription
+     */
+    interface SubscriptionDetail {
+        /**
+         * 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;
+    }
+}
+/**
+ * Identifier of a delivery protocol. Only HTTP is allowed for now
+ */
+export type SimSwapProtocol = 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA';
+/**
+ * Represents a event-type subscription.
+ */
+export interface SimSwapSubscription {
+    /**
+     * 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` or `subscriptionMaxEvents` to limit subscription
+     * lifetime. Event type attributes must be defined in `subscriptionDetail`
+     */
+    config: SimSwapConfig;
+    /**
+     * Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: SimSwapProtocol;
+    /**
+     * The address to which events shall be delivered using the selected protocol.
+     */
+    sink: string;
+    /**
+     * Camara Event types eligible for subscription:
+     *
+     * - org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification
+     *   when a sim swap is performed on the line. 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<SimSwapSubscriptionEventType>;
+    /**
+     * 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` 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 metainformation is kept).
+     */
+    status?: 'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'INACTIVE' | 'DELETED';
+}
+/**
+ * swapped - Event triggered when a sim swap occurs on the line
+ */
+export type SimSwapSubscriptionEventType = 'org.camaraproject.sim-swap-subscriptions.v0.swapped';
+export type SubscriptionListResponse = Array<SimSwapSubscription>;
+/**
+ * Response for a event-type subscription request 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` or `subscriptionMaxEvents` to limit
+     * subscription lifetime. Event type attributes must be defined in
+     * `subscriptionDetail`
+     */
+    config: SimSwapConfig;
+    /**
+     * Body param: Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: SimSwapProtocol;
+    /**
+     * Body param: The address to which events shall be delivered using the selected
+     * protocol.
+     */
+    sink: string;
+    /**
+     * Body param: Camara Event types eligible for subscription:
+     *
+     * - org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification
+     *   when a sim swap is performed on the line.
+     */
+    types: Array<SimSwapSubscriptionEventType>;
+    /**
+     * 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. With the current API version the type MUST be set to
+         * ACCESSTOKEN.
+         */
+        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 SimSwapConfig as SimSwapConfig, type SimSwapProtocol as SimSwapProtocol, type SimSwapSubscription as SimSwapSubscription, type SimSwapSubscriptionEventType as SimSwapSubscriptionEventType, 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/simswap/subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/resources/simswap/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAYnG;;;;;;;;;;OAUG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAWlC;;;;;;;;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;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAErD;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;;;;WAKG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;CACjF;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,qDAAqD,CAAC;AAEjG,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAE1B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;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,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,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/simswap/subscriptions.js

@@ -0,0 +1,109 @@
+"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 sim swap event subscription for a phone number
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: { phoneNumber: '+123456789' },
+     *       subscriptionMaxEvents: 10,
+     *       subscriptionExpireTime: '2025-01-17T13:18:23.682Z',
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.sim-swap-subscriptions.v0.swapped',
+     *     ],
+     *     sinkCredential: {
+     *       credentialType: 'ACCESSTOKEN',
+     *       accessToken: 'yJ2ZXIiOiIxLjAiLCJ0eXAiO...',
+     *       accessTokenExpiresUtc: '1717753038',
+     *       accessTokenType: 'bearer',
+     *     },
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/simswap/subscriptions', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * retrieve event subscription information for a given subscription.
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscription =
+     *   await client.simswap.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get((0, path_1.path) `/simswap/subscriptions/${subscriptionID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieve a list of sim swap event subscription(s)
+     *
+     * @example
+     * ```ts
+     * const simSwapSubscriptions =
+     *   await client.simswap.subscriptions.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.get('/simswap/subscriptions', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * delete a given event subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.simswap.subscriptions.delete(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    delete(subscriptionID, params = {}, options) {
+        const { 'x-correlator': xCorrelator } = params ?? {};
+        return this._client.delete((0, path_1.path) `/simswap/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/simswap/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/resources/simswap/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,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;;;;;;;;;;OAUG;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,0BAA0B,cAAc,EAAE,EAAE;YACtE,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,wBAAwB,EAAE;YAChD,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,0BAA0B,cAAc,EAAE,EAAE;YACzE,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;AAjHD,sCAiHC"}