@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/auth-role-api.d.ts

The fulfillment API TS Client enables you to work with the fulfillment API

/**
 * Fulfillment 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://fulfillment-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)  [Fulfillment API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-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 { AuthRoleCollection } from '../models';
import { AuthRoleResource } from '../models';
import { NewAuthRoleResource } from '../models';
/**
 * AuthRoleApi - axios parameter creator
 * @export
 */
export declare const AuthRoleApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Delete a role for this resource server
     * @summary Delete a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAuthRole: (roleCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get a role from this resource server by its roleCode
     * @summary Get a role from this resource server by its roleCode
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthRole: (roleCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get all available roles from this resource server
     * @summary Get all available roles 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}
     */
    getAuthRoleCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Patch a role for this resource server
     * @summary Patch a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchAuthRole: (roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Post a role for this resource server
     * @summary Post a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postAuthRole: (roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AuthRoleApi - functional programming interface
 * @export
 */
export declare const AuthRoleApiFp: (configuration?: Configuration) => {
    /**
     * Delete a role for this resource server
     * @summary Delete a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAuthRole(roleCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Get a role from this resource server by its roleCode
     * @summary Get a role from this resource server by its roleCode
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthRole(roleCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthRoleResource>>;
    /**
     * Get all available roles from this resource server
     * @summary Get all available roles 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}
     */
    getAuthRoleCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthRoleCollection>>;
    /**
     * Patch a role for this resource server
     * @summary Patch a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthRoleResource>>;
    /**
     * Post a role for this resource server
     * @summary Post a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthRoleResource>>;
};
/**
 * AuthRoleApi - factory interface
 * @export
 */
export declare const AuthRoleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Delete a role for this resource server
     * @summary Delete a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAuthRole(roleCode: string, options?: any): AxiosPromise<void>;
    /**
     * Get a role from this resource server by its roleCode
     * @summary Get a role from this resource server by its roleCode
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthRole(roleCode: string, options?: any): AxiosPromise<AuthRoleResource>;
    /**
     * Get all available roles from this resource server
     * @summary Get all available roles 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}
     */
    getAuthRoleCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: any): AxiosPromise<AuthRoleCollection>;
    /**
     * Patch a role for this resource server
     * @summary Patch a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: any): AxiosPromise<AuthRoleResource>;
    /**
     * Post a role for this resource server
     * @summary Post a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: any): AxiosPromise<AuthRoleResource>;
};
/**
 * AuthRoleApi - interface
 * @export
 * @interface AuthRoleApi
 */
export interface AuthRoleApiInterface {
    /**
     * Delete a role for this resource server
     * @summary Delete a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApiInterface
     */
    deleteAuthRole(roleCode: string, options?: AxiosRequestConfig): AxiosPromise<void>;
    /**
     * Get a role from this resource server by its roleCode
     * @summary Get a role from this resource server by its roleCode
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApiInterface
     */
    getAuthRole(roleCode: string, options?: AxiosRequestConfig): AxiosPromise<AuthRoleResource>;
    /**
     * Get all available roles from this resource server
     * @summary Get all available roles 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 AuthRoleApiInterface
     */
    getAuthRoleCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): AxiosPromise<AuthRoleCollection>;
    /**
     * Patch a role for this resource server
     * @summary Patch a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApiInterface
     */
    patchAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): AxiosPromise<AuthRoleResource>;
    /**
     * Post a role for this resource server
     * @summary Post a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApiInterface
     */
    postAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): AxiosPromise<AuthRoleResource>;
}
/**
 * AuthRoleApi - object-oriented interface
 * @export
 * @class AuthRoleApi
 * @extends {BaseAPI}
 */
export declare class AuthRoleApi extends BaseAPI implements AuthRoleApiInterface {
    /**
     * Delete a role for this resource server
     * @summary Delete a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApi
     */
    deleteAuthRole(roleCode: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * Get a role from this resource server by its roleCode
     * @summary Get a role from this resource server by its roleCode
     * @param {string} roleCode Identifier for the role
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApi
     */
    getAuthRole(roleCode: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthRoleResource, any>>;
    /**
     * Get all available roles from this resource server
     * @summary Get all available roles 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 AuthRoleApi
     */
    getAuthRoleCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthRoleCollection, any>>;
    /**
     * Patch a role for this resource server
     * @summary Patch a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApi
     */
    patchAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthRoleResource, any>>;
    /**
     * Post a role for this resource server
     * @summary Post a role for this resource server
     * @param {string} roleCode Identifier for the role
     * @param {NewAuthRoleResource} newAuthRoleResource
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthRoleApi
     */
    postAuthRole(roleCode: string, newAuthRoleResource: NewAuthRoleResource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthRoleResource, any>>;
}