@voucherify/sdk 2.9.3 → 3.0.0

package/docs/ClientSideApi.md

@@ -0,0 +1,324 @@
+# Voucherify.ClientSideApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**checkEligibilityClientSide**](ClientSideApi.md#checkEligibilityClientSide) | **POST** /client/v1/qualifications | Check Eligibility (client-side)
+[**listPromotionTiersClientSide**](ClientSideApi.md#listPromotionTiersClientSide) | **GET** /client/v1/promotions/tiers | List Promotion Tiers (client-side)
+[**redeemStackedDiscountsClientSide**](ClientSideApi.md#redeemStackedDiscountsClientSide) | **POST** /client/v1/redemptions | Redeem Stackable Discounts (client-side)
+[**trackCustomEventClientSide**](ClientSideApi.md#trackCustomEventClientSide) | **POST** /client/v1/events | Track Custom Event (client-side)
+[**validateStackedDiscountsClientSide**](ClientSideApi.md#validateStackedDiscountsClientSide) | **POST** /client/v1/validations | Validate Stackable Discounts (client-side)
+
+
+
+## checkEligibilityClientSide
+
+> ClientQualificationsCheckEligibilityResponseBody checkEligibilityClientSide(clientQualificationsCheckEligibilityRequestBody)
+
+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.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-Client-Application-Id
+let X-Client-Application-Id = defaultClient.authentications['X-Client-Application-Id'];
+X-Client-Application-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Application-Id.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';
+// Configure API key authorization: X-Client-Token
+let X-Client-Token = defaultClient.authentications['X-Client-Token'];
+X-Client-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Token.apiKeyPrefix = 'Token';
+
+let apiInstance = new Voucherify.ClientSideApi();
+let clientQualificationsCheckEligibilityRequestBody = new Voucherify.ClientQualificationsCheckEligibilityRequestBody(); // ClientQualificationsCheckEligibilityRequestBody | Define order and customer context.
+apiInstance.checkEligibilityClientSide(clientQualificationsCheckEligibilityRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **clientQualificationsCheckEligibilityRequestBody** | [**ClientQualificationsCheckEligibilityRequestBody**](ClientQualificationsCheckEligibilityRequestBody.md)| Define order and customer context. | 
+
+### Return type
+
+[**ClientQualificationsCheckEligibilityResponseBody**](ClientQualificationsCheckEligibilityResponseBody.md)
+
+### Authorization
+
+[X-Client-Application-Id](../README.md#X-Client-Application-Id), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth), [X-Client-Token](../README.md#X-Client-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## listPromotionTiersClientSide
+
+> ClientPromotionsTiersListResponseBody listPromotionTiersClientSide(origin, opts)
+
+List Promotion Tiers (client-side)
+
+This method enables you to list promotion tiers.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-Client-Application-Id
+let X-Client-Application-Id = defaultClient.authentications['X-Client-Application-Id'];
+X-Client-Application-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Application-Id.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';
+// Configure API key authorization: X-Client-Token
+let X-Client-Token = defaultClient.authentications['X-Client-Token'];
+X-Client-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Token.apiKeyPrefix = 'Token';
+
+let apiInstance = new Voucherify.ClientSideApi();
+let origin = "origin_example"; // String | Indicates the origin (scheme, hostname, and port).
+let opts = {
+  'isAvailable': true, // Boolean | This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions.
+  'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items.
+  'page': 56, // Number | Which page of results to return. The lowest value is 1.
+  'order': new Voucherify.ParameterOrderListPromotionTiersClientSide() // ParameterOrderListPromotionTiersClientSide | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+};
+apiInstance.listPromotionTiersClientSide(origin, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **origin** | **String**| Indicates the origin (scheme, hostname, and port). | 
+ **isAvailable** | **Boolean**| This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. | [optional] 
+ **limit** | **Number**| Limits the number of objects to be returned. The limit can range between 1 and 100 items. | [optional] 
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional] 
+ **order** | [**ParameterOrderListPromotionTiersClientSide**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+
+### Return type
+
+[**ClientPromotionsTiersListResponseBody**](ClientPromotionsTiersListResponseBody.md)
+
+### Authorization
+
+[X-Client-Application-Id](../README.md#X-Client-Application-Id), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth), [X-Client-Token](../README.md#X-Client-Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## redeemStackedDiscountsClientSide
+
+> ClientRedemptionsRedeemResponseBody redeemStackedDiscountsClientSide(origin, clientRedemptionsRedeemRequestBody)
+
+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).
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-Client-Application-Id
+let X-Client-Application-Id = defaultClient.authentications['X-Client-Application-Id'];
+X-Client-Application-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Application-Id.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';
+// Configure API key authorization: X-Client-Token
+let X-Client-Token = defaultClient.authentications['X-Client-Token'];
+X-Client-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Token.apiKeyPrefix = 'Token';
+
+let apiInstance = new Voucherify.ClientSideApi();
+let origin = "origin_example"; // String | Indicates the origin (scheme, hostname, and port).
+let clientRedemptionsRedeemRequestBody = {"customer":{"source_id":"sample_customer","metadata":{"key":"value"}},"options":{"expand":["order","redeemable","category"]},"redeemables":[{"object":"voucher","id":"voucher-code"}],"session":{"type":"LOCK","key":"session_key"},"order":{"amount":55000,"status":"PAID","items":[{"quantity":2,"price":20000,"source_id":"sample product1","related_object":"product","product":{"metadata":{"key":"value"}}},{"quantity":1,"price":15000,"source_id":"sample product2","related_object":"product","product":{"metadata":{"key":"value"}}}],"metadata":{"key":"value"}}}; // ClientRedemptionsRedeemRequestBody | 
+apiInstance.redeemStackedDiscountsClientSide(origin, clientRedemptionsRedeemRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **origin** | **String**| Indicates the origin (scheme, hostname, and port). | 
+ **clientRedemptionsRedeemRequestBody** | [**ClientRedemptionsRedeemRequestBody**](ClientRedemptionsRedeemRequestBody.md)|  | 
+
+### Return type
+
+[**ClientRedemptionsRedeemResponseBody**](ClientRedemptionsRedeemResponseBody.md)
+
+### Authorization
+
+[X-Client-Application-Id](../README.md#X-Client-Application-Id), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth), [X-Client-Token](../README.md#X-Client-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## trackCustomEventClientSide
+
+> ClientEventsCreateResponseBody trackCustomEventClientSide(origin, clientEventsCreateRequestBody)
+
+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.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-Client-Application-Id
+let X-Client-Application-Id = defaultClient.authentications['X-Client-Application-Id'];
+X-Client-Application-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Application-Id.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';
+// Configure API key authorization: X-Client-Token
+let X-Client-Token = defaultClient.authentications['X-Client-Token'];
+X-Client-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Token.apiKeyPrefix = 'Token';
+
+let apiInstance = new Voucherify.ClientSideApi();
+let origin = "origin_example"; // String | Indicates the origin (scheme, hostname, and port).
+let clientEventsCreateRequestBody = {"event":"user_subscribed","customer":{"source_id":"source_customer_event"},"referral":{"code":"46jL0kYI","referrer_id":"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"},"metadata":{"login":"bob","pricing_plan":"PP1","volume_number":4}}; // ClientEventsCreateRequestBody | Specify the details of the custom event.
+apiInstance.trackCustomEventClientSide(origin, clientEventsCreateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **origin** | **String**| Indicates the origin (scheme, hostname, and port). | 
+ **clientEventsCreateRequestBody** | [**ClientEventsCreateRequestBody**](ClientEventsCreateRequestBody.md)| Specify the details of the custom event. | 
+
+### Return type
+
+[**ClientEventsCreateResponseBody**](ClientEventsCreateResponseBody.md)
+
+### Authorization
+
+[X-Client-Application-Id](../README.md#X-Client-Application-Id), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth), [X-Client-Token](../README.md#X-Client-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validateStackedDiscountsClientSide
+
+> ClientValidationsValidateResponseBody validateStackedDiscountsClientSide(origin, clientValidationsValidateRequestBody)
+
+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.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-Client-Application-Id
+let X-Client-Application-Id = defaultClient.authentications['X-Client-Application-Id'];
+X-Client-Application-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Application-Id.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';
+// Configure API key authorization: X-Client-Token
+let X-Client-Token = defaultClient.authentications['X-Client-Token'];
+X-Client-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-Client-Token.apiKeyPrefix = 'Token';
+
+let apiInstance = new Voucherify.ClientSideApi();
+let origin = "origin_example"; // String | Indicates the origin (scheme, hostname, and port).
+let clientValidationsValidateRequestBody = {"customer":{"source_id":"sample_customer","metadata":{"key":"value"}},"options":{"expand":["order","redeemable","category"]},"redeemables":[{"object":"voucher","id":"voucher-code"}],"session":{"type":"LOCK"},"order":{"amount":55000,"status":"PAID","items":[{"quantity":2,"price":20000,"source_id":"sample product1","related_object":"product","product":{"metadata":{"key":"value"}}},{"quantity":1,"price":15000,"source_id":"sample product2","related_object":"product","product":{"metadata":{"key":"value"}}}],"metadata":{"key":"value"}}}; // ClientValidationsValidateRequestBody | 
+apiInstance.validateStackedDiscountsClientSide(origin, clientValidationsValidateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **origin** | **String**| Indicates the origin (scheme, hostname, and port). | 
+ **clientValidationsValidateRequestBody** | [**ClientValidationsValidateRequestBody**](ClientValidationsValidateRequestBody.md)|  | 
+
+### Return type
+
+[**ClientValidationsValidateResponseBody**](ClientValidationsValidateResponseBody.md)
+
+### Authorization
+
+[X-Client-Application-Id](../README.md#X-Client-Application-Id), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth), [X-Client-Token](../README.md#X-Client-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/docs/ClientValidationsValidateRequestBody.md

@@ -0,0 +1,15 @@
+# Voucherify.ClientValidationsValidateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**ClientValidationsValidateRequestBodyOptions**](ClientValidationsValidateRequestBodyOptions.md) |  | [optional] 
+**redeemables** | [**[ClientValidationsValidateRequestBodyRedeemablesItem]**](ClientValidationsValidateRequestBodyRedeemablesItem.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**customer** | [**Customer**](Customer.md) |  | [optional] 
+**session** | [**Session**](Session.md) |  | [optional] 
+**trackingId** | **String** | Is correspondent to Customer's source_id | [optional] 
+**metadata** | **Object** | A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format. | [optional] 
+
+

package/docs/ClientValidationsValidateRequestBodyOptions.md

@@ -0,0 +1,24 @@
+# Voucherify.ClientValidationsValidateRequestBodyOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expand** | **[String]** | The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details.   | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"category\"] | - Returns an expanded `categories` object, showing details about the category. | | [optional] 
+
+
+
+## Enum: [ExpandEnum]
+
+
+* `order` (value: `"order"`)
+
+* `redemption` (value: `"redemption"`)
+
+* `redeemable` (value: `"redeemable"`)
+
+* `category` (value: `"category"`)
+
+
+
+

package/docs/ClientValidationsValidateRequestBodyRedeemablesItem.md

@@ -0,0 +1,25 @@
+# Voucherify.ClientValidationsValidateRequestBodyRedeemablesItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**gift** | [**ClientValidationsValidateRequestBodyRedeemablesItemGift**](ClientValidationsValidateRequestBodyRedeemablesItemGift.md) |  | [optional] 
+**reward** | [**ClientValidationsValidateRequestBodyRedeemablesItemReward**](ClientValidationsValidateRequestBodyRedeemablesItemReward.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `promotion_tier` (value: `"promotion_tier"`)
+
+* `promotion_stack` (value: `"promotion_stack"`)
+
+
+
+

package/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md

@@ -0,0 +1,9 @@
+# Voucherify.ClientValidationsValidateRequestBodyRedeemablesItemGift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credits** | **Number** | The number of credits that the user wants to use from the gift card to fulfill the order. The value of credits cannot be higher than the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+
+

package/docs/ClientValidationsValidateRequestBodyRedeemablesItemReward.md

@@ -0,0 +1,10 @@
+# Voucherify.ClientValidationsValidateRequestBodyRedeemablesItemReward
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique reward ID assigned by Voucherify. The reward must be assigned to the campaign in order for the user to be able to use the reward. | [optional] 
+**points** | **Number** | The number of loyalty points that the user wants to spend in order to fulfill the order using a **pay with points** reward. The number of points cannot be higher than the current balance on the loyalty card. | [optional] 
+
+

package/docs/ClientValidationsValidateResponseBody.md

@@ -0,0 +1,17 @@
+# Voucherify.ClientValidationsValidateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the validation, assigned by Voucherify. | [optional] 
+**valid** | **Boolean** | The result of the validation. It takes all of the redeemables into account and returns a `false` if at least one redeemable is inapplicable. Returns `true` if all redeemables are applicable. | [optional] 
+**redeemables** | [**[ClientValidationsValidateResponseBodyRedeemablesItem]**](ClientValidationsValidateResponseBodyRedeemablesItem.md) |  | [optional] 
+**skippedRedeemables** | [**[ValidationsRedeemableSkipped]**](ValidationsRedeemableSkipped.md) | Lists validation results of each skipped redeemable. | [optional] 
+**inapplicableRedeemables** | [**[ValidationsRedeemableInapplicable]**](ValidationsRedeemableInapplicable.md) | Lists validation results of each inapplicable redeemable. | [optional] 
+**order** | [**ClientValidationsValidateResponseBodyOrder**](ClientValidationsValidateResponseBodyOrder.md) |  | [optional] 
+**trackingId** | **String** | Hashed customer source ID. | [optional] 
+**session** | [**Session**](Session.md) |  | [optional] 
+**stackingRules** | [**StackingRules**](StackingRules.md) |  | 
+
+

package/docs/ClientValidationsValidateResponseBodyOrder.md

@@ -0,0 +1,54 @@
+# Voucherify.ClientValidationsValidateResponseBodyOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] 
+**sourceId** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] 
+**status** | **String** | The order status. | [optional] 
+**amount** | **Number** | This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**initialAmount** | **Number** | This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**discountAmount** | **Number** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**itemsDiscountAmount** | **Number** | Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**totalDiscountAmount** | **Number** | Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**totalAmount** | **Number** | Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**appliedDiscountAmount** | **Number** | This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**itemsAppliedDiscountAmount** | **Number** | Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `sum(items, i => i.applied_discount_amount)` | [optional] 
+**totalAppliedDiscountAmount** | **Number** | Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'order']
+**createdAt** | **Date** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] 
+**customerId** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] 
+**referrerId** | **String** | Unique referrer ID. | [optional] 
+**customer** | [**CustomerId**](CustomerId.md) |  | [optional] 
+**referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] 
+**redemptions** | [**{String: OrderRedemptionsEntry}**](OrderRedemptionsEntry.md) |  | [optional] 
+**items** | [**[ClientValidationsValidateResponseBodyOrderItemsItem]**](ClientValidationsValidateResponseBodyOrderItemsItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] 
+
+
+
+## Enum: StatusEnum
+
+
+* `CREATED` (value: `"CREATED"`)
+
+* `PAID` (value: `"PAID"`)
+
+* `CANCELED` (value: `"CANCELED"`)
+
+* `FULFILLED` (value: `"FULFILLED"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `order` (value: `"order"`)
+
+
+
+

package/docs/ClientValidationsValidateResponseBodyOrderItemsItem.md

@@ -0,0 +1,50 @@
+# Voucherify.ClientValidationsValidateResponseBodyOrderItemsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the order line item. | [optional] 
+**skuId** | **String** | Unique identifier of the SKU. It is assigned by Voucherify. | [optional] 
+**productId** | **String** | Unique identifier of the product. It is assigned by Voucherify. | [optional] 
+**relatedObject** | **String** | Used along with the source_id property, can be set to either sku or product. | [optional] 
+**sourceId** | **String** | The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. | [optional] 
+**quantity** | **Number** | The quantity of the particular item in the cart. | [optional] 
+**discountQuantity** | **Number** | Number of dicounted items. | [optional] 
+**initialQuantity** | **Number** | A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity. | [optional] 
+**amount** | **Number** | The total amount of the order item (price * quantity). | [optional] 
+**discountAmount** | **Number** | Sum of all order-item-level discounts applied to the order. | [optional] 
+**appliedDiscountAmount** | **Number** | This field shows the order-level discount applied. | [optional] 
+**appliedDiscountQuantity** | **Number** | Number of the discounted items applied in the transaction. | [optional] 
+**appliedQuantity** | **Number** | Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | [optional] 
+**appliedQuantityAmount** | **Number** | Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | [optional] 
+**initialAmount** | **Number** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] 
+**price** | **Number** | Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**subtotalAmount** | **Number** | Final order item amount after the applied item-level discount.  If there are no item-level discounts applied, this item is equal to the `amount`.    `subtotal_amount`=`amount`-`applied_discount_amount` | [optional] 
+**product** | [**OrderCalculatedItemProduct**](OrderCalculatedItemProduct.md) |  | [optional] 
+**sku** | [**OrderCalculatedItemSku**](OrderCalculatedItemSku.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'order_item']
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas. | [optional] 
+**applicationDetails** | [**[ApplicationDetailsItem]**](ApplicationDetailsItem.md) | Array containing details about the items that are replaced and the items that are replacements for discounts with the `REPLACE_ITEMS` effect. | [optional] 
+
+
+
+## Enum: RelatedObjectEnum
+
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `order_item` (value: `"order_item"`)
+
+
+
+

package/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md

@@ -0,0 +1,44 @@
+# Voucherify.ClientValidationsValidateResponseBodyRedeemablesItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**id** | **String** | Redeemable ID, i.e. the voucher code. | [optional] 
+**object** | **String** | Redeemable's object type. | [optional] 
+**order** | [**ClientValidationsValidateResponseBodyRedeemablesItemOrder**](ClientValidationsValidateResponseBodyRedeemablesItemOrder.md) |  | [optional] 
+**applicableTo** | [**ApplicableToResultList**](ApplicableToResultList.md) |  | [optional] 
+**inapplicableTo** | [**InapplicableToResultList**](InapplicableToResultList.md) |  | [optional] 
+**result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redeemable. | [optional] 
+**categories** | [**[CategoryWithStackingRulesType]**](CategoryWithStackingRulesType.md) |  | [optional] 
+**campaignName** | **String** | Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] 
+**campaignId** | **String** | Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] 
+**name** | **String** | Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] 
+
+
+
+## Enum: StatusEnum
+
+
+* `APPLICABLE` (value: `"APPLICABLE"`)
+
+* `INAPPLICABLE` (value: `"INAPPLICABLE"`)
+
+* `SKIPPED` (value: `"SKIPPED"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `promotion_tier` (value: `"promotion_tier"`)
+
+
+
+

package/docs/ClientValidationsValidateResponseBodyRedeemablesItemOrder.md

@@ -0,0 +1,54 @@
+# Voucherify.ClientValidationsValidateResponseBodyRedeemablesItemOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] 
+**sourceId** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] 
+**status** | **String** | The order status. | [optional] 
+**amount** | **Number** | This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**initialAmount** | **Number** | This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**discountAmount** | **Number** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**itemsDiscountAmount** | **Number** | Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**totalDiscountAmount** | **Number** | Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**totalAmount** | **Number** | Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**appliedDiscountAmount** | **Number** | This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**itemsAppliedDiscountAmount** | **Number** | Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `sum(items, i => i.applied_discount_amount)` | [optional] 
+**totalAppliedDiscountAmount** | **Number** | Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'order']
+**createdAt** | **Date** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] 
+**customerId** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] 
+**referrerId** | **String** | Unique referrer ID. | [optional] 
+**customer** | [**ClientValidationsValidateResponseBodyRedeemablesItemOrderCustomer**](ClientValidationsValidateResponseBodyRedeemablesItemOrderCustomer.md) |  | [optional] 
+**referrer** | [**ClientValidationsValidateResponseBodyRedeemablesItemOrderReferrer**](ClientValidationsValidateResponseBodyRedeemablesItemOrderReferrer.md) |  | [optional] 
+**redemptions** | [**{String: OrderRedemptionsEntry}**](OrderRedemptionsEntry.md) |  | [optional] 
+**items** | [**[OrderCalculatedItem]**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] 
+
+
+
+## Enum: StatusEnum
+
+
+* `CREATED` (value: `"CREATED"`)
+
+* `PAID` (value: `"PAID"`)
+
+* `CANCELED` (value: `"CANCELED"`)
+
+* `FULFILLED` (value: `"FULFILLED"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `order` (value: `"order"`)
+
+
+
+