@voucherify/sdk 2.9.3 → 3.0.0

package/docs/CampaignsTransactionsExportCreateResponseBody.md

@@ -0,0 +1,53 @@
+# Voucherify.CampaignsTransactionsExportCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique export ID. | [optional] 
+**object** | **String** | The type of object being represented. This object stores information about the `export`. | [optional] [default to 'export']
+**createdAt** | **Date** | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. | [optional] 
+**status** | **String** | Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated. | [optional] [default to 'SCHEDULED']
+**channel** | **String** | The channel through which the export was triggered. | [optional] [default to 'API']
+**exportedObject** | **String** | The type of exported object. | [optional] [default to 'voucher_transactions']
+**parameters** | [**CampaignsTransactionsExportCreateResponseBodyParameters**](CampaignsTransactionsExportCreateResponseBodyParameters.md) |  | [optional] 
+**result** | [**CampaignsTransactionsExportCreateResponseBodyResult**](CampaignsTransactionsExportCreateResponseBodyResult.md) |  | [optional] 
+**userId** | **String** | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the `channel` value is `WEBSITE`. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `export` (value: `"export"`)
+
+
+
+
+
+## Enum: StatusEnum
+
+
+* `SCHEDULED` (value: `"SCHEDULED"`)
+
+
+
+
+
+## Enum: ChannelEnum
+
+
+* `API` (value: `"API"`)
+
+
+
+
+
+## Enum: ExportedObjectEnum
+
+
+* `voucher_transactions` (value: `"voucher_transactions"`)
+
+
+
+

package/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md

@@ -0,0 +1,51 @@
+# Voucherify.CampaignsTransactionsExportCreateResponseBodyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **String** | How the export is ordered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] 
+**fields** | **[String]** | Data fields that will be exported for the transactions that are associated with balance movements on cards in a campaign. | [optional] 
+**filters** | [**CampaignsTransactionsExportCreateResponseBodyParametersFilters**](CampaignsTransactionsExportCreateResponseBodyParametersFilters.md) |  | [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"`)
+
+* `source` (value: `"source"`)
+
+* `details` (value: `"details"`)
+
+* `related_transaction_id` (value: `"related_transaction_id"`)
+
+
+
+

package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md

@@ -0,0 +1,12 @@
+# Voucherify.CampaignsTransactionsExportCreateResponseBodyParametersFilters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**junction** | [**Junction**](Junction.md) |  | [optional] 
+**createdAt** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) |  | [optional] 
+**voucherId** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
+**campaignId** | [**CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId**](CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md) |  | [optional] 
+
+

package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md

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

package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md

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

package/docs/CampaignsTransactionsExportCreateResponseBodyResult.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsTransactionsExportCreateResponseBodyResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of the CSV file location. It contains the `token` used for authorization in the [Download export](/api-reference/exports/download-export) method. | [optional] 
+
+

package/docs/CampaignsTransactionsListResponseBody.md

@@ -0,0 +1,31 @@
+# Voucherify.CampaignsTransactionsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of transaction objects. | [optional] [default to 'data']
+**data** | [**[VoucherTransaction]**](VoucherTransaction.md) | A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object. | [optional] 
+**hasMore** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different paging or a different start date filter) to get more records returned in the results. | [optional] 
+**moreStartingAfter** | **String** | Returns an ID that can be used to return another page of results. Use the transaction ID in the `starting_after_id` query parameter to display another page of the results starting after the transaction with that ID. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/CampaignsUpdateRequestBody.md

@@ -0,0 +1,60 @@
+# Voucherify.CampaignsUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
+**category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] 
+**unsetMetadataFields** | **[String]** | Determine which metadata should be removed from campaign. | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] 
+**accessSettings** | [**AccessSettings**](AccessSettings.md) |  | [optional] 
+**activityDurationAfterPublishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.  - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). -  `STATIC`: vouchers need to be manually published.  If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**referralProgram** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**options** | [**CampaignsUpdateRequestBodyOptions**](CampaignsUpdateRequestBodyOptions.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
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+
+
+

package/docs/CampaignsUpdateRequestBodyOptions.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsUpdateRequestBodyOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recalculateTiers** | **Boolean** | Determine if tiers should be recalculated or no. | [optional] 
+
+

package/docs/CampaignsUpdateResponseBody.md

@@ -0,0 +1,126 @@
+# Voucherify.CampaignsUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] 
+**name** | **String** | Campaign name. | [optional] 
+**description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
+**campaignType** | **String** | Type of campaign. | [optional] 
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
+**voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] 
+**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [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] 
+**activityDurationAfterPublishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] 
+**vouchersCount** | **Number** | Total number of unique vouchers in campaign. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] 
+**active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] 
+**category** | **String** | Unique category name. | [optional] 
+**creationStatus** | **String** | Indicates the status of the campaign creation. | [optional] 
+**vouchersGenerationStatus** | **String** | Indicates the status of the campaign's voucher generation. | [optional] 
+**readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the [GET Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint. | [optional] 
+**_protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the campaign category. For the GET [List campaigns](/api-reference/campaigns/list-campaigns) endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET [Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint, it is always returned as an empty array. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
+**referralProgram** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
+**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**accessSettingsAssignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
+**promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `PROMOTION` (value: `"PROMOTION"`)
+
+* `REFERRAL_PROGRAM` (value: `"REFERRAL_PROGRAM"`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+* `STANDALONE` (value: `"STANDALONE"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: CreationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+
+
+## Enum: VouchersGenerationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+

package/docs/CampaignsVouchersCreateCombinedResponseBody.md

@@ -0,0 +1,72 @@
+# Voucherify.CampaignsVouchersCreateCombinedResponseBody
+
+## 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** | [**CampaignsVouchersCreateCombinedResponseBodyGift**](CampaignsVouchersCreateCombinedResponseBodyGift.md) |  | [optional] 
+**loyaltyCard** | [**CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard**](CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.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** | [**CampaignsVouchersCreateCombinedResponseBodyPublish**](CampaignsVouchersCreateCombinedResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**CampaignsVouchersCreateCombinedResponseBodyRedemption**](CampaignsVouchersCreateCombinedResponseBodyRedemption.md) |  | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the category. | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [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/CampaignsVouchersCreateCombinedResponseBodyGift.md

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

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

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

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

@@ -0,0 +1,16 @@
+# Voucherify.CampaignsVouchersCreateInBulkRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Unique voucher code. | [optional] 
+**codeConfig** | [**CodeConfig**](CodeConfig.md) |  | [optional] 
+**category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the voucher. 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] 
+**redemption** | [**CampaignsVouchersCreateInBulkRequestBodyRedemption**](CampaignsVouchersCreateInBulkRequestBodyRedemption.md) |  | [optional] 
+**additionalInfo** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the voucher starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the voucher expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] 
+
+

package/docs/CampaignsVouchersCreateInBulkRequestBodyRedemption.md

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

package/docs/CampaignsVouchersCreateRequestBody.md

@@ -0,0 +1,14 @@
+# Voucherify.CampaignsVouchersCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the voucher. 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] 
+**redemption** | [**CampaignsVouchersCreateRequestBodyRedemption**](CampaignsVouchersCreateRequestBodyRedemption.md) |  | [optional] 
+**additionalInfo** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the voucher starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the voucher expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] 
+
+

package/docs/CampaignsVouchersCreateRequestBodyRedemption.md

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

package/docs/CampaignsVouchersCreateResponseBody.md

@@ -0,0 +1,71 @@
+# Voucherify.CampaignsVouchersCreateResponseBody
+
+## 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** | [**CampaignsVouchersCreateResponseBodyGift**](CampaignsVouchersCreateResponseBodyGift.md) |  | [optional] 
+**loyaltyCard** | [**CampaignsVouchersCreateResponseBodyLoyaltyCard**](CampaignsVouchersCreateResponseBodyLoyaltyCard.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** | [**CampaignsVouchersCreateResponseBodyPublish**](CampaignsVouchersCreateResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**CampaignsVouchersCreateResponseBodyRedemption**](CampaignsVouchersCreateResponseBodyRedemption.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`)
+
+
+
+