@emilgroup/partner-sdk 1.0.1 → 1.2.1-beta.1

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

@@ -0,0 +1,375 @@
+/**
+ * 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 { CreateTagRequestDto } from '../models';
+import { CreateTagResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetTagResponseClass } from '../models';
+import { ListTagsResponseClass } from '../models';
+import { UpdateTagResponseClass } from '../models';
+/**
+ * PartnerTagsApi - axios parameter creator
+ * @export
+ */
+export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
+     * @summary Create the partner tag
+     * @param {CreateTagRequestDto} createTagRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTag: (createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
+     * @summary Delete the partner tag
+     * @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}
+     */
+    deleteTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code        that was returned when you created it and Emil Api will return the corresponding partner tag information.
+     * @summary Retrieve the partner tag
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of partner tags you have previously created.          The partner tags are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List partner tags
+     * @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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTags: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner tag
+     * @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}
+     */
+    updateTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnerTagsApi - functional programming interface
+ * @export
+ */
+export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
+     * @summary Create the partner tag
+     * @param {CreateTagRequestDto} createTagRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTagResponseClass>>;
+    /**
+     * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
+     * @summary Delete the partner tag
+     * @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}
+     */
+    deleteTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code        that was returned when you created it and Emil Api will return the corresponding partner tag information.
+     * @summary Retrieve the partner tag
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTagResponseClass>>;
+    /**
+     * Returns a list of partner tags you have previously created.          The partner tags are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List partner tags
+     * @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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTags(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTagsResponseClass>>;
+    /**
+     * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner tag
+     * @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}
+     */
+    updateTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTagResponseClass>>;
+};
+/**
+ * PartnerTagsApi - factory interface
+ * @export
+ */
+export declare const PartnerTagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
+     * @summary Create the partner tag
+     * @param {CreateTagRequestDto} createTagRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTagResponseClass>;
+    /**
+     * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
+     * @summary Delete the partner tag
+     * @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}
+     */
+    deleteTag(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code        that was returned when you created it and Emil Api will return the corresponding partner tag information.
+     * @summary Retrieve the partner tag
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTag(code: string, authorization?: string, options?: any): AxiosPromise<GetTagResponseClass>;
+    /**
+     * Returns a list of partner tags you have previously created.          The partner tags are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List partner tags
+     * @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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTags(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTagsResponseClass>;
+    /**
+     * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner tag
+     * @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}
+     */
+    updateTag(code: string, authorization?: string, options?: any): AxiosPromise<UpdateTagResponseClass>;
+};
+/**
+ * Request parameters for createTag operation in PartnerTagsApi.
+ * @export
+ * @interface PartnerTagsApiCreateTagRequest
+ */
+export interface PartnerTagsApiCreateTagRequest {
+    /**
+     *
+     * @type {CreateTagRequestDto}
+     * @memberof PartnerTagsApiCreateTag
+     */
+    readonly createTagRequestDto: CreateTagRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTagsApiCreateTag
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteTag operation in PartnerTagsApi.
+ * @export
+ * @interface PartnerTagsApiDeleteTagRequest
+ */
+export interface PartnerTagsApiDeleteTagRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerTagsApiDeleteTag
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTagsApiDeleteTag
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getTag operation in PartnerTagsApi.
+ * @export
+ * @interface PartnerTagsApiGetTagRequest
+ */
+export interface PartnerTagsApiGetTagRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerTagsApiGetTag
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTagsApiGetTag
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listTags operation in PartnerTagsApi.
+ * @export
+ * @interface PartnerTagsApiListTagsRequest
+ */
+export interface PartnerTagsApiListTagsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnerTagsApiListTags
+     */
+    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 PartnerTagsApiListTags
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly search?: any;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @type {string}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, slug, label&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerTagsApiListTags
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateTag operation in PartnerTagsApi.
+ * @export
+ * @interface PartnerTagsApiUpdateTagRequest
+ */
+export interface PartnerTagsApiUpdateTagRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerTagsApiUpdateTag
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerTagsApiUpdateTag
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnerTagsApi - object-oriented interface
+ * @export
+ * @class PartnerTagsApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnerTagsApi extends BaseAPI {
+    /**
+     * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
+     * @summary Create the partner tag
+     * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTagsApi
+     */
+    createTag(requestParameters: PartnerTagsApiCreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTagResponseClass, any>>;
+    /**
+     * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
+     * @summary Delete the partner tag
+     * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTagsApi
+     */
+    deleteTag(requestParameters: PartnerTagsApiDeleteTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code        that was returned when you created it and Emil Api will return the corresponding partner tag information.
+     * @summary Retrieve the partner tag
+     * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTagsApi
+     */
+    getTag(requestParameters: PartnerTagsApiGetTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagResponseClass, any>>;
+    /**
+     * Returns a list of partner tags you have previously created.          The partner tags are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List partner tags
+     * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTagsApi
+     */
+    listTags(requestParameters?: PartnerTagsApiListTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTagsResponseClass, any>>;
+    /**
+     * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner tag
+     * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerTagsApi
+     */
+    updateTag(requestParameters: PartnerTagsApiUpdateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTagResponseClass, any>>;
+}