camara-sdk 0.1.1

package/resources/deviceidentifier.d.mts

@@ -0,0 +1,334 @@
+import { APIResource } from "../core/resource.mjs";
+import * as DeviceidentifierAPI from "./deviceidentifier.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Deviceidentifier extends APIResource {
+    /**
+     * Get details about the specific device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrieveIdentifier();
+     * ```
+     */
+    retrieveIdentifier(params: DeviceidentifierRetrieveIdentifierParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrieveIdentifierResponse>;
+    /**
+     * Get a pseudonymous identifier for device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrievePpid();
+     * ```
+     */
+    retrievePpid(params: DeviceidentifierRetrievePpidParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrievePpidResponse>;
+    /**
+     * Get details about the type of device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrieveType();
+     * ```
+     */
+    retrieveType(params: DeviceidentifierRetrieveTypeParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrieveTypeResponse>;
+}
+/**
+ * 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 1: 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. NOTE 2: For the current 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.
+ */
+export interface DeviceIdentifierDevice {
+    /**
+     * 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?: DeviceIdentifierDeviceIpv4Addr;
+    /**
+     * 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;
+}
+/**
+ * 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.
+ */
+export interface DeviceIdentifierDeviceIpv4Addr {
+    /**
+     * 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;
+}
+/**
+ * Common request body to allow optional Device object to be passed
+ */
+export interface DeviceIdentifierRequestBody {
+    /**
+     * 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+}
+export interface DeviceidentifierRetrieveIdentifierResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrieveIdentifierResponse.Device;
+    /**
+     * IMEI of the device
+     */
+    imei?: string;
+    /**
+     * IMEISV of the device
+     */
+    imeisv?: string;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * Manufacturer of the device
+     */
+    manufacturer?: string;
+    /**
+     * Model of the device
+     */
+    model?: string;
+    /**
+     * IMEI TAC of the device
+     */
+    tac?: string;
+}
+export declare namespace DeviceidentifierRetrieveIdentifierResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrievePpidResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrievePpidResponse.Device;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * A PPID for the identified physical device
+     */
+    ppid?: string;
+}
+export declare namespace DeviceidentifierRetrievePpidResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrieveTypeResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrieveTypeResponse.Device;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * Manufacturer of the device
+     */
+    manufacturer?: string;
+    /**
+     * Model of the device
+     */
+    model?: string;
+    /**
+     * IMEI TAC of the device
+     */
+    tac?: string;
+}
+export declare namespace DeviceidentifierRetrieveTypeResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrieveIdentifierParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface DeviceidentifierRetrievePpidParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface DeviceidentifierRetrieveTypeParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace Deviceidentifier {
+    export { type DeviceIdentifierDevice as DeviceIdentifierDevice, type DeviceIdentifierDeviceIpv4Addr as DeviceIdentifierDeviceIpv4Addr, type DeviceIdentifierRequestBody as DeviceIdentifierRequestBody, type DeviceidentifierRetrieveIdentifierResponse as DeviceidentifierRetrieveIdentifierResponse, type DeviceidentifierRetrievePpidResponse as DeviceidentifierRetrievePpidResponse, type DeviceidentifierRetrieveTypeResponse as DeviceidentifierRetrieveTypeResponse, type DeviceidentifierRetrieveIdentifierParams as DeviceidentifierRetrieveIdentifierParams, type DeviceidentifierRetrievePpidParams as DeviceidentifierRetrievePpidParams, type DeviceidentifierRetrieveTypeParams as DeviceidentifierRetrieveTypeParams, };
+}
+//# sourceMappingURL=deviceidentifier.d.mts.map

package/resources/deviceidentifier.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceidentifier.d.mts","sourceRoot":"","sources":["../src/resources/deviceidentifier.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,kBAAkB,CAChB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;IAYzD;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAYnD;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAWpD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;IAE7C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,0CAA0C;IACzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,0CAA0C,CAAC,MAAM,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,0CAA0C,CAAC;IAC1D;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;OAIG;IACH,MAAM,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;OAIG;IACH,MAAM,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,wCAAwC;IACvD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/deviceidentifier.d.ts

@@ -0,0 +1,334 @@
+import { APIResource } from "../core/resource.js";
+import * as DeviceidentifierAPI from "./deviceidentifier.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Deviceidentifier extends APIResource {
+    /**
+     * Get details about the specific device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrieveIdentifier();
+     * ```
+     */
+    retrieveIdentifier(params: DeviceidentifierRetrieveIdentifierParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrieveIdentifierResponse>;
+    /**
+     * Get a pseudonymous identifier for device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrievePpid();
+     * ```
+     */
+    retrievePpid(params: DeviceidentifierRetrievePpidParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrievePpidResponse>;
+    /**
+     * Get details about the type of device being used by a given mobile subscriber
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.deviceidentifier.retrieveType();
+     * ```
+     */
+    retrieveType(params: DeviceidentifierRetrieveTypeParams, options?: RequestOptions): APIPromise<DeviceidentifierRetrieveTypeResponse>;
+}
+/**
+ * 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 1: 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. NOTE 2: For the current 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.
+ */
+export interface DeviceIdentifierDevice {
+    /**
+     * 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?: DeviceIdentifierDeviceIpv4Addr;
+    /**
+     * 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;
+}
+/**
+ * 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.
+ */
+export interface DeviceIdentifierDeviceIpv4Addr {
+    /**
+     * 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;
+}
+/**
+ * Common request body to allow optional Device object to be passed
+ */
+export interface DeviceIdentifierRequestBody {
+    /**
+     * 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+}
+export interface DeviceidentifierRetrieveIdentifierResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrieveIdentifierResponse.Device;
+    /**
+     * IMEI of the device
+     */
+    imei?: string;
+    /**
+     * IMEISV of the device
+     */
+    imeisv?: string;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * Manufacturer of the device
+     */
+    manufacturer?: string;
+    /**
+     * Model of the device
+     */
+    model?: string;
+    /**
+     * IMEI TAC of the device
+     */
+    tac?: string;
+}
+export declare namespace DeviceidentifierRetrieveIdentifierResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrievePpidResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrievePpidResponse.Device;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * A PPID for the identified physical device
+     */
+    ppid?: string;
+}
+export declare namespace DeviceidentifierRetrievePpidResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrieveTypeResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    device?: DeviceidentifierRetrieveTypeResponse.Device;
+    /**
+     * Date and time that the information was last confirmed by the mobile operator to
+     * be correct. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone.
+     */
+    lastChecked?: string;
+    /**
+     * Manufacturer of the device
+     */
+    manufacturer?: string;
+    /**
+     * Model of the device
+     */
+    model?: string;
+    /**
+     * IMEI TAC of the device
+     */
+    tac?: string;
+}
+export declare namespace DeviceidentifierRetrieveTypeResponse {
+    /**
+     * The device subscription identifier that was used to identify the device whose
+     * identifier is being returned. If this property is not present, then the device
+     * subscription identifier specified in the request was used.
+     */
+    interface Device extends DeviceidentifierAPI.DeviceIdentifierDevice {
+    }
+}
+export interface DeviceidentifierRetrieveIdentifierParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface DeviceidentifierRetrievePpidParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export interface DeviceidentifierRetrieveTypeParams {
+    /**
+     * Body param: 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 1: 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. NOTE 2: For the current 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?: DeviceIdentifierDevice;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace Deviceidentifier {
+    export { type DeviceIdentifierDevice as DeviceIdentifierDevice, type DeviceIdentifierDeviceIpv4Addr as DeviceIdentifierDeviceIpv4Addr, type DeviceIdentifierRequestBody as DeviceIdentifierRequestBody, type DeviceidentifierRetrieveIdentifierResponse as DeviceidentifierRetrieveIdentifierResponse, type DeviceidentifierRetrievePpidResponse as DeviceidentifierRetrievePpidResponse, type DeviceidentifierRetrieveTypeResponse as DeviceidentifierRetrieveTypeResponse, type DeviceidentifierRetrieveIdentifierParams as DeviceidentifierRetrieveIdentifierParams, type DeviceidentifierRetrievePpidParams as DeviceidentifierRetrievePpidParams, type DeviceidentifierRetrieveTypeParams as DeviceidentifierRetrieveTypeParams, };
+}
+//# sourceMappingURL=deviceidentifier.d.ts.map

package/resources/deviceidentifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceidentifier.d.ts","sourceRoot":"","sources":["../src/resources/deviceidentifier.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,kBAAkB,CAChB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;IAYzD;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAYnD;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAWpD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;IAE7C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,0CAA0C;IACzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,0CAA0C,CAAC,MAAM,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,0CAA0C,CAAC;IAC1D;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;OAIG;IACH,MAAM,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;OAIG;IACH,MAAM,CAAC,EAAE,oCAAoC,CAAC,MAAM,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,UAAiB,MAAO,SAAQ,mBAAmB,CAAC,sBAAsB;KAAG;CAC9E;AAED,MAAM,WAAW,wCAAwC;IACvD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}