@voucherify/sdk 2.9.3 → 3.0.0

package/docs/VouchersBalanceUpdateRequestBody.md

@@ -0,0 +1,11 @@
+# Voucherify.VouchersBalanceUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The incremental amount to be added to or removed from the current balance on the gift card or loyalty card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. To remove balance, simply add a minus sign before the value, i.e. to remove $20, use -2000. | [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. | [optional] 
+**reason** | **String** | Reason why the transaction occurred. | [optional] 
+
+

package/docs/VouchersBalanceUpdateResponseBody.md

@@ -0,0 +1,44 @@
+# Voucherify.VouchersBalanceUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift card or loyalty card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**total** | **Number** | Total income incurred over the lifespan of the gift card or loyalty card. | [optional] 
+**balance** | **Number** | The balance after adding or subtracting a specified amount. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**type** | **String** | The type of voucher being modified. | [optional] 
+**operationType** | **String** | The type of the operation being performed. | [optional] [default to 'MANUAL']
+**object** | **String** | The type of the object represented by JSON. Default is `balance`. | [optional] [default to 'balance']
+**relatedObject** | [**VouchersBalanceUpdateResponseBodyRelatedObject**](VouchersBalanceUpdateResponseBodyRelatedObject.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `gift_voucher` (value: `"gift_voucher"`)
+
+* `loyalty_card` (value: `"loyalty_card"`)
+
+
+
+
+
+## Enum: OperationTypeEnum
+
+
+* `MANUAL` (value: `"MANUAL"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `balance` (value: `"balance"`)
+
+
+
+

package/docs/VouchersBalanceUpdateResponseBodyRelatedObject.md

@@ -0,0 +1,19 @@
+# Voucherify.VouchersBalanceUpdateResponseBodyRelatedObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The object being modified, i.e. `voucher`. | [optional] [default to 'voucher']
+**id** | **String** | Identifies the voucher that is being modified, this is the ID that was assigned by the Voucherify API. | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+
+
+

package/docs/VouchersCreateRequestBody.md

@@ -0,0 +1,62 @@
+# Voucherify.VouchersCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the `code_config` object to set the rules that the Voucherify API will use to create a random code, or don't pass any code and Voucherify will generate a random code. | [optional] 
+**campaign** | **String** | Identifies the voucher's parent campaign using a unique campaign name. | [optional] 
+**campaignId** | **String** | Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API. | [optional] 
+**category** | **String** | The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] 
+**categoryId** | **String** | Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] 
+**startDate** | **Date** | Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date. | [optional] 
+**expirationDate** | **Date** | Expiration date defines when the code expires. Expiration timestamp is presented in the 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] 
+**validationRules** | **[String]** | Array containing the ID of the validation rule associated with the voucher. | [optional] 
+**redemption** | [**VouchersCreateRequestBodyRedemption**](VouchersCreateRequestBodyRedemption.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+**loyaltyCard** | [**SimpleLoyaltyCard**](SimpleLoyaltyCard.md) |  | [optional] 
+**codeConfig** | [**CodeConfig**](CodeConfig.md) |  | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+
+
+

package/docs/VouchersCreateRequestBodyRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.VouchersCreateRequestBodyRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+
+

package/docs/VouchersCreateResponseBody.md

@@ -0,0 +1,71 @@
+# Voucherify.VouchersCreateResponseBody
+
+## 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** | [**VouchersCreateResponseBodyGift**](VouchersCreateResponseBodyGift.md) |  | [optional] 
+**loyaltyCard** | [**VouchersCreateResponseBodyLoyaltyCard**](VouchersCreateResponseBodyLoyaltyCard.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** | [**VouchersCreateResponseBodyPublish**](VouchersCreateResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**VouchersCreateResponseBodyRedemption**](VouchersCreateResponseBodyRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.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/VouchersCreateResponseBodyGift.md

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

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

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

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

@@ -0,0 +1,60 @@
+# Voucherify.VouchersCreateWithSpecificCodeRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign** | **String** | Identifies the voucher's parent campaign using a unique campaign name. | [optional] 
+**campaignId** | **String** | Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API. | [optional] 
+**category** | **String** | The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] 
+**categoryId** | **String** | Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] 
+**startDate** | **Date** | Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date. | [optional] 
+**expirationDate** | **Date** | Expiration date defines when the code expires. Expiration timestamp is presented in the 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] 
+**validationRules** | **[String]** | Array containing the ID of the validation rule associated with the voucher. | [optional] 
+**redemption** | [**VouchersCreateWithSpecificCodeRequestBodyRedemption**](VouchersCreateWithSpecificCodeRequestBodyRedemption.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+**loyaltyCard** | [**SimpleLoyaltyCard**](SimpleLoyaltyCard.md) |  | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+
+
+

package/docs/VouchersCreateWithSpecificCodeRequestBodyRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.VouchersCreateWithSpecificCodeRequestBodyRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+
+

package/docs/VouchersDisableResponseBody.md

@@ -0,0 +1,71 @@
+# Voucherify.VouchersDisableResponseBody
+
+## 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** | [**VouchersDisableResponseBodyGift**](VouchersDisableResponseBodyGift.md) |  | [optional] 
+**loyaltyCard** | [**VouchersDisableResponseBodyLoyaltyCard**](VouchersDisableResponseBodyLoyaltyCard.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** | [**VouchersDisableResponseBodyPublish**](VouchersDisableResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**VouchersDisableResponseBodyRedemption**](VouchersDisableResponseBodyRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.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/VouchersDisableResponseBodyGift.md

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

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

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

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

@@ -0,0 +1,71 @@
+# Voucherify.VouchersEnableResponseBody
+
+## 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** | [**VouchersEnableResponseBodyGift**](VouchersEnableResponseBodyGift.md) |  | [optional] 
+**loyaltyCard** | [**VouchersEnableResponseBodyLoyaltyCard**](VouchersEnableResponseBodyLoyaltyCard.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** | [**VouchersEnableResponseBodyPublish**](VouchersEnableResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**VouchersEnableResponseBodyRedemption**](VouchersEnableResponseBodyRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.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/VouchersEnableResponseBodyGift.md

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

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

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