@voucherify/sdk 2.9.4 → 3.0.0

package/docs/LoyaltiesEarningRulesCreateResponseBody.md

@@ -0,0 +1,59 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Assigned by the Voucherify API, identifies the earning rule object. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format. | [optional] 
+**loyalty** | [**LoyaltiesEarningRulesCreateResponseBodyLoyalty**](LoyaltiesEarningRulesCreateResponseBodyLoyalty.md) |  | [optional] 
+**event** | **String** |  | [optional] 
+**customEvent** | [**LoyaltiesEarningRulesCreateResponseBodyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md) |  | [optional] 
+**segment** | [**LoyaltiesEarningRulesCreateResponseBodySegment**](LoyaltiesEarningRulesCreateResponseBodySegment.md) |  | [optional] 
+**loyaltyTier** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md) |  | [optional] 
+**pendingPoints** | [**LoyaltiesEarningRulesCreateResponseBodyPendingPoints**](LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md) |  | [optional] 
+**source** | [**LoyaltiesEarningRulesCreateResponseBodySource**](LoyaltiesEarningRulesCreateResponseBodySource.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional] [default to 'earning_rule']
+**automationId** | **String** | For internal use by Voucherify. | [optional] 
+**startDate** | **String** | Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default. | [optional] 
+**expirationDate** | **String** | Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default. | [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] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format. | [optional] 
+**expirationRules** | [**EarningRuleExpirationRules**](EarningRuleExpirationRules.md) |  | [optional] 
+**validationRuleId** | **String** | A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format. | [optional] 
+**active** | **Boolean** | A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the start_date and expiration_date of the campaign or the earning rule's own start_date and expiration_date.  - `true` indicates an active earning rule - `false` indicates an inactive earning rule | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `earning_rule` (value: `"earning_rule"`)
+
+
+
+
+
+## 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/LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyCustomEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schemaId** | **String** | Unique identifier of the custom event schema | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md

@@ -0,0 +1,50 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyalty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**points** | **Number** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+**calculationType** | **String** |  | [optional] 
+**order** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md) |  | [optional] 
+**orderItems** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems.md) |  | [optional] 
+**customer** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md) |  | [optional] 
+**customEvent** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `FIXED` (value: `"FIXED"`)
+
+* `PROPORTIONAL` (value: `"PROPORTIONAL"`)
+
+
+
+
+
+## Enum: CalculationTypeEnum
+
+
+* `ORDER_AMOUNT` (value: `"ORDER_AMOUNT"`)
+
+* `ORDER_TOTAL_AMOUNT` (value: `"ORDER_TOTAL_AMOUNT"`)
+
+* `ORDER_METADATA` (value: `"ORDER_METADATA"`)
+
+* `ORDER_ITEMS_QUANTITY` (value: `"ORDER_ITEMS_QUANTITY"`)
+
+* `ORDER_ITEMS_AMOUNT` (value: `"ORDER_ITEMS_AMOUNT"`)
+
+* `ORDER_ITEMS_SUBTOTAL_AMOUNT` (value: `"ORDER_ITEMS_SUBTOTAL_AMOUNT"`)
+
+* `CUSTOMER_METADATA` (value: `"CUSTOMER_METADATA"`)
+
+* `CUSTOM_EVENT_METADATA` (value: `"CUSTOM_EVENT_METADATA"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | For how many increments of the customer 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** |  Custom event metadata property. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | For how many increments of the customer 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** | Customer metadata property. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md

@@ -0,0 +1,11 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md) |  | [optional] 
+**totalAmount** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md) |  | [optional] 
+**metadata** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md

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

@@ -0,0 +1,11 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md) |  | [optional] 
+**amount** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md) |  | [optional] 
+**subtotalAmount** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md

@@ -0,0 +1,27 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount
+
+## 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** | [**[LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem]**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.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/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md

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

@@ -0,0 +1,27 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity
+
+## 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** | [**[LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem]**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.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/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md

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

@@ -0,0 +1,27 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount
+
+## 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** | [**[LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem]**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.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/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md

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

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata
+
+## 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/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md

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

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier
+
+## 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/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md

@@ -0,0 +1,19 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodyPendingPoints
+
+## 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/LoyaltiesEarningRulesCreateResponseBodySegment.md

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

package/docs/LoyaltiesEarningRulesCreateResponseBodySource.md

@@ -0,0 +1,20 @@
+# Voucherify.LoyaltiesEarningRulesCreateResponseBodySource
+
+## 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/LoyaltiesEarningRulesDisableResponseBody.md

@@ -0,0 +1,58 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Assigned by the Voucherify API, identifies the earning rule object. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format. | [optional] 
+**loyalty** | [**LoyaltiesEarningRulesDisableResponseBodyLoyalty**](LoyaltiesEarningRulesDisableResponseBodyLoyalty.md) |  | [optional] 
+**event** | **String** |  | [optional] 
+**customEvent** | [**LoyaltiesEarningRulesDisableResponseBodyCustomEvent**](LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md) |  | [optional] 
+**segment** | [**LoyaltiesEarningRulesDisableResponseBodySegment**](LoyaltiesEarningRulesDisableResponseBodySegment.md) |  | [optional] 
+**loyaltyTier** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier.md) |  | [optional] 
+**pendingPoints** | [**LoyaltiesEarningRulesDisableResponseBodyPendingPoints**](LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md) |  | [optional] 
+**source** | [**LoyaltiesEarningRulesDisableResponseBodySource**](LoyaltiesEarningRulesDisableResponseBodySource.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional] [default to 'earning_rule']
+**automationId** | **String** | For internal use by Voucherify. | [optional] 
+**startDate** | **String** | Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default. | [optional] 
+**expirationDate** | **String** | Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default. | [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] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format. | [optional] 
+**expirationRules** | [**EarningRuleExpirationRules**](EarningRuleExpirationRules.md) |  | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format. | [optional] 
+**active** | **Boolean** | A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the start_date and expiration_date of the campaign or the earning rule's own start_date and expiration_date. | [optional] [default to false]
+
+
+
+## Enum: ObjectEnum
+
+
+* `earning_rule` (value: `"earning_rule"`)
+
+
+
+
+
+## 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/LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyCustomEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schemaId** | **String** | Unique identifier of the custom event schema | [optional] 
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md

@@ -0,0 +1,50 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyalty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**points** | **Number** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
+**pointsFormula** | **String** | Formula used to dynamically calculate the rewarded points. | [optional] 
+**calculationType** | **String** |  | [optional] 
+**order** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder.md) |  | [optional] 
+**orderItems** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems.md) |  | [optional] 
+**customer** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md) |  | [optional] 
+**customEvent** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `FIXED` (value: `"FIXED"`)
+
+* `PROPORTIONAL` (value: `"PROPORTIONAL"`)
+
+
+
+
+
+## Enum: CalculationTypeEnum
+
+
+* `ORDER_AMOUNT` (value: `"ORDER_AMOUNT"`)
+
+* `ORDER_TOTAL_AMOUNT` (value: `"ORDER_TOTAL_AMOUNT"`)
+
+* `ORDER_METADATA` (value: `"ORDER_METADATA"`)
+
+* `ORDER_ITEMS_QUANTITY` (value: `"ORDER_ITEMS_QUANTITY"`)
+
+* `ORDER_ITEMS_AMOUNT` (value: `"ORDER_ITEMS_AMOUNT"`)
+
+* `ORDER_ITEMS_SUBTOTAL_AMOUNT` (value: `"ORDER_ITEMS_SUBTOTAL_AMOUNT"`)
+
+* `CUSTOMER_METADATA` (value: `"CUSTOMER_METADATA"`)
+
+* `CUSTOM_EVENT_METADATA` (value: `"CUSTOM_EVENT_METADATA"`)
+
+
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | For how many increments of the customer 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** |  Custom event metadata property. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md

@@ -0,0 +1,9 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md

@@ -0,0 +1,12 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**every** | **Number** | For how many increments of the customer 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** | Customer metadata property. | [optional] 
+
+

package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder.md

@@ -0,0 +1,11 @@
+# Voucherify.LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md) |  | [optional] 
+**totalAmount** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md) |  | [optional] 
+**metadata** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md) |  | [optional] 
+
+