@voucherify/sdk 2.9.3 → 3.0.0

package/docs/OAuthApi.md

@@ -0,0 +1,187 @@
+# Voucherify.OAuthApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**generateOauthToken**](OAuthApi.md#generateOauthToken) | **POST** /v1/oauth/token | Generate OAuth 2.0 Token
+[**introspectOauthToken**](OAuthApi.md#introspectOauthToken) | **POST** /v1/oauth/introspect | Introspect OAuth 2.0 Token
+[**revokeOauthToken**](OAuthApi.md#revokeOauthToken) | **POST** /v1/oauth/token/revoke | Revoke OAuth 2.0 Token
+
+
+
+## generateOauthToken
+
+> OAuthTokenGenerateResponseBody generateOauthToken(opts)
+
+Generate OAuth 2.0 Token
+
+Generate an OAuth 2.0 token for an API client. The token can be used to authorize access to the Voucherify API. The token inherits the permissions and IP whitelists of the API key that is used to generate the OAuth token. You can define the scope that limits its usage. You can generate up to 1000 OAuth tokens per project. The token expires in 900 seconds (15 minutes). If the API key that is used to generate the OAuth token is deleted or blocked, you cannot generate new OAuth tokens and the existing ones will stop working within one minute. If the API key used to generate an OAuth token is regenerated, the OAuth token can still be used. 🚧 Format of scope values Separate the values of the scope property with spaces.
+
+### 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';
+
+let apiInstance = new Voucherify.OAuthApi();
+let opts = {
+  'grantType': "'client_credentials'", // String | Gives an access token outside of the context of a user.
+  'scope': "scope_example" // String | Defines the scope of possible actions that can be done with the OAuth token. The `api` scope allows using the server-side API. The `client_api` scope allows using the whole client-side API. The values are space-delimited; do **not** use commas to separate the values.  Allowed values: `api`, `assets`, `async-actions`, `campaigns`, `categories`, `client_api`, `client_consents`, `client_customers`, `client_events`, `client_promotions`, `client_publish`, `client_qualifications`, `client_redeem`, `client_redemptions`, `client_validate`, `client_validations`, `client_vouchers`, `consents`, `customers`, `events`, `exports`, `locations`, `loyalties`, `metadata-schemas`, `orders`, `product-collections`, `products`, `promotions`, `publications`, `qualifications`, `redemptions`, `referrals`, `rewards`, `segments`, `SKUs`, `task-results`, `templates`, `trash-bin`, `validation-rules-assignments`, `validation-rules`, `validations`, `vouchers`.
+};
+apiInstance.generateOauthToken(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grantType** | **String**| Gives an access token outside of the context of a user. | [optional] [default to 'client_credentials']
+ **scope** | **String**| Defines the scope of possible actions that can be done with the OAuth token. The `api` scope allows using the server-side API. The `client_api` scope allows using the whole client-side API. The values are space-delimited; do **not** use commas to separate the values.  Allowed values: `api`, `assets`, `async-actions`, `campaigns`, `categories`, `client_api`, `client_consents`, `client_customers`, `client_events`, `client_promotions`, `client_publish`, `client_qualifications`, `client_redeem`, `client_redemptions`, `client_validate`, `client_validations`, `client_vouchers`, `consents`, `customers`, `events`, `exports`, `locations`, `loyalties`, `metadata-schemas`, `orders`, `product-collections`, `products`, `promotions`, `publications`, `qualifications`, `redemptions`, `referrals`, `rewards`, `segments`, `SKUs`, `task-results`, `templates`, `trash-bin`, `validation-rules-assignments`, `validation-rules`, `validations`, `vouchers`. | [optional] 
+
+### Return type
+
+[**OAuthTokenGenerateResponseBody**](OAuthTokenGenerateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## introspectOauthToken
+
+> OAuthTokenIntrospectResponseBody introspectOauthToken(opts)
+
+Introspect OAuth 2.0 Token
+
+Introspect an OAuth 2.0 token for an API client.
+
+### 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';
+
+let apiInstance = new Voucherify.OAuthApi();
+let opts = {
+  'accessToken': "accessToken_example" // String | An OAuth 2.0 token generated with the API token and key.
+};
+apiInstance.introspectOauthToken(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accessToken** | **String**| An OAuth 2.0 token generated with the API token and key. | [optional] 
+
+### Return type
+
+[**OAuthTokenIntrospectResponseBody**](OAuthTokenIntrospectResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## revokeOauthToken
+
+> revokeOauthToken(opts)
+
+Revoke OAuth 2.0 Token
+
+Revoke an OAuth 2.0 token for an API client. Once revoked, the token cannot be used anymore.
+
+### 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';
+
+let apiInstance = new Voucherify.OAuthApi();
+let opts = {
+  'accessToken': "accessToken_example" // String | An OAuth 2.0 token generated with the API token and key.
+};
+apiInstance.revokeOauthToken(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accessToken** | **String**| An OAuth 2.0 token generated with the API token and key. | [optional] 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: Not defined
+

package/docs/OAuthTokenGenerateResponseBody.md

@@ -0,0 +1,23 @@
+# Voucherify.OAuthTokenGenerateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accessToken** | **String** | The access token used to authorize access to the Voucherify API. | [optional] 
+**clientId** | **String** | Unique client identifier, assigned by Voucherify, for OAuth. | [optional] 
+**expiresAt** | **Number** | Timestamp in seconds in the Unix format indicating when the token expires. | [optional] 
+**expiresIn** | **Number** | Number of seconds left until the token expires. | [optional] 
+**scope** | **String** | Defines the scope of possible actions that can be done with the OAuth token. The `api` scope allows using the server-side API. The `client_api` scope allows using the whole client-side API. Possible values: `api`, `assets`, `async-actions`, `campaigns`, `categories`, `client_api`, `client_consents`, `client_customers`, `client_events`, `client_promotions`, `client_publish`, `client_qualifications`, `client_redeem`, `client_redemptions`, `client_validate`, `client_validations`, `client_vouchers`, `consents`, `customers`, `events`, `exports`, `locations`, `loyalties`, `metadata-schemas`, `orders`, `product-collections`, `products`, `promotions`, `publications`, `qualifications`, `redemptions`, `referrals`, `rewards`, `segments`, `SKUs`, `task-results`, `templates`, `trash-bin`, `validation-rules-assignments`, `validation-rules`, `validations`, `vouchers`. | [optional] 
+**tokenType** | **String** | Type of the token. Use the value as the header prefix for authorization. | [optional] [default to 'Bearer']
+
+
+
+## Enum: TokenTypeEnum
+
+
+* `Bearer` (value: `"Bearer"`)
+
+
+
+

package/docs/OAuthTokenIntrospectResponseBody.md

@@ -0,0 +1,24 @@
+# Voucherify.OAuthTokenIntrospectResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accessToken** | **String** | The access token used to authorize access to the Voucherify API. | [optional] 
+**clientId** | **String** | Unique client identifier, assigned by Voucherify, for OAuth. | [optional] 
+**expiresAt** | **Number** | Timestamp in seconds in the Unix format indicating when the token expires. | [optional] 
+**expiresIn** | **Number** | Number of seconds left until the token expires. | [optional] 
+**scope** | **String** | Defines the scope of possible actions that can be done with the OAuth token. The `api` scope allows using the server-side API. The `client_api` scope allows using the whole client-side API. Possible values: `api`, `assets`, `async-actions`, `campaigns`, `categories`, `client_api`, `client_consents`, `client_customers`, `client_events`, `client_promotions`, `client_publish`, `client_qualifications`, `client_redeem`, `client_redemptions`, `client_validate`, `client_validations`, `client_vouchers`, `consents`, `customers`, `events`, `exports`, `locations`, `loyalties`, `metadata-schemas`, `orders`, `product-collections`, `products`, `promotions`, `publications`, `qualifications`, `redemptions`, `referrals`, `rewards`, `segments`, `SKUs`, `task-results`, `templates`, `trash-bin`, `validation-rules-assignments`, `validation-rules`, `validations`, `vouchers`. | [optional] 
+**tokenType** | **String** | Type of the token. Use the value as the header prefix for authorization. | [optional] [default to 'Bearer']
+**active** | **Boolean** | Determines if the token is active. Nonexistent tokens are also marked as inactive. | [optional] 
+
+
+
+## Enum: TokenTypeEnum
+
+
+* `Bearer` (value: `"Bearer"`)
+
+
+
+

package/docs/Order.md

@@ -0,0 +1,31 @@
+# Voucherify.Order
+
+## 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** | 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] 
+**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] 
+**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] 
+**items** | [**[OrderItem]**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [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] 
+
+
+
+## Enum: StatusEnum
+
+
+* `CREATED` (value: `"CREATED"`)
+
+* `PAID` (value: `"PAID"`)
+
+* `CANCELED` (value: `"CANCELED"`)
+
+* `FULFILLED` (value: `"FULFILLED"`)
+
+
+
+

package/docs/OrderCalculated.md

@@ -0,0 +1,53 @@
+# Voucherify.OrderCalculated
+
+## 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] 
+
+
+
+## Enum: StatusEnum
+
+
+* `CREATED` (value: `"CREATED"`)
+
+* `PAID` (value: `"PAID"`)
+
+* `CANCELED` (value: `"CANCELED"`)
+
+* `FULFILLED` (value: `"FULFILLED"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `order` (value: `"order"`)
+
+
+
+

package/docs/OrderCalculatedItem.md

@@ -0,0 +1,49 @@
+# Voucherify.OrderCalculatedItem
+
+## 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] 
+
+
+
+## Enum: RelatedObjectEnum
+
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `order_item` (value: `"order_item"`)
+
+
+
+

package/docs/OrderCalculatedItemProduct.md

@@ -0,0 +1,14 @@
+# Voucherify.OrderCalculatedItemProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the product and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] 
+**override** | **Boolean** | The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] 
+**name** | **String** | Product name. | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. | [optional] 
+**price** | **Number** | Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+
+

package/docs/OrderCalculatedItemSku.md

@@ -0,0 +1,14 @@
+# Voucherify.OrderCalculatedItemSku
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] 
+**override** | **Boolean** | The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] 
+**sku** | **String** | The SKU name. | [optional] 
+**price** | **Number** | SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections. | [optional] 
+
+

package/docs/OrderItem.md

@@ -0,0 +1,33 @@
+# Voucherify.OrderItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**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] 
+**product** | [**OrderItemProduct**](OrderItemProduct.md) |  | [optional] 
+**sku** | [**OrderItemSku**](OrderItemSku.md) |  | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to define business validation rules. | [optional] 
+
+
+
+## Enum: RelatedObjectEnum
+
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/OrderItemProduct.md

@@ -0,0 +1,14 @@
+# Voucherify.OrderItemProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the product and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] 
+**override** | **Boolean** | The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. Override works only for endpoints that create an order in the database. | [optional] 
+**name** | **String** | Product name. | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. | [optional] 
+**price** | **Number** | Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+
+

package/docs/OrderItemSku.md

@@ -0,0 +1,14 @@
+# Voucherify.OrderItemSku
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] 
+**override** | **Boolean** | The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] 
+**sku** | **String** | The SKU name. | [optional] 
+**price** | **Number** | SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to create product collections. | [optional] 
+
+

package/docs/OrderRedemptionsEntry.md

@@ -0,0 +1,16 @@
+# Voucherify.OrderRedemptionsEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. | [optional] 
+**rollbackId** | **String** | Unique ID of the redemption rollback. | [optional] 
+**rollbackDate** | **Date** | Timestamp representing the date and time when the redemption rollback was created. The value is shown in the ISO 8601 format. | [optional] 
+**relatedObjectType** | **String** | The source of the incentive. | [optional] [default to 'redemption']
+**relatedObjectId** | **String** | Unique ID of the parent redemption. | [optional] 
+**relatedObjectParentId** | **String** | Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign. | [optional] 
+**stacked** | **[String]** | Contains a list of unique IDs of child redemptions, which belong to the stacked incentives. | [optional] 
+**rollbackStacked** | **[String]** | Lists the rollback redemption IDs of the particular child redemptions. | [optional] 
+
+