camara-sdk 0.1.1

package/resources/populationdensitydata.d.ts

@@ -0,0 +1,180 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Populationdensitydata extends APIResource {
+    /**
+     * Retrieves population density estimation together with the estimation range
+     * related for a time slot for a given area (described as a polygon) as a data set
+     * consisting of a sequence of equally-sized objects covering the input polygon
+     * area.
+     *
+     * @example
+     * ```ts
+     * const populationdensitydata =
+     *   await client.populationdensitydata.retrieve({
+     *     area: {
+     *       areaType: 'POLYGON',
+     *       boundary: [
+     *         { latitude: 45.754114, longitude: 4.860374 },
+     *         { latitude: 45.753845, longitude: 4.863185 },
+     *         { latitude: 45.75249, longitude: 4.861876 },
+     *         { latitude: 45.751224, longitude: 4.861125 },
+     *         { latitude: 45.751442, longitude: 4.859827 },
+     *       ],
+     *     },
+     *     endTime: '2024-04-23T14:44:18.165Z',
+     *     startTime: '2024-04-23T14:44:18.165Z',
+     *     precision: 7,
+     *   });
+     * ```
+     */
+    retrieve(params: PopulationdensitydataRetrieveParams, options?: RequestOptions): APIPromise<PopulationdensitydataRetrieveResponse>;
+}
+/**
+ * Population density values is represented in time intervals for different cells
+ * of the requested area. Each element in `timedPopulationDensityData` array
+ * corresponds to a time interval, containing population density data for the grid
+ * cells. The intervals are 1 hour long.
+ */
+export interface PopulationdensitydataRetrieveResponse {
+    /**
+     * Represents the state of the response for the input polygon defined in the
+     * request, the possible values are:
+     *
+     * - `SUPPORTED_AREA`: The whole request area is supported. Population density data
+     *   for the entire requested area is returned.
+     * - `PART_OF_AREA_NOT_SUPPORTED`: Part of the requested area is outside the MNOs
+     *   coverage area, the cells outside the coverage area will have property
+     *   `dataType` with value `NO_DATA`.
+     * - `AREA_NOT_SUPPORTED`: The whole requested area is outside the MNOs coverage
+     *   area. No data will be returned.
+     * - `OPERATION_NOT_COMPLETED`: An error happened during asynchronous processing of
+     *   the request. This status will only be returned in case the asynchronous API
+     *   behaviour is used.
+     */
+    status: 'SUPPORTED_AREA' | 'PART_OF_AREA_NOT_SUPPORTED' | 'AREA_NOT_SUPPORTED' | 'OPERATION_NOT_COMPLETED';
+    /**
+     * Time ranges along with the population density data for the cells within it. The
+     * request startTime or the request endTime have to be fully covered by the
+     * intervals. For example, if the intervals are 1-hour long and the input date
+     * range were [2024-01-03T11:25:00Z to 2024-01-03T12:45:00Z] it would contain 2
+     * intervals (Interval from 2024-01-03T11:00:00Z to 2024-01-03T12:00:00Z and
+     * interval from 2024-01-03T12:00:00Z to 2024-01-03T13:00:00Z).
+     */
+    timedPopulationDensityData: Array<PopulationdensitydataRetrieveResponse.TimedPopulationDensityData>;
+    /**
+     * Information about the status, mandatory when property `status` is
+     * `OPERATION_NOT_COMPLETED` for adding extra information about the error.
+     */
+    statusInfo?: string;
+}
+export declare namespace PopulationdensitydataRetrieveResponse {
+    interface TimedPopulationDensityData {
+        /**
+         * Population density data for the different cells in a concrete time range.
+         */
+        cellPopulationDensityData: Array<TimedPopulationDensityData.CellPopulationDensityData>;
+        /**
+         * Interval end time. It must follow
+         * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+         * have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which
+         * allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+         */
+        endTime: string;
+        /**
+         * Interval start time. It must follow
+         * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+         * have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which
+         * allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+         */
+        startTime: string;
+    }
+    namespace TimedPopulationDensityData {
+        /**
+         * Population density data of a cell in a concrete time range. In case of
+         * insufficient data, to guarantee an anonymized prediction due to the k-anonymity
+         * within a specific cell and time range, no population density data is returned
+         * and the property `dataType` value is "LOW_DENSITY". In case of a cell not
+         * supported `dataType` value is "NO_DATA"
+         */
+        interface CellPopulationDensityData {
+            dataType: 'NO_DATA' | 'LOW_DENSITY' | 'DENSITY_ESTIMATION';
+            /**
+             * Coordinates of the cell represented as a string using the
+             * [Geohash system](https://en.wikipedia.org/wiki/Geohash). Encoding a geographic
+             * location into a short string. The value length, and thus, the cell granularity,
+             * is determined by the request body property `precision`.
+             */
+            geohash: string;
+        }
+    }
+}
+export interface PopulationdensitydataRetrieveParams {
+    /**
+     * Body param: Base schema for all areas
+     */
+    area: PopulationdensitydataRetrieveParams.Area;
+    /**
+     * Body param: End date time. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which
+     * allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z) The maximum
+     * endTime allowed is 3 months from the time of the request.
+     */
+    endTime: string;
+    /**
+     * Body param: Start date time. It must follow
+     * [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must
+     * have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ
+     */
+    startTime: string;
+    /**
+     * Body param: Precision required of response cells. Precision defines a geohash
+     * level and corresponds to the length of the geohash for each cell. More
+     * information at [Geohash system](https://en.wikipedia.org/wiki/Geohash)" If not
+     * included the default precision level 7 is used by default. In case of using a
+     * not supported level by the MNO, the API returns the error response
+     * `POPULATION_DENSITY_DATA.UNSUPPORTED_PRECISION`.
+     */
+    precision?: number;
+    /**
+     * Body param: The address 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?: PopulationdensitydataRetrieveParams.SinkCredential;
+    /**
+     * Header param: Correlation id for the different services.
+     */
+    'x-correlator'?: string;
+}
+export declare namespace PopulationdensitydataRetrieveParams {
+    /**
+     * Base schema for all areas
+     */
+    interface Area {
+        /**
+         * Type of this area. POLYGON - The area is defined as a polygon.
+         */
+        areaType: 'POLYGON';
+    }
+    /**
+     * A sink credential provides authentication or authorization information necessary
+     * to enable delivery of events to a target.
+     */
+    interface SinkCredential {
+        /**
+         * The type of the credential. Note: Type of the credential - MUST be set to
+         * ACCESSTOKEN for now
+         */
+        credentialType: 'PLAIN' | 'ACCESSTOKEN' | 'REFRESHTOKEN';
+    }
+}
+export declare namespace Populationdensitydata {
+    export { type PopulationdensitydataRetrieveResponse as PopulationdensitydataRetrieveResponse, type PopulationdensitydataRetrieveParams as PopulationdensitydataRetrieveParams, };
+}
+//# sourceMappingURL=populationdensitydata.d.ts.map

package/resources/populationdensitydata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"populationdensitydata.d.ts","sourceRoot":"","sources":["../src/resources/populationdensitydata.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAWrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qCAAqC;IACpD;;;;;;;;;;;;;;OAcG;IACH,MAAM,EAAE,gBAAgB,GAAG,4BAA4B,GAAG,oBAAoB,GAAG,yBAAyB,CAAC;IAE3G;;;;;;;OAOG;IACH,0BAA0B,EAAE,KAAK,CAAC,qCAAqC,CAAC,0BAA0B,CAAC,CAAC;IAEpG;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,qCAAqC,CAAC;IACrD,UAAiB,0BAA0B;QACzC;;WAEG;QACH,yBAAyB,EAAE,KAAK,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;QAEvF;;;;;WAKG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;;WAKG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,0BAA0B,CAAC;QAC1C;;;;;;WAMG;QACH,UAAiB,yBAAyB;YACxC,QAAQ,EAAE,SAAS,GAAG,aAAa,GAAG,oBAAoB,CAAC;YAE3D;;;;;eAKG;YACH,OAAO,EAAE,MAAM,CAAC;SACjB;KACF;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,mCAAmC,CAAC,IAAI,CAAC;IAE/C;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,mCAAmC,CAAC,cAAc,CAAC;IAEpE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,SAAS,CAAC;KACrB;IAED;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,cAAc,EAAE,OAAO,GAAG,aAAa,GAAG,cAAc,CAAC;KAC1D;CACF;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB,CAAC;IAC7C,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/populationdensitydata.js

@@ -0,0 +1,47 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Populationdensitydata = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+class Populationdensitydata extends resource_1.APIResource {
+    /**
+     * Retrieves population density estimation together with the estimation range
+     * related for a time slot for a given area (described as a polygon) as a data set
+     * consisting of a sequence of equally-sized objects covering the input polygon
+     * area.
+     *
+     * @example
+     * ```ts
+     * const populationdensitydata =
+     *   await client.populationdensitydata.retrieve({
+     *     area: {
+     *       areaType: 'POLYGON',
+     *       boundary: [
+     *         { latitude: 45.754114, longitude: 4.860374 },
+     *         { latitude: 45.753845, longitude: 4.863185 },
+     *         { latitude: 45.75249, longitude: 4.861876 },
+     *         { latitude: 45.751224, longitude: 4.861125 },
+     *         { latitude: 45.751442, longitude: 4.859827 },
+     *       ],
+     *     },
+     *     endTime: '2024-04-23T14:44:18.165Z',
+     *     startTime: '2024-04-23T14:44:18.165Z',
+     *     precision: 7,
+     *   });
+     * ```
+     */
+    retrieve(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/populationdensitydata/retrieve', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Populationdensitydata = Populationdensitydata;
+//# sourceMappingURL=populationdensitydata.js.map

package/resources/populationdensitydata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"populationdensitydata.js","sourceRoot":"","sources":["../src/resources/populationdensitydata.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAGnD,MAAa,qBAAsB,SAAQ,sBAAW;IACpD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAC1D,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;CACF;AAzCD,sDAyCC"}

package/resources/populationdensitydata.mjs

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+export class Populationdensitydata extends APIResource {
+    /**
+     * Retrieves population density estimation together with the estimation range
+     * related for a time slot for a given area (described as a polygon) as a data set
+     * consisting of a sequence of equally-sized objects covering the input polygon
+     * area.
+     *
+     * @example
+     * ```ts
+     * const populationdensitydata =
+     *   await client.populationdensitydata.retrieve({
+     *     area: {
+     *       areaType: 'POLYGON',
+     *       boundary: [
+     *         { latitude: 45.754114, longitude: 4.860374 },
+     *         { latitude: 45.753845, longitude: 4.863185 },
+     *         { latitude: 45.75249, longitude: 4.861876 },
+     *         { latitude: 45.751224, longitude: 4.861125 },
+     *         { latitude: 45.751442, longitude: 4.859827 },
+     *       ],
+     *     },
+     *     endTime: '2024-04-23T14:44:18.165Z',
+     *     startTime: '2024-04-23T14:44:18.165Z',
+     *     precision: 7,
+     *   });
+     * ```
+     */
+    retrieve(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/populationdensitydata/retrieve', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=populationdensitydata.mjs.map

package/resources/populationdensitydata.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"populationdensitydata.mjs","sourceRoot":"","sources":["../src/resources/populationdensitydata.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAC1D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}