@smartbooks-ai/api-client 0.0.5 → 0.0.7

package/src/src/apis/StructureDefinitionApi.ts

@@ -1,601 +0,0 @@
-/* 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 {
-  DefaultStructure,
-  ReportingPeriodChangeRequest,
-  ReportingStructureSegments,
-  StructureDefinition,
-  StructureDefinitionVersionPostRequest,
-  StructureDefinitionVersionResponse,
-  TriggeredOperation,
-} from '../models/index';
-import * as runtime from '../runtime';
-
-export interface StructureDefinitionApiChangeReportingPeriodSynchronouslyRequest {
-  companyCode: string;
-  reportingPeriodChangeRequest: ReportingPeriodChangeRequest;
-}
-
-export interface StructureDefinitionApiGetRequest {
-  companyCode: string;
-}
-
-export interface StructureDefinitionApiGetLatestVersionRequest {
-  companyCode: string;
-  experimental?: string | null;
-}
-
-export interface StructureDefinitionApiGetReportingStructureRequest {
-  companyCode: string;
-  structureCode: string;
-  reportingStructureType: string;
-  experimental?: string | null;
-}
-
-export interface StructureDefinitionApiPostVersionRequest {
-  companyCode: string;
-  structureDefinitionVersionPostRequest: StructureDefinitionVersionPostRequest;
-}
-
-export interface StructureDefinitionApiPreviewSegmentsRequest {
-  companyCode: string;
-  structureDefinition: StructureDefinition;
-  applyChanges?: boolean | null;
-  experimental?: string | null;
-}
-
-/**
- * StructureDefinitionApi - interface
- *
- * @export
- * @interface StructureDefinitionApiInterface
- */
-export interface StructureDefinitionApiInterface {
-  /**
-   *
-   * @param {string} companyCode
-   * @param {ReportingPeriodChangeRequest} reportingPeriodChangeRequest
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  changeReportingPeriodSynchronouslyRaw(
-    requestParameters: StructureDefinitionApiChangeReportingPeriodSynchronouslyRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<TriggeredOperation>>;
-
-  /**
-   */
-  changeReportingPeriodSynchronously(
-    companyCode: string,
-    reportingPeriodChangeRequest: ReportingPeriodChangeRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<TriggeredOperation>;
-
-  /**
-   *
-   * @param {string} companyCode
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  getRaw(
-    requestParameters: StructureDefinitionApiGetRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<StructureDefinition>>;
-
-  /**
-   */
-  get(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StructureDefinition>;
-
-  /**
-   *
-   * @param {string} companyCode
-   * @param {string} [experimental]
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  getLatestVersionRaw(
-    requestParameters: StructureDefinitionApiGetLatestVersionRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<StructureDefinitionVersionResponse>>;
-
-  /**
-   */
-  getLatestVersion(
-    companyCode: string,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<StructureDefinitionVersionResponse>;
-
-  /**
-   *
-   * @param {string} companyCode
-   * @param {string} structureCode
-   * @param {string} reportingStructureType
-   * @param {string} [experimental]
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  getReportingStructureRaw(
-    requestParameters: StructureDefinitionApiGetReportingStructureRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<DefaultStructure>>;
-
-  /**
-   */
-  getReportingStructure(
-    companyCode: string,
-    structureCode: string,
-    reportingStructureType: string,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<DefaultStructure>;
-
-  /**
-   *
-   * @param {string} companyCode
-   * @param {StructureDefinitionVersionPostRequest} structureDefinitionVersionPostRequest
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  postVersionRaw(
-    requestParameters: StructureDefinitionApiPostVersionRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<TriggeredOperation>>;
-
-  /**
-   */
-  postVersion(
-    companyCode: string,
-    structureDefinitionVersionPostRequest: StructureDefinitionVersionPostRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<TriggeredOperation>;
-
-  /**
-   *
-   * @param {string} companyCode
-   * @param {StructureDefinition} structureDefinition
-   * @param {boolean} [applyChanges]
-   * @param {string} [experimental]
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof StructureDefinitionApiInterface
-   */
-  previewSegmentsRaw(
-    requestParameters: StructureDefinitionApiPreviewSegmentsRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<ReportingStructureSegments>>;
-
-  /**
-   */
-  previewSegments(
-    companyCode: string,
-    structureDefinition: StructureDefinition,
-    applyChanges?: boolean | null,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<ReportingStructureSegments>;
-}
-
-/**
- *
- */
-export class StructureDefinitionApi extends runtime.BaseAPI implements StructureDefinitionApiInterface {
-  /**
-   */
-  async changeReportingPeriodSynchronouslyRaw(
-    requestParameters: StructureDefinitionApiChangeReportingPeriodSynchronouslyRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<TriggeredOperation>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling changeReportingPeriodSynchronously().',
-      );
-    }
-
-    if (requestParameters['reportingPeriodChangeRequest'] == null) {
-      throw new runtime.RequiredError(
-        'reportingPeriodChangeRequest',
-        'Required parameter "reportingPeriodChangeRequest" was null or undefined when calling changeReportingPeriodSynchronously().',
-      );
-    }
-
-    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}/structuredefinition/reporting-period/change/sync`.replace(
-          `{${'company_code'}}`,
-          encodeURIComponent(String(requestParameters['companyCode'])),
-        ),
-        method: 'POST',
-        headers: headerParameters,
-        query: queryParameters,
-        body: requestParameters['reportingPeriodChangeRequest'],
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async changeReportingPeriodSynchronously(
-    companyCode: string,
-    reportingPeriodChangeRequest: ReportingPeriodChangeRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<TriggeredOperation> {
-    const response = await this.changeReportingPeriodSynchronouslyRaw(
-      { companyCode: companyCode, reportingPeriodChangeRequest: reportingPeriodChangeRequest },
-      initOverrides,
-    );
-    return await response.value();
-  }
-
-  /**
-   */
-  async getRaw(
-    requestParameters: StructureDefinitionApiGetRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<StructureDefinition>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling get().',
-      );
-    }
-
-    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}/structuredefinition`.replace(
-          `{${'company_code'}}`,
-          encodeURIComponent(String(requestParameters['companyCode'])),
-        ),
-        method: 'GET',
-        headers: headerParameters,
-        query: queryParameters,
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async get(
-    companyCode: string,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<StructureDefinition> {
-    const response = await this.getRaw({ companyCode: companyCode }, initOverrides);
-    return await response.value();
-  }
-
-  /**
-   */
-  async getLatestVersionRaw(
-    requestParameters: StructureDefinitionApiGetLatestVersionRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<StructureDefinitionVersionResponse>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling getLatestVersion().',
-      );
-    }
-
-    const queryParameters: any = {};
-
-    if (requestParameters['experimental'] != null) {
-      queryParameters['experimental'] = requestParameters['experimental'];
-    }
-
-    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}/structuredefinition/versions/latest`.replace(
-          `{${'company_code'}}`,
-          encodeURIComponent(String(requestParameters['companyCode'])),
-        ),
-        method: 'GET',
-        headers: headerParameters,
-        query: queryParameters,
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async getLatestVersion(
-    companyCode: string,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<StructureDefinitionVersionResponse> {
-    const response = await this.getLatestVersionRaw(
-      { companyCode: companyCode, experimental: experimental },
-      initOverrides,
-    );
-    return await response.value();
-  }
-
-  /**
-   */
-  async getReportingStructureRaw(
-    requestParameters: StructureDefinitionApiGetReportingStructureRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<DefaultStructure>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling getReportingStructure().',
-      );
-    }
-
-    if (requestParameters['structureCode'] == null) {
-      throw new runtime.RequiredError(
-        'structureCode',
-        'Required parameter "structureCode" was null or undefined when calling getReportingStructure().',
-      );
-    }
-
-    if (requestParameters['reportingStructureType'] == null) {
-      throw new runtime.RequiredError(
-        'reportingStructureType',
-        'Required parameter "reportingStructureType" was null or undefined when calling getReportingStructure().',
-      );
-    }
-
-    const queryParameters: any = {};
-
-    if (requestParameters['experimental'] != null) {
-      queryParameters['experimental'] = requestParameters['experimental'];
-    }
-
-    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}/structuredefinition/{structure_code}/reporting_structure/{reporting_structure_type}`
-          .replace(`{${'company_code'}}`, encodeURIComponent(String(requestParameters['companyCode'])))
-          .replace(`{${'structure_code'}}`, encodeURIComponent(String(requestParameters['structureCode'])))
-          .replace(
-            `{${'reporting_structure_type'}}`,
-            encodeURIComponent(String(requestParameters['reportingStructureType'])),
-          ),
-        method: 'GET',
-        headers: headerParameters,
-        query: queryParameters,
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async getReportingStructure(
-    companyCode: string,
-    structureCode: string,
-    reportingStructureType: string,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<DefaultStructure> {
-    const response = await this.getReportingStructureRaw(
-      {
-        companyCode: companyCode,
-        structureCode: structureCode,
-        reportingStructureType: reportingStructureType,
-        experimental: experimental,
-      },
-      initOverrides,
-    );
-    return await response.value();
-  }
-
-  /**
-   */
-  async postVersionRaw(
-    requestParameters: StructureDefinitionApiPostVersionRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<TriggeredOperation>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling postVersion().',
-      );
-    }
-
-    if (requestParameters['structureDefinitionVersionPostRequest'] == null) {
-      throw new runtime.RequiredError(
-        'structureDefinitionVersionPostRequest',
-        'Required parameter "structureDefinitionVersionPostRequest" was null or undefined when calling postVersion().',
-      );
-    }
-
-    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}/structuredefinition/versions`.replace(
-          `{${'company_code'}}`,
-          encodeURIComponent(String(requestParameters['companyCode'])),
-        ),
-        method: 'POST',
-        headers: headerParameters,
-        query: queryParameters,
-        body: requestParameters['structureDefinitionVersionPostRequest'],
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async postVersion(
-    companyCode: string,
-    structureDefinitionVersionPostRequest: StructureDefinitionVersionPostRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<TriggeredOperation> {
-    const response = await this.postVersionRaw(
-      { companyCode: companyCode, structureDefinitionVersionPostRequest: structureDefinitionVersionPostRequest },
-      initOverrides,
-    );
-    return await response.value();
-  }
-
-  /**
-   */
-  async previewSegmentsRaw(
-    requestParameters: StructureDefinitionApiPreviewSegmentsRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<ReportingStructureSegments>> {
-    if (requestParameters['companyCode'] == null) {
-      throw new runtime.RequiredError(
-        'companyCode',
-        'Required parameter "companyCode" was null or undefined when calling previewSegments().',
-      );
-    }
-
-    if (requestParameters['structureDefinition'] == null) {
-      throw new runtime.RequiredError(
-        'structureDefinition',
-        'Required parameter "structureDefinition" was null or undefined when calling previewSegments().',
-      );
-    }
-
-    const queryParameters: any = {};
-
-    if (requestParameters['applyChanges'] != null) {
-      queryParameters['apply_changes'] = requestParameters['applyChanges'];
-    }
-
-    if (requestParameters['experimental'] != null) {
-      queryParameters['experimental'] = requestParameters['experimental'];
-    }
-
-    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}/structuredefinition/preview_segments`.replace(
-          `{${'company_code'}}`,
-          encodeURIComponent(String(requestParameters['companyCode'])),
-        ),
-        method: 'POST',
-        headers: headerParameters,
-        query: queryParameters,
-        body: requestParameters['structureDefinition'],
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response);
-  }
-
-  /**
-   */
-  async previewSegments(
-    companyCode: string,
-    structureDefinition: StructureDefinition,
-    applyChanges?: boolean | null,
-    experimental?: string | null,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<ReportingStructureSegments> {
-    const response = await this.previewSegmentsRaw(
-      {
-        companyCode: companyCode,
-        structureDefinition: structureDefinition,
-        applyChanges: applyChanges,
-        experimental: experimental,
-      },
-      initOverrides,
-    );
-    return await response.value();
-  }
-}