@datenkraft/bb-organization-structure-api-ts-client
Version:
The organization-structure API TS Client enables you to work with the organization-structure API
101 lines (100 loc) • 6.44 kB
TypeScript
/**
* 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 { GetAuthPermissionCollectionResponse } from '../models';
/**
* AuthPermissionApi - axios parameter creator
* @export
*/
export declare const AuthPermissionApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get all permissions from this resource server
* @summary Get all permissions from this resource server
* @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}
*/
getAuthPermissionCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* AuthPermissionApi - functional programming interface
* @export
*/
export declare const AuthPermissionApiFp: (configuration?: Configuration) => {
/**
* Get all permissions from this resource server
* @summary Get all permissions from this resource server
* @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}
*/
getAuthPermissionCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthPermissionCollectionResponse>>;
};
/**
* AuthPermissionApi - factory interface
* @export
*/
export declare const AuthPermissionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get all permissions from this resource server
* @summary Get all permissions from this resource server
* @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}
*/
getAuthPermissionCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: any): AxiosPromise<GetAuthPermissionCollectionResponse>;
};
/**
* AuthPermissionApi - interface
* @export
* @interface AuthPermissionApi
*/
export interface AuthPermissionApiInterface {
/**
* Get all permissions from this resource server
* @summary Get all permissions from this resource server
* @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 AuthPermissionApiInterface
*/
getAuthPermissionCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): AxiosPromise<GetAuthPermissionCollectionResponse>;
}
/**
* AuthPermissionApi - object-oriented interface
* @export
* @class AuthPermissionApi
* @extends {BaseAPI}
*/
export declare class AuthPermissionApi extends BaseAPI implements AuthPermissionApiInterface {
/**
* Get all permissions from this resource server
* @summary Get all permissions from this resource server
* @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 AuthPermissionApi
*/
getAuthPermissionCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthPermissionCollectionResponse, any>>;
}