@smartbooks-ai/api-client 0.0.3

package/src/apis/ConsolidationApi.ts

@@ -0,0 +1,682 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Smartbooks Restful API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * 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 {
+  ConsolidatedStructureDefinition,
+  ConsolidatedStructureDefinitionVersionPostRequest,
+  ConsolidatedStructureDefinitionVersionResponse,
+  ConsolidatedStructureSegmentsPreview,
+  ConsolidationSettings,
+  ConsolidationSettingsVersionPostRequest,
+  ConsolidationSettingsVersionResponse,
+} from '../models/index';
+import * as runtime from '../runtime';
+
+export interface ConsolidationApiGetLatestSettingsVersionRequest {
+  companyCode: string;
+}
+
+export interface ConsolidationApiGetLatestStructureVersionRequest {
+  companyCode: string;
+}
+
+export interface ConsolidationApiGetSettingsRequest {
+  companyCode: string;
+}
+
+export interface ConsolidationApiGetStructureRequest {
+  companyCode: string;
+}
+
+export interface ConsolidationApiPostSettingsVersionRequest {
+  companyCode: string;
+  consolidationSettingsVersionPostRequest: ConsolidationSettingsVersionPostRequest;
+}
+
+export interface ConsolidationApiPostStructureVersionRequest {
+  companyCode: string;
+  consolidatedStructureDefinitionVersionPostRequest: ConsolidatedStructureDefinitionVersionPostRequest;
+}
+
+export interface ConsolidationApiPreviewSegmentsRequest {
+  companyCode: string;
+  consolidatedStructureDefinition: ConsolidatedStructureDefinition;
+}
+
+export interface ConsolidationApiResetStructureRequest {
+  companyCode: string;
+}
+
+/**
+ * ConsolidationApi - interface
+ *
+ * @export
+ * @interface ConsolidationApiInterface
+ */
+export interface ConsolidationApiInterface {
+  /**
+   *
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  getLatestSettingsVersionRaw(
+    requestParameters: ConsolidationApiGetLatestSettingsVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettingsVersionResponse>>;
+
+  /**
+   */
+  getLatestSettingsVersion(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettingsVersionResponse>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  getLatestStructureVersionRaw(
+    requestParameters: ConsolidationApiGetLatestStructureVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinitionVersionResponse>>;
+
+  /**
+   */
+  getLatestStructureVersion(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinitionVersionResponse>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  getSettingsRaw(
+    requestParameters: ConsolidationApiGetSettingsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettings>>;
+
+  /**
+   */
+  getSettings(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettings>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  getStructureRaw(
+    requestParameters: ConsolidationApiGetStructureRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinition>>;
+
+  /**
+   */
+  getStructure(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinition>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {ConsolidationSettingsVersionPostRequest} consolidationSettingsVersionPostRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  postSettingsVersionRaw(
+    requestParameters: ConsolidationApiPostSettingsVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettingsVersionResponse>>;
+
+  /**
+   */
+  postSettingsVersion(
+    companyCode: string,
+    consolidationSettingsVersionPostRequest: ConsolidationSettingsVersionPostRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettingsVersionResponse>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {ConsolidatedStructureDefinitionVersionPostRequest} consolidatedStructureDefinitionVersionPostRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  postStructureVersionRaw(
+    requestParameters: ConsolidationApiPostStructureVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinitionVersionResponse>>;
+
+  /**
+   */
+  postStructureVersion(
+    companyCode: string,
+    consolidatedStructureDefinitionVersionPostRequest: ConsolidatedStructureDefinitionVersionPostRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinitionVersionResponse>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {ConsolidatedStructureDefinition} consolidatedStructureDefinition
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  previewSegmentsRaw(
+    requestParameters: ConsolidationApiPreviewSegmentsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureSegmentsPreview>>;
+
+  /**
+   */
+  previewSegments(
+    companyCode: string,
+    consolidatedStructureDefinition: ConsolidatedStructureDefinition,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureSegmentsPreview>;
+
+  /**
+   *
+   * @param {string} companyCode
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ConsolidationApiInterface
+   */
+  resetStructureRaw(
+    requestParameters: ConsolidationApiResetStructureRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinition>>;
+
+  /**
+   */
+  resetStructure(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinition>;
+}
+
+/**
+ *
+ */
+export class ConsolidationApi extends runtime.BaseAPI implements ConsolidationApiInterface {
+  /**
+   */
+  async getLatestSettingsVersionRaw(
+    requestParameters: ConsolidationApiGetLatestSettingsVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettingsVersionResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling getLatestSettingsVersion().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/settings/versions/latest`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async getLatestSettingsVersion(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettingsVersionResponse> {
+    const response = await this.getLatestSettingsVersionRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   */
+  async getLatestStructureVersionRaw(
+    requestParameters: ConsolidationApiGetLatestStructureVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinitionVersionResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling getLatestStructureVersion().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/structure/versions/latest`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async getLatestStructureVersion(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinitionVersionResponse> {
+    const response = await this.getLatestStructureVersionRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   */
+  async getSettingsRaw(
+    requestParameters: ConsolidationApiGetSettingsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettings>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling getSettings().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/settings`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async getSettings(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettings> {
+    const response = await this.getSettingsRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   */
+  async getStructureRaw(
+    requestParameters: ConsolidationApiGetStructureRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinition>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling getStructure().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/structure`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async getStructure(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinition> {
+    const response = await this.getStructureRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+
+  /**
+   */
+  async postSettingsVersionRaw(
+    requestParameters: ConsolidationApiPostSettingsVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidationSettingsVersionResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling postSettingsVersion().',
+      );
+    }
+
+    if (requestParameters['consolidationSettingsVersionPostRequest'] == null) {
+      throw new runtime.RequiredError(
+        'consolidationSettingsVersionPostRequest',
+        'Required parameter "consolidationSettingsVersionPostRequest" was null or undefined when calling postSettingsVersion().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/settings/versions`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['consolidationSettingsVersionPostRequest'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async postSettingsVersion(
+    companyCode: string,
+    consolidationSettingsVersionPostRequest: ConsolidationSettingsVersionPostRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidationSettingsVersionResponse> {
+    const response = await this.postSettingsVersionRaw(
+      { companyCode: companyCode, consolidationSettingsVersionPostRequest: consolidationSettingsVersionPostRequest },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   */
+  async postStructureVersionRaw(
+    requestParameters: ConsolidationApiPostStructureVersionRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinitionVersionResponse>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling postStructureVersion().',
+      );
+    }
+
+    if (requestParameters['consolidatedStructureDefinitionVersionPostRequest'] == null) {
+      throw new runtime.RequiredError(
+        'consolidatedStructureDefinitionVersionPostRequest',
+        'Required parameter "consolidatedStructureDefinitionVersionPostRequest" was null or undefined when calling postStructureVersion().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/structure/versions`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['consolidatedStructureDefinitionVersionPostRequest'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async postStructureVersion(
+    companyCode: string,
+    consolidatedStructureDefinitionVersionPostRequest: ConsolidatedStructureDefinitionVersionPostRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinitionVersionResponse> {
+    const response = await this.postStructureVersionRaw(
+      {
+        companyCode: companyCode,
+        consolidatedStructureDefinitionVersionPostRequest: consolidatedStructureDefinitionVersionPostRequest,
+      },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   */
+  async previewSegmentsRaw(
+    requestParameters: ConsolidationApiPreviewSegmentsRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureSegmentsPreview>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling previewSegments().',
+      );
+    }
+
+    if (requestParameters['consolidatedStructureDefinition'] == null) {
+      throw new runtime.RequiredError(
+        'consolidatedStructureDefinition',
+        'Required parameter "consolidatedStructureDefinition" was null or undefined when calling previewSegments().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/structure/preview_segments`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+        body: requestParameters['consolidatedStructureDefinition'],
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async previewSegments(
+    companyCode: string,
+    consolidatedStructureDefinition: ConsolidatedStructureDefinition,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureSegmentsPreview> {
+    const response = await this.previewSegmentsRaw(
+      { companyCode: companyCode, consolidatedStructureDefinition: consolidatedStructureDefinition },
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   */
+  async resetStructureRaw(
+    requestParameters: ConsolidationApiResetStructureRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<ConsolidatedStructureDefinition>> {
+    if (requestParameters['companyCode'] == null) {
+      throw new runtime.RequiredError(
+        'companyCode',
+        'Required parameter "companyCode" was null or undefined when calling resetStructure().',
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('bearerToken', ['internal']);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/api/v1/c/{company_code}/consolidation/structure/reset`.replace(
+          `{${'company_code'}}`,
+          encodeURIComponent(String(requestParameters['companyCode'])),
+        ),
+        method: 'POST',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response);
+  }
+
+  /**
+   */
+  async resetStructure(
+    companyCode: string,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<ConsolidatedStructureDefinition> {
+    const response = await this.resetStructureRaw({ companyCode: companyCode }, initOverrides);
+    return await response.value();
+  }
+}