@datenkraft/bb-organization-structure-api-ts-client/dist/Generated/apis/identity-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 { GetIdentityCollectionResponse } from '../models';
import { Identity } from '../models';
import { NewIdentity } from '../models';
import { PatchIdentity } from '../models';
/**
 * IdentityApi - axios parameter creator
 * @export
 */
export declare const IdentityApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get an Identity by identityId
     * @summary Get an Identity by identityId
     * @param {string} identityId Identity Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentity: (identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get a list of Identities
     * @summary Get a list of Identities
     * @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 {string} [filterEmail] Email filter
     * @param {boolean} [filterIsActive] A filter to only return identities that are active or not.
     * @param {string} [filterProjectId] A filter to only return identities assigned to a specific project.
     * @param {string} [filterSearch] A filter to search for identities.  Usage: - Provide a search term to filter results. - The search term filters the response for identities where the email contains the search term. - The search is not case sensitive.
     * @param {'external' | 'internal'} [filterOrigin] A filter to only return identities that are of the given origin.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentityCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterEmail?: string, filterIsActive?: boolean, filterProjectId?: string, filterSearch?: string, filterOrigin?: 'external' | 'internal', options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Update one or more fields of an Identity
     * @summary Update an Identity
     * @param {string} identityId Identity Id
     * @param {PatchIdentity} patchIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchIdentity: (identityId: string, patchIdentity: PatchIdentity, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Post a new Identity
     * @summary Post a new Identity
     * @param {NewIdentity} newIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentity: (newIdentity: NewIdentity, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * IdentityApi - functional programming interface
 * @export
 */
export declare const IdentityApiFp: (configuration?: Configuration) => {
    /**
     * Get an Identity by identityId
     * @summary Get an Identity by identityId
     * @param {string} identityId Identity Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentity(identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identity>>;
    /**
     * Get a list of Identities
     * @summary Get a list of Identities
     * @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 {string} [filterEmail] Email filter
     * @param {boolean} [filterIsActive] A filter to only return identities that are active or not.
     * @param {string} [filterProjectId] A filter to only return identities assigned to a specific project.
     * @param {string} [filterSearch] A filter to search for identities.  Usage: - Provide a search term to filter results. - The search term filters the response for identities where the email contains the search term. - The search is not case sensitive.
     * @param {'external' | 'internal'} [filterOrigin] A filter to only return identities that are of the given origin.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentityCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterEmail?: string, filterIsActive?: boolean, filterProjectId?: string, filterSearch?: string, filterOrigin?: 'external' | 'internal', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIdentityCollectionResponse>>;
    /**
     * Update one or more fields of an Identity
     * @summary Update an Identity
     * @param {string} identityId Identity Id
     * @param {PatchIdentity} patchIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchIdentity(identityId: string, patchIdentity: PatchIdentity, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identity>>;
    /**
     * Post a new Identity
     * @summary Post a new Identity
     * @param {NewIdentity} newIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentity(newIdentity: NewIdentity, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identity>>;
};
/**
 * IdentityApi - factory interface
 * @export
 */
export declare const IdentityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get an Identity by identityId
     * @summary Get an Identity by identityId
     * @param {string} identityId Identity Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentity(identityId: string, options?: any): AxiosPromise<Identity>;
    /**
     * Get a list of Identities
     * @summary Get a list of Identities
     * @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 {string} [filterEmail] Email filter
     * @param {boolean} [filterIsActive] A filter to only return identities that are active or not.
     * @param {string} [filterProjectId] A filter to only return identities assigned to a specific project.
     * @param {string} [filterSearch] A filter to search for identities.  Usage: - Provide a search term to filter results. - The search term filters the response for identities where the email contains the search term. - The search is not case sensitive.
     * @param {'external' | 'internal'} [filterOrigin] A filter to only return identities that are of the given origin.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIdentityCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterEmail?: string, filterIsActive?: boolean, filterProjectId?: string, filterSearch?: string, filterOrigin?: 'external' | 'internal', options?: any): AxiosPromise<GetIdentityCollectionResponse>;
    /**
     * Update one or more fields of an Identity
     * @summary Update an Identity
     * @param {string} identityId Identity Id
     * @param {PatchIdentity} patchIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchIdentity(identityId: string, patchIdentity: PatchIdentity, options?: any): AxiosPromise<Identity>;
    /**
     * Post a new Identity
     * @summary Post a new Identity
     * @param {NewIdentity} newIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postIdentity(newIdentity: NewIdentity, options?: any): AxiosPromise<Identity>;
};
/**
 * IdentityApi - interface
 * @export
 * @interface IdentityApi
 */
export interface IdentityApiInterface {
    /**
     * Get an Identity by identityId
     * @summary Get an Identity by identityId
     * @param {string} identityId Identity Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApiInterface
     */
    getIdentity(identityId: string, options?: AxiosRequestConfig): AxiosPromise<Identity>;
    /**
     * Get a list of Identities
     * @summary Get a list of Identities
     * @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 {string} [filterEmail] Email filter
     * @param {boolean} [filterIsActive] A filter to only return identities that are active or not.
     * @param {string} [filterProjectId] A filter to only return identities assigned to a specific project.
     * @param {string} [filterSearch] A filter to search for identities.  Usage: - Provide a search term to filter results. - The search term filters the response for identities where the email contains the search term. - The search is not case sensitive.
     * @param {'external' | 'internal'} [filterOrigin] A filter to only return identities that are of the given origin.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApiInterface
     */
    getIdentityCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterEmail?: string, filterIsActive?: boolean, filterProjectId?: string, filterSearch?: string, filterOrigin?: 'external' | 'internal', options?: AxiosRequestConfig): AxiosPromise<GetIdentityCollectionResponse>;
    /**
     * Update one or more fields of an Identity
     * @summary Update an Identity
     * @param {string} identityId Identity Id
     * @param {PatchIdentity} patchIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApiInterface
     */
    patchIdentity(identityId: string, patchIdentity: PatchIdentity, options?: AxiosRequestConfig): AxiosPromise<Identity>;
    /**
     * Post a new Identity
     * @summary Post a new Identity
     * @param {NewIdentity} newIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApiInterface
     */
    postIdentity(newIdentity: NewIdentity, options?: AxiosRequestConfig): AxiosPromise<Identity>;
}
/**
 * IdentityApi - object-oriented interface
 * @export
 * @class IdentityApi
 * @extends {BaseAPI}
 */
export declare class IdentityApi extends BaseAPI implements IdentityApiInterface {
    /**
     * Get an Identity by identityId
     * @summary Get an Identity by identityId
     * @param {string} identityId Identity Id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApi
     */
    getIdentity(identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Identity, any>>;
    /**
     * Get a list of Identities
     * @summary Get a list of Identities
     * @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 {string} [filterEmail] Email filter
     * @param {boolean} [filterIsActive] A filter to only return identities that are active or not.
     * @param {string} [filterProjectId] A filter to only return identities assigned to a specific project.
     * @param {string} [filterSearch] A filter to search for identities.  Usage: - Provide a search term to filter results. - The search term filters the response for identities where the email contains the search term. - The search is not case sensitive.
     * @param {'external' | 'internal'} [filterOrigin] A filter to only return identities that are of the given origin.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApi
     */
    getIdentityCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterEmail?: string, filterIsActive?: boolean, filterProjectId?: string, filterSearch?: string, filterOrigin?: 'external' | 'internal', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIdentityCollectionResponse, any>>;
    /**
     * Update one or more fields of an Identity
     * @summary Update an Identity
     * @param {string} identityId Identity Id
     * @param {PatchIdentity} patchIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApi
     */
    patchIdentity(identityId: string, patchIdentity: PatchIdentity, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Identity, any>>;
    /**
     * Post a new Identity
     * @summary Post a new Identity
     * @param {NewIdentity} newIdentity
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityApi
     */
    postIdentity(newIdentity: NewIdentity, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Identity, any>>;
}