camara-sdk 0.1.1

package/resources/connectivityinsights/connectivityinsights.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectivityinsights.d.mts","sourceRoot":"","sources":["../../src/resources/connectivityinsights/connectivityinsights.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EACL,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,0BAA0B,EAC1B,aAAa,EACd;AAED,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;CAClG;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,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/connectivityinsights/connectivityinsights.d.ts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../core/resource.js";
+import * as SubscriptionsAPI from "./subscriptions.js";
+import { Config, Protocol, Subscription, SubscriptionCreateParams, SubscriptionDeleteParams, SubscriptionDeleteResponse, SubscriptionEventType, SubscriptionListParams, SubscriptionListResponse, SubscriptionRetrieveParams, Subscriptions } from "./subscriptions.js";
+export declare class Connectivityinsights extends APIResource {
+    subscriptions: SubscriptionsAPI.Subscriptions;
+}
+export declare namespace Connectivityinsights {
+    export { Subscriptions as Subscriptions, type Config as Config, type Protocol as Protocol, type Subscription as Subscription, type SubscriptionEventType as SubscriptionEventType, 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=connectivityinsights.d.ts.map

package/resources/connectivityinsights/connectivityinsights.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectivityinsights.d.ts","sourceRoot":"","sources":["../../src/resources/connectivityinsights/connectivityinsights.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EACL,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,0BAA0B,EAC1B,aAAa,EACd;AAED,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;CAClG;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,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/connectivityinsights/connectivityinsights.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connectivityinsights = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const SubscriptionsAPI = tslib_1.__importStar(require("./subscriptions.js"));
+const subscriptions_1 = require("./subscriptions.js");
+class Connectivityinsights extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+    }
+}
+exports.Connectivityinsights = Connectivityinsights;
+Connectivityinsights.Subscriptions = subscriptions_1.Subscriptions;
+//# sourceMappingURL=connectivityinsights.js.map

package/resources/connectivityinsights/connectivityinsights.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectivityinsights.js","sourceRoot":"","sources":["../../src/resources/connectivityinsights/connectivityinsights.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6EAAoD;AACpD,sDAYyB;AAEzB,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnG,CAAC;CAAA;AAFD,oDAEC;AAED,oBAAoB,CAAC,aAAa,GAAG,6BAAa,CAAC"}

package/resources/connectivityinsights/connectivityinsights.mjs

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as SubscriptionsAPI from "./subscriptions.mjs";
+import { Subscriptions, } from "./subscriptions.mjs";
+export class Connectivityinsights extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+    }
+}
+Connectivityinsights.Subscriptions = Subscriptions;
+//# sourceMappingURL=connectivityinsights.mjs.map

package/resources/connectivityinsights/connectivityinsights.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectivityinsights.mjs","sourceRoot":"","sources":["../../src/resources/connectivityinsights/connectivityinsights.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAWL,aAAa,GACd;AAED,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAArD;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnG,CAAC;CAAA;AAED,oBAAoB,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/resources/connectivityinsights/index.d.mts

@@ -0,0 +1,3 @@
+export { Connectivityinsights } from "./connectivityinsights.mjs";
+export { Subscriptions, type Config, type Protocol, type Subscription, type SubscriptionEventType, type SubscriptionListResponse, type SubscriptionDeleteResponse, type SubscriptionCreateParams, type SubscriptionRetrieveParams, type SubscriptionListParams, type SubscriptionDeleteParams, } from "./subscriptions.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/connectivityinsights/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/connectivityinsights/index.ts"],"names":[],"mappings":"OAEO,EAAE,oBAAoB,EAAE;OACxB,EACL,aAAa,EACb,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,GAC9B"}

package/resources/connectivityinsights/index.d.ts

@@ -0,0 +1,3 @@
+export { Connectivityinsights } from "./connectivityinsights.js";
+export { Subscriptions, type Config, type Protocol, type Subscription, type SubscriptionEventType, type SubscriptionListResponse, type SubscriptionDeleteResponse, type SubscriptionCreateParams, type SubscriptionRetrieveParams, type SubscriptionListParams, type SubscriptionDeleteParams, } from "./subscriptions.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/connectivityinsights/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/connectivityinsights/index.ts"],"names":[],"mappings":"OAEO,EAAE,oBAAoB,EAAE;OACxB,EACL,aAAa,EACb,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,GAC9B"}

package/resources/connectivityinsights/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscriptions = exports.Connectivityinsights = void 0;
+var connectivityinsights_1 = require("./connectivityinsights.js");
+Object.defineProperty(exports, "Connectivityinsights", { enumerable: true, get: function () { return connectivityinsights_1.Connectivityinsights; } });
+var subscriptions_1 = require("./subscriptions.js");
+Object.defineProperty(exports, "Subscriptions", { enumerable: true, get: function () { return subscriptions_1.Subscriptions; } });
+//# sourceMappingURL=index.js.map

package/resources/connectivityinsights/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/connectivityinsights/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kEAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,oDAYyB;AAXvB,8GAAA,aAAa,OAAA"}

package/resources/connectivityinsights/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Connectivityinsights } from "./connectivityinsights.mjs";
+export { Subscriptions, } from "./subscriptions.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/connectivityinsights/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/connectivityinsights/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,oBAAoB,EAAE;OACxB,EACL,aAAa,GAWd"}

package/resources/connectivityinsights/subscriptions.d.mts

@@ -0,0 +1,445 @@
+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 Connectivity insights subscription for a device
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.connectivityinsights.subscriptions.create({
+     *     config: {
+     *       subscriptionDetail: {
+     *         applicationProfileId:
+     *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *         device: {},
+     *       },
+     *     },
+     *     protocol: 'HTTP',
+     *     sink: 'https://endpoint.example.com/sink',
+     *     types: [
+     *       'org.camaraproject.connectivity-insights-subscriptions.v0.network-quality',
+     *     ],
+     *   });
+     * ```
+     */
+    create(params: SubscriptionCreateParams, options?: RequestOptions): APIPromise<Subscription>;
+    /**
+     * Retrieve a given subscription by ID
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.connectivityinsights.subscriptions.retrieve(
+     *     'qs15-h556-rt89-1298',
+     *   );
+     * ```
+     */
+    retrieve(subscriptionID: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Subscription>;
+    /**
+     * Operation to list subscriptions authorized to be retrieved by the provided
+     * access token.
+     *
+     * @example
+     * ```ts
+     * const subscriptions =
+     *   await client.connectivityinsights.subscriptions.list();
+     * ```
+     */
+    list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
+    /**
+     * Delete a given subscription by ID
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.connectivityinsights.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 Config {
+    /**
+     * The detail of the requested event subscription
+     */
+    subscriptionDetail: Config.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.
+     */
+    initialEvent?: boolean;
+    /**
+     * The subscription expiration time (in date-time format) requested by the API
+     * consumer. Up to API project decision to keep it. 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. Note
+     * on combined usage of `initialEvent` and `subscriptionMaxEvents`: If an event is
+     * triggered following `initialEvent` set to `true`, this event will be counted
+     * towards `subscriptionMaxEvents`.
+     */
+    subscriptionMaxEvents?: number;
+}
+export declare namespace Config {
+    /**
+     * The detail of the requested event subscription
+     */
+    interface SubscriptionDetail {
+        /**
+         * Identifier for the Application Profile
+         */
+        applicationProfileId: string;
+        /**
+         * 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` NOTE1: the network operator might
+         * support only a subset of these options. The API invoker can provide multiple
+         * identifiers to be compatible across different network operators. In this case
+         * the identifiers MUST belong to the same device. NOTE2: as for this Commonalities
+         * release, we are enforcing that the networkAccessIdentifier is only part of the
+         * schema for future-proofing, and CAMARA does not currently allow its use. After
+         * the CAMARA meta-release work is concluded and the relevant issues are resolved,
+         * its use will need to be explicitly documented in the guidelines.
+         */
+        device: SubscriptionDetail.Device;
+        /**
+         * A server hosting backend applications to deliver some business logic to clients.
+         *
+         * The developer can choose to provide the below specified device identifiers:
+         *
+         * - `ipv4Address`
+         * - `ipv6Address`
+         *
+         * The Operator will use this information to calculate the end to end network
+         * performance in scenarios where its feasible.
+         */
+        applicationServer?: SubscriptionDetail.ApplicationServer;
+        /**
+         * Specification of several TCP or UDP ports
+         */
+        applicationServerPorts?: SubscriptionDetail.ApplicationServerPorts;
+    }
+    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` NOTE1: the network operator might
+         * support only a subset of these options. The API invoker can provide multiple
+         * identifiers to be compatible across different network operators. In this case
+         * the identifiers MUST belong to the same device. NOTE2: as for this Commonalities
+         * release, we are enforcing that the networkAccessIdentifier is only part of the
+         * schema for future-proofing, and CAMARA does not currently allow its use. After
+         * the CAMARA meta-release work is concluded and the relevant issues are resolved,
+         * its use will need to be explicitly documented in the guidelines.
+         */
+        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).
+             *
+             * The session shall apply to all IP flows between the device subnet and the
+             * specified application server, unless further restricted by the optional
+             * parameters devicePorts or applicationServerPorts.
+             */
+            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;
+            }
+        }
+        /**
+         * A server hosting backend applications to deliver some business logic to clients.
+         *
+         * The developer can choose to provide the below specified device identifiers:
+         *
+         * - `ipv4Address`
+         * - `ipv6Address`
+         *
+         * The Operator will use this information to calculate the end to end network
+         * performance in scenarios where its feasible.
+         */
+        interface ApplicationServer {
+            /**
+             * IPv4 address may be specified in form <address/mask> as:
+             *
+             * - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP
+             *   number will match the flow control rule.
+             * - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24.
+             *   In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit
+             *   width MUST be valid for the IP version.
+             */
+            ipv4Address?: string;
+            /**
+             * IPv6 address may be specified in form <address/mask> as:
+             *
+             * - address - The /128 subnet is optional for single addresses:
+             *   - 2001:db8:85a3:8d3:1319:8a2e:370:7344
+             *   - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128
+             * - address/mask - an IP v6 number with a mask:
+             *   - 2001:db8:85a3:8d3::0/64
+             *   - 2001:db8:85a3:8d3::/64
+             */
+            ipv6Address?: string;
+        }
+        /**
+         * Specification of several TCP or UDP ports
+         */
+        interface ApplicationServerPorts {
+            /**
+             * Array of TCP or UDP ports
+             */
+            ports?: Array<number>;
+            /**
+             * Range of TCP or UDP ports
+             */
+            ranges?: Array<ApplicationServerPorts.Range>;
+        }
+        namespace ApplicationServerPorts {
+            interface Range {
+                /**
+                 * TCP or UDP port number
+                 */
+                from: number;
+                /**
+                 * TCP or UDP port number
+                 */
+                to: number;
+            }
+        }
+    }
+}
+/**
+ * Identifier of a delivery protocol. Only HTTP is allowed for now
+ */
+export type Protocol = 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA';
+/**
+ * Represents a event-type subscription.
+ */
+export interface Subscription {
+    /**
+     * 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: Config;
+    /**
+     * Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: Protocol;
+    /**
+     * The address to which events shall be delivered using the selected protocol.
+     */
+    sink: 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;
+    /**
+     * Camara Event types eligible to be delivered by this subscription.
+     */
+    types: Array<SubscriptionEventType>;
+    /**
+     * 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;
+    /**
+     * 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.
+     * - `DEACTIVE`: 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 metainformation is kept).
+     */
+    status?: 'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'DEACTIVE' | 'DELETED';
+    /**
+     * When this information is contained within an event notification, it SHALL be
+     * referred to as `subscriptionId` as per the Commonalities Event Notification
+     * Model.
+     */
+    subscriptionId?: string;
+}
+/**
+ * event-type - Event triggered when an event-type event occurred
+ */
+export type SubscriptionEventType = 'org.camaraproject.connectivity-insights-subscriptions.v0.network-quality';
+export type SubscriptionListResponse = Array<Subscription>;
+/**
+ * Response for a event-type subscription request managed asynchronously (Creation
+ * or Deletion)
+ */
+export interface SubscriptionDeleteResponse {
+    /**
+     * When this information is contained within an event notification, it SHALL be
+     * referred to as `subscriptionId` as per the Commonalities Event Notification
+     * Model.
+     */
+    subscriptionId?: 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: Config;
+    /**
+     * Body param: Identifier of a delivery protocol. Only HTTP is allowed for now
+     */
+    protocol: Protocol;
+    /**
+     * 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.
+     */
+    types: Array<SubscriptionEventType>;
+    /**
+     * Body param: A sink credential provides authentication or authorization
+     * information
+     */
+    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
+     */
+    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 Config as Config, type Protocol as Protocol, type Subscription as Subscription, type SubscriptionEventType as SubscriptionEventType, 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/connectivityinsights/subscriptions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../../src/resources/connectivityinsights/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAW3B;;;;;;;;;OASG;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,MAAM;IACrB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC;IAE9C;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;;;;;;;;WAYG;QACH,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;QAElC;;;;;;;;;;WAUG;QACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC;QAEzD;;WAEG;QACH,sBAAsB,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC;KACpE;IAED,UAAiB,kBAAkB,CAAC;QAClC;;;;;;;;;;;;WAYG;QACH,UAAiB,MAAM;YACrB;;;;;;;;;;;;;;;;;eAiBG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YAEjC;;;;;;;;eAQG;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;QAED;;;;;;;;;;WAUG;QACH,UAAiB,iBAAiB;YAChC;;;;;;;;eAQG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;;;;;;;eASG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,sBAAsB;YACrC;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,MAAM,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;SAC9C;QAED,UAAiB,sBAAsB,CAAC;YACtC,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;aACZ;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;IAEhF;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC/B,0EAA0E,CAAC;AAE7E,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpC;;;OAGG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC,cAAc,CAAC;IAEzD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;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,MAAM,IAAI,MAAM,EACrB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,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"}