@voucherify/sdk 2.9.3 → 3.0.0

package/docs/ProductsCreateRequestBody.md

@@ -0,0 +1,15 @@
+# Voucherify.ProductsCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the product and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | Unique product source ID. | [optional] 
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+
+

package/docs/ProductsCreateResponseBody.md

@@ -0,0 +1,28 @@
+# Voucherify.ProductsCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique product ID assigned by Voucherify. | [optional] 
+**sourceId** | **String** | Unique product source ID. | [optional] 
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional] [default to 'product']
+**skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `product` (value: `"product"`)
+
+
+
+

package/docs/ProductsGetResponseBody.md

@@ -0,0 +1,28 @@
+# Voucherify.ProductsGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique product ID assigned by Voucherify. | [optional] 
+**sourceId** | **String** | Unique product source ID. | [optional] 
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional] [default to 'product']
+**skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `product` (value: `"product"`)
+
+
+
+

package/docs/ProductsImportCsvCreateResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.ProductsImportCsvCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/ProductsListResponseBody.md

@@ -0,0 +1,12 @@
+# Voucherify.ProductsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about products in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of product objects. | [optional] [default to 'products']
+**products** | [**[Product]**](Product.md) | Contains array of product objects. | [optional] 
+**total** | **Number** | Total number of product objects. | [optional] 
+
+

package/docs/ProductsMetadataUpdateInBulkRequestBody.md

@@ -0,0 +1,10 @@
+# Voucherify.ProductsMetadataUpdateInBulkRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceIds** | **[String]** | Array of unique product source IDs. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] 
+
+

package/docs/ProductsMetadataUpdateInBulkResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.ProductsMetadataUpdateInBulkResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/ProductsSkusCreateRequestBody.md

@@ -0,0 +1,16 @@
+# Voucherify.ProductsSkusCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique SKU ID. | [optional] 
+**sourceId** | **String** | A unique SKU identifier from your inventory system. | [optional] 
+**sku** | **String** | Unique user-defined SKU name. | [optional] 
+**price** | **Number** | SKU unit price. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**currency** | **String** | SKU price currency. | [optional] 
+**attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] 
+
+

package/docs/ProductsSkusCreateResponseBody.md

@@ -0,0 +1,29 @@
+# Voucherify.ProductsSkusCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | A unique SKU identifier from your inventory system. | [optional] 
+**productId** | **String** | The parent product's unique ID. | [optional] 
+**sku** | **String** | Unique user-defined SKU name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**currency** | **String** | SKU price currency. | [optional] 
+**attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional] [default to 'sku']
+
+
+
+## Enum: ObjectEnum
+
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/ProductsSkusListResponseBody.md

@@ -0,0 +1,12 @@
+# Voucherify.ProductsSkusListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about SKUs. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the JSON property that contains the array of SKUs. | [optional] [default to 'data']
+**skus** | [**[Sku]**](Sku.md) | A dictionary that contains an array of SKUs. | [optional] 
+**total** | **Number** | Total number of SKUs in the product. | [optional] 
+
+

package/docs/ProductsSkusUpdateRequestBody.md

@@ -0,0 +1,14 @@
+# Voucherify.ProductsSkusUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **String** | Unique user-defined SKU name. | [optional] 
+**price** | **Number** | SKU unit price. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**currency** | **String** | SKU price currency. | [optional] 
+**attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] 
+
+

package/docs/ProductsSkusUpdateResponseBody.md

@@ -0,0 +1,29 @@
+# Voucherify.ProductsSkusUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] 
+**sourceId** | **String** | A unique SKU identifier from your inventory system. | [optional] 
+**productId** | **String** | The parent product's unique ID. | [optional] 
+**sku** | **String** | Unique user-defined SKU name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**currency** | **String** | SKU price currency. | [optional] 
+**attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional] [default to 'sku']
+
+
+
+## Enum: ObjectEnum
+
+
+* `sku` (value: `"sku"`)
+
+
+
+

package/docs/ProductsUpdateInBulkRequestBody.md

@@ -0,0 +1,14 @@
+# Voucherify.ProductsUpdateInBulkRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceId** | **String** | Unique product source ID from your inventory system. | [optional] 
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] 
+
+

package/docs/ProductsUpdateInBulkResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.ProductsUpdateInBulkResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/ProductsUpdateRequestBody.md

@@ -0,0 +1,13 @@
+# Voucherify.ProductsUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+
+

package/docs/ProductsUpdateResponseBody.md

@@ -0,0 +1,28 @@
+# Voucherify.ProductsUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique product ID assigned by Voucherify. | [optional] 
+**sourceId** | **String** | Unique product source ID. | [optional] 
+**name** | **String** | Unique user-defined product name. | [optional] 
+**price** | **Number** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] 
+**attributes** | **[String]** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. | [optional] 
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional] [default to 'product']
+**skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `product` (value: `"product"`)
+
+
+
+

package/docs/PromotionStack.md

@@ -0,0 +1,26 @@
+# Voucherify.PromotionStack
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Promotion stack name. | [optional] 
+**tiers** | [**PromotionStackTiers**](PromotionStackTiers.md) |  | [optional] 
+**id** | **String** | Unique promotion stack ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the promotion stack was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the promotion stack was updated. The value is shown in the ISO 8601 format. | [optional] 
+**campaignId** | **String** | Promotion stack's parent campaign's unique ID. | [optional] 
+**object** | **String** | The type of the object represented by JSON.  | [optional] [default to 'promotion_stack']
+**categoryId** | **String** | Promotion stack category ID. | [optional] 
+**categories** | [**[Category]**](Category.md) | Details about the category assigned to the promotion stack. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `promotion_stack` (value: `"promotion_stack"`)
+
+
+
+

package/docs/PromotionStackBase.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionStackBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Promotion stack name. | [optional] 
+**tiers** | [**PromotionStackBaseTiers**](PromotionStackBaseTiers.md) |  | [optional] 
+
+

package/docs/PromotionStackBaseTiers.md

@@ -0,0 +1,19 @@
+# Voucherify.PromotionStackBaseTiers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **[String]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
+**hierarchyMode** | **String** |  | [optional] [default to 'MANUAL']
+
+
+
+## Enum: HierarchyModeEnum
+
+
+* `MANUAL` (value: `"MANUAL"`)
+
+
+
+

package/docs/PromotionStackTiers.md

@@ -0,0 +1,19 @@
+# Voucherify.PromotionStackTiers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **[String]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
+**hierarchyMode** | **String** |  | [optional] [default to 'MANUAL']
+
+
+
+## Enum: HierarchyModeEnum
+
+
+* `MANUAL` (value: `"MANUAL"`)
+
+
+
+

package/docs/PromotionTier.md

@@ -0,0 +1,51 @@
+# Voucherify.PromotionTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique promotion tier ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] 
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**PromotionTierAction**](PromotionTierAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**promotionId** | **String** | Promotion unique ID. | [optional] 
+**campaign** | [**PromotionTierCampaign**](PromotionTierCampaign.md) |  | [optional] 
+**campaignId** | **String** | Promotion tier's parent campaign's unique ID. | [optional] 
+**active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier 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] 
+**summary** | [**PromotionTierSummary**](PromotionTierSummary.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional] [default to 'promotion_tier']
+**validationRuleAssignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] 
+**categoryId** | **String** | Promotion tier category ID. | [optional] 
+**categories** | [**[Category]**](Category.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`)
+
+
+
+

package/docs/PromotionTierAction.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionTierAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/PromotionTierCampaign.md

@@ -0,0 +1,38 @@
+# Voucherify.PromotionTierCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID. | [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] 
+**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 indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional] [default to 'campaign']
+
+
+
+## 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/PromotionTierCreateParams.md

@@ -0,0 +1,43 @@
+# Voucherify.PromotionTierCreateParams
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**PromotionTierCreateParamsAction**](PromotionTierCreateParamsAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**validationRules** | **[String]** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] 
+**active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier 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] 
+**category** | **String** | Assign category to the promotion tier. | [optional] 
+**categoryId** | **String** | Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e. `cat_0c9da30e7116ba6bba`. | [optional] 
+
+
+
+## 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/PromotionTierCreateParamsAction.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionTierCreateParamsAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/PromotionTierSummary.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionTierSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**PromotionTierSummaryRedemptions**](PromotionTierSummaryRedemptions.md) |  | [optional] 
+**orders** | [**PromotionTierSummaryOrders**](PromotionTierSummaryOrders.md) |  | [optional] 
+
+

package/docs/PromotionTierSummaryOrders.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionTierSummaryOrders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **Number** | Sum of order totals. | [optional] 
+**totalDiscountAmount** | **Number** | Sum of total discount applied using the promotion tier. | [optional] 
+
+

package/docs/PromotionTierSummaryRedemptions.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionTierSummaryRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalRedeemed** | **Number** | Number of times the promotion tier was redeemed. | [optional] 
+
+

package/docs/PromotionTiersList.md

@@ -0,0 +1,13 @@
+# Voucherify.PromotionTiersList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of promotion tier objects. | [optional] [default to 'tiers']
+**tiers** | [**[PromotionTier]**](PromotionTier.md) | Contains array of promotion tier objects. | [optional] 
+**total** | **Number** | Total number of promotion tiers. | [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 to get more records returned in the results. | [optional] 
+
+