@voucherify/sdk 2.9.3 → 3.0.0

package/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md

@@ -0,0 +1,54 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrder
+
+## 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** | [**RedemptionsListResponseBodyRedemptionsItemOrderCustomer**](RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md) |  | [optional] 
+**referrer** | [**RedemptionsListResponseBodyRedemptionsItemOrderReferrer**](RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md) |  | [optional] 
+**redemptions** | [**{String: OrderRedemptionsEntry}**](OrderRedemptionsEntry.md) |  | [optional] 
+**items** | [**[RedemptionsListResponseBodyRedemptionsItemOrderItemsItem]**](RedemptionsListResponseBodyRedemptionsItemOrderItemsItem.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/RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md

@@ -0,0 +1,19 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrderCustomer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of an existing customer. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'customer']
+
+
+
+## Enum: ObjectEnum
+
+
+* `customer` (value: `"customer"`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemOrderItemsItem.md

@@ -0,0 +1,50 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrderItemsItem
+
+## 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** | [**RedemptionsListResponseBodyRedemptionsItemOrderItemsItemProduct**](RedemptionsListResponseBodyRedemptionsItemOrderItemsItemProduct.md) |  | [optional] 
+**sku** | [**RedemptionsListResponseBodyRedemptionsItemOrderItemsItemSku**](RedemptionsListResponseBodyRedemptionsItemOrderItemsItemSku.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/RedemptionsListResponseBodyRedemptionsItemOrderItemsItemProduct.md

@@ -0,0 +1,14 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrderItemsItemProduct
+
+## 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/RedemptionsListResponseBodyRedemptionsItemOrderItemsItemSku.md

@@ -0,0 +1,14 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrderItemsItemSku
+
+## 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/RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md

@@ -0,0 +1,19 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemOrderReferrer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of an existing customer. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'customer']
+
+
+
+## Enum: ObjectEnum
+
+
+* `customer` (value: `"customer"`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTier.md

@@ -0,0 +1,51 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique promotion tier ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] 
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierAction**](RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**promotionId** | **String** | Promotion unique ID. | [optional] 
+**campaign** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign**](RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md) |  | [optional] 
+**campaignId** | **String** | Promotion tier's parent campaign's unique ID. | [optional] 
+**active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.  | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**summary** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary**](RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional] [default to 'promotion_tier']
+**validationRuleAssignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] 
+**categoryId** | **String** | Promotion tier category ID. | [optional] 
+**categories** | [**[Category]**](Category.md) |  | [optional] 
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTierAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md

@@ -0,0 +1,38 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional] [default to 'campaign']
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions**](RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions.md) |  | [optional] 
+**orders** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders**](RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders.md) |  | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **Number** | Sum of order totals. | [optional] 
+**totalDiscountAmount** | **Number** | Sum of total discount applied using the promotion tier. | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalRedeemed** | **Number** | Number of times the promotion tier was redeemed. | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rollbacks** | [**[RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem]**](RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md) |  | [optional] 
+**redemptions** | [**[RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem]**](RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.md) |  | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique redemption ID. | [optional] 
+**date** | **Date** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md

@@ -0,0 +1,22 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique rollback redemption ID. | [optional] 
+**date** | **Date** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
+**rollbackOrderMode** | **String** | Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. This is returned only in GET `v1/redemptions/` and GET `v1/redemptions/{redemptionId}` endpoints. | [optional] 
+
+
+
+## Enum: RollbackOrderModeEnum
+
+
+* `WITH_ORDER` (value: `"WITH_ORDER"`)
+
+* `WITHOUT_ORDER` (value: `"WITHOUT_ORDER"`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemSession.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemSession
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | The session unique ID assigned by Voucherify or your own unique session ID sent in the request. | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemVoucher.md

@@ -0,0 +1,72 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemVoucher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Assigned by the Voucherify API, identifies the voucher. | [optional] 
+**code** | **String** | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] 
+**campaign** | **String** | A unique campaign name, identifies the voucher's parent campaign. | [optional] 
+**campaignId** | **String** | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] 
+**category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] 
+**categoryId** | **String** | Unique category ID assigned by Voucherify. | [optional] 
+**type** | **String** | Defines the type of the voucher.  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**gift** | [**RedemptionsListResponseBodyRedemptionsItemVoucherGift**](RedemptionsListResponseBodyRedemptionsItemVoucherGift.md) |  | [optional] 
+**loyaltyCard** | [**RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard**](RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md) |  | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the code expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] 
+**additionalInfo** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] 
+**assets** | [**VoucherAssets**](VoucherAssets.md) |  | [optional] 
+**isReferralCode** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] 
+**holderId** | **String** | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] 
+**referrerId** | **String** | Unique identifier of the referring person. | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional] [default to 'voucher']
+**publish** | [**RedemptionsListResponseBodyRedemptionsItemVoucherPublish**](RedemptionsListResponseBodyRedemptionsItemVoucherPublish.md) |  | [optional] 
+**redemption** | [**RedemptionsListResponseBodyRedemptionsItemVoucherRedemption**](RedemptionsListResponseBodyRedemptionsItemVoucherRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+**holder** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md

@@ -0,0 +1,23 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemVoucherGift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**subtractedAmount** | **Number** | Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**balance** | **Number** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] 
+
+
+
+## Enum: EffectEnum
+
+
+* `APPLY_TO_ORDER` (value: `"APPLY_TO_ORDER"`)
+
+* `APPLY_TO_ITEMS` (value: `"APPLY_TO_ITEMS"`)
+
+
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md

@@ -0,0 +1,15 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | Total number of points added to the loyalty card over its lifespan. | [optional] 
+**balance** | **Number** | Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. | [optional] 
+**nextExpirationDate** | **Date** | The next closest date when the next set of points are due to expire. | [optional] 
+**nextExpirationPoints** | **Number** | The amount of points that are set to expire next. | [optional] 
+**pendingPoints** | **Number** | Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. | [optional] 
+**expiredPoints** | **Number** | Shows the total number of expired points over the lifetime of the loyalty card. | [optional] 
+**subtractedPoints** | **Number** | Shows the total number of subtracted points over the lifetime of the loyalty card. | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherPublish.md

@@ -0,0 +1,11 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemVoucherPublish
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional] [default to 'list']
+**count** | **Number** | Publication events counter. | [optional] 
+**url** | **String** | The endpoint where this list of publications can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/publications` | [optional] 
+
+

package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherRedemption.md

@@ -0,0 +1,13 @@
+# Voucherify.RedemptionsListResponseBodyRedemptionsItemVoucherRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+**redeemedQuantity** | **Number** | How many times a voucher has already been redeemed. | [optional] 
+**redeemedPoints** | **Number** | Total loyalty points redeemed. | [optional] 
+**object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional] [default to 'list']
+**url** | **String** | The endpoint where this list of redemptions can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] 
+
+

package/docs/RedemptionsRedeemRequestBody.md

@@ -0,0 +1,15 @@
+# Voucherify.RedemptionsRedeemRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**RedemptionsRedeemRequestBodyOptions**](RedemptionsRedeemRequestBodyOptions.md) |  | [optional] 
+**redeemables** | [**[RedemptionsRedeemRequestBodyRedeemablesItem]**](RedemptionsRedeemRequestBodyRedeemablesItem.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/RedemptionsRedeemRequestBodyOptions.md

@@ -0,0 +1,24 @@
+# Voucherify.RedemptionsRedeemRequestBodyOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expand** | **[String]** | Expand array lets you configure params 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. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br />- Returns redemption object `metadata`.<br />- 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/RedemptionsRedeemRequestBodyRedeemablesItem.md

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

package/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionsRedeemRequestBodyRedeemablesItemGift
+
+## 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/RedemptionsRedeemRequestBodyRedeemablesItemReward.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionsRedeemRequestBodyRedeemablesItemReward
+
+## 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/RedemptionsRedeemResponseBody.md

@@ -0,0 +1,13 @@
+# Voucherify.RedemptionsRedeemResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**[Redemption]**](Redemption.md) |  | [optional] 
+**parentRedemption** | [**Redemption**](Redemption.md) |  | [optional] 
+**order** | [**RedemptionsRedeemResponseBodyOrder**](RedemptionsRedeemResponseBodyOrder.md) |  | [optional] 
+**inapplicableRedeemables** | [**[ValidationsRedeemableInapplicable]**](ValidationsRedeemableInapplicable.md) | Lists validation results of each inapplicable redeemable. | [optional] 
+**skippedRedeemables** | [**[ValidationsRedeemableSkipped]**](ValidationsRedeemableSkipped.md) | Lists validation results of each redeemable. If a redeemable can be applied, the API returns `\"status\": \"APPLICABLE\"`. | [optional] 
+
+