@voucherify/sdk 2.9.3 → 3.0.0

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md

@@ -0,0 +1,27 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. | [optional] 
+**points** | **Number** | Number of points to be awarded, i.e. how many points to be added to the loyalty card. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+**object** | **String** | Type of object which will be covered by the earning rule. This is required together with `id`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used. | [optional] 
+**id** | **String** | Unique ID of the resource assigned by Voucherify. This is required together with `object`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used. Values are, for example, `pc_75U0dHlr7u75BJodrW1AE3t6` for product collection, `prod_0bae32322150fd0546` for a product, or `sku_0b7d7dfb090be5c619` for a SKU. | [optional] 
+**applicableTo** | [**[LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem]**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md) | Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by `object` and `id` to define only one object. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `products_collection` (value: `"products_collection"`)
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md

@@ -0,0 +1,23 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | Type of object which will be covered by the earning rule. | [optional] 
+**id** | **String** | Unique ID of the resource assigned by Voucherify. Values are, for example, `pc_75U0dHlr7u75BJodrW1AE3t6` for product collection, `prod_0bae32322150fd0546` for a product, or `sku_0b7d7dfb090be5c619` for a SKU. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `products_collection` (value: `"products_collection"`)
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md

@@ -0,0 +1,27 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. | [optional] 
+**points** | **Number** | Number of points to be awarded, i.e. how many points to be added to the loyalty card. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+**object** | **String** | Type of object which will be covered by the earning rule. This is required together with `id`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used. | [optional] 
+**id** | **String** | Unique ID of the resource assigned by Voucherify. This is required together with `object`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used. Values are, for example, `pc_75U0dHlr7u75BJodrW1AE3t6` for product collection, `prod_0bae32322150fd0546` for a product, or `sku_0b7d7dfb090be5c619` for a SKU. | [optional] 
+**applicableTo** | [**[LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem]**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md) | Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by `object` and `id` to define only one object. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `products_collection` (value: `"products_collection"`)
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md

@@ -0,0 +1,23 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | Type of object which will be covered by the earning rule. | [optional] 
+**id** | **String** | Unique ID of the resource assigned by Voucherify. Values are, for example, `pc_75U0dHlr7u75BJodrW1AE3t6` for product collection, `prod_0bae32322150fd0546` for a product, or `sku_0b7d7dfb090be5c619` for a SKU. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `products_collection` (value: `"products_collection"`)
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | For how many increments of the order metadata property to grant points for. | [optional] 
+**points** | **Number** | Number of points to be awarded, i.e. how many points to be added to the loyalty card. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+**property** | **String** | Order metadata property. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md

@@ -0,0 +1,11 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. | [optional] 
+**points** | **Number** | Number of points to be awarded, i.e. how many points to be added to the loyalty card. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md

@@ -0,0 +1,19 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodyPendingPoints
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**periodType** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only `DAY` value is accepted. | [optional] [default to 'DAY']
+**periodValue** | **Number** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] 
+
+
+
+## Enum: PeriodTypeEnum
+
+
+* `DAY` (value: `"DAY"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodySegment.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodySegment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesUpdateResponseBodySource.md

@@ -0,0 +1,20 @@
+# Voucherify.LoyaltiesEarningRulesUpdateResponseBodySource
+
+## 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] 
+**objectId** | **String** | A unique campaign identifier assigned by the Voucherify API. | [optional] 
+**objectType** | **String** | Defines the object associated with the earning rule. Defaults to `campaign`. | [optional] [default to 'campaign']
+
+
+
+## Enum: ObjectTypeEnum
+
+
+* `campaign` (value: `"campaign"`)
+
+
+
+

package/docs/LoyaltiesGetCampaignResponseBody.md

@@ -0,0 +1,114 @@
+# Voucherify.LoyaltiesGetCampaignResponseBody
+
+## 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] [default to 'LOYALTY_PROGRAM']
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] 
+**voucher** | [**LoyaltyCampaignVoucher**](LoyaltyCampaignVoucher.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** | Always set to `true` for loyalty campaigns, meaning customers can join the campaign only once. It can't be changed to `false`. | [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 campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` 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. | [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 category. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
+**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+**accessSettingsAssignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+
+
+
+
+## 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/LoyaltiesListCampaignsResponseBody.md

@@ -0,0 +1,21 @@
+# Voucherify.LoyaltiesListCampaignsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about loyalty campaigns in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of loyalty campaign objects. | [optional] [default to 'campaigns']
+**campaigns** | [**[LoyaltyCampaign]**](LoyaltyCampaign.md) | Contains an array of loyalty campaign objects. | [optional] 
+**total** | **Number** | Total number of loyalty campaign objects. | [optional] 
+
+
+
+## Enum: DataRefEnum
+
+
+* `campaigns` (value: `"campaigns"`)
+
+
+
+

package/docs/LoyaltiesListMembersResponseBody.md

@@ -0,0 +1,21 @@
+# Voucherify.LoyaltiesListMembersResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about members in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of voucher objects. | [optional] [default to 'vouchers']
+**vouchers** | [**[LoyaltyMember]**](LoyaltyMember.md) | Contains array of voucher objects representing loyalty cards, in other words, loyalty program members. | [optional] 
+**total** | **Number** | Total number of voucher objects. | [optional] 
+
+
+
+## Enum: DataRefEnum
+
+
+* `vouchers` (value: `"vouchers"`)
+
+
+
+

package/docs/LoyaltiesLoyaltyTierReward.md

@@ -0,0 +1,20 @@
+# Voucherify.LoyaltiesLoyaltyTierReward
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reward** | [**Reward**](Reward.md) |  | 
+**assignment** | [**RewardAssignment**](RewardAssignment.md) |  | 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the loyalty tier reward. | [default to 'loyalty_tier_reward']
+
+
+
+## Enum: ObjectEnum
+
+
+* `loyalty_tier_reward` (value: `"loyalty_tier_reward"`)
+
+
+
+

package/docs/LoyaltiesMemberActivityListResponseBody.md

@@ -0,0 +1,22 @@
+# Voucherify.LoyaltiesMemberActivityListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about member activities in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of member activity objects. | [optional] [default to 'data']
+**data** | [**[MemberActivity]**](MemberActivity.md) | Array of member activity objects. | [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 `starting_after_id` query or a different limit 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 event ID in the `starting_after_id` query parameter to display another page of the results starting after the event with that ID. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+

package/docs/LoyaltiesMembersBalanceUpdateRequestBody.md

@@ -0,0 +1,13 @@
+# Voucherify.LoyaltiesMembersBalanceUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | Incremental balance to be added to/subtracted from the loyalty card.  - To add points: 100 - To subtract points, add a minus: -100 | [optional] 
+**expirationType** | [**PointsExpirationTypes**](PointsExpirationTypes.md) |  | [optional] 
+**expirationDate** | **Date** | Set expiration date for added points, i.e. `YYYY-MM-DD`. This parameter is required only when expiration_type is set to `CUSTOM_DATE`. | [optional] 
+**reason** | **String** | Reason for the transfer. | [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] 
+
+

package/docs/LoyaltiesMembersBalanceUpdateResponseBody.md

@@ -0,0 +1,46 @@
+# Voucherify.LoyaltiesMembersBalanceUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | The incremental points removed or added to the current balance on the loyalty card. | [optional] 
+**total** | **Number** | The total of points accrued over the lifetime of the loyalty card. | [optional] 
+**balance** | **Number** | The balance after adding/removing points. | [optional] 
+**type** | **String** | The type of voucher being modified. | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is balance. | [optional] [default to 'balance']
+**relatedObject** | [**LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject**](LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md) |  | [optional] 
+**operationType** | **String** | The type of operation being performed. | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `loyalty_card` (value: `"loyalty_card"`)
+
+* `gift_voucher` (value: `"gift_voucher"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `balance` (value: `"balance"`)
+
+
+
+
+
+## Enum: OperationTypeEnum
+
+
+* `MANUAL` (value: `"MANUAL"`)
+
+* `AUTOMATIC` (value: `"AUTOMATIC"`)
+
+
+
+

package/docs/LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md

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

package/docs/LoyaltiesMembersCreateRequestBody.md

@@ -0,0 +1,13 @@
+# Voucherify.LoyaltiesMembersCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**voucher** | **String** | Code of voucher being published. | [optional] 
+**sourceId** | **String** | The merchant's publication ID if it is different from the Voucherify publication ID. It's an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service. If `source_id` is provided only 1 voucher can be published per request. | [optional] 
+**customer** | [**Customer**](Customer.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format. | [optional] 
+**channel** | **String** | Specify the distribution channel. | [optional] 
+
+

package/docs/LoyaltiesMembersCreateResponseBody.md

@@ -0,0 +1,64 @@
+# Voucherify.LoyaltiesMembersCreateResponseBody
+
+## 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. | [optional] 
+**categoryId** | **String** | Unique category ID assigned by Voucherify. | [optional] 
+**type** | **String** | Defines the type of the voucher.  | [optional] [default to 'LOYALTY_CARD']
+**discount** | **Object** |  | [optional] 
+**gift** | **Object** |  | [optional] 
+**loyaltyCard** | [**LoyaltiesMembersCreateResponseBodyLoyaltyCard**](LoyaltiesMembersCreateResponseBodyLoyaltyCard.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** | This is always false for loyalty members. | [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 identifier of the customer who owns the voucher. | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional] [default to 'voucher']
+**publish** | [**LoyaltiesMembersCreateResponseBodyPublish**](LoyaltiesMembersCreateResponseBodyPublish.md) |  | [optional] 
+**redemption** | [**LoyaltiesMembersCreateResponseBodyRedemption**](LoyaltiesMembersCreateResponseBodyRedemption.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `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/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md

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

@@ -0,0 +1,11 @@
+# Voucherify.LoyaltiesMembersCreateResponseBodyPublish
+
+## 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 event 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/LoyaltiesMembersCreateResponseBodyRedemption.md

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