@voucherify/sdk 2.9.3 → 3.0.0

package/docs/AccessSettings.md

@@ -0,0 +1,10 @@
+# Voucherify.AccessSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assign** | [**AccessSettingsAssign**](AccessSettingsAssign.md) |  | [optional] 
+**unassign** | [**AccessSettingsUnassign**](AccessSettingsUnassign.md) |  | [optional] 
+
+

package/docs/AccessSettingsAssign.md

@@ -0,0 +1,11 @@
+# Voucherify.AccessSettingsAssign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**areasIds** | **[String]** | List all area IDs to which the campaign will be assigned. | [optional] 
+**areaStoresIds** | **[String]** | List all store IDs to which the campaign will be assigned. | [optional] 
+**areaAllStoresIds** | **[String]** | List all area IDs where the campaign is assigned to all stores in the area. This assignment is not equal to the assignment to all `area_stores_ids` listed separately. | [optional] 
+
+

package/docs/AccessSettingsCampaignAssignmentsList.md

@@ -0,0 +1,30 @@
+# Voucherify.AccessSettingsCampaignAssignmentsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. Default is `list`. This object stores information about campaign assignments to areas and stores | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of campaign assignments. | [optional] [default to 'data']
+**data** | [**[AreaStoreCampaignAssignment]**](AreaStoreCampaignAssignment.md) | Contains an array of campaign assignments. | [optional] 
+**total** | **Number** | Total number of areas and stores to which the campaign is assigned. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/AccessSettingsUnassign.md

@@ -0,0 +1,11 @@
+# Voucherify.AccessSettingsUnassign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**areasIds** | **[String]** | List all area IDs from which the campaign will be unassigned. | [optional] 
+**areaStoresIds** | **[String]** | List all store IDs from which the campaign will be unassigned. | [optional] 
+**areaAllStoresIds** | **[String]** | List all area IDs where the campaign will be unassigned from all stores in the area. This unassignment is not equal to the unassignment from all `area_stores_ids` listed separately. | [optional] 
+
+

package/docs/ApplicableTo.md

@@ -0,0 +1,49 @@
+# Voucherify.ApplicableTo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | This object stores information about the resource to which the discount is applicable. | [optional] 
+**id** | **String** | Unique product collection, product, or SKU identifier assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The source identifier from your inventory system. | [optional] 
+**productId** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] 
+**productSourceId** | **String** | Parent product's source ID from your inventory system. | [optional] 
+**price** | **Number** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. | [optional] 
+**priceFormula** | **Number** | Formula used to dynamically calculate the discounted price of an item. | [optional] 
+**effect** | [**ApplicableToEffect**](ApplicableToEffect.md) |  | 
+**quantityLimit** | **Number** | The maximum number of units allowed to be discounted per order line item. | [optional] 
+**aggregatedQuantityLimit** | **Number** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] 
+**amountLimit** | **Number** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] 
+**aggregatedAmountLimit** | **Number** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] 
+**orderItemIndices** | **[Number]** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional] 
+**orderItemUnits** | [**[ApplicableToOrderItemUnitsItem]**](ApplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request. | [optional] 
+**repeat** | **Number** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] 
+**skipInitially** | **Number** | Determines how many items are skipped before the discount is applied. | [optional] 
+**target** | **String** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+* `products_collection` (value: `"products_collection"`)
+
+
+
+
+
+## Enum: TargetEnum
+
+
+* `ITEM` (value: `"ITEM"`)
+
+* `UNIT` (value: `"UNIT"`)
+
+
+
+

package/docs/ApplicableToEffect.md

@@ -0,0 +1,16 @@
+# Voucherify.ApplicableToEffect
+
+## Enum
+
+
+* `APPLY_TO_EVERY` (value: `"APPLY_TO_EVERY"`)
+
+* `APPLY_TO_CHEAPEST` (value: `"APPLY_TO_CHEAPEST"`)
+
+* `APPLY_FROM_CHEAPEST` (value: `"APPLY_FROM_CHEAPEST"`)
+
+* `APPLY_TO_MOST_EXPENSIVE` (value: `"APPLY_TO_MOST_EXPENSIVE"`)
+
+* `APPLY_FROM_MOST_EXPENSIVE` (value: `"APPLY_FROM_MOST_EXPENSIVE"`)
+
+

package/docs/ApplicableToOrderItemUnitsItem.md

@@ -0,0 +1,11 @@
+# Voucherify.ApplicableToOrderItemUnitsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Number** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] 
+**units** | **[Number]** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units. | [optional] 
+**unitsLimitExceeded** | **Boolean** | Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000. | [optional] 
+
+

package/docs/ApplicableToResultList.md

@@ -0,0 +1,30 @@
+# Voucherify.ApplicableToResultList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[ApplicableTo]**](ApplicableTo.md) | Contains array of items to which the discount can apply. | [optional] 
+**total** | **Number** | Total number of objects defining included products, SKUs, or product collections. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'list']
+**dataRef** | **String** | The type of the object represented by JSON. | [optional] [default to 'data']
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/ApplicationDetailsItem.md

@@ -0,0 +1,15 @@
+# Voucherify.ApplicationDetailsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceIndex** | **Number** | Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`. | [optional] 
+**sourceAppliedQuantity** | **Number** | Number of source units that are replaced. | [optional] 
+**sourceAppliedQuantityAmount** | **Number** | Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity. | [optional] 
+**targetIndex** | **Number** | Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, `target_index` equals `3`, as enumeration starts from `0`. | [optional] 
+**targetAppliedQuantity** | **Number** | Number of added target units that are replacements. | [optional] 
+**targetAppliedQuantityAmount** | **Number** | Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity. | [optional] 
+**targetAppliedDiscountAmount** | **Number** | Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`. | [optional] 
+
+

package/docs/AreaStoreCampaignAssignment.md

@@ -0,0 +1,23 @@
+# Voucherify.AreaStoreCampaignAssignment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the campaign assignment. | [optional] 
+**areaId** | **String** | Unique identifier of the area to which the campaign is assigned. | [optional] 
+**allStores** | **Boolean** | Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the `access_settings.assign.area_all_stores_ids` in the request. | [optional] 
+**areaStoreId** | **String** | Unique identifier of the store to which the campaign is assigned. | [optional] 
+**createdAt** | **Date** | Date and time when the assignment was made. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores. | [optional] [default to 'area_store_campaign_assignment']
+
+
+
+## Enum: ObjectEnum
+
+
+* `area_store_campaign_assignment` (value: `"area_store_campaign_assignment"`)
+
+
+
+

package/docs/AsyncActionBase.md

@@ -0,0 +1,55 @@
+# Voucherify.AsyncActionBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Async action unique ID. | [optional] 
+**type** | **String** | Type of async action. | [optional] 
+**status** | **String** | Status of the async action. Informs you whether the async action has already been completed. | [optional] 
+**operationStatus** | **String** | Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the async action was scheduled in ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format. | [optional] 
+**requestId** | **String** | Unique request ID. | [optional] 
+**processingTime** | **Number** | The length of time it took to process the request in milliseconds. | [optional] 
+**progress** | **Number** | % progress to completion of the asynchronous action. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the `async_action`. | [optional] [default to 'async_action']
+
+
+
+## Enum: StatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `ENQUEUED` (value: `"ENQUEUED"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+
+
+
+
+## Enum: OperationStatusEnum
+
+
+* `FAILED` (value: `"FAILED"`)
+
+* `SUCCESS` (value: `"SUCCESS"`)
+
+* `UNKNOWN` (value: `"UNKNOWN"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `async_action` (value: `"async_action"`)
+
+
+
+

package/docs/AsyncActionGetResponseBody.md

@@ -0,0 +1,56 @@
+# Voucherify.AsyncActionGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Async action unique ID. | [optional] 
+**type** | **String** | Type of async action. | [optional] 
+**status** | **String** | Status of the async action. Informs you whether the async action has already been completed. | [optional] 
+**operationStatus** | **String** | Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the async action was scheduled in ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format. | [optional] 
+**requestId** | **String** | Unique request ID. | [optional] 
+**processingTime** | **Number** | The length of time it took to process the request in milliseconds. | [optional] 
+**progress** | **Number** | % progress to completion of the asynchronous action. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the `async_action`. | [optional] [default to 'async_action']
+**result** | **Object** |  | [optional] 
+
+
+
+## Enum: StatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `ENQUEUED` (value: `"ENQUEUED"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+
+
+
+
+## Enum: OperationStatusEnum
+
+
+* `FAILED` (value: `"FAILED"`)
+
+* `SUCCESS` (value: `"SUCCESS"`)
+
+* `UNKNOWN` (value: `"UNKNOWN"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `async_action` (value: `"async_action"`)
+
+
+
+

package/docs/AsyncActionsApi.md

@@ -0,0 +1,132 @@
+# Voucherify.AsyncActionsApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getAsyncAction**](AsyncActionsApi.md#getAsyncAction) | **GET** /v1/async-actions/{asyncActionId} | Get Async Action
+[**listAsyncActions**](AsyncActionsApi.md#listAsyncActions) | **GET** /v1/async-actions | List Async Actions
+
+
+
+## getAsyncAction
+
+> AsyncActionGetResponseBody getAsyncAction(asyncActionId)
+
+Get Async Action
+
+Check the result of a scheduled asynchronous operation.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).       
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.AsyncActionsApi();
+let asyncActionId = "asyncActionId_example"; // String | Unique ID of the asynchronous operation.
+apiInstance.getAsyncAction(asyncActionId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asyncActionId** | **String**| Unique ID of the asynchronous operation. | 
+
+### Return type
+
+[**AsyncActionGetResponseBody**](AsyncActionGetResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listAsyncActions
+
+> AsyncActionsListResponseBody listAsyncActions(opts)
+
+List Async Actions
+
+Track asynchronous operations scheduled in your project.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).       
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.AsyncActionsApi();
+let opts = {
+  'limit': 56, // Number | Limit the number of asynchronous actions that the API returns in the response.
+  'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). 
+};
+apiInstance.listAsyncActions(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| Limit the number of asynchronous actions that the API returns in the response. | [optional] 
+ **endDate** | **Date**| Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).  | [optional] 
+
+### Return type
+
+[**AsyncActionsListResponseBody**](AsyncActionsListResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/AsyncActionsListResponseBody.md

@@ -0,0 +1,30 @@
+# Voucherify.AsyncActionsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about asynchronous actions. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the JSON property that contains the array of asynchronous actions. | [optional] [default to 'async_actions']
+**asyncActions** | [**[AsyncActionBase]**](AsyncActionBase.md) |  | [optional] 
+**hasMore** | **Boolean** | As query results are always limited by parameters, the `has_more` flag indicates if there are more records available. This lets you know if you can run another request to get more records returned in the results. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `async_actions` (value: `"async_actions"`)
+
+
+
+

package/docs/BinApi.md

@@ -0,0 +1,136 @@
+# Voucherify.BinApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**deleteBinEntry**](BinApi.md#deleteBinEntry) | **DELETE** /v1/trash-bin/{binEntryId} | Delete Bin Entry
+[**listBinEntries**](BinApi.md#listBinEntries) | **GET** /v1/trash-bin | List Bin Entries
+
+
+
+## deleteBinEntry
+
+> deleteBinEntry(binEntryId)
+
+Delete Bin Entry
+
+Deletes permanently a bin entry with a given ID.The following resources can be moved to the bin and permanently deleted: - campaigns - vouchers - products - SKUs To use this endpoint and delete a given resource type, you must have the following permissions: - vouchers.delete to delete a voucher, - campaigns.delete to delete a campaign, - products.delete to delete a product or SKU.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.BinApi();
+let binEntryId = "binEntryId_example"; // String | Provide the unique identifier of the bin entry.
+apiInstance.deleteBinEntry(binEntryId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **binEntryId** | **String**| Provide the unique identifier of the bin entry. | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## listBinEntries
+
+> TrashBinListResponseBody listBinEntries(opts)
+
+List Bin Entries
+
+Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.BinApi();
+let opts = {
+  'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
+  'order': new Voucherify.ParameterOrderListBin(), // ParameterOrderListBin | Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
+  'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
+  'filters': new Voucherify.ParameterFiltersListBin() // ParameterFiltersListBin | Filters for listing bin entries.
+};
+apiInstance.listBinEntries(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] 
+ **order** | [**ParameterOrderListBin**](.md)| Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] 
+ **filters** | [**ParameterFiltersListBin**](.md)| Filters for listing bin entries. | [optional] 
+
+### Return type
+
+[**TrashBinListResponseBody**](TrashBinListResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/Bundle.md

@@ -0,0 +1,12 @@
+# Voucherify.Bundle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | Determines how many bundles are qualified. If there are missing bundle products, the value is `0`. If the bundle is qualified, the value is `1`. The maximum number of identified bundles can equal the number set in `limit`. Also defines the multiplier of the discount for `AMOUNT`, `PERCENT`, and `UNIT` discount types. To inform end-customers that more products can be added to meet additional bundles, compare this parameter with `limit`. | [optional] 
+**limit** | **Number** | Determines the maximum number of identified bundles. This also defines the maximum multiplier of the bundle discount. | [optional] 
+**identified** | [**[BundleIdentifiedItem]**](BundleIdentifiedItem.md) | Determines products from the customer's order items that meet bundle conditions. SKUs meet the conditions for their product that is used in the bundle. Returns only the products and their quantity that meet the bundle. | [optional] 
+**missing** | [**[BundleMissingItem]**](BundleMissingItem.md) | Determines products, SKUs, or collections from the bundle that are missing in the customer's order items. Determines also the missing quantity. For collections, this means that order items do not include a sufficient number of items that belong to the collection. Not returned when all required bundle items are in the order. | [optional] 
+
+