@voucherify/sdk 2.9.3 → 3.0.0

package/docs/VoucherLoyaltyCard.md

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

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

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

@@ -0,0 +1,51 @@
+# Voucherify.VoucherTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique transaction ID. | [optional] 
+**sourceId** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] 
+**voucherId** | **String** | Unique voucher ID. | [optional] 
+**campaignId** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] 
+**source** | **String** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] 
+**reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] 
+**relatedTransactionId** | **String** | The related transaction ID on the receiving card. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] 
+**details** | [**VoucherTransactionDetails**](VoucherTransactionDetails.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `CREDITS_REDEMPTION` (value: `"CREDITS_REDEMPTION"`)
+
+* `CREDITS_REFUND` (value: `"CREDITS_REFUND"`)
+
+* `CREDITS_ADDITION` (value: `"CREDITS_ADDITION"`)
+
+* `CREDITS_REMOVAL` (value: `"CREDITS_REMOVAL"`)
+
+* `PENDING_POINTS_ACTIVATION` (value: `"PENDING_POINTS_ACTIVATION"`)
+
+* `POINTS_ACCRUAL` (value: `"POINTS_ACCRUAL"`)
+
+* `POINTS_REDEMPTION` (value: `"POINTS_REDEMPTION"`)
+
+* `POINTS_REFUND` (value: `"POINTS_REFUND"`)
+
+* `POINTS_ADDITION` (value: `"POINTS_ADDITION"`)
+
+* `POINTS_REMOVAL` (value: `"POINTS_REMOVAL"`)
+
+* `POINTS_EXPIRATION` (value: `"POINTS_EXPIRATION"`)
+
+* `POINTS_TRANSFER_IN` (value: `"POINTS_TRANSFER_IN"`)
+
+* `POINTS_TRANSFER_OUT` (value: `"POINTS_TRANSFER_OUT"`)
+
+
+
+

package/docs/VoucherTransactionDetails.md

@@ -0,0 +1,23 @@
+# Voucherify.VoucherTransactionDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | [**VoucherBalance**](VoucherBalance.md) |  | [optional] 
+**order** | [**VoucherTransactionDetailsOrder**](VoucherTransactionDetailsOrder.md) |  | [optional] 
+**event** | [**VoucherTransactionDetailsEvent**](VoucherTransactionDetailsEvent.md) |  | [optional] 
+**earningRule** | [**VoucherTransactionDetailsEarningRule**](VoucherTransactionDetailsEarningRule.md) |  | [optional] 
+**segment** | [**VoucherTransactionDetailsSegment**](VoucherTransactionDetailsSegment.md) |  | [optional] 
+**loyaltyTier** | [**VoucherTransactionDetailsLoyaltyTier**](VoucherTransactionDetailsLoyaltyTier.md) |  | [optional] 
+**redemption** | [**VoucherTransactionDetailsRedemption**](VoucherTransactionDetailsRedemption.md) |  | [optional] 
+**rollback** | [**VoucherTransactionDetailsRollback**](VoucherTransactionDetailsRollback.md) |  | [optional] 
+**customEvent** | [**VoucherTransactionDetailsCustomEvent**](VoucherTransactionDetailsCustomEvent.md) |  | [optional] 
+**eventSchema** | [**VoucherTransactionDetailsEventSchema**](VoucherTransactionDetailsEventSchema.md) |  | [optional] 
+**holderLoyaltyTier** | [**VoucherTransactionDetailsHolderLoyaltyTier**](VoucherTransactionDetailsHolderLoyaltyTier.md) |  | [optional] 
+**pendingPoints** | [**LoyaltyPendingPoints**](LoyaltyPendingPoints.md) |  | [optional] 
+**reward** | [**VoucherTransactionDetailsReward**](VoucherTransactionDetailsReward.md) |  | [optional] 
+**sourceVoucher** | [**SimpleVoucher**](SimpleVoucher.md) |  | [optional] 
+**destinationVoucher** | [**SimpleVoucher**](SimpleVoucher.md) |  | [optional] 
+
+

package/docs/VoucherTransactionDetailsCustomEvent.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsCustomEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the event. | [optional] 
+**type** | **String** | Type of the custom event. | [optional] 
+
+

package/docs/VoucherTransactionDetailsEarningRule.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsEarningRule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | [optional] 
+**source** | [**VoucherTransactionDetailsEarningRuleSource**](VoucherTransactionDetailsEarningRuleSource.md) |  | [optional] 
+
+

package/docs/VoucherTransactionDetailsEarningRuleSource.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionDetailsEarningRuleSource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**banner** | **String** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
+
+

package/docs/VoucherTransactionDetailsEvent.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique event ID. | [optional] 
+**type** | **String** | Type of event. | [optional] 
+
+

package/docs/VoucherTransactionDetailsEventSchema.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsEventSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the metadata schema. | [optional] 
+**name** | **String** | Type of the custom event. | [optional] 
+
+

package/docs/VoucherTransactionDetailsHolderLoyaltyTier.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsHolderLoyaltyTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] 
+**name** | **String** | User-defined name of the loyalty tier. | [optional] 
+
+

package/docs/VoucherTransactionDetailsLoyaltyTier.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsLoyaltyTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] 
+**name** | **String** | User-defined name of the loyalty tier. | [optional] 
+
+

package/docs/VoucherTransactionDetailsOrder.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique order ID. | [optional] 
+**sourceId** | **String** | The merchant's order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. | [optional] 
+
+

package/docs/VoucherTransactionDetailsRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionDetailsRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique redemption ID. | [optional] 
+
+

package/docs/VoucherTransactionDetailsReward.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsReward
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique reward ID. | [optional] 
+**name** | **String** | Reward name. | [optional] 
+
+

package/docs/VoucherTransactionDetailsRollback.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionDetailsRollback
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the redemption rollback. | [optional] 
+
+

package/docs/VoucherTransactionDetailsSegment.md

@@ -0,0 +1,10 @@
+# Voucherify.VoucherTransactionDetailsSegment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the segment. | [optional] 
+**name** | **String** | Name of the segment. | [optional] 
+
+

package/docs/VoucherTransactionsExportFilterConditions.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionsExportFilterConditions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**voucherId** | [**VoucherTransactionsExportFilterConditionsVoucherId**](VoucherTransactionsExportFilterConditionsVoucherId.md) |  | [optional] 
+
+

package/docs/VoucherTransactionsExportFilterConditionsVoucherId.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionsExportFilterConditionsVoucherId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditions** | [**VoucherTransactionsExportFilterConditionsVoucherIdConditions**](VoucherTransactionsExportFilterConditionsVoucherIdConditions.md) |  | [optional] 
+
+

package/docs/VoucherTransactionsExportFilterConditionsVoucherIdConditions.md

@@ -0,0 +1,9 @@
+# Voucherify.VoucherTransactionsExportFilterConditionsVoucherIdConditions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_in** | **[String]** |  | [optional] 
+
+

package/docs/VoucherTransactionsExportParameters.md

@@ -0,0 +1,52 @@
+# Voucherify.VoucherTransactionsExportParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **String** | How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] 
+**fields** | **[String]** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:  | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br /> - `CREDITS_ADDITION` <br /> - `CREDITS_REFUND` <br /> - `CREDITS_REDEMPTION` <br /> - `POINTS_ACCRUAL` <br /> - `POINTS_REDEMPTION`<br /> - `POINTS_REFUND`<br /> - `POINTS_ADDITION`<br /> - `POINTS_REMOVAL`<br /> - `POINTS_EXPIRATION`<br /> - `POINTS_TRANSFER_IN`<br /> - `POINTS_TRANSFER_OUT` | | source_id | Unique transaction source ID. | 8638 | | reason | Contains the reason for the transaction if one was included originally. |  | | balance | The gift card or loyalty card balance after the transaction. |  | | amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. |  | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z  | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source|  Channel through which the transaction was initiated. | API | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 | | [optional] 
+
+
+
+## Enum: OrderEnum
+
+
+* `-created_at` (value: `"-created_at"`)
+
+* `created_at` (value: `"created_at"`)
+
+
+
+
+
+## Enum: [FieldsEnum]
+
+
+* `id` (value: `"id"`)
+
+* `type` (value: `"type"`)
+
+* `source_id` (value: `"source_id"`)
+
+* `reason` (value: `"reason"`)
+
+* `balance` (value: `"balance"`)
+
+* `amount` (value: `"amount"`)
+
+* `created_at` (value: `"created_at"`)
+
+* `voucher_id` (value: `"voucher_id"`)
+
+* `campaign_id` (value: `"campaign_id"`)
+
+* `source` (value: `"source"`)
+
+* `details` (value: `"details"`)
+
+* `related_transaction_id` (value: `"related_transaction_id"`)
+
+
+
+

package/docs/VoucherTransactionsFilters.md

@@ -0,0 +1,53 @@
+# Voucherify.VoucherTransactionsFilters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **String** | How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] 
+**fields** | **[String]** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:  | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br /> - `CREDITS_ADDITION` <br /> - `CREDITS_REFUND` <br /> - `CREDITS_REDEMPTION` <br /> - `POINTS_ACCRUAL`<br /> - `POINTS_REDEMPTION`<br /> - `POINTS_REFUND`<br /> - `POINTS_ADDITION`<br /> - `POINTS_REMOVAL`<br /> - `POINTS_EXPIRATION`<br /> - `POINTS_TRANSFER_IN`<br /> - `POINTS_TRANSFER_OUT` | | source_id | Unique transaction source ID. | 8638 | | reason | Contains the reason for the transaction if one was included originally. |  | | balance | The gift card or loyalty card balance after the transaction. |  | | amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. |  | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z  | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source|  Channel through which the transaction was initiated. | API | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 | | [optional] 
+**filters** | [**VoucherTransactionsExportFilterConditions**](VoucherTransactionsExportFilterConditions.md) |  | 
+
+
+
+## Enum: OrderEnum
+
+
+* `-created_at` (value: `"-created_at"`)
+
+* `created_at` (value: `"created_at"`)
+
+
+
+
+
+## Enum: [FieldsEnum]
+
+
+* `id` (value: `"id"`)
+
+* `type` (value: `"type"`)
+
+* `source_id` (value: `"source_id"`)
+
+* `reason` (value: `"reason"`)
+
+* `balance` (value: `"balance"`)
+
+* `amount` (value: `"amount"`)
+
+* `created_at` (value: `"created_at"`)
+
+* `voucher_id` (value: `"voucher_id"`)
+
+* `campaign_id` (value: `"campaign_id"`)
+
+* `source` (value: `"source"`)
+
+* `details` (value: `"details"`)
+
+* `related_transaction_id` (value: `"related_transaction_id"`)
+
+
+
+

package/docs/VoucherWithCategories.md

@@ -0,0 +1,70 @@
+# Voucherify.VoucherWithCategories
+
+## 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** | [**VoucherWithCategoriesGift**](VoucherWithCategoriesGift.md) |  | [optional] 
+**loyaltyCard** | [**VoucherWithCategoriesLoyaltyCard**](VoucherWithCategoriesLoyaltyCard.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** | [**VoucherWithCategoriesPublish**](VoucherWithCategoriesPublish.md) |  | [optional] 
+**redemption** | [**VoucherWithCategoriesRedemption**](VoucherWithCategoriesRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [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/VoucherWithCategoriesGift.md

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

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

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

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