@voucherify/sdk 2.9.3 → 3.0.0

package/docs/RedemptionEntryVoucherPublish.md

@@ -0,0 +1,11 @@
+# Voucherify.RedemptionEntryVoucherPublish
+
+## 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/RedemptionEntryVoucherRedemption.md

@@ -0,0 +1,13 @@
+# Voucherify.RedemptionEntryVoucherRedemption
+
+## 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/RedemptionGift.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionGift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | Amount subtracted from the gift card as a result of the redemption. The amount is expressed as the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
+
+

package/docs/RedemptionLoyaltyCard.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionLoyaltyCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | Number of points subtracted from the loyalty card as a result of the redemption. | [optional] 
+
+

package/docs/RedemptionOrder.md

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

@@ -0,0 +1,19 @@
+# Voucherify.RedemptionOrderCustomer
+
+## 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/RedemptionOrderItemsItem.md

@@ -0,0 +1,50 @@
+# Voucherify.RedemptionOrderItemsItem
+
+## 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/RedemptionOrderReferrer.md

@@ -0,0 +1,19 @@
+# Voucherify.RedemptionOrderReferrer
+
+## 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/RedemptionRelatedRedemptions.md

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

package/docs/RedemptionRelatedRedemptionsRedemptionsItem.md

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

@@ -0,0 +1,22 @@
+# Voucherify.RedemptionRelatedRedemptionsRollbacksItem
+
+## 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/RedemptionRewardResult.md

@@ -0,0 +1,44 @@
+# Voucherify.RedemptionRewardResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] 
+**assignmentId** | **String** | Unique reward assignment ID assigned by Voucherify. | [optional] 
+**voucher** | [**Voucher**](Voucher.md) |  | [optional] 
+**product** | [**Product**](Product.md) |  | [optional] 
+**sku** | [**Sku**](Sku.md) |  | [optional] 
+**loyaltyTierId** | **String** | Unique loyalty tier ID assigned by Voucherify. | [optional] 
+**id** | **String** | Unique reward ID. | [optional] 
+**name** | **String** | Name of the reward. | [optional] 
+**object** | **String** | The type of the object represented by the JSON | [optional] [default to 'reward']
+**createdAt** | **Date** | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp in ISO 8601 format indicating when the reward was updated. | [optional] 
+**parameters** | [**RedemptionRewardResultParameters**](RedemptionRewardResultParameters.md) |  | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward. | [optional] 
+**type** | **String** | Reward type. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `reward` (value: `"reward"`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `CAMPAIGN` (value: `"CAMPAIGN"`)
+
+* `COIN` (value: `"COIN"`)
+
+* `MATERIAL` (value: `"MATERIAL"`)
+
+
+
+

package/docs/RedemptionRewardResultParameters.md

@@ -0,0 +1,11 @@
+# Voucherify.RedemptionRewardResultParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign** | [**RedemptionRewardResultParametersCampaign**](RedemptionRewardResultParametersCampaign.md) |  | [optional] 
+**product** | [**RedemptionRewardResultParametersProduct**](RedemptionRewardResultParametersProduct.md) |  | [optional] 
+**coin** | [**RedemptionRewardResultParametersCoin**](RedemptionRewardResultParametersCoin.md) |  | [optional] 
+
+

package/docs/RedemptionRewardResultParametersCampaign.md

@@ -0,0 +1,11 @@
+# Voucherify.RedemptionRewardResultParametersCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Campaign unique ID. | [optional] 
+**balance** | **Number** | Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. | [optional] 
+**type** | **String** | Defines the type of the campaign. | [optional] 
+
+

package/docs/RedemptionRewardResultParametersCoin.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionRewardResultParametersCoin
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchangeRatio** | **Number** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] 
+**pointsRatio** | **Number** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] 
+
+

package/docs/RedemptionRewardResultParametersProduct.md

@@ -0,0 +1,10 @@
+# Voucherify.RedemptionRewardResultParametersProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique product ID, assigned by Voucherify.  | [optional] 
+**skuId** | **String** | Unique identifier of the SKU. It is assigned by Voucherify. | [optional] 
+
+

package/docs/RedemptionRollback.md

@@ -0,0 +1,75 @@
+# Voucherify.RedemptionRollback
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the redemption rollback. | [optional] 
+**object** | **String** | The type of the object represented by the JSON | [optional] [default to 'redemption_rollback']
+**date** | **Date** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
+**customerId** | **String** | Unique customer ID of the redeeming customer. | [optional] 
+**trackingId** | **String** | Hashed customer source ID. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | [optional] 
+**amount** | **Number** | For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. | [optional] 
+**redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] 
+**reason** | **String** | System generated cause for the redemption being invalid in the context of the provided parameters. | [optional] 
+**result** | **String** | Redemption result. | [optional] 
+**status** | **String** | Redemption status. | [optional] 
+**failureCode** | **String** | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. | [optional] 
+**failureMessage** | **String** | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. | [optional] 
+**order** | [**RedemptionRollbackOrder**](RedemptionRollbackOrder.md) |  | [optional] 
+**channel** | [**RedemptionRollbackChannel**](RedemptionRollbackChannel.md) |  | [optional] 
+**customer** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] 
+**relatedObjectType** | **String** | Defines the related object. | [optional] 
+**relatedObjectId** | **String** | Unique identifier of the related object. It is assigned by Voucherify, i.e. `v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno` for a voucher. | [optional] 
+**voucher** | [**Voucher**](Voucher.md) |  | [optional] 
+**promotionTier** | [**PromotionTier**](PromotionTier.md) |  | [optional] 
+**reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) |  | [optional] 
+**gift** | [**RedemptionRollbackGift**](RedemptionRollbackGift.md) |  | [optional] 
+**loyaltyCard** | [**RedemptionRollbackLoyaltyCard**](RedemptionRollbackLoyaltyCard.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `redemption_rollback` (value: `"redemption_rollback"`)
+
+
+
+
+
+## Enum: ResultEnum
+
+
+* `SUCCESS` (value: `"SUCCESS"`)
+
+* `FAILURE` (value: `"FAILURE"`)
+
+
+
+
+
+## Enum: StatusEnum
+
+
+* `SUCCEEDED` (value: `"SUCCEEDED"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+
+
+
+
+## Enum: RelatedObjectTypeEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `promotion_tier` (value: `"promotion_tier"`)
+
+* `redemption` (value: `"redemption"`)
+
+
+
+

package/docs/RedemptionRollbackChannel.md

@@ -0,0 +1,21 @@
+# Voucherify.RedemptionRollbackChannel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channelId** | **String** | Unique identifier of the channel which was used by the user performing the redemption rollback. This is either a user ID from the user using the Voucherify Dashboard or an X-APP-Id of a user using the API. | [optional] 
+**channelType** | **String** | The source of the channel for the redemption. A `USER` corresponds to the Voucherify Dashboard and an `API` corresponds to the API. | [optional] 
+
+
+
+## Enum: ChannelTypeEnum
+
+
+* `USER` (value: `"USER"`)
+
+* `API` (value: `"API"`)
+
+
+
+

package/docs/RedemptionRollbackGift.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionRollbackGift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | Amount returned to the gift card as a result of the redemption rollback and expressed as a negative integer. The amount is expressed as the smallest currency unit (e.g. -100 cents for $1.00 returned). | [optional] 
+
+

package/docs/RedemptionRollbackLoyaltyCard.md

@@ -0,0 +1,9 @@
+# Voucherify.RedemptionRollbackLoyaltyCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | Number of points being returned to the loyalty card for the reward redemption rollback. It is expressed as a negative integer. | [optional] 
+
+

package/docs/RedemptionRollbackOrder.md

@@ -0,0 +1,54 @@
+# Voucherify.RedemptionRollbackOrder
+
+## 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** | [**[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"`)
+
+
+
+

package/docs/RedemptionSession.md

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

@@ -0,0 +1,72 @@
+# Voucherify.RedemptionVoucher
+
+## 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** | [**RedemptionVoucherGift**](RedemptionVoucherGift.md) |  | [optional] 
+**loyaltyCard** | [**RedemptionVoucherLoyaltyCard**](RedemptionVoucherLoyaltyCard.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** | [**RedemptionVoucherPublish**](RedemptionVoucherPublish.md) |  | [optional] 
+**redemption** | [**RedemptionVoucherRedemption**](RedemptionVoucherRedemption.md) |  | [optional] 
+**categories** | [**[CategoryWithStackingRulesType]**](CategoryWithStackingRulesType.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/RedemptionVoucherGift.md

@@ -0,0 +1,23 @@
+# Voucherify.RedemptionVoucherGift
+
+## 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/RedemptionVoucherLoyaltyCard.md

@@ -0,0 +1,15 @@
+# Voucherify.RedemptionVoucherLoyaltyCard
+
+## 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] 
+
+