camara-sdk 0.1.1

package/src/resources/regiondevicecount.ts

@@ -0,0 +1,216 @@
+// 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';
+
+export class Regiondevicecount extends APIResource {
+  /**
+   * Get the number of devices in the specified area during a certain time interval.
+   *
+   * - The query area can be a circle or a polygon composed of longitude and latitude
+   *   points.
+   * - If the areaType is circle, the circleCenter and circleRadius must be provided;
+   *   if the area is a polygon, the point list must be provided.
+   * - If starttime and endtime are not passed in,this api should return the current
+   *   number of devices in the area.
+   * - If the device appears in the specified area at least once during the certain
+   *   time interval, it should be counted.
+   *
+   * @example
+   * ```ts
+   * const response = await client.regiondevicecount.getCount({
+   *   area: {
+   *     areaType: 'CIRCLE',
+   *     center: { latitude: 45.754114, longitude: 4.860374 },
+   *     radius: 800,
+   *   },
+   *   endtime: '2023-07-04T14:27:08.312+02:00',
+   *   filter: {
+   *     roamingStatus: ['roaming'],
+   *     deviceType: ['human device', 'IoT device'],
+   *   },
+   *   sink: 'https://endpoint.example.com/sink',
+   *   sinkCredential: {
+   *     credentialType: 'ACCESSTOKEN',
+   *     accessToken: 'yJ2ZXIiOiIxLjAiLCJ0eXAiO...',
+   *     accessTokenExpiresUtc: '1717753038',
+   *     accessTokenType: 'bearer',
+   *   },
+   *   starttime: '2023-07-03T14:27:08.312+02:00',
+   * });
+   * ```
+   */
+  getCount(
+    params: RegiondevicecountGetCountParams,
+    options?: RequestOptions,
+  ): APIPromise<RegiondevicecountGetCountResponse> {
+    const { 'x-correlator': xCorrelator, ...body } = params;
+    return this._client.post('/regiondevicecount/count', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * RegionDeviceCount result
+ */
+export interface RegiondevicecountGetCountResponse {
+  /**
+   * Device Count
+   */
+  count?: number;
+
+  /**
+   * SUPPORTED_AREA: The whole requested area is supported Region Device Count for
+   * the entire requested area is returned - Telco Coverage = 100 %
+   *
+   * PART_OF_AREA_NOT_SUPPORTED: Part of the requested area is outside the MNOs
+   * coverage area, the area outside the coverage area are not returned - 100% >Telco
+   * Coverage >=50%
+   *
+   * AREA_NOT_SUPPORTED: The whole requested area is outside the MNO coverage area No
+   * data will be returned- Telco Coverage <50%
+   *
+   * DENSITY_BELOW_PRIVACY_THRESHOLD: The number of connected devices is below
+   * privacy threshold of local regulation
+   *
+   * TIME_INTERVAL_NO_DATA_FOUND: Unable to find device count data within the
+   * requested time interval
+   */
+  status?:
+    | 'SUPPORTED_AREA'
+    | 'PART_OF_AREA_NOT_SUPPORTED'
+    | 'AREA_NOT_SUPPORTED'
+    | 'DENSITY_BELOW_PRIVACY_THRESHOLD'
+    | 'TIME_INTERVAL_NO_DATA_FOUND';
+}
+
+export interface RegiondevicecountGetCountParams {
+  /**
+   * Body param:
+   */
+  area?: RegiondevicecountGetCountParams.Area;
+
+  /**
+   * Body param: Ending timestamp for counting the number of devices in the area. It
+   * must follow
+   * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+   * have time zone.
+   */
+  endtime?: string | null;
+
+  /**
+   * Body param: This parameter is used to filter devices. Currently, two filtering
+   * criteria are defined, `roamingStatus` and `deviceType`, which can be expanded in
+   * the future. `IN` logic is used used for multiple filtering items within a single
+   * filtering criterion, `AND` logic is used between multiple filtering criteria.
+   *
+   * - If a filtering critera is not provided, it means that there is no need to
+   *   filter this item.
+   * - At least one of the criteria must be provided,a filter without any criteria is
+   *   not allowed.
+   * - If no filtering is required, this parameter does not need to be provided. For
+   *   example
+   *   ,`"filter":{"roamingStatus": ["roaming"],"deviceType": ["human device","IoT device"]}`
+   *   means the API need to return the count of human network devices and IoT
+   *   devices that are in roaming mode.`"filter":{"roamingStatus": ["non-roaming"]}`
+   *   means that the API need to return the count of all devices that are not in
+   *   roaming mode.
+   */
+  filter?: RegiondevicecountGetCountParams.Filter;
+
+  /**
+   * Body param: The URL where the API response will be asynchronously delivered,
+   * using the HTTP protocol.
+   */
+  sink?: string;
+
+  /**
+   * Body param: A sink credential provides authentication or authorization
+   * information necessary to enable delivery of events to a target.
+   */
+  sinkCredential?: RegiondevicecountGetCountParams.SinkCredential;
+
+  /**
+   * Body param: Starting timestamp for counting the number of devices in the area.
+   * It must follow
+   * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+   * have time zone.
+   */
+  starttime?: string | null;
+
+  /**
+   * Header param: Correlation ID for cross-service tracking
+   */
+  'x-correlator'?: string;
+}
+
+export namespace RegiondevicecountGetCountParams {
+  export interface Area {
+    /**
+     * Type of this area. CIRCLE - The area is defined as a circle. POLYGON - The area
+     * is defined as a polygon.
+     */
+    areaType: 'CIRCLE' | 'POLYGON';
+  }
+
+  /**
+   * This parameter is used to filter devices. Currently, two filtering criteria are
+   * defined, `roamingStatus` and `deviceType`, which can be expanded in the future.
+   * `IN` logic is used used for multiple filtering items within a single filtering
+   * criterion, `AND` logic is used between multiple filtering criteria.
+   *
+   * - If a filtering critera is not provided, it means that there is no need to
+   *   filter this item.
+   * - At least one of the criteria must be provided,a filter without any criteria is
+   *   not allowed.
+   * - If no filtering is required, this parameter does not need to be provided. For
+   *   example
+   *   ,`"filter":{"roamingStatus": ["roaming"],"deviceType": ["human device","IoT device"]}`
+   *   means the API need to return the count of human network devices and IoT
+   *   devices that are in roaming mode.`"filter":{"roamingStatus": ["non-roaming"]}`
+   *   means that the API need to return the count of all devices that are not in
+   *   roaming mode.
+   */
+  export interface Filter {
+    /**
+     * Filtering by device type, 'human device' represents the need to filter for human
+     * network devices, 'IoT device' represents the need to filter for IoT devices, and
+     * 'other' represents the need to filter for other types of devices.
+     */
+    deviceType?: Array<'human device' | 'IoT device' | 'other'>;
+
+    /**
+     * Filter whether the device is in roaming mode,'roaming' represents the need to
+     * filter devices that are in roaming mode,'non-roaming' represents the need to
+     * filter devices that are not roaming.
+     */
+    roamingStatus?: Array<'roaming' | 'non-roaming'>;
+  }
+
+  /**
+   * A sink credential provides authentication or authorization information necessary
+   * to enable delivery of events to a target.
+   */
+  export interface SinkCredential {
+    /**
+     * The type of the credential. Note: Type of the credential - MUST be set to
+     * ACCESSTOKEN for now
+     */
+    credentialType: 'PLAIN' | 'ACCESSTOKEN' | 'REFRESHTOKEN';
+  }
+}
+
+export declare namespace Regiondevicecount {
+  export {
+    type RegiondevicecountGetCountResponse as RegiondevicecountGetCountResponse,
+    type RegiondevicecountGetCountParams as RegiondevicecountGetCountParams,
+  };
+}

package/src/resources/simswap/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Simswap } from './simswap';
+export {
+  Subscriptions,
+  type SimSwapConfig,
+  type SimSwapProtocol,
+  type SimSwapSubscription,
+  type SimSwapSubscriptionEventType,
+  type SubscriptionListResponse,
+  type SubscriptionDeleteResponse,
+  type SubscriptionCreateParams,
+  type SubscriptionRetrieveParams,
+  type SubscriptionListParams,
+  type SubscriptionDeleteParams,
+} from './subscriptions';

package/src/resources/simswap/simswap.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SubscriptionsAPI from './subscriptions';
+import {
+  SimSwapConfig,
+  SimSwapProtocol,
+  SimSwapSubscription,
+  SimSwapSubscriptionEventType,
+  SubscriptionCreateParams,
+  SubscriptionDeleteParams,
+  SubscriptionDeleteResponse,
+  SubscriptionListParams,
+  SubscriptionListResponse,
+  SubscriptionRetrieveParams,
+  Subscriptions,
+} from './subscriptions';
+
+export class Simswap extends APIResource {
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+}
+
+Simswap.Subscriptions = Subscriptions;
+
+export declare namespace Simswap {
+  export {
+    Subscriptions as Subscriptions,
+    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,
+  };
+}

package/src/resources/simswap/subscriptions.ts

@@ -0,0 +1,357 @@
+// 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 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> {
+    const { 'x-correlator': xCorrelator, ...body } = params;
+    return this._client.post('/simswap/subscriptions', {
+      body,
+      ...options,
+      headers: 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: string,
+    params: SubscriptionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SimSwapSubscription> {
+    const { 'x-correlator': xCorrelator } = params ?? {};
+    return this._client.get(path`/simswap/subscriptions/${subscriptionID}`, {
+      ...options,
+      headers: 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: SubscriptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionListResponse> {
+    const { 'x-correlator': xCorrelator } = params ?? {};
+    return this._client.get('/simswap/subscriptions', {
+      ...options,
+      headers: 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: string,
+    params: SubscriptionDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionDeleteResponse> {
+    const { 'x-correlator': xCorrelator } = params ?? {};
+    return this._client.delete(path`/simswap/subscriptions/${subscriptionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * 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 namespace SimSwapConfig {
+  /**
+   * The detail of the requested event subscription
+   */
+  export 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 namespace SubscriptionCreateParams {
+  /**
+   * A sink credential provides authentication or authorization information necessary
+   * to enable delivery of events to a target.
+   */
+  export 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,
+  };
+}

package/src/resources/simswap.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './simswap/index';