@voucherify/sdk 3.0.0 → 3.0.2

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

@@ -0,0 +1,305 @@
+/**
+* Products service.
+* @module api/ProductsApi
+* @version 3.0.2
+*/
+export default class ProductsApi {
+    /**
+    * Constructs a new ProductsApi.
+    * @alias ProductsApi
+    * @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 createProduct operation.
+     * @callback createProductCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Product
+     * Creates a product object.  📘 Upsert Mode  If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields.
+     * @param {ProductsCreateRequestBody} productsCreateRequestBody Specify the product parameters.
+     * @param {createProductCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsCreateResponseBody}
+     * @returns {Promise<(ProductsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsCreateResponseBody` object or with `undefined`.
+     */
+    createProduct(productsCreateRequestBody: ProductsCreateRequestBody, callback?: (error: Error | null, data?: ProductsCreateResponseBody, response?: any) => any): Promise<(ProductsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the createSku operation.
+     * @callback createSkuCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsSkusCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create SKU
+     * This method adds product variants to a [created product](/api-reference/products/create-product).   📘 Upsert Mode  If you pass an id or a source_id that already exists in the sku database, Voucherify will return a related sku object with updated fields.
+     * @param {String} productId A Voucherify [product](/api-reference/products/get-product) ID or product source ID.
+     * @param {ProductsSkusCreateRequestBody} productsSkusCreateRequestBody Specify the SKU parameters to be created.
+     * @param {createSkuCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsSkusCreateResponseBody}
+     * @returns {Promise<(ProductsSkusCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsSkusCreateResponseBody` object or with `undefined`.
+     */
+    createSku(productId: string, productsSkusCreateRequestBody: ProductsSkusCreateRequestBody, callback?: (error: Error | null, data?: ProductsSkusCreateResponseBody, response?: any) => any): Promise<(ProductsSkusCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deleteProduct operation.
+     * @callback deleteProductCallback
+     * @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 Product
+     * Deletes a product and all related SKUs. This operation cannot be undone.  If the force parameter is set to false or not set at all, the product and all related SKUs will be moved to [the bin](/api-reference/bin/list-bin-entries).
+     * @param {String} productId A Voucherify product ID or source ID.
+     * @param {{
+        force?: Boolean,
+     }} [opts] Optional parameters
+     * @param {deleteProductCallback} [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`.
+     */
+    deleteProduct(productId: string, opts?: {
+        force?: boolean;
+    }, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the deleteSku operation.
+     * @callback deleteSkuCallback
+     * @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 SKU
+     * Deletes a product SKU. This operation cannot be undone.  If the force parameter is set to false or not set at all, the SKU will be moved to [the bin](/api-reference/bin/list-bin-entries).
+     * @param {String} productId A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID.
+     * @param {String} skuId A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID.
+     * @param {{
+        force?: Boolean,
+     }} [opts] Optional parameters
+     * @param {deleteSkuCallback} [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`.
+     */
+    deleteSku(productId: string, skuId: string, opts?: {
+        force?: boolean;
+    }, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the getProduct operation.
+     * @callback getProductCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Product
+     * Retrieve details of a given product and its SKUs, if any.
+     * @param {String} productId A Voucherify product ID or source ID.
+     * @param {getProductCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsGetResponseBody}
+     * @returns {Promise<(ProductsGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsGetResponseBody` object or with `undefined`.
+     */
+    getProduct(productId: string, callback?: (error: Error | null, data?: ProductsGetResponseBody, response?: any) => any): Promise<(ProductsGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getSku operation.
+     * @callback getSkuCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {SkusGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get SKU
+     * Retrieve details of a SKU.
+     * @param {String} skuId A Voucherify SKU identifier or SKU source ID.
+     * @param {getSkuCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link SkusGetResponseBody}
+     * @returns {Promise<(SkusGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `SkusGetResponseBody` object or with `undefined`.
+     */
+    getSku(skuId: string, callback?: (error: Error | null, data?: SkusGetResponseBody, response?: any) => any): Promise<(SkusGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importProductsUsingCsv operation.
+     * @callback importProductsUsingCsvCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsImportCsvCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Import Products using CSV
+     * Import products into the repository using a CSV file. The CSV file has to include headers in the first line.  📘 Standard product fields mapping  - Create a **comma separated value (CSV) file** or download our CSV import template. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b82ed68d51e779443f550/Import_products_template.csv).  - Supported CSV file headers: name,source_id,price,attributes,image_url,Metadata_property_name  - **Name** is a **required** field. The remaining fields in the CSV template are optional.  - Override/Update products **names** in Voucherify using this method. Data will be updated for each product included in the CSV file whose **source_id** matches a source ID in Voucherify. No other data can be updated other than the product name.  - Note that dates and date-time attributes need to be provided in compliance with the **ISO 8601 norms**. For example, 2022-03-11T09:00:00.000Z or 2022-03-11     - YYYY-MM-DD     - YYYY-MM-DDTHH     - YYYY-MM-DDTHH:mm     - YYYY-MM-DDTHH:mm:ss     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ss.SSSZ  - Columns that cannot be mapped to standard fields, will be mapped to **Custom attributes** and added as **products metadata**. There is no limit on the number of custom attributes that you can import as metadata.   - To provide the proper data type, you need to add all custom attributes to the metadata schema **before importing the file**. Read more [here](https://support.voucherify.io/article/99-schema-validation-metadata#add-metadata).  - **Product attributes** (not custom attributes) need to be separated by a comma and enclosed in double quotes, i.e attribute1,attribute2.  - Headers with metadata names **cant contain white-space characters**.  - If you import metadata defined in the schema as **arrays (multiple)**, you need to separate each value using a comma, for example:       - array of strings: subscribed,premium       - array of numbers: 123,234.      - array of dates: 2000-01-01,2000-01-02 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 {{
+        file?: File,
+     }} [opts] Optional parameters
+     * @param {importProductsUsingCsvCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsImportCsvCreateResponseBody}
+     * @returns {Promise<(ProductsImportCsvCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsImportCsvCreateResponseBody` object or with `undefined`.
+     */
+    importProductsUsingCsv(opts?: {
+        file?: File;
+    }, callback?: (error: Error | null, data?: ProductsImportCsvCreateResponseBody, response?: any) => any): Promise<(ProductsImportCsvCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importSKUsUsingCsv operation.
+     * @callback importSKUsUsingCsvCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {SkusImportCsvCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Import SKUs using CSV
+     * Import SKUs into the repository using a CSV file. The CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b98d08c9b585083488a4c/Import_SKUS_template.csv).   🚧 Import sequence  First import products using the [dedicated endpoint](/api-reference/products/import-products-using-csv), then import SKUs using this endpoint to properly match SKUs to products.  📘 Standard SKU fields mapping  - **Required** fields are source_id and product_id.  - Supported CSV file headers: product_id,sku,source_id,price,image_url,attributes  - SKU **source_id** must be unique in the entire product catalog, no duplicates are allowed.  - SKU attributes need to be in the form of a stringy-fied json, i.e.{color:blue}. These attributes must be defined in the **product** beforehand so you can import them to the SKU.  - You can use this method to update the following parameters in bulk: **sku** and the sku **price**.  - Columns that cannot be mapped to standard fields will be mapped to Custom attributes and added as product metadata. There is no limit on the number of custom attributes that you can import as metadata. 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 {{
+        file?: File,
+     }} [opts] Optional parameters
+     * @param {importSKUsUsingCsvCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link SkusImportCsvCreateResponseBody}
+     * @returns {Promise<(SkusImportCsvCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `SkusImportCsvCreateResponseBody` object or with `undefined`.
+     */
+    importSKUsUsingCsv(opts?: {
+        file?: File;
+    }, callback?: (error: Error | null, data?: SkusImportCsvCreateResponseBody, response?: any) => any): Promise<(SkusImportCsvCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listProducts operation.
+     * @callback listProductsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Products
+     * Retrieve a list of products.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrder, "prototype" | "constructFromObject">,
+        startDate?: Date,
+        endDate?: Date,
+     }} [opts] Optional parameters
+     * @param {listProductsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsListResponseBody}
+     * @returns {Promise<(ProductsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsListResponseBody` object or with `undefined`.
+     */
+    listProducts(opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrder, "prototype" | "constructFromObject">;
+        startDate?: Date;
+        endDate?: Date;
+    }, callback?: (error: Error | null, data?: ProductsListResponseBody, response?: any) => any): Promise<(ProductsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listSKUsInProduct operation.
+     * @callback listSKUsInProductCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsSkusListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List SKUs in Product
+     * Retrieve all SKUs for a given product.
+     * @param {String} productId A Voucherify [product](/api-reference/products/get-product) ID or product source ID.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrder, "prototype" | "constructFromObject">,
+        startDate?: Date,
+        endDate?: Date,
+     }} [opts] Optional parameters
+     * @param {listSKUsInProductCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsSkusListResponseBody}
+     * @returns {Promise<(ProductsSkusListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsSkusListResponseBody` object or with `undefined`.
+     */
+    listSKUsInProduct(productId: string, opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrder, "prototype" | "constructFromObject">;
+        startDate?: Date;
+        endDate?: Date;
+    }, callback?: (error: Error | null, data?: ProductsSkusListResponseBody, response?: any) => any): Promise<(ProductsSkusListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateProduct operation.
+     * @callback updateProductCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Product
+     * Updates the specified product by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.
+     * @param {String} productId A Voucherify product ID or source ID.
+     * @param {ProductsUpdateRequestBody} productsUpdateRequestBody Specify the parameters of the product that are to be updated.
+     * @param {updateProductCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsUpdateResponseBody}
+     * @returns {Promise<(ProductsUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsUpdateResponseBody` object or with `undefined`.
+     */
+    updateProduct(productId: string, productsUpdateRequestBody: ProductsUpdateRequestBody, callback?: (error: Error | null, data?: ProductsUpdateResponseBody, response?: any) => any): Promise<(ProductsUpdateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateProductsInBulk operation.
+     * @callback updateProductsInBulkCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsUpdateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Products in Bulk
+     * Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
+     * @param {Array.<ProductsUpdateInBulkRequestBody>} productsUpdateInBulkRequestBody List the product fields to be updated in each product object.
+     * @param {updateProductsInBulkCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsUpdateInBulkResponseBody}
+     * @returns {Promise<(ProductsUpdateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsUpdateInBulkResponseBody` object or with `undefined`.
+     */
+    updateProductsInBulk(productsUpdateInBulkRequestBody: Array<ProductsUpdateInBulkRequestBody>, callback?: (error: Error | null, data?: ProductsUpdateInBulkResponseBody, response?: any) => any): Promise<(ProductsUpdateInBulkResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateProductsMetadataInBulk operation.
+     * @callback updateProductsMetadataInBulkCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsMetadataUpdateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Products' Metadata in Bulk
+     * Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
+     * @param {ProductsMetadataUpdateInBulkRequestBody} productsMetadataUpdateInBulkRequestBody List the source_ids of the products you would like to update with the metadata key/value pairs.
+     * @param {updateProductsMetadataInBulkCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsMetadataUpdateInBulkResponseBody}
+     * @returns {Promise<(ProductsMetadataUpdateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsMetadataUpdateInBulkResponseBody` object or with `undefined`.
+     */
+    updateProductsMetadataInBulk(productsMetadataUpdateInBulkRequestBody: ProductsMetadataUpdateInBulkRequestBody, callback?: (error: Error | null, data?: ProductsMetadataUpdateInBulkResponseBody, response?: any) => any): Promise<(ProductsMetadataUpdateInBulkResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateSku operation.
+     * @callback updateSkuCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ProductsSkusUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update SKU
+     * Updates the specified SKU 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 schema wont be modified. Even if provided, they will be silently skipped.
+     * @param {String} productId A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID.
+     * @param {String} skuId A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID.
+     * @param {ProductsSkusUpdateRequestBody} productsSkusUpdateRequestBody Specify the parameters to be updated.
+     * @param {updateSkuCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ProductsSkusUpdateResponseBody}
+     * @returns {Promise<(ProductsSkusUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ProductsSkusUpdateResponseBody` object or with `undefined`.
+     */
+    updateSku(productId: string, skuId: string, productsSkusUpdateRequestBody: ProductsSkusUpdateRequestBody, callback?: (error: Error | null, data?: ProductsSkusUpdateResponseBody, response?: any) => any): Promise<(ProductsSkusUpdateResponseBody | undefined)>;
+}
+import ProductsCreateRequestBody from '../model/ProductsCreateRequestBody';
+import ProductsCreateResponseBody from '../model/ProductsCreateResponseBody';
+import ProductsSkusCreateRequestBody from '../model/ProductsSkusCreateRequestBody';
+import ProductsSkusCreateResponseBody from '../model/ProductsSkusCreateResponseBody';
+import ProductsGetResponseBody from '../model/ProductsGetResponseBody';
+import SkusGetResponseBody from '../model/SkusGetResponseBody';
+import ProductsImportCsvCreateResponseBody from '../model/ProductsImportCsvCreateResponseBody';
+import SkusImportCsvCreateResponseBody from '../model/SkusImportCsvCreateResponseBody';
+import ParameterOrder from '../model/ParameterOrder';
+import ProductsListResponseBody from '../model/ProductsListResponseBody';
+import ProductsSkusListResponseBody from '../model/ProductsSkusListResponseBody';
+import ProductsUpdateRequestBody from '../model/ProductsUpdateRequestBody';
+import ProductsUpdateResponseBody from '../model/ProductsUpdateResponseBody';
+import ProductsUpdateInBulkRequestBody from '../model/ProductsUpdateInBulkRequestBody';
+import ProductsUpdateInBulkResponseBody from '../model/ProductsUpdateInBulkResponseBody';
+import ProductsMetadataUpdateInBulkRequestBody from '../model/ProductsMetadataUpdateInBulkRequestBody';
+import ProductsMetadataUpdateInBulkResponseBody from '../model/ProductsMetadataUpdateInBulkResponseBody';
+import ProductsSkusUpdateRequestBody from '../model/ProductsSkusUpdateRequestBody';
+import ProductsSkusUpdateResponseBody from '../model/ProductsSkusUpdateResponseBody';

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

@@ -0,0 +1,285 @@
+/**
+* Promotions service.
+* @module api/PromotionsApi
+* @version 3.0.2
+*/
+export default class PromotionsApi {
+    /**
+    * Constructs a new PromotionsApi.
+    * @alias PromotionsApi
+    * @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 addPromotionTierToCampaign operation.
+     * @callback addPromotionTierToCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Add Promotion Tier to Campaign
+     * This method allows you to add a new promotion tier to an existing campaign. The tier hierarchy will be set as the next consequtive integer following the lowest ranking tier.
+     * @param {String} campaignId Unique campaign ID assigned by Voucherify.
+     * @param {PromotionsTiersCreateRequestBody} promotionsTiersCreateRequestBody Specify the promotion tier parameters.
+     * @param {addPromotionTierToCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersCreateResponseBody}
+     * @returns {Promise<(PromotionsTiersCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersCreateResponseBody` object or with `undefined`.
+     */
+    addPromotionTierToCampaign(campaignId: string, promotionsTiersCreateRequestBody: PromotionsTiersCreateRequestBody, callback?: (error: Error | null, data?: PromotionsTiersCreateResponseBody, response?: any) => any): Promise<(PromotionsTiersCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the createPromotionStack operation.
+     * @callback createPromotionStackCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsStacksCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Promotion Stack
+     * This method creates one promotion stack. The sequence of promotion tier IDs will determine the promotion stacking order.
+     * @param {String} campaignId Unique campaign ID.
+     * @param {PromotionsStacksCreateRequestBody} promotionsStacksCreateRequestBody Specify the order of promotion tiers for the promotion stack.
+     * @param {createPromotionStackCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsStacksCreateResponseBody}
+     * @returns {Promise<(PromotionsStacksCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsStacksCreateResponseBody` object or with `undefined`.
+     */
+    createPromotionStack(campaignId: string, promotionsStacksCreateRequestBody: PromotionsStacksCreateRequestBody, callback?: (error: Error | null, data?: PromotionsStacksCreateResponseBody, response?: any) => any): Promise<(PromotionsStacksCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deletePromotionStack operation.
+     * @callback deletePromotionStackCallback
+     * @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 Promotion Stack
+     * This method deletes a promotion stack.
+     * @param {String} campaignId ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign.
+     * @param {String} stackId Promotion stack ID.
+     * @param {deletePromotionStackCallback} [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`.
+     */
+    deletePromotionStack(campaignId: string, stackId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the deletePromotionTier operation.
+     * @callback deletePromotionTierCallback
+     * @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 Promotion Tier
+     * This method deletes a promotion tier.
+     * @param {String} promotionTierId Unique promotion tier ID.
+     * @param {deletePromotionTierCallback} [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`.
+     */
+    deletePromotionTier(promotionTierId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the disablePromotionTier operation.
+     * @callback disablePromotionTierCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersDisableResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Disable Promotion Tier
+     * This method disables a promotion tier, i.e. makes the active parameter   false.
+     * @param {String} promotionTierId Unique promotion tier ID.
+     * @param {disablePromotionTierCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersDisableResponseBody}
+     * @returns {Promise<(PromotionsTiersDisableResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersDisableResponseBody` object or with `undefined`.
+     */
+    disablePromotionTier(promotionTierId: string, callback?: (error: Error | null, data?: PromotionsTiersDisableResponseBody, response?: any) => any): Promise<(PromotionsTiersDisableResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the enablePromotionTier operation.
+     * @callback enablePromotionTierCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersEnableResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Enable Promotion Tier
+     * This method enables a promotion tier, i.e. makes the active parameter   true.
+     * @param {String} promotionTierId Unique promotion tier ID.
+     * @param {enablePromotionTierCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersEnableResponseBody}
+     * @returns {Promise<(PromotionsTiersEnableResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersEnableResponseBody` object or with `undefined`.
+     */
+    enablePromotionTier(promotionTierId: string, callback?: (error: Error | null, data?: PromotionsTiersEnableResponseBody, response?: any) => any): Promise<(PromotionsTiersEnableResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getPromotionStack operation.
+     * @callback getPromotionStackCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsStacksGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Promotion Stack
+     * This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.
+     * @param {String} campaignId ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign.
+     * @param {String} stackId Promotion stack ID.
+     * @param {getPromotionStackCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsStacksGetResponseBody}
+     * @returns {Promise<(PromotionsStacksGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsStacksGetResponseBody` object or with `undefined`.
+     */
+    getPromotionStack(campaignId: string, stackId: string, callback?: (error: Error | null, data?: PromotionsStacksGetResponseBody, response?: any) => any): Promise<(PromotionsStacksGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getPromotionTier operation.
+     * @callback getPromotionTierCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Promotion Tier
+     * This method enables you to retrieve a specific promotion tier.
+     * @param {String} promotionTierId Unique promotion tier ID.
+     * @param {getPromotionTierCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersGetResponseBody}
+     * @returns {Promise<(PromotionsTiersGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersGetResponseBody` object or with `undefined`.
+     */
+    getPromotionTier(promotionTierId: string, callback?: (error: Error | null, data?: PromotionsTiersGetResponseBody, response?: any) => any): Promise<(PromotionsTiersGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listAllPromotionStacks operation.
+     * @callback listAllPromotionStacksCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsStacksListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Promotion Stacks
+     * This method enables you to list promotion stacks irrespective of the campaign they are associated with.  You can use filters in the query parameters to specify the stacks to be returned in the response. # Advanced filters for fetching promotion stacks
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListAllPromotionStacks, "prototype" | "constructFromObject">,
+        createdAt?: ParameterCreatedBeforeAfter,
+        updatedAt?: ParameterUpdatedBeforeAfter,
+     }} [opts] Optional parameters
+     * @param {listAllPromotionStacksCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsStacksListResponseBody}
+     * @returns {Promise<(PromotionsStacksListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsStacksListResponseBody` object or with `undefined`.
+     */
+    listAllPromotionStacks(opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListAllPromotionStacks, "prototype" | "constructFromObject">;
+        createdAt?: ParameterCreatedBeforeAfter;
+        updatedAt?: ParameterUpdatedBeforeAfter;
+    }, callback?: (error: Error | null, data?: PromotionsStacksListResponseBody, response?: any) => any): Promise<(PromotionsStacksListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listPromotionStacksInCampaign operation.
+     * @callback listPromotionStacksInCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsStacksListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Promotion Stacks in Campaign
+     * This method enables you to list promotion stacks from a specified campaign.
+     * @param {String} campaignId Unique campaign ID.
+     * @param {listPromotionStacksInCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsStacksListResponseBody}
+     * @returns {Promise<(PromotionsStacksListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsStacksListResponseBody` object or with `undefined`.
+     */
+    listPromotionStacksInCampaign(campaignId: string, callback?: (error: Error | null, data?: PromotionsStacksListResponseBody, response?: any) => any): Promise<(PromotionsStacksListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listPromotionTiers operation.
+     * @callback listPromotionTiersCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Promotion Tiers
+     * This method enables you to list promotion tiers.
+     * @param {{
+        isAvailable?: Boolean,
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListPromotionTiers, "prototype" | "constructFromObject">,
+     }} [opts] Optional parameters
+     * @param {listPromotionTiersCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersListResponseBody}
+     * @returns {Promise<(PromotionsTiersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersListResponseBody` object or with `undefined`.
+     */
+    listPromotionTiers(opts?: {
+        isAvailable?: boolean;
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListPromotionTiers, "prototype" | "constructFromObject">;
+    }, callback?: (error: Error | null, data?: PromotionsTiersListResponseBody, response?: any) => any): Promise<(PromotionsTiersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listPromotionTiersFromCampaign operation.
+     * @callback listPromotionTiersFromCampaignCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Promotion Tiers from Campaign
+     * This method enables you to list promotion tiers from a specified campaign.
+     * @param {String} campaignId Unique campaign ID assigned by Voucherify.
+     * @param {listPromotionTiersFromCampaignCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersListResponseBody}
+     * @returns {Promise<(PromotionsTiersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersListResponseBody` object or with `undefined`.
+     */
+    listPromotionTiersFromCampaign(campaignId: string, callback?: (error: Error | null, data?: PromotionsTiersListResponseBody, response?: any) => any): Promise<(PromotionsTiersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updatePromotionStack operation.
+     * @callback updatePromotionStackCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsStacksUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Promotion Stack
+     * This methods allows for editing an existing stack.
+     * @param {String} campaignId ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign.
+     * @param {String} stackId Promotion stack ID.
+     * @param {PromotionsStacksUpdateRequestBody} promotionsStacksUpdateRequestBody Specify the promotion stack parameters that you would like to update.
+     * @param {updatePromotionStackCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsStacksUpdateResponseBody}
+     * @returns {Promise<(PromotionsStacksUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsStacksUpdateResponseBody` object or with `undefined`.
+     */
+    updatePromotionStack(campaignId: string, stackId: string, promotionsStacksUpdateRequestBody: PromotionsStacksUpdateRequestBody, callback?: (error: Error | null, data?: PromotionsStacksUpdateResponseBody, response?: any) => any): Promise<(PromotionsStacksUpdateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updatePromotionTier operation.
+     * @callback updatePromotionTierCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PromotionsTiersUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Promotion Tier
+     * This method updates a promotion tier.
+     * @param {String} promotionTierId Unique promotion tier ID.
+     * @param {PromotionsTiersUpdateRequestBody} promotionsTiersUpdateRequestBody Specify the promotion tier parameters that you would like to update.
+     * @param {updatePromotionTierCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PromotionsTiersUpdateResponseBody}
+     * @returns {Promise<(PromotionsTiersUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PromotionsTiersUpdateResponseBody` object or with `undefined`.
+     */
+    updatePromotionTier(promotionTierId: string, promotionsTiersUpdateRequestBody: PromotionsTiersUpdateRequestBody, callback?: (error: Error | null, data?: PromotionsTiersUpdateResponseBody, response?: any) => any): Promise<(PromotionsTiersUpdateResponseBody | undefined)>;
+}
+import PromotionsTiersCreateRequestBody from '../model/PromotionsTiersCreateRequestBody';
+import PromotionsTiersCreateResponseBody from '../model/PromotionsTiersCreateResponseBody';
+import PromotionsStacksCreateRequestBody from '../model/PromotionsStacksCreateRequestBody';
+import PromotionsStacksCreateResponseBody from '../model/PromotionsStacksCreateResponseBody';
+import PromotionsTiersDisableResponseBody from '../model/PromotionsTiersDisableResponseBody';
+import PromotionsTiersEnableResponseBody from '../model/PromotionsTiersEnableResponseBody';
+import PromotionsStacksGetResponseBody from '../model/PromotionsStacksGetResponseBody';
+import PromotionsTiersGetResponseBody from '../model/PromotionsTiersGetResponseBody';
+import ParameterOrderListAllPromotionStacks from '../model/ParameterOrderListAllPromotionStacks';
+import ParameterCreatedBeforeAfter from '../model/ParameterCreatedBeforeAfter';
+import ParameterUpdatedBeforeAfter from '../model/ParameterUpdatedBeforeAfter';
+import PromotionsStacksListResponseBody from '../model/PromotionsStacksListResponseBody';
+import ParameterOrderListPromotionTiers from '../model/ParameterOrderListPromotionTiers';
+import PromotionsTiersListResponseBody from '../model/PromotionsTiersListResponseBody';
+import PromotionsStacksUpdateRequestBody from '../model/PromotionsStacksUpdateRequestBody';
+import PromotionsStacksUpdateResponseBody from '../model/PromotionsStacksUpdateResponseBody';
+import PromotionsTiersUpdateRequestBody from '../model/PromotionsTiersUpdateRequestBody';
+import PromotionsTiersUpdateResponseBody from '../model/PromotionsTiersUpdateResponseBody';