UNPKG

@datenkraft/bb-organization-structure-api-ts-client

Version:

The organization-structure API TS Client enables you to work with the organization-structure API

250 lines (249 loc) 13 kB
/** * Backbone Organization Structure API * - alpha: Currently developed API version. Subject to major changes. - beta: A semi-stable early access version. New features can be added. Breaking changes are possible. - stable: The API is recommended for use in production. [Changelog](https://organization-structure-api.steve.niceshops.com/v2/docs/changelog.html) All data is transferred in UTF-8 encoding.\\ The API uses stateless HTTP. No cookies have to be kept.\\ Authentication via OAuth2 client credentials flow. [Privacy Policy](https://www.niceshops.com/en/dienstleistungen/data-privacy-policy) [Backbone Organization Structure API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-organization-structure-api-php-client) * * The version of the OpenAPI document: v2.beta * * * 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, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { NewProjectSku } from '../models'; import { Project } from '../models'; import { ProjectSku } from '../models'; import { ProjectSkuCollection } from '../models'; /** * ProjectSkuApi - axios parameter creator * @export */ export declare const ProjectSkuApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a ProjectSku relation * @summary Delete ProjectSku relation * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProjectSku: (projectId: string, skuCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Get ProjectSku relation entity. * @summary Get ProjectSku relation entity. * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSku: (projectId: string, skuCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Get ProjectSku relations for a Project. * @summary Get ProjectSku relations for a Project. * @param {string} projectId Project Id * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSkuCollection: (projectId: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Post new ProjectSku relations * @summary Post new ProjectSku relations * @param {string} projectId Project Id * @param {Array<NewProjectSku>} newProjectSku * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProjectSkuCollection: (projectId: string, newProjectSku: Array<NewProjectSku>, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * ProjectSkuApi - functional programming interface * @export */ export declare const ProjectSkuApiFp: (configuration?: Configuration) => { /** * Delete a ProjectSku relation * @summary Delete ProjectSku relation * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * Get ProjectSku relation entity. * @summary Get ProjectSku relation entity. * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectSku>>; /** * Get ProjectSku relations for a Project. * @summary Get ProjectSku relations for a Project. * @param {string} projectId Project Id * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSkuCollection(projectId: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectSkuCollection>>; /** * Post new ProjectSku relations * @summary Post new ProjectSku relations * @param {string} projectId Project Id * @param {Array<NewProjectSku>} newProjectSku * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProjectSkuCollection(projectId: string, newProjectSku: Array<NewProjectSku>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>; }; /** * ProjectSkuApi - factory interface * @export */ export declare const ProjectSkuApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a ProjectSku relation * @summary Delete ProjectSku relation * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProjectSku(projectId: string, skuCode: string, options?: any): AxiosPromise<void>; /** * Get ProjectSku relation entity. * @summary Get ProjectSku relation entity. * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSku(projectId: string, skuCode: string, options?: any): AxiosPromise<ProjectSku>; /** * Get ProjectSku relations for a Project. * @summary Get ProjectSku relations for a Project. * @param {string} projectId Project Id * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectSkuCollection(projectId: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: any): AxiosPromise<ProjectSkuCollection>; /** * Post new ProjectSku relations * @summary Post new ProjectSku relations * @param {string} projectId Project Id * @param {Array<NewProjectSku>} newProjectSku * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProjectSkuCollection(projectId: string, newProjectSku: Array<NewProjectSku>, options?: any): AxiosPromise<Project>; }; /** * ProjectSkuApi - interface * @export * @interface ProjectSkuApi */ export interface ProjectSkuApiInterface { /** * Delete a ProjectSku relation * @summary Delete ProjectSku relation * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApiInterface */ deleteProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): AxiosPromise<void>; /** * Get ProjectSku relation entity. * @summary Get ProjectSku relation entity. * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApiInterface */ getProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): AxiosPromise<ProjectSku>; /** * Get ProjectSku relations for a Project. * @summary Get ProjectSku relations for a Project. * @param {string} projectId Project Id * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApiInterface */ getProjectSkuCollection(projectId: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): AxiosPromise<ProjectSkuCollection>; /** * Post new ProjectSku relations * @summary Post new ProjectSku relations * @param {string} projectId Project Id * @param {Array<NewProjectSku>} newProjectSku * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApiInterface */ postProjectSkuCollection(projectId: string, newProjectSku: Array<NewProjectSku>, options?: AxiosRequestConfig): AxiosPromise<Project>; } /** * ProjectSkuApi - object-oriented interface * @export * @class ProjectSkuApi * @extends {BaseAPI} */ export declare class ProjectSkuApi extends BaseAPI implements ProjectSkuApiInterface { /** * Delete a ProjectSku relation * @summary Delete ProjectSku relation * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApi */ deleteProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * Get ProjectSku relation entity. * @summary Get ProjectSku relation entity. * @param {string} projectId Project Id * @param {string} skuCode Sku Code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApi */ getProjectSku(projectId: string, skuCode: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectSku, any>>; /** * Get ProjectSku relations for a Project. * @summary Get ProjectSku relations for a Project. * @param {string} projectId Project Id * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApi */ getProjectSkuCollection(projectId: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectSkuCollection, any>>; /** * Post new ProjectSku relations * @summary Post new ProjectSku relations * @param {string} projectId Project Id * @param {Array<NewProjectSku>} newProjectSku * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectSkuApi */ postProjectSkuCollection(projectId: string, newProjectSku: Array<NewProjectSku>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>; }