@cosmotech/aip-client 0.2.0-dev → 0.2.0-dev2

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.2.0-dev
+## @cosmotech/aip-client@0.2.0-dev2
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cosmotech/aip-client@0.2.0-dev --save
+npm install @cosmotech/aip-client@0.2.0-dev2 --save
 ```
 
 _unPublished (not recommended):_

package/api/default-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/metric-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/metric-costs-per-year-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/objective-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/objective-weight-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/value-framework-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/base.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/default-api.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Root
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    root: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export declare const DefaultApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Root
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    root(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Root
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    root(options?: any): AxiosPromise<any>;
+};
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export declare class DefaultApi extends BaseAPI {
+    /**
+     *
+     * @summary Root
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    root(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+}

package/dist/api/default-api.js

@@ -0,0 +1,128 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+const DefaultApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Root
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        root: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/about`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+const DefaultApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Root
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        root(options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.root(options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.root']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+    };
+};
+exports.DefaultApiFp = DefaultApiFp;
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+const DefaultApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.DefaultApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Root
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        root(options) {
+            return localVarFp.root(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.DefaultApiFactory = DefaultApiFactory;
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+class DefaultApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Root
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    root(options) {
+        return (0, exports.DefaultApiFp)(this.configuration).root(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.DefaultApi = DefaultApi;

package/dist/api/metric-api.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { MetricCreate } from '../models';
+import { MetricResponse } from '../models';
+import { MetricUpdate } from '../models';
+/**
+ * MetricApi - axios parameter creator
+ * @export
+ */
+export declare const MetricApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * @summary Delete a metric
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetric: (metricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single metric by its ID.
+     * @summary Get a metric by ID
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricById: (metricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all metrics.
+     * @summary List metrics
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetrics: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a metric
+     * @param {string} metricId UUID of the metric
+     * @param {MetricUpdate} metricUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetric: (metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * @summary Create a metric
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetric: (metricCreate: MetricCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetricApi - functional programming interface
+ * @export
+ */
+export declare const MetricApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * @summary Delete a metric
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetric(metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a single metric by its ID.
+     * @summary Get a metric by ID
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricById(metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+    /**
+     * Retrieve a paginated list of all metrics.
+     * @summary List metrics
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetrics(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricResponse>>>;
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a metric
+     * @param {string} metricId UUID of the metric
+     * @param {MetricUpdate} metricUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * @summary Create a metric
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetric(metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+};
+/**
+ * MetricApi - factory interface
+ * @export
+ */
+export declare const MetricApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * @summary Delete a metric
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetric(metricId: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieve a single metric by its ID.
+     * @summary Get a metric by ID
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricById(metricId: string, options?: any): AxiosPromise<MetricResponse>;
+    /**
+     * Retrieve a paginated list of all metrics.
+     * @summary List metrics
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetrics(offset?: number, limit?: number, options?: any): AxiosPromise<Array<MetricResponse>>;
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a metric
+     * @param {string} metricId UUID of the metric
+     * @param {MetricUpdate} metricUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: any): AxiosPromise<MetricResponse>;
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * @summary Create a metric
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetric(metricCreate: MetricCreate, options?: any): AxiosPromise<MetricResponse>;
+};
+/**
+ * MetricApi - object-oriented interface
+ * @export
+ * @class MetricApi
+ * @extends {BaseAPI}
+ */
+export declare class MetricApi extends BaseAPI {
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * @summary Delete a metric
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    deleteMetric(metricId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a single metric by its ID.
+     * @summary Get a metric by ID
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    getMetricById(metricId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all metrics.
+     * @summary List metrics
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    getMetrics(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse[], any, {}>>;
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a metric
+     * @param {string} metricId UUID of the metric
+     * @param {MetricUpdate} metricUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * @summary Create a metric
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    postMetric(metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+}