@emilgroup/discount-sdk 1.5.1 → 1.7.0

package/dist/api/vouchers-api.d.ts

@@ -0,0 +1,393 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService 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 { CreateVoucherRequestDto } from '../models';
+import { CreateVoucherResponseClass } from '../models';
+import { GetVoucherResponseClass } from '../models';
+import { ListVouchersResponseClass } from '../models';
+import { UpdateVoucherRequestDto } from '../models';
+import { UpdateVoucherResponseClass } from '../models';
+/**
+ * VouchersApi - axios parameter creator
+ * @export
+ */
+export declare const VouchersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a voucher.
+     * @summary Create the Voucher
+     * @param {CreateVoucherRequestDto} createVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVoucher: (createVoucherRequestDto: CreateVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete a voucher.
+     * @summary Delete the Voucher
+     * @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}
+     */
+    deleteVoucher: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get a voucher.
+     * @summary Retrieve the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'campaign' | 'productDiscounts'} [expand] You can expand voucher in this endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVoucher: (code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of Vouchers you have previously created.          The Vouchers are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List Vouchers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, voucherCode, productSlugsList&lt;/i&gt;
+     * @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, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt&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: campaign, productDiscounts&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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVouchers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update a voucher.
+     * @summary Update the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVoucherRequestDto} updateVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVoucher: (code: string, updateVoucherRequestDto: UpdateVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VouchersApi - functional programming interface
+ * @export
+ */
+export declare const VouchersApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a voucher.
+     * @summary Create the Voucher
+     * @param {CreateVoucherRequestDto} createVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVoucher(createVoucherRequestDto: CreateVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVoucherResponseClass>>;
+    /**
+     * This will delete a voucher.
+     * @summary Delete the Voucher
+     * @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}
+     */
+    deleteVoucher(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get a voucher.
+     * @summary Retrieve the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'campaign' | 'productDiscounts'} [expand] You can expand voucher in this endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVoucher(code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetVoucherResponseClass>>;
+    /**
+     * Returns a list of Vouchers you have previously created.          The Vouchers are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List Vouchers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, voucherCode, productSlugsList&lt;/i&gt;
+     * @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, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt&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: campaign, productDiscounts&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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVouchers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListVouchersResponseClass>>;
+    /**
+     * This will update a voucher.
+     * @summary Update the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVoucherRequestDto} updateVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVoucher(code: string, updateVoucherRequestDto: UpdateVoucherRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateVoucherResponseClass>>;
+};
+/**
+ * VouchersApi - factory interface
+ * @export
+ */
+export declare const VouchersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a voucher.
+     * @summary Create the Voucher
+     * @param {CreateVoucherRequestDto} createVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createVoucher(createVoucherRequestDto: CreateVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<CreateVoucherResponseClass>;
+    /**
+     * This will delete a voucher.
+     * @summary Delete the Voucher
+     * @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}
+     */
+    deleteVoucher(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get a voucher.
+     * @summary Retrieve the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'campaign' | 'productDiscounts'} [expand] You can expand voucher in this endpoint.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVoucher(code: string, authorization?: string, expand?: 'campaign' | 'productDiscounts', options?: any): AxiosPromise<GetVoucherResponseClass>;
+    /**
+     * Returns a list of Vouchers you have previously created.          The Vouchers are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List Vouchers
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, voucherCode, productSlugsList&lt;/i&gt;
+     * @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, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt&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: campaign, productDiscounts&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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVouchers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListVouchersResponseClass>;
+    /**
+     * This will update a voucher.
+     * @summary Update the Voucher
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateVoucherRequestDto} updateVoucherRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVoucher(code: string, updateVoucherRequestDto: UpdateVoucherRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateVoucherResponseClass>;
+};
+/**
+ * Request parameters for createVoucher operation in VouchersApi.
+ * @export
+ * @interface VouchersApiCreateVoucherRequest
+ */
+export interface VouchersApiCreateVoucherRequest {
+    /**
+     *
+     * @type {CreateVoucherRequestDto}
+     * @memberof VouchersApiCreateVoucher
+     */
+    readonly createVoucherRequestDto: CreateVoucherRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VouchersApiCreateVoucher
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteVoucher operation in VouchersApi.
+ * @export
+ * @interface VouchersApiDeleteVoucherRequest
+ */
+export interface VouchersApiDeleteVoucherRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VouchersApiDeleteVoucher
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VouchersApiDeleteVoucher
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getVoucher operation in VouchersApi.
+ * @export
+ * @interface VouchersApiGetVoucherRequest
+ */
+export interface VouchersApiGetVoucherRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VouchersApiGetVoucher
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VouchersApiGetVoucher
+     */
+    readonly authorization?: string;
+    /**
+     * You can expand voucher in this endpoint.
+     * @type {'campaign' | 'productDiscounts'}
+     * @memberof VouchersApiGetVoucher
+     */
+    readonly expand?: 'campaign' | 'productDiscounts';
+}
+/**
+ * Request parameters for listVouchers operation in VouchersApi.
+ * @export
+ * @interface VouchersApiListVouchersRequest
+ */
+export interface VouchersApiListVouchersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 {string}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly pageToken?: string;
+    /**
+     * 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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly filter?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, voucherCode, productSlugsList&lt;/i&gt;
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly search?: string;
+    /**
+     * 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, voucherCode, campaignId, discountPeriodMonths, discountType, discountValue, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    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: campaign, productDiscounts&lt;i&gt;
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    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: id, code, voucherCode, campaignId, discountType, createdAt, discountValue, discountPeriodMonths, productDiscounts.productSlug&lt;/i&gt;
+     * @type {string}
+     * @memberof VouchersApiListVouchers
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateVoucher operation in VouchersApi.
+ * @export
+ * @interface VouchersApiUpdateVoucherRequest
+ */
+export interface VouchersApiUpdateVoucherRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof VouchersApiUpdateVoucher
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateVoucherRequestDto}
+     * @memberof VouchersApiUpdateVoucher
+     */
+    readonly updateVoucherRequestDto: UpdateVoucherRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof VouchersApiUpdateVoucher
+     */
+    readonly authorization?: string;
+}
+/**
+ * VouchersApi - object-oriented interface
+ * @export
+ * @class VouchersApi
+ * @extends {BaseAPI}
+ */
+export declare class VouchersApi extends BaseAPI {
+    /**
+     * This will create a voucher.
+     * @summary Create the Voucher
+     * @param {VouchersApiCreateVoucherRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VouchersApi
+     */
+    createVoucher(requestParameters: VouchersApiCreateVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVoucherResponseClass, any, {}>>;
+    /**
+     * This will delete a voucher.
+     * @summary Delete the Voucher
+     * @param {VouchersApiDeleteVoucherRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VouchersApi
+     */
+    deleteVoucher(requestParameters: VouchersApiDeleteVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get a voucher.
+     * @summary Retrieve the Voucher
+     * @param {VouchersApiGetVoucherRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VouchersApi
+     */
+    getVoucher(requestParameters: VouchersApiGetVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetVoucherResponseClass, any, {}>>;
+    /**
+     * Returns a list of Vouchers you have previously created.          The Vouchers are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List Vouchers
+     * @param {VouchersApiListVouchersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VouchersApi
+     */
+    listVouchers(requestParameters?: VouchersApiListVouchersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListVouchersResponseClass, any, {}>>;
+    /**
+     * This will update a voucher.
+     * @summary Update the Voucher
+     * @param {VouchersApiUpdateVoucherRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VouchersApi
+     */
+    updateVoucher(requestParameters: VouchersApiUpdateVoucherRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateVoucherResponseClass, any, {}>>;
+}