/** * 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'; /** * DocsApi - axios parameter creator * @export */ export declare const DocsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get the changelog in the specified format * @summary Get the changelog in the specified format * @param {'md' | 'html'} format Changelog file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChangelogInFormat: (format: 'md' | 'html', options?: AxiosRequestConfig) => Promise; /** * Get the openapi documentation as json * @summary Get the openapi documentation as json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApi: (options?: AxiosRequestConfig) => Promise; /** * Get the openapi documentation in the specified format * @summary Get the openapi documentation in the specified format * @param {'yaml' | 'json'} format Openapi file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApiInFormat: (format: 'yaml' | 'json', options?: AxiosRequestConfig) => Promise; }; /** * DocsApi - functional programming interface * @export */ export declare const DocsApiFp: (configuration?: Configuration) => { /** * Get the changelog in the specified format * @summary Get the changelog in the specified format * @param {'md' | 'html'} format Changelog file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChangelogInFormat(format: 'md' | 'html', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the openapi documentation as json * @summary Get the openapi documentation as json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApi(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the openapi documentation in the specified format * @summary Get the openapi documentation in the specified format * @param {'yaml' | 'json'} format Openapi file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApiInFormat(format: 'yaml' | 'json', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DocsApi - factory interface * @export */ export declare const DocsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get the changelog in the specified format * @summary Get the changelog in the specified format * @param {'md' | 'html'} format Changelog file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChangelogInFormat(format: 'md' | 'html', options?: any): AxiosPromise; /** * Get the openapi documentation as json * @summary Get the openapi documentation as json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApi(options?: any): AxiosPromise; /** * Get the openapi documentation in the specified format * @summary Get the openapi documentation in the specified format * @param {'yaml' | 'json'} format Openapi file format * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenApiInFormat(format: 'yaml' | 'json', options?: any): AxiosPromise; }; /** * DocsApi - interface * @export * @interface DocsApi */ export interface DocsApiInterface { /** * Get the changelog in the specified format * @summary Get the changelog in the specified format * @param {'md' | 'html'} format Changelog file format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApiInterface */ getChangelogInFormat(format: 'md' | 'html', options?: AxiosRequestConfig): AxiosPromise; /** * Get the openapi documentation as json * @summary Get the openapi documentation as json * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApiInterface */ getOpenApi(options?: AxiosRequestConfig): AxiosPromise; /** * Get the openapi documentation in the specified format * @summary Get the openapi documentation in the specified format * @param {'yaml' | 'json'} format Openapi file format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApiInterface */ getOpenApiInFormat(format: 'yaml' | 'json', options?: AxiosRequestConfig): AxiosPromise; } /** * DocsApi - object-oriented interface * @export * @class DocsApi * @extends {BaseAPI} */ export declare class DocsApi extends BaseAPI implements DocsApiInterface { /** * Get the changelog in the specified format * @summary Get the changelog in the specified format * @param {'md' | 'html'} format Changelog file format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApi */ getChangelogInFormat(format: 'md' | 'html', options?: AxiosRequestConfig): Promise>; /** * Get the openapi documentation as json * @summary Get the openapi documentation as json * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApi */ getOpenApi(options?: AxiosRequestConfig): Promise>; /** * Get the openapi documentation in the specified format * @summary Get the openapi documentation in the specified format * @param {'yaml' | 'json'} format Openapi file format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocsApi */ getOpenApiInFormat(format: 'yaml' | 'json', options?: AxiosRequestConfig): Promise>; }