@datenkraft/bb-organization-structure-api-ts-client/dist/Generated/apis/identity-project-api.d.ts

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

/**
 * 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 { GetIdentityProjectCollectionResponse } from '../models';
import { IdentityProject } from '../models';
/**
 * IdentityProjectApi - axios parameter creator
 * @export
 */
export declare const IdentityProjectApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get a list of Identities and the Projects they are related to
     * @summary Get a list of Identities and the Projects they are related to
     * @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}
     */
    getIdentityProjectCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Post a new Identity to Project relation
     * @summary Post a new Identity to Project relation
     * @param {IdentityProject} identityProject
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentityProject: (identityProject: IdentityProject, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * IdentityProjectApi - functional programming interface
 * @export
 */
export declare const IdentityProjectApiFp: (configuration?: Configuration) => {
    /**
     * Get a list of Identities and the Projects they are related to
     * @summary Get a list of Identities and the Projects they are related to
     * @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}
     */
    getIdentityProjectCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIdentityProjectCollectionResponse>>;
    /**
     * Post a new Identity to Project relation
     * @summary Post a new Identity to Project relation
     * @param {IdentityProject} identityProject
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentityProject(identityProject: IdentityProject, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityProject>>;
};
/**
 * IdentityProjectApi - factory interface
 * @export
 */
export declare const IdentityProjectApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get a list of Identities and the Projects they are related to
     * @summary Get a list of Identities and the Projects they are related to
     * @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}
     */
    getIdentityProjectCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: any): AxiosPromise<GetIdentityProjectCollectionResponse>;
    /**
     * Post a new Identity to Project relation
     * @summary Post a new Identity to Project relation
     * @param {IdentityProject} identityProject
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentityProject(identityProject: IdentityProject, options?: any): AxiosPromise<IdentityProject>;
};
/**
 * IdentityProjectApi - interface
 * @export
 * @interface IdentityProjectApi
 */
export interface IdentityProjectApiInterface {
    /**
     * Get a list of Identities and the Projects they are related to
     * @summary Get a list of Identities and the Projects they are related to
     * @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 IdentityProjectApiInterface
     */
    getIdentityProjectCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): AxiosPromise<GetIdentityProjectCollectionResponse>;
    /**
     * Post a new Identity to Project relation
     * @summary Post a new Identity to Project relation
     * @param {IdentityProject} identityProject
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityProjectApiInterface
     */
    postIdentityProject(identityProject: IdentityProject, options?: AxiosRequestConfig): AxiosPromise<IdentityProject>;
}
/**
 * IdentityProjectApi - object-oriented interface
 * @export
 * @class IdentityProjectApi
 * @extends {BaseAPI}
 */
export declare class IdentityProjectApi extends BaseAPI implements IdentityProjectApiInterface {
    /**
     * Get a list of Identities and the Projects they are related to
     * @summary Get a list of Identities and the Projects they are related to
     * @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 IdentityProjectApi
     */
    getIdentityProjectCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIdentityProjectCollectionResponse, any>>;
    /**
     * Post a new Identity to Project relation
     * @summary Post a new Identity to Project relation
     * @param {IdentityProject} identityProject
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityProjectApi
     */
    postIdentityProject(identityProject: IdentityProject, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProject, any>>;
}