@voucherify/sdk 2.9.3 → 3.0.0

package/docs/QualificationsRedeemableBaseOrder.md

@@ -0,0 +1,54 @@
+# Voucherify.QualificationsRedeemableBaseOrder
+
+## 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** | [**[QualificationsRedeemableBaseOrderItemsItem]**](QualificationsRedeemableBaseOrderItemsItem.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/QualificationsRedeemableBaseOrderItemsItem.md

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

@@ -0,0 +1,54 @@
+# Voucherify.QualificationsRedeemableOrder
+
+## 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** | [**[QualificationsRedeemableOrderItemsItem]**](QualificationsRedeemableOrderItemsItem.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/QualificationsRedeemableOrderItemsItem.md

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

@@ -0,0 +1,32 @@
+# Voucherify.QualificationsRedeemables
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. Default is `list`. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of qualified redeemables. | [optional] [default to 'data']
+**data** | [**[QualificationsRedeemable]**](QualificationsRedeemable.md) | Array of qualified redeemables. | [optional] 
+**total** | **Number** | The number of redeemables returned in the API request. | [optional] 
+**hasMore** | **Boolean** | As results are always limited, the `has_more` flag indicates if there are more records for given parameters. This lets you know if you can run another request (with different options) to get more records returned in the results. | [optional] 
+**moreStartingAfter** | **Date** | Timestamp representing the date and time to use in `starting_after` cursor to get more redeemables. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/RedeemableGift.md

@@ -0,0 +1,11 @@
+# Voucherify.RedeemableGift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | **Number** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**credits** | **Number** | The number of credits that the user wants to use from the gift card to fulfil the order. The value of credits cannot be higher than the current balance on the gift card. If the user gives more points than he has on the gift card, the application will return an error code in response. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**lockedCredits** | **Number** | The number of credits that are locked under a validation session. This is returned if the qualification request includes `session.type: LOCK` parameter in the body. The value is multiplied by 100 to represent 2 decimal places. For example `10000` for `$100.00`. Returns `0` if there aren't any active validation sessions for the gift card. | [optional] 
+
+

package/docs/RedeemableHolder.md

@@ -0,0 +1,63 @@
+# Voucherify.RedeemableHolder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the redeemable holder. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format. | [optional] 
+**redeemableId** | **String** | Identifier of the redeemable item. | [optional] 
+**redeemableObject** | **String** | Type of the redeemable. | [optional] 
+**customerId** | **String** | Unique identifier of the customer. | [optional] 
+**holderRole** | **String** | Role of the holder. | [optional] 
+**campaignId** | **String** | Unique identifier of the campaign as assigned by Voucherify. | [optional] 
+**campaignType** | **String** | Defines the type of the campaign. | [optional] [default to 'REFERRAL_PROGRAM']
+**voucherType** | **String** | Defines the type of the voucher. | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to a redeemable holder. The metadata object stores all custom attributes assigned to the `redeemable_holder` object. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'redeemable_holder']
+
+
+
+## Enum: HolderRoleEnum
+
+
+* `OWNER` (value: `"OWNER"`)
+
+* `REFERRER` (value: `"REFERRER"`)
+
+* `REFEREE` (value: `"REFEREE"`)
+
+
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `REFERRAL_PROGRAM` (value: `"REFERRAL_PROGRAM"`)
+
+
+
+
+
+## Enum: VoucherTypeEnum
+
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `redeemable_holder` (value: `"redeemable_holder"`)
+
+
+
+

package/docs/RedeemableLoyaltyCard.md

@@ -0,0 +1,13 @@
+# Voucherify.RedeemableLoyaltyCard
+
+## 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] 
+**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] 
+**transfers** | [**[LoyaltiesTransferPoints]**](LoyaltiesTransferPoints.md) |  | [optional] 
+
+

package/docs/RedeemableResult.md

@@ -0,0 +1,13 @@
+# Voucherify.RedeemableResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**bundle** | [**Bundle**](Bundle.md) |  | [optional] 
+**gift** | [**RedeemableGift**](RedeemableGift.md) |  | [optional] 
+**loyaltyCard** | [**RedeemableLoyaltyCard**](RedeemableLoyaltyCard.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+
+

package/docs/RedeemableVoucher.md

@@ -0,0 +1,70 @@
+# Voucherify.RedeemableVoucher
+
+## 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** | The value is null. | [optional] 
+**categoryId** | **String** | Unique category ID assigned by Voucherify. | [optional] 
+**categories** | **[Object]** | Contains an empty array. | [optional] 
+**type** | **String** | Defines the type of the voucher.  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**gift** | [**RedeemableVoucherGift**](RedeemableVoucherGift.md) |  | [optional] 
+**loyaltyCard** | [**RedeemableVoucherLoyaltyCard**](RedeemableVoucherLoyaltyCard.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] 
+**referrerId** | **String** | Unique identifier of the referring person. | [optional] 
+**holderId** | **String** | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional] [default to 'voucher']
+**publish** | [**RedeemableVoucherPublish**](RedeemableVoucherPublish.md) |  | [optional] 
+**redemption** | [**RedeemableVoucherRedemption**](RedeemableVoucherRedemption.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/RedeemableVoucherGift.md

@@ -0,0 +1,23 @@
+# Voucherify.RedeemableVoucherGift
+
+## 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`. `balance` = `amount` - `subtracted_amount` - `redemption.redeemed_amount`. | [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/RedeemableVoucherLoyaltyCard.md

@@ -0,0 +1,15 @@
+# Voucherify.RedeemableVoucherLoyaltyCard
+
+## 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/RedeemableVoucherPublish.md

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

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

@@ -0,0 +1,78 @@
+# Voucherify.Redemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique redemption ID. | [optional] 
+**object** | **String** | The type of the object represented by the JSON | [optional] [default to 'redemption']
+**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 is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. | [optional] 
+**redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] 
+**result** | **String** | Redemption result. | [optional] 
+**status** | **String** | Redemption status. | [optional] 
+**session** | [**RedemptionSession**](RedemptionSession.md) |  | [optional] 
+**relatedRedemptions** | [**RedemptionRelatedRedemptions**](RedemptionRelatedRedemptions.md) |  | [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** | [**RedemptionOrder**](RedemptionOrder.md) |  | [optional] 
+**channel** | [**RedemptionChannel**](RedemptionChannel.md) |  | [optional] 
+**customer** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] 
+**relatedObjectType** | **String** | Defines the related object. | [optional] 
+**relatedObjectId** | **String** | Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher. | [optional] 
+**promotionTier** | [**PromotionTier**](PromotionTier.md) |  | [optional] 
+**reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) |  | [optional] 
+**gift** | [**RedemptionGift**](RedemptionGift.md) |  | [optional] 
+**loyaltyCard** | [**RedemptionLoyaltyCard**](RedemptionLoyaltyCard.md) |  | [optional] 
+**voucher** | [**RedemptionVoucher**](RedemptionVoucher.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `redemption` (value: `"redemption"`)
+
+
+
+
+
+## Enum: ResultEnum
+
+
+* `SUCCESS` (value: `"SUCCESS"`)
+
+* `FAILURE` (value: `"FAILURE"`)
+
+
+
+
+
+## Enum: StatusEnum
+
+
+* `SUCCEEDED` (value: `"SUCCEEDED"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `ROLLED_BACK` (value: `"ROLLED_BACK"`)
+
+
+
+
+
+## Enum: RelatedObjectTypeEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `promotion_tier` (value: `"promotion_tier"`)
+
+* `redemption` (value: `"redemption"`)
+
+
+
+

package/docs/RedemptionChannel.md

@@ -0,0 +1,23 @@
+# Voucherify.RedemptionChannel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channelId** | **String** | Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API. For `AUTO_REDEEM`, it is the reward assignment ID. | [optional] 
+**channelType** | **String** | The source of the channel for the redemption. A `USER` corresponds to the Voucherify Dashboard, `API` corresponds to the API, and `AUTO_REDEEM` corresponds to a loyalty campaign reward that has been redeemed automatically. | [optional] 
+
+
+
+## Enum: ChannelTypeEnum
+
+
+* `USER` (value: `"USER"`)
+
+* `API` (value: `"API"`)
+
+* `AUTO_REDEEM` (value: `"AUTO_REDEEM"`)
+
+
+
+