@emilgroup/partner-sdk-node 1.0.0

package/dist/api/partners-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 { CreatePartnerRequestDto } from '../models';
+import { CreatePartnerResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetPartnerResponseClass } from '../models';
+import { ListPartnersResponseClass } from '../models';
+import { UpdatePartnerRequestDto } from '../models';
+import { UpdatePartnerResponseClass } from '../models';
+/**
+ * PartnersApi - axios parameter creator
+ * @export
+ */
+export declare const PartnersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a partner.
+     * @summary Create the partner
+     * @param {CreatePartnerRequestDto} createPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartner: (createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
+     * @summary Delete the partner
+     * @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}
+     */
+    deletePartner: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+     * @summary Retrieve the partner
+     * @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}
+     */
+    getPartner: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partners
+     * @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}
+     */
+    listPartners: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRequestDto} updatePartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartner: (code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnersApi - functional programming interface
+ * @export
+ */
+export declare const PartnersApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a partner.
+     * @summary Create the partner
+     * @param {CreatePartnerRequestDto} createPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartner(createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerResponseClass>>;
+    /**
+     * Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
+     * @summary Delete the partner
+     * @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}
+     */
+    deletePartner(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+     * @summary Retrieve the partner
+     * @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}
+     */
+    getPartner(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerResponseClass>>;
+    /**
+     * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partners
+     * @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}
+     */
+    listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>>;
+    /**
+     * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRequestDto} updatePartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartner(code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerResponseClass>>;
+};
+/**
+ * PartnersApi - factory interface
+ * @export
+ */
+export declare const PartnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a partner.
+     * @summary Create the partner
+     * @param {CreatePartnerRequestDto} createPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartner(createPartnerRequestDto: CreatePartnerRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerResponseClass>;
+    /**
+     * Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
+     * @summary Delete the partner
+     * @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}
+     */
+    deletePartner(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+     * @summary Retrieve the partner
+     * @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}
+     */
+    getPartner(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerResponseClass>;
+    /**
+     * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partners
+     * @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}
+     */
+    listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnersResponseClass>;
+    /**
+     * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRequestDto} updatePartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartner(code: string, updatePartnerRequestDto: UpdatePartnerRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerResponseClass>;
+};
+/**
+ * Request parameters for createPartner operation in PartnersApi.
+ * @export
+ * @interface PartnersApiCreatePartnerRequest
+ */
+export interface PartnersApiCreatePartnerRequest {
+    /**
+     *
+     * @type {CreatePartnerRequestDto}
+     * @memberof PartnersApiCreatePartner
+     */
+    readonly createPartnerRequestDto: CreatePartnerRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiCreatePartner
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePartner operation in PartnersApi.
+ * @export
+ * @interface PartnersApiDeletePartnerRequest
+ */
+export interface PartnersApiDeletePartnerRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnersApiDeletePartner
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiDeletePartner
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartner operation in PartnersApi.
+ * @export
+ * @interface PartnersApiGetPartnerRequest
+ */
+export interface PartnersApiGetPartnerRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnersApiGetPartner
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiGetPartner
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof PartnersApiGetPartner
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for listPartners operation in PartnersApi.
+ * @export
+ * @interface PartnersApiListPartnersRequest
+ */
+export interface PartnersApiListPartnersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiListPartners
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    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 PartnersApiListPartners
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updatePartner operation in PartnersApi.
+ * @export
+ * @interface PartnersApiUpdatePartnerRequest
+ */
+export interface PartnersApiUpdatePartnerRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnersApiUpdatePartner
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePartnerRequestDto}
+     * @memberof PartnersApiUpdatePartner
+     */
+    readonly updatePartnerRequestDto: UpdatePartnerRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiUpdatePartner
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnersApi - object-oriented interface
+ * @export
+ * @class PartnersApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnersApi extends BaseAPI {
+    /**
+     * This will create a partner.
+     * @summary Create the partner
+     * @param {PartnersApiCreatePartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    createPartner(requestParameters: PartnersApiCreatePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerResponseClass, any>>;
+    /**
+     * Permanently deletes the partner. Supply the unique code that was returned when you created the partner and this will delete it.
+     * @summary Delete the partner
+     * @param {PartnersApiDeletePartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    deletePartner(requestParameters: PartnersApiDeletePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+     * @summary Retrieve the partner
+     * @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    getPartner(requestParameters: PartnersApiGetPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerResponseClass, any>>;
+    /**
+     * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List partners
+     * @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    listPartners(requestParameters?: PartnersApiListPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnersResponseClass, any>>;
+    /**
+     * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner
+     * @param {PartnersApiUpdatePartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    updatePartner(requestParameters: PartnersApiUpdatePartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerResponseClass, any>>;
+}