@emilgroup/partner-sdk-node 1.0.0

package/dist/api/partner-types-api.d.ts

@@ -0,0 +1,394 @@
+/**
+ * EMIL PartnerService
+ * The EMIL PartnerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreatePartnerTypeRequestDto } from '../models';
+import { CreatePartnerTypeResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetPartnerTypeResponseClass } from '../models';
+import { ListPartnerTypesResponseClass } from '../models';
+import { UpdatePartnerTypeRequestDto } from '../models';
+import { UpdatePartnerTypeResponseClass } from '../models';
+/**
+ * PartnerTypesApi - axios parameter creator
+ * @export
+ */
+export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a partner type.
+     * @summary Create the partner-types
+     * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerType: (createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
+     * @summary Delete the partner-types
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerType: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
+     * @summary Retrieve the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerType: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partner-types
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerTypes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerType: (code: string, updatePartnerTypeRequestDto: UpdatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnerTypesApi - functional programming interface
+ * @export
+ */
+export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a partner type.
+     * @summary Create the partner-types
+     * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerType(createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerTypeResponseClass>>;
+    /**
+     * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
+     * @summary Delete the partner-types
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerType(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
+     * @summary Retrieve the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerType(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerTypeResponseClass>>;
+    /**
+     * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partner-types
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>>;
+    /**
+     * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerType(code: string, updatePartnerTypeRequestDto: UpdatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerTypeResponseClass>>;
+};
+/**
+ * PartnerTypesApi - factory interface
+ * @export
+ */
+export declare const PartnerTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a partner type.
+     * @summary Create the partner-types
+     * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerType(createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerTypeResponseClass>;
+    /**
+     * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
+     * @summary Delete the partner-types
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerType(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
+     * @summary Retrieve the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerType(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerTypeResponseClass>;
+    /**
+     * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partner-types
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass>;
+    /**
+     * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner-types
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerType(code: string, updatePartnerTypeRequestDto: UpdatePartnerTypeRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerTypeResponseClass>;
+};
+/**
+ * Request parameters for createPartnerType operation in PartnerTypesApi.
+ * @export
+ * @interface PartnerTypesApiCreatePartnerTypeRequest
+ */
+export interface PartnerTypesApiCreatePartnerTypeRequest {
+    /**
+     *
+     * @type {CreatePartnerTypeRequestDto}
+     * @memberof PartnerTypesApiCreatePartnerType
+     */
+    readonly createPartnerTypeRequestDto: CreatePartnerTypeRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTypesApiCreatePartnerType
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePartnerType operation in PartnerTypesApi.
+ * @export
+ * @interface PartnerTypesApiDeletePartnerTypeRequest
+ */
+export interface PartnerTypesApiDeletePartnerTypeRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerTypesApiDeletePartnerType
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTypesApiDeletePartnerType
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerType operation in PartnerTypesApi.
+ * @export
+ * @interface PartnerTypesApiGetPartnerTypeRequest
+ */
+export interface PartnerTypesApiGetPartnerTypeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerTypesApiGetPartnerType
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTypesApiGetPartnerType
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof PartnerTypesApiGetPartnerType
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for listPartnerTypes operation in PartnerTypesApi.
+ * @export
+ * @interface PartnerTypesApiListPartnerTypesRequest
+ */
+export interface PartnerTypesApiListPartnerTypesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly pageSize?: any;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly filter?: any;
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly search?: any;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly order?: any;
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly expand?: any;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof PartnerTypesApiListPartnerTypes
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updatePartnerType operation in PartnerTypesApi.
+ * @export
+ * @interface PartnerTypesApiUpdatePartnerTypeRequest
+ */
+export interface PartnerTypesApiUpdatePartnerTypeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerTypesApiUpdatePartnerType
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePartnerTypeRequestDto}
+     * @memberof PartnerTypesApiUpdatePartnerType
+     */
+    readonly updatePartnerTypeRequestDto: UpdatePartnerTypeRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTypesApiUpdatePartnerType
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnerTypesApi - object-oriented interface
+ * @export
+ * @class PartnerTypesApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnerTypesApi extends BaseAPI {
+    /**
+     * This will create a partner type.
+     * @summary Create the partner-types
+     * @param {PartnerTypesApiCreatePartnerTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTypesApi
+     */
+    createPartnerType(requestParameters: PartnerTypesApiCreatePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerTypeResponseClass, any>>;
+    /**
+     * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
+     * @summary Delete the partner-types
+     * @param {PartnerTypesApiDeletePartnerTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTypesApi
+     */
+    deletePartnerType(requestParameters: PartnerTypesApiDeletePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
+     * @summary Retrieve the partner-types
+     * @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTypesApi
+     */
+    getPartnerType(requestParameters: PartnerTypesApiGetPartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerTypeResponseClass, any>>;
+    /**
+     * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partner-types
+     * @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTypesApi
+     */
+    listPartnerTypes(requestParameters?: PartnerTypesApiListPartnerTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerTypesResponseClass, any>>;
+    /**
+     * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner-types
+     * @param {PartnerTypesApiUpdatePartnerTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTypesApi
+     */
+    updatePartnerType(requestParameters: PartnerTypesApiUpdatePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerTypeResponseClass, any>>;
+}