@voucherify/sdk 3.0.0 → 3.0.1

package/dist/types/api/CampaignsApi.d.ts

@@ -0,0 +1,325 @@
+/**
+* Campaigns service.
+* @module api/CampaignsApi
+* @version 3.0.1
+*/
+export default class CampaignsApi {
+    /**
+    * Constructs a new CampaignsApi.
+    * @alias CampaignsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the addVoucherWithSpecificCodeToCampaign operation.
+     * @callback addVoucherWithSpecificCodeToCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsVouchersCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Add Voucher with Specific Code to Campaign
+     * This method gives a possibility to add a new voucher to an existing campaign. The voucher definition will be inherited from the definition kept in the campaign profile. However, you are able to overwrite a few properties inherited from the campaign.
+     * @param {String} campaignId The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {String} code A custom **code** that identifies the voucher.
+     * @param {CampaignsVouchersCreateRequestBody} campaignsVouchersCreateRequestBody Specify the voucher parameters that you would like to overwrite.
+     * @param {addVoucherWithSpecificCodeToCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsVouchersCreateResponseBody}
+     * @returns {Promise<(CampaignsVouchersCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsVouchersCreateResponseBody` object or with `undefined`.
+     */
+    addVoucherWithSpecificCodeToCampaign(campaignId: string, code: string, campaignsVouchersCreateRequestBody: CampaignsVouchersCreateRequestBody, callback?: (error: Error | null, data?: CampaignsVouchersCreateResponseBody, response?: any) => any): Promise<(CampaignsVouchersCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the addVouchersToCampaign operation.
+     * @callback addVouchersToCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsVouchersCreateCombinedResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Add Vouchers to Campaign
+     * This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
+     * @param {String} campaignId The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {CampaignsVouchersCreateInBulkRequestBody} campaignsVouchersCreateInBulkRequestBody Specify the voucher parameters that you would like to overwrite.
+     * @param {{
+        vouchersCount?: Number,
+     }} [opts] Optional parameters
+     * @param {addVouchersToCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsVouchersCreateCombinedResponseBody}
+     * @returns {Promise<(CampaignsVouchersCreateCombinedResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsVouchersCreateCombinedResponseBody` object or with `undefined`.
+     */
+    addVouchersToCampaign(campaignId: string, campaignsVouchersCreateInBulkRequestBody: CampaignsVouchersCreateInBulkRequestBody, opts?: {
+        vouchersCount?: number;
+    }, callback?: (error: Error | null, data?: CampaignsVouchersCreateCombinedResponseBody, response?: any) => any): Promise<(CampaignsVouchersCreateCombinedResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the createCampaign operation.
+     * @callback createCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Campaign
+     * Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.    📘 Global uniqueness  All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.    🚧 Code generation status  This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features.
+     * @param {CampaignsCreateRequestBody} campaignsCreateRequestBody Specify the details of the campaign that you would like to create.
+     * @param {createCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsCreateResponseBody}
+     * @returns {Promise<(CampaignsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsCreateResponseBody` object or with `undefined`.
+     */
+    createCampaign(campaignsCreateRequestBody: CampaignsCreateRequestBody, callback?: (error: Error | null, data?: CampaignsCreateResponseBody, response?: any) => any): Promise<(CampaignsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deleteCampaign operation.
+     * @callback deleteCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsDeleteResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Campaign
+     * Deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the campaign and all related vouchers will be moved to [the bin](/api-reference/bin/list-bin-entries). This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {{
+        force?: Boolean,
+     }} [opts] Optional parameters
+     * @param {deleteCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsDeleteResponseBody}
+     * @returns {Promise<(CampaignsDeleteResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsDeleteResponseBody` object or with `undefined`.
+     */
+    deleteCampaign(campaignId: string, opts?: {
+        force?: boolean;
+    }, callback?: (error: Error | null, data?: CampaignsDeleteResponseBody, response?: any) => any): Promise<(CampaignsDeleteResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the disableCampaign operation.
+     * @callback disableCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {Object} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Disable Campaign
+     * There are various times when youll want to manage a campaigns accessibility. This can be done by two API methods for managing the campaign state - *enable* and *disable*.   Sets campaign state to **inactive**. The vouchers in this campaign can no longer be redeemed.
+     * @param {String} campaignId The campaign ID or name of the campaign being disabled. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {disableCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Object}
+     * @returns {Promise<(Object | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `Object` object or with `undefined`.
+     */
+    disableCampaign(campaignId: string, callback?: (error: Error | null, data?: any, response?: any) => any): Promise<(any | undefined)>;
+    /**
+     * Callback function to receive the result of the enableCampaign operation.
+     * @callback enableCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {Object} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Enable Campaign
+     * There are various times when youll want to manage a campaigns accessibility. This can be done by two API methods for managing the campaign state - *enable* and *disable*.   Sets campaign state to **active**. The vouchers in this campaign can be redeemed - only if the redemption occurs after the start date of the campaign and voucher and the voucher and campaign are not expired.
+     * @param {String} campaignId The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.
+     * @param {enableCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Object}
+     * @returns {Promise<(Object | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `Object` object or with `undefined`.
+     */
+    enableCampaign(campaignId: string, callback?: (error: Error | null, data?: any, response?: any) => any): Promise<(any | undefined)>;
+    /**
+     * Callback function to receive the result of the exportCampaignTransactions operation.
+     * @callback exportCampaignTransactionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsTransactionsExportCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Export Campaign Transactions
+     * Export transactions is an asynchronous process that generates a CSV file with the data about credit movements on all gift cards or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows:    👍 Export Loyalty Campaign Transactions  For loyalty campaigns, this method works in the same way the [POST Export Loyalty Campaign Transactions](/api-reference/loyalties/export-loyalty-campaign-transactions) does.
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {CampaignsTransactionsExportCreateRequestBody} campaignsTransactionsExportCreateRequestBody Specify the parameters for the transaction export.
+     * @param {exportCampaignTransactionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsTransactionsExportCreateResponseBody}
+     * @returns {Promise<(CampaignsTransactionsExportCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsTransactionsExportCreateResponseBody` object or with `undefined`.
+     */
+    exportCampaignTransactions(campaignId: string, campaignsTransactionsExportCreateRequestBody: CampaignsTransactionsExportCreateRequestBody, callback?: (error: Error | null, data?: CampaignsTransactionsExportCreateResponseBody, response?: any) => any): Promise<(CampaignsTransactionsExportCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getCampaign operation.
+     * @callback getCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Campaign
+     * Retrieves the campaign with the given campaign ID or campaign name.
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {getCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsGetResponseBody}
+     * @returns {Promise<(CampaignsGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsGetResponseBody` object or with `undefined`.
+     */
+    getCampaign(campaignId: string, callback?: (error: Error | null, data?: CampaignsGetResponseBody, response?: any) => any): Promise<(CampaignsGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getCampaignSummary operation.
+     * @callback getCampaignSummaryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsSummaryGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Campaign Summary
+     * Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type. Use start_date and end_date to narrow down the data to specific periods. 🚧 Campaigns created before v20250602 version This endpoint returns analytics data for campaigns that were created after the [v20250602 version](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20250602) was released on 17 June 2025. Older campaigns return empty data.
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {{
+        startDate?: Date,
+        endDate?: Date,
+     }} [opts] Optional parameters
+     * @param {getCampaignSummaryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsSummaryGetResponseBody}
+     * @returns {Promise<(CampaignsSummaryGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsSummaryGetResponseBody` object or with `undefined`.
+     */
+    getCampaignSummary(campaignId: string, opts?: {
+        startDate?: Date;
+        endDate?: Date;
+    }, callback?: (error: Error | null, data?: CampaignsSummaryGetResponseBody, response?: any) => any): Promise<(CampaignsSummaryGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importVouchersToCampaign operation.
+     * @callback importVouchersToCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsImportCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Import Vouchers to Campaign
+     * Imports vouchers to an **existing** campaign. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
+     * @param {String} campaignId The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {Array.<CampaignsImportVoucherItem>} campaignsImportVoucherItem Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings.
+     * @param {importVouchersToCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsImportCreateResponseBody}
+     * @returns {Promise<(CampaignsImportCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsImportCreateResponseBody` object or with `undefined`.
+     */
+    importVouchersToCampaign(campaignId: string, campaignsImportVoucherItem: Array<CampaignsImportVoucherItem>, callback?: (error: Error | null, data?: CampaignsImportCreateResponseBody, response?: any) => any): Promise<(CampaignsImportCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importVouchersToCampaignUsingCsv operation.
+     * @callback importVouchersToCampaignUsingCsvCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsImportCsvCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Import Vouchers to Campaign by CSV
+     * Imports vouchers to an **existing** campaign.   The CSV file has to include headers in the first line.  This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
+     * @param {String} campaignId The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.
+     * @param {{
+        file?: File,
+     }} [opts] Optional parameters
+     * @param {importVouchersToCampaignUsingCsvCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsImportCsvCreateResponseBody}
+     * @returns {Promise<(CampaignsImportCsvCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsImportCsvCreateResponseBody` object or with `undefined`.
+     */
+    importVouchersToCampaignUsingCsv(campaignId: string, opts?: {
+        file?: File;
+    }, callback?: (error: Error | null, data?: CampaignsImportCsvCreateResponseBody, response?: any) => any): Promise<(CampaignsImportCsvCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listCampaignTransactions operation.
+     * @callback listCampaignTransactionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsTransactionsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Campaign Transactions
+     * Retrieves all transactions for the campaign with the given campaign ID or campaign name. The id filter denotes the unique transaction identifier.  🚧  The endpoint works only for gift card and loyalty campaigns.
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {{
+        limit?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListTransactions, "prototype" | "constructFromObject">,
+        startingAfterId?: String,
+        filters?: ParametersFiltersListCampaignTransactions,
+     }} [opts] Optional parameters
+     * @param {listCampaignTransactionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsTransactionsListResponseBody}
+     * @returns {Promise<(CampaignsTransactionsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsTransactionsListResponseBody` object or with `undefined`.
+     */
+    listCampaignTransactions(campaignId: string, opts?: {
+        limit?: number;
+        order?: Exclude<keyof typeof ParameterOrderListTransactions, "prototype" | "constructFromObject">;
+        startingAfterId?: string;
+        filters?: ParametersFiltersListCampaignTransactions;
+    }, callback?: (error: Error | null, data?: CampaignsTransactionsListResponseBody, response?: any) => any): Promise<(CampaignsTransactionsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listCampaigns operation.
+     * @callback listCampaignsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Campaigns
+     * Retrieve a list of campaigns in a project.  The campaigns are returned sorted by creation date, with the most recent campaigns appearing first.   When you get a list of campaigns, you can optionally specify query parameters to customize the amount of campaigns returned per call using limit, which page of campaigns to return using page, sort the campaigns using the order query parameter and filter the results by the campaign_type. This method will return an error when trying to return a limit of more than 100 campaigns.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        campaignType?: Exclude<keyof typeof ParameterCampaignType, "prototype" | "constructFromObject">,
+        expand?: Exclude<keyof typeof ParameterExpandListCampaigns, "prototype" | "constructFromObject">,
+        campaignStatus?: Exclude<keyof typeof ParameterCampaignStatusListCampaigns, "prototype" | "constructFromObject">,
+        isReferralCode?: Boolean,
+        order?: Exclude<keyof typeof ParameterOrderListCampaigns, "prototype" | "constructFromObject">,
+        filters?: ParameterFiltersListCampaigns,
+        accessSettings?: ParameterCampaignsAccessSetttings,
+     }} [opts] Optional parameters
+     * @param {listCampaignsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsListResponseBody}
+     * @returns {Promise<(CampaignsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsListResponseBody` object or with `undefined`.
+     */
+    listCampaigns(opts?: {
+        limit?: number;
+        page?: number;
+        campaignType?: Exclude<keyof typeof ParameterCampaignType, "prototype" | "constructFromObject">;
+        expand?: Exclude<keyof typeof ParameterExpandListCampaigns, "prototype" | "constructFromObject">;
+        campaignStatus?: Exclude<keyof typeof ParameterCampaignStatusListCampaigns, "prototype" | "constructFromObject">;
+        isReferralCode?: boolean;
+        order?: Exclude<keyof typeof ParameterOrderListCampaigns, "prototype" | "constructFromObject">;
+        filters?: ParameterFiltersListCampaigns;
+        accessSettings?: ParameterCampaignsAccessSetttings;
+    }, callback?: (error: Error | null, data?: CampaignsListResponseBody, response?: any) => any): Promise<(CampaignsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateCampaign operation.
+     * @callback updateCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CampaignsUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Campaign
+     * Updates the specified campaign by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.  Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.     🚧 Vouchers will be affected  This method will update vouchers aggregated in the campaign. It will affect all vouchers that are not published or redeemed yet.
+     * @param {String} campaignId You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+     * @param {CampaignsUpdateRequestBody} campaignsUpdateRequestBody Specify the campaign parameters to be updated.
+     * @param {updateCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CampaignsUpdateResponseBody}
+     * @returns {Promise<(CampaignsUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CampaignsUpdateResponseBody` object or with `undefined`.
+     */
+    updateCampaign(campaignId: string, campaignsUpdateRequestBody: CampaignsUpdateRequestBody, callback?: (error: Error | null, data?: CampaignsUpdateResponseBody, response?: any) => any): Promise<(CampaignsUpdateResponseBody | undefined)>;
+}
+import CampaignsVouchersCreateRequestBody from '../model/CampaignsVouchersCreateRequestBody';
+import CampaignsVouchersCreateResponseBody from '../model/CampaignsVouchersCreateResponseBody';
+import CampaignsVouchersCreateInBulkRequestBody from '../model/CampaignsVouchersCreateInBulkRequestBody';
+import CampaignsVouchersCreateCombinedResponseBody from '../model/CampaignsVouchersCreateCombinedResponseBody';
+import CampaignsCreateRequestBody from '../model/CampaignsCreateRequestBody';
+import CampaignsCreateResponseBody from '../model/CampaignsCreateResponseBody';
+import CampaignsDeleteResponseBody from '../model/CampaignsDeleteResponseBody';
+import CampaignsTransactionsExportCreateRequestBody from '../model/CampaignsTransactionsExportCreateRequestBody';
+import CampaignsTransactionsExportCreateResponseBody from '../model/CampaignsTransactionsExportCreateResponseBody';
+import CampaignsGetResponseBody from '../model/CampaignsGetResponseBody';
+import CampaignsSummaryGetResponseBody from '../model/CampaignsSummaryGetResponseBody';
+import CampaignsImportVoucherItem from '../model/CampaignsImportVoucherItem';
+import CampaignsImportCreateResponseBody from '../model/CampaignsImportCreateResponseBody';
+import CampaignsImportCsvCreateResponseBody from '../model/CampaignsImportCsvCreateResponseBody';
+import ParameterOrderListTransactions from '../model/ParameterOrderListTransactions';
+import ParametersFiltersListCampaignTransactions from '../model/ParametersFiltersListCampaignTransactions';
+import CampaignsTransactionsListResponseBody from '../model/CampaignsTransactionsListResponseBody';
+import ParameterCampaignType from '../model/ParameterCampaignType';
+import ParameterExpandListCampaigns from '../model/ParameterExpandListCampaigns';
+import ParameterCampaignStatusListCampaigns from '../model/ParameterCampaignStatusListCampaigns';
+import ParameterOrderListCampaigns from '../model/ParameterOrderListCampaigns';
+import ParameterFiltersListCampaigns from '../model/ParameterFiltersListCampaigns';
+import ParameterCampaignsAccessSetttings from '../model/ParameterCampaignsAccessSetttings';
+import CampaignsListResponseBody from '../model/CampaignsListResponseBody';
+import CampaignsUpdateRequestBody from '../model/CampaignsUpdateRequestBody';
+import CampaignsUpdateResponseBody from '../model/CampaignsUpdateResponseBody';

package/dist/types/api/CategoriesApi.d.ts

@@ -0,0 +1,101 @@
+/**
+* Categories service.
+* @module api/CategoriesApi
+* @version 3.0.1
+*/
+export default class CategoriesApi {
+    /**
+    * Constructs a new CategoriesApi.
+    * @alias CategoriesApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the createCategory operation.
+     * @callback createCategoryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CategoriesCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Category
+     * Create category with a specific name and hierarchy.
+     * @param {CategoriesCreateRequestBody} categoriesCreateRequestBody Specify the details of the category that you would like to create.
+     * @param {createCategoryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CategoriesCreateResponseBody}
+     * @returns {Promise<(CategoriesCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CategoriesCreateResponseBody` object or with `undefined`.
+     */
+    createCategory(categoriesCreateRequestBody: CategoriesCreateRequestBody, callback?: (error: Error | null, data?: CategoriesCreateResponseBody, response?: any) => any): Promise<(CategoriesCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deleteCategory operation.
+     * @callback deleteCategoryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Category
+     * Delete a category by the category ID.
+     * @param {String} categoryId Unique category ID assigned by Voucherify.
+     * @param {deleteCategoryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    deleteCategory(categoryId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the getCategory operation.
+     * @callback getCategoryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CategoriesGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Category
+     * Retrieve a category by the category ID.
+     * @param {String} categoryId Unique category ID assigned by Voucherify.
+     * @param {getCategoryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CategoriesGetResponseBody}
+     * @returns {Promise<(CategoriesGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CategoriesGetResponseBody` object or with `undefined`.
+     */
+    getCategory(categoryId: string, callback?: (error: Error | null, data?: CategoriesGetResponseBody, response?: any) => any): Promise<(CategoriesGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listCategories operation.
+     * @callback listCategoriesCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CategoriesListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Categories
+     * List all categories.
+     * @param {listCategoriesCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CategoriesListResponseBody}
+     * @returns {Promise<(CategoriesListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CategoriesListResponseBody` object or with `undefined`.
+     */
+    listCategories(callback?: (error: Error | null, data?: CategoriesListResponseBody, response?: any) => any): Promise<(CategoriesListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateCategory operation.
+     * @callback updateCategoryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {CategoriesUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Category
+     * Update a category using the category ID.
+     * @param {String} categoryId Unique category ID assigned by Voucherify.
+     * @param {CategoriesUpdateRequestBody} categoriesUpdateRequestBody Specify the details of the category that you would like to update.
+     * @param {updateCategoryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link CategoriesUpdateResponseBody}
+     * @returns {Promise<(CategoriesUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `CategoriesUpdateResponseBody` object or with `undefined`.
+     */
+    updateCategory(categoryId: string, categoriesUpdateRequestBody: CategoriesUpdateRequestBody, callback?: (error: Error | null, data?: CategoriesUpdateResponseBody, response?: any) => any): Promise<(CategoriesUpdateResponseBody | undefined)>;
+}
+import CategoriesCreateRequestBody from '../model/CategoriesCreateRequestBody';
+import CategoriesCreateResponseBody from '../model/CategoriesCreateResponseBody';
+import CategoriesGetResponseBody from '../model/CategoriesGetResponseBody';
+import CategoriesListResponseBody from '../model/CategoriesListResponseBody';
+import CategoriesUpdateRequestBody from '../model/CategoriesUpdateRequestBody';
+import CategoriesUpdateResponseBody from '../model/CategoriesUpdateResponseBody';

package/dist/types/api/ClientSideApi.d.ts

@@ -0,0 +1,120 @@
+/**
+* ClientSide service.
+* @module api/ClientSideApi
+* @version 3.0.1
+*/
+export default class ClientSideApi {
+    /**
+    * Constructs a new ClientSideApi.
+    * @alias ClientSideApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the checkEligibilityClientSide operation.
+     * @callback checkEligibilityClientSideCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ClientQualificationsCheckEligibilityResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Check Eligibility (client-side)
+     * Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version  👍 Scenario Guide  Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging  The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.
+     * @param {ClientQualificationsCheckEligibilityRequestBody} clientQualificationsCheckEligibilityRequestBody Define order and customer context.
+     * @param {checkEligibilityClientSideCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ClientQualificationsCheckEligibilityResponseBody}
+     * @returns {Promise<(ClientQualificationsCheckEligibilityResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ClientQualificationsCheckEligibilityResponseBody` object or with `undefined`.
+     */
+    checkEligibilityClientSide(clientQualificationsCheckEligibilityRequestBody: ClientQualificationsCheckEligibilityRequestBody, callback?: (error: Error | null, data?: ClientQualificationsCheckEligibilityResponseBody, response?: any) => any): Promise<(ClientQualificationsCheckEligibilityResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listPromotionTiersClientSide operation.
+     * @callback listPromotionTiersClientSideCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ClientPromotionsTiersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Promotion Tiers (client-side)
+     * This method enables you to list promotion tiers.
+     * @param {String} origin Indicates the origin (scheme, hostname, and port).
+     * @param {{
+        isAvailable?: Boolean,
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListPromotionTiersClientSide, "prototype" | "constructFromObject">,
+     }} [opts] Optional parameters
+     * @param {listPromotionTiersClientSideCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ClientPromotionsTiersListResponseBody}
+     * @returns {Promise<(ClientPromotionsTiersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ClientPromotionsTiersListResponseBody` object or with `undefined`.
+     */
+    listPromotionTiersClientSide(origin: string, opts?: {
+        isAvailable?: boolean;
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListPromotionTiersClientSide, "prototype" | "constructFromObject">;
+    }, callback?: (error: Error | null, data?: ClientPromotionsTiersListResponseBody, response?: any) => any): Promise<(ClientPromotionsTiersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the redeemStackedDiscountsClientSide operation.
+     * @callback redeemStackedDiscountsClientSideCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ClientRedemptionsRedeemResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Redeem Stackable Discounts (client-side)
+     * This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:    📘 Rollbacks  You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).
+     * @param {String} origin Indicates the origin (scheme, hostname, and port).
+     * @param {ClientRedemptionsRedeemRequestBody} clientRedemptionsRedeemRequestBody
+     * @param {redeemStackedDiscountsClientSideCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ClientRedemptionsRedeemResponseBody}
+     * @returns {Promise<(ClientRedemptionsRedeemResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ClientRedemptionsRedeemResponseBody` object or with `undefined`.
+     */
+    redeemStackedDiscountsClientSide(origin: string, clientRedemptionsRedeemRequestBody: ClientRedemptionsRedeemRequestBody, callback?: (error: Error | null, data?: ClientRedemptionsRedeemResponseBody, response?: any) => any): Promise<(ClientRedemptionsRedeemResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the trackCustomEventClientSide operation.
+     * @callback trackCustomEventClientSideCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ClientEventsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Track Custom Event (client-side)
+     * To track a custom event, you create an event object.   The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created.
+     * @param {String} origin Indicates the origin (scheme, hostname, and port).
+     * @param {ClientEventsCreateRequestBody} clientEventsCreateRequestBody Specify the details of the custom event.
+     * @param {trackCustomEventClientSideCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ClientEventsCreateResponseBody}
+     * @returns {Promise<(ClientEventsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ClientEventsCreateResponseBody` object or with `undefined`.
+     */
+    trackCustomEventClientSide(origin: string, clientEventsCreateRequestBody: ClientEventsCreateRequestBody, callback?: (error: Error | null, data?: ClientEventsCreateResponseBody, response?: any) => any): Promise<(ClientEventsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the validateStackedDiscountsClientSide operation.
+     * @callback validateStackedDiscountsClientSideCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ClientValidationsValidateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Validate Stackable Discounts (client-side)
+     * Verify redeemables provided in the request. This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications.
+     * @param {String} origin Indicates the origin (scheme, hostname, and port).
+     * @param {ClientValidationsValidateRequestBody} clientValidationsValidateRequestBody
+     * @param {validateStackedDiscountsClientSideCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ClientValidationsValidateResponseBody}
+     * @returns {Promise<(ClientValidationsValidateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ClientValidationsValidateResponseBody` object or with `undefined`.
+     */
+    validateStackedDiscountsClientSide(origin: string, clientValidationsValidateRequestBody: ClientValidationsValidateRequestBody, callback?: (error: Error | null, data?: ClientValidationsValidateResponseBody, response?: any) => any): Promise<(ClientValidationsValidateResponseBody | undefined)>;
+}
+import ClientQualificationsCheckEligibilityRequestBody from '../model/ClientQualificationsCheckEligibilityRequestBody';
+import ClientQualificationsCheckEligibilityResponseBody from '../model/ClientQualificationsCheckEligibilityResponseBody';
+import ParameterOrderListPromotionTiersClientSide from '../model/ParameterOrderListPromotionTiersClientSide';
+import ClientPromotionsTiersListResponseBody from '../model/ClientPromotionsTiersListResponseBody';
+import ClientRedemptionsRedeemRequestBody from '../model/ClientRedemptionsRedeemRequestBody';
+import ClientRedemptionsRedeemResponseBody from '../model/ClientRedemptionsRedeemResponseBody';
+import ClientEventsCreateRequestBody from '../model/ClientEventsCreateRequestBody';
+import ClientEventsCreateResponseBody from '../model/ClientEventsCreateResponseBody';
+import ClientValidationsValidateRequestBody from '../model/ClientValidationsValidateRequestBody';
+import ClientValidationsValidateResponseBody from '../model/ClientValidationsValidateResponseBody';