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

package/configuration.ts

@@ -1,10 +1,9 @@
 /* tslint:disable */
-/* eslint-disable */
 /**
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,12 +11,24 @@
  * Do not edit the class manually.
  */
 
+interface AWSv4Configuration {
+  options?: {
+    region?: string
+    service?: string
+  }
+  credentials?: {
+    accessKeyId?: string
+    secretAccessKey?: string,
+    sessionToken?: string
+  }
+}
 
 export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -28,49 +39,43 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
-     * override base path
-     *
-     * @type {string}
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
      * @memberof Configuration
      */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -87,9 +92,15 @@ export class Configuration {
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

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

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,10 +11,9 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { type RequestArgs, BaseAPI } from '../base';
 /**
  * DefaultApi - axios parameter creator
- * @export
  */
 export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -27,7 +26,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * DefaultApi - functional programming interface
- * @export
  */
 export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
@@ -40,7 +38,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
 };
 /**
  * DefaultApi - factory interface
- * @export
  */
 export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -49,13 +46,10 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    root(options?: any): AxiosPromise<any>;
+    root(options?: RawAxiosRequestConfig): AxiosPromise<any>;
 };
 /**
  * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
 export declare class DefaultApi extends BaseAPI {
     /**
@@ -63,7 +57,6 @@ 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

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,7 +31,6 @@ const common_1 = require("../common");
 const base_1 = require("../base");
 /**
  * DefaultApi - axios parameter creator
- * @export
  */
 const DefaultApiAxiosParamCreator = function (configuration) {
     return {
@@ -41,7 +40,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        root: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+        root: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
             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);
@@ -52,6 +51,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
+            localVarHeaderParameter['Accept'] = 'application/json';
             (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);
@@ -65,7 +65,6 @@ const DefaultApiAxiosParamCreator = function (configuration) {
 exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
 /**
  * DefaultApi - functional programming interface
- * @export
  */
 const DefaultApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
@@ -77,12 +76,12 @@ const DefaultApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         root(options) {
-            var _a, _b, _c;
             return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
                 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);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.root']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === 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, localVarOperationServerBasePath || basePath);
             });
         },
     };
@@ -90,7 +89,6 @@ const DefaultApiFp = function (configuration) {
 exports.DefaultApiFp = DefaultApiFp;
 /**
  * DefaultApi - factory interface
- * @export
  */
 const DefaultApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.DefaultApiFp)(configuration);
@@ -109,9 +107,6 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
 exports.DefaultApiFactory = DefaultApiFactory;
 /**
  * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
 class DefaultApi extends base_1.BaseAPI {
     /**
@@ -119,7 +114,6 @@ 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));

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

@@ -0,0 +1,245 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { ImpactAPIResponse } from '../models';
+import type { ImpactCreate } from '../models';
+import type { ImpactUpdate } from '../models';
+/**
+ * ImpactApi - axios parameter creator
+ */
+export declare const ImpactApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new impact under this option.
+     * @summary Create an impact for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactCreate} impactCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an existing impact by its ID.
+     * @summary Delete an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a specific impact for the option.
+     * @summary Get an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all impacts for a specific option.
+     * @summary List impacts for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @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}
+     */
+    getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactUpdate} impactUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ImpactApi - functional programming interface
+ */
+export declare const ImpactApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new impact under this option.
+     * @summary Create an impact for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactCreate} impactCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
+    /**
+     * Delete an existing impact by its ID.
+     * @summary Delete an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a specific impact for the option.
+     * @summary Get an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
+    /**
+     * Retrieve a paginated list of all impacts for a specific option.
+     * @summary List impacts for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @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}
+     */
+    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
+    /**
+     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactUpdate} impactUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
+};
+/**
+ * ImpactApi - factory interface
+ */
+export declare const ImpactApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new impact under this option.
+     * @summary Create an impact for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactCreate} impactCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
+    /**
+     * Delete an existing impact by its ID.
+     * @summary Delete an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a specific impact for the option.
+     * @summary Get an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
+    /**
+     * Retrieve a paginated list of all impacts for a specific option.
+     * @summary List impacts for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @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}
+     */
+    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
+    /**
+     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactUpdate} impactUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
+};
+/**
+ * ImpactApi - object-oriented interface
+ */
+export declare class ImpactApi extends BaseAPI {
+    /**
+     * Create a new impact under this option.
+     * @summary Create an impact for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactCreate} impactCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
+    /**
+     * Delete an existing impact by its ID.
+     * @summary Delete an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a specific impact for the option.
+     * @summary Get an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all impacts for a specific option.
+     * @summary List impacts for this option
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @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}
+     */
+    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
+    /**
+     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update an impact for this option
+     * @param {string} impactId UUID of the impact
+     * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
+     * @param {ImpactUpdate} impactUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
+}