voucherify 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975f30def905da1be2113aa216f3cadb71729ca0af624ba07f1fd1fa2e9160a8
-  data.tar.gz: 2a04785161aaa255462c0c82164609de9c13fb9361c2acf0736748ab181aeb51
+  metadata.gz: 0cfa860ad1a89bbecdb001167c8535db422362f08463cc3b0defe52df109d373
+  data.tar.gz: 74e3d7ebc8493c06057d33b3127987816f131e2094a92135338ee4ecac3ac384
 SHA512:
-  metadata.gz: d08f967fd2feba68b9a56d4f8b8c3715e669bb9dfd7f62a4685670a41e8927b0c310a95c625f1236650a8bf32601254620cdbc2fb051a8e216c7cc3976ef1c91
-  data.tar.gz: d1b7492bfab83b6434e06fc6248b5172dba77e86a603e8c9252fa29083a42b9cc967dd9b0d48eb30ba561d519f0e77d1d8b8511161e29f484129b4d8c3595e92
+  metadata.gz: 1016d225a183845e3c020dbad2ed4ac09c40c1268486d91984ce7b002d0e247ed554f9d81fe3ac8298e261192069caff1a1408d5313aa3fcb448dcfa09521c5d
+  data.tar.gz: c091f4cd61e42bbf982effb3b52e4017e7fc1e10e4d13f07c8570d8c82fdcfd7aa90cdd5009a4479238a256b65cf15c01adffbb9d6cdc4128d2ec7c022155971

data/Dockerfile

@@ -5,7 +5,7 @@ WORKDIR /app
 COPY . .
 
 RUN gem build VoucherifySdk.gemspec
-RUN gem install voucherify-7.0.0.gem
+RUN gem install voucherify-8.0.0.gem
 RUN gem install dotenv
 RUN gem install rspec
 

data/EXAMPLES.md

@@ -67,15 +67,15 @@ gem build VoucherifySdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./VoucherifySdk-7.0.0.gem
+gem install ./VoucherifySdk-8.0.0.gem
 ```
 
-(for development, run `gem install --dev ./VoucherifySdk-7.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./VoucherifySdk-8.0.0.gem` to install the development dependencies)
 
 Add this to the Gemfile:
 
 ```shell
-gem 'VoucherifySdk', '~> 7.0.0'
+gem 'VoucherifySdk', '~> 8.0.0'
 ```
 
 Then install dependencies with bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    voucherify (7.0.0)
+    voucherify (8.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -113,7 +113,13 @@ Remember that this SDK is auto generated (except of the tests) so changes made h
 
 ## 📅 Changelog
 
-- **2024-10-28** - `7.0.0`
+- **2024-10-28** - `8.0.0`
+  - Added missing `enums` in few filters models
+  - !!! BREAKING CHANGES !!!
+    - VouchersApi.generateRandomCode now requires `VouchersCreateResponseBody` instead of plain `object`
+    - property `product` in model `Discount` now uses `DiscountProduct` instead of `SimpleProductDiscountUnit`
+    - property `filters` of model `ExportsCreateRequestBodyParameters` now uses plain `object` instead of `ExportsCreateRequestBodyParametersFilters`
+- **2024-10-25** - `7.0.0`
   - Fix object parsing in query. For example `filters` while listing redemptions.
   - !!! BREAKING CHANGES !!!
     - Remove support for `/v1/customers/{customerId}/consents` - put `Update Customer's consents [Deprecated]`
@@ -589,6 +595,7 @@ Class | Method | HTTP request | Description
  - [VoucherifySdk::CustomersUpdateResponseBodyAddress](docs/CustomersUpdateResponseBodyAddress.md)
  - [VoucherifySdk::CustomersUpdateResponseBodyAssets](docs/CustomersUpdateResponseBodyAssets.md)
  - [VoucherifySdk::Discount](docs/Discount.md)
+ - [VoucherifySdk::DiscountProduct](docs/DiscountProduct.md)
  - [VoucherifySdk::DiscountUnitMultipleOneUnit](docs/DiscountUnitMultipleOneUnit.md)
  - [VoucherifySdk::EarningRule](docs/EarningRule.md)
  - [VoucherifySdk::EarningRuleCustomEvent](docs/EarningRuleCustomEvent.md)
@@ -617,20 +624,16 @@ Class | Method | HTTP request | Description
  - [VoucherifySdk::ExportOrderFields](docs/ExportOrderFields.md)
  - [VoucherifySdk::ExportOrderOrder](docs/ExportOrderOrder.md)
  - [VoucherifySdk::ExportParameters](docs/ExportParameters.md)
- - [VoucherifySdk::ExportParametersFilters](docs/ExportParametersFilters.md)
  - [VoucherifySdk::ExportResult](docs/ExportResult.md)
  - [VoucherifySdk::ExportVoucherTransactionsFields](docs/ExportVoucherTransactionsFields.md)
  - [VoucherifySdk::ExportVoucherTransactionsFilters](docs/ExportVoucherTransactionsFilters.md)
  - [VoucherifySdk::ExportVoucherTransactionsOrder](docs/ExportVoucherTransactionsOrder.md)
  - [VoucherifySdk::ExportsCreateRequestBody](docs/ExportsCreateRequestBody.md)
  - [VoucherifySdk::ExportsCreateRequestBodyParameters](docs/ExportsCreateRequestBodyParameters.md)
- - [VoucherifySdk::ExportsCreateRequestBodyParametersFilters](docs/ExportsCreateRequestBodyParametersFilters.md)
  - [VoucherifySdk::ExportsCreateResponseBody](docs/ExportsCreateResponseBody.md)
  - [VoucherifySdk::ExportsCreateResponseBodyParameters](docs/ExportsCreateResponseBodyParameters.md)
- - [VoucherifySdk::ExportsCreateResponseBodyParametersFilters](docs/ExportsCreateResponseBodyParametersFilters.md)
  - [VoucherifySdk::ExportsGetResponseBody](docs/ExportsGetResponseBody.md)
  - [VoucherifySdk::ExportsGetResponseBodyParameters](docs/ExportsGetResponseBodyParameters.md)
- - [VoucherifySdk::ExportsGetResponseBodyParametersFilters](docs/ExportsGetResponseBodyParametersFilters.md)
  - [VoucherifySdk::ExportsGetResponseBodyResult](docs/ExportsGetResponseBodyResult.md)
  - [VoucherifySdk::ExportsListResponseBody](docs/ExportsListResponseBody.md)
  - [VoucherifySdk::FieldConditions](docs/FieldConditions.md)
@@ -1547,6 +1550,8 @@ Class | Method | HTTP request | Description
  - [VoucherifySdk::VouchersBalanceUpdateRequestBody](docs/VouchersBalanceUpdateRequestBody.md)
  - [VoucherifySdk::VouchersBalanceUpdateResponseBody](docs/VouchersBalanceUpdateResponseBody.md)
  - [VoucherifySdk::VouchersBalanceUpdateResponseBodyRelatedObject](docs/VouchersBalanceUpdateResponseBodyRelatedObject.md)
+ - [VoucherifySdk::VouchersCreateRequestBody](docs/VouchersCreateRequestBody.md)
+ - [VoucherifySdk::VouchersCreateRequestBodyRedemption](docs/VouchersCreateRequestBodyRedemption.md)
  - [VoucherifySdk::VouchersCreateResponseBody](docs/VouchersCreateResponseBody.md)
  - [VoucherifySdk::VouchersCreateResponseBodyGift](docs/VouchersCreateResponseBodyGift.md)
  - [VoucherifySdk::VouchersCreateResponseBodyLoyaltyCard](docs/VouchersCreateResponseBodyLoyaltyCard.md)

data/docs/CampaignsCreateRequestBody.md

@@ -19,7 +19,7 @@
 | **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
 | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
 | **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **validation_rules** | **Array<String>** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
 | **campaign_type** | **String** |  | [optional] |
 | **voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) |  | [optional] |

data/docs/CampaignsImportVoucherItem.md

@@ -7,7 +7,7 @@
 | **code** | **String** | Value representing the imported code. | [optional] |
 | **redemption** | [**CampaignsImportVoucherItemRedemption**](CampaignsImportVoucherItemRedemption.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] |
-| **metadata** | **Object** |  | [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] |
 | **category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](ref:list-vouchers) endpoint. | [optional] |
 | **start_date** | **Time** | Activation timestamp presented in the ISO 8601 format. Voucher is *inactive before* this date. Start date defines when the code starts to be active. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ | [optional] |
 | **expiration_date** | **Time** | Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format.  Voucher is *inactive after* this date. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ | [optional] |

data/docs/CampaignsUpdateRequestBody.md

@@ -11,7 +11,7 @@
 | **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
 | **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
 | **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
 | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
 | **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |

data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md

@@ -11,6 +11,6 @@
 | **applicable_to** | [**ApplicableToResultList**](ApplicableToResultList.md) |  | [optional] |
 | **inapplicable_to** | [**InapplicableToResultList**](InapplicableToResultList.md) |  | [optional] |
 | **result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) |  | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redeemable. | [optional] |
 | **categories** | [**Array<CategoryWithStackingRulesType>**](CategoryWithStackingRulesType.md) |  | [optional] |
 

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **key** | **String** |  | [optional] |
 | **message** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
 

data/docs/Discount.md

@@ -13,7 +13,7 @@
 | **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
 | **unit_off_formula** | **String** |  | [optional] |
 | **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
-| **product** | [**SimpleProductDiscountUnit**](SimpleProductDiscountUnit.md) |  | [optional] |
+| **product** | [**DiscountProduct**](DiscountProduct.md) |  | [optional] |
 | **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) |  | [optional] |
 | **units** | [**Array<DiscountUnitMultipleOneUnit>**](DiscountUnitMultipleOneUnit.md) |  | [optional] |
 | **percent_off** | **Float** | The percent discount that the customer will receive. | [optional] |

data/docs/DiscountProduct.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::DiscountProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique product ID, assigned by Voucherify. | [optional] |
+| **source_id** | **String** | Product's source ID. | [optional] |
+| **name** | **String** | Product name. | [optional] |
+

data/docs/EarningRuleLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**EarningRuleLoyaltyOrder**](EarningRuleLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**EarningRuleLoyaltyOrderItems**](EarningRuleLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**EarningRuleLoyaltyCustomer**](EarningRuleLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**EarningRuleLoyaltyCustomEvent**](EarningRuleLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/ExportParameters.md

@@ -6,5 +6,5 @@
 | ---- | ---- | ----------- | ----- |
 | **order** | **String** |  | [optional] |
 | **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
-| **filters** | [**ExportParametersFilters**](ExportParametersFilters.md) |  | [optional] |
+| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
 

data/docs/ExportsCreateRequestBodyParameters.md

@@ -6,5 +6,5 @@
 | ---- | ---- | ----------- | ----- |
 | **order** | **String** |  | [optional] |
 | **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
-| **filters** | [**ExportsCreateRequestBodyParametersFilters**](ExportsCreateRequestBodyParametersFilters.md) |  | [optional] |
+| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
 

data/docs/ExportsCreateResponseBodyParameters.md

@@ -6,5 +6,5 @@
 | ---- | ---- | ----------- | ----- |
 | **order** | **String** |  | [optional] |
 | **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
-| **filters** | [**ExportsCreateResponseBodyParametersFilters**](ExportsCreateResponseBodyParametersFilters.md) |  | [optional] |
+| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
 

data/docs/ExportsGetResponseBodyParameters.md

@@ -6,5 +6,5 @@
 | ---- | ---- | ----------- | ----- |
 | **order** | **String** |  | [optional] |
 | **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
-| **filters** | [**ExportsGetResponseBodyParametersFilters**](ExportsGetResponseBodyParametersFilters.md) |  | [optional] |
+| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
 

data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md

@@ -14,7 +14,7 @@
 | **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
 | **validity_day_of_week** | **Array<Integer>** | 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] |
 | **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **segment** | [**LoyaltiesEarningRulesCreateRequestBodyItemSegment**](LoyaltiesEarningRulesCreateRequestBodyItemSegment.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent**](LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent.md) |  | [optional] |
 | **loyalty_tier** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier.md) |  | [optional] |

data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md

@@ -7,8 +7,8 @@
 | **type** | **String** |  | [optional] |
 | **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
-| **custom_event** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent.md) |  | [optional] |
-| **order_items** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems.md) |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder.md) |  | [optional] |
+| **order_items** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer.md) |  | [optional] |
+| **custom_event** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent.md) |  | [optional] |
 

data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesGetResponseBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrder**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItems**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional] |
+| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 | **calculation_type** | **String** |  | [optional] |
 | **order** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrder.md) |  | [optional] |
 | **order_items** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItems.md) |  | [optional] |
 | **customer** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer.md) |  | [optional] |
 | **custom_event** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent.md) |  | [optional] |
-| **points** | **Integer** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] |
 

data/docs/ProductCollectionsProductsListResponseBodyDataItem.md

@@ -9,7 +9,7 @@
 | **name** | **String** | Unique user-defined product name. | [optional] |
 | **price** | **Integer** | 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** | **Array<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** |  | [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. and 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] |
 | **image_url** | **String** |  | [optional] |
 | **created_at** | **String** |  | [optional] |
 | **updated_at** | **String** |  | [optional] |

data/docs/PublicationsCreateRequestBody.md

@@ -7,7 +7,7 @@
 | **voucher** | **String** | Code of the voucher being published. | [optional] |
 | **source_id** | **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** |  | [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] |
 | **campaign** | [**CreatePublicationCampaign**](CreatePublicationCampaign.md) |  | [optional] |
 

data/docs/PublicationsCreateResponseBody.md

@@ -9,7 +9,7 @@
 | **created_at** | **Time** | Timestamp representing the date and time when the publication was created. The value is shown in the ISO 8601 format. | [optional] |
 | **customer_id** | **String** | Unique customer ID of the customer receiving the publication. | [optional] |
 | **tracking_id** | **String** | Customer's `source_id`. | [optional] |
-| **metadata** | **Object** |  | [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** | How the publication was originated. It can be your own custom channel or an example value provided here. | [optional][default to 'API'] |
 | **source_id** | **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.  | [optional] |
 | **result** | **String** | Status of the publication attempt. | [optional][default to 'SUCCESS'] |

data/docs/RedemptionEntry.md

@@ -9,7 +9,7 @@
 | **date** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **customer_id** | **String** | Unique customer ID of the redeeming customer. | [optional] |
 | **tracking_id** | **String** | Hashed customer source ID. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | [optional] |
 | **amount** | **Integer** | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. | [optional] |
 | **redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] |
 | **result** | **String** | Redemption result. | [optional] |

data/docs/RedemptionEntryCustomer.md

@@ -8,6 +8,6 @@
 | **name** | **String** | Customer's first and last name. | [optional] |
 | **email** | **String** | Customer's email address. | [optional] |
 | **source_id** | **String** | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'customer'] |
 

data/docs/RedemptionEntryOrder.md

@@ -17,7 +17,7 @@
 | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
 | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
 | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
@@ -25,5 +25,5 @@
 | **referrer_id** | **String** | Unique referrer ID. | [optional] |
 | **customer** | [**RedemptionEntryOrderCustomer**](RedemptionEntryOrderCustomer.md) |  | [optional] |
 | **referrer** | [**RedemptionEntryOrderReferrer**](RedemptionEntryOrderReferrer.md) |  | [optional] |
-| **redemptions** | **Object** |  | [optional] |
+| **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) |  | [optional] |
 

data/docs/RedemptionEntryPromotionTier.md

@@ -10,7 +10,7 @@
 | **name** | **String** | Name of the promotion tier. | [optional] |
 | **banner** | **String** | Text to be displayed to your customers on your website. | [optional] |
 | **action** | [**RedemptionEntryPromotionTierAction**](RedemptionEntryPromotionTierAction.md) |  | [optional] |
-| **metadata** | **Object** |  | [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** | **Integer** | 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] |
 | **promotion_id** | **String** | Promotion unique ID. | [optional] |
 | **campaign** | [**RedemptionEntryPromotionTierCampaign**](RedemptionEntryPromotionTierCampaign.md) |  | [optional] |

data/docs/RedemptionEntryVoucher.md

@@ -21,7 +21,7 @@
 | **validity_hours** | [**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] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/RedemptionsGetResponseBody.md

@@ -9,7 +9,7 @@
 | **date** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **customer_id** | **String** | Unique customer ID of the redeeming customer. | [optional] |
 | **tracking_id** | **String** | Hashed customer source ID. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | [optional] |
 | **amount** | **Integer** | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. | [optional] |
 | **redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] |
 | **result** | **String** | Redemption result. | [optional] |

data/docs/RedemptionsGetResponseBodyCustomer.md

@@ -8,6 +8,6 @@
 | **name** | **String** | Customer's first and last name. | [optional] |
 | **email** | **String** | Customer's email address. | [optional] |
 | **source_id** | **String** | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'customer'] |
 

data/docs/RedemptionsGetResponseBodyOrder.md

@@ -17,7 +17,7 @@
 | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
 | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
 | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
@@ -25,5 +25,5 @@
 | **referrer_id** | **String** | Unique referrer ID. | [optional] |
 | **customer** | [**RedemptionsGetResponseBodyOrderCustomer**](RedemptionsGetResponseBodyOrderCustomer.md) |  | [optional] |
 | **referrer** | [**RedemptionsGetResponseBodyOrderReferrer**](RedemptionsGetResponseBodyOrderReferrer.md) |  | [optional] |
-| **redemptions** | **Object** |  | [optional] |
+| **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) |  | [optional] |
 

data/docs/RedemptionsGetResponseBodyPromotionTier.md

@@ -10,7 +10,7 @@
 | **name** | **String** | Name of the promotion tier. | [optional] |
 | **banner** | **String** | Text to be displayed to your customers on your website. | [optional] |
 | **action** | [**RedemptionsGetResponseBodyPromotionTierAction**](RedemptionsGetResponseBodyPromotionTierAction.md) |  | [optional] |
-| **metadata** | **Object** |  | [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** | **Integer** | 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] |
 | **promotion_id** | **String** | Promotion unique ID. | [optional] |
 | **campaign** | [**RedemptionsGetResponseBodyPromotionTierCampaign**](RedemptionsGetResponseBodyPromotionTierCampaign.md) |  | [optional] |

data/docs/RedemptionsGetResponseBodyVoucher.md

@@ -21,7 +21,7 @@
 | **validity_hours** | [**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] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/RedemptionsListResponseBodyRedemptionsItem.md

@@ -9,7 +9,7 @@
 | **date** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **customer_id** | **String** | Unique customer ID of the redeeming customer. | [optional] |
 | **tracking_id** | **String** | Hashed customer source ID. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | [optional] |
 | **amount** | **Integer** | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. | [optional] |
 | **redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] |
 | **result** | **String** | Redemption result. | [optional] |

data/docs/RedemptionsListResponseBodyRedemptionsItemCustomer.md

@@ -8,6 +8,6 @@
 | **name** | **String** | Customer's first and last name. | [optional] |
 | **email** | **String** | Customer's email address. | [optional] |
 | **source_id** | **String** | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'customer'] |
 

data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md

@@ -17,7 +17,7 @@
 | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
 | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
 | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
@@ -25,5 +25,5 @@
 | **referrer_id** | **String** | Unique referrer ID. | [optional] |
 | **customer** | [**RedemptionsListResponseBodyRedemptionsItemOrderCustomer**](RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md) |  | [optional] |
 | **referrer** | [**RedemptionsListResponseBodyRedemptionsItemOrderReferrer**](RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md) |  | [optional] |
-| **redemptions** | **Object** |  | [optional] |
+| **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) |  | [optional] |
 

data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTier.md

@@ -10,7 +10,7 @@
 | **name** | **String** | Name of the promotion tier. | [optional] |
 | **banner** | **String** | Text to be displayed to your customers on your website. | [optional] |
 | **action** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierAction**](RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md) |  | [optional] |
-| **metadata** | **Object** |  | [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** | **Integer** | 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] |
 | **promotion_id** | **String** | Promotion unique ID. | [optional] |
 | **campaign** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign**](RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md) |  | [optional] |

data/docs/RedemptionsListResponseBodyRedemptionsItemVoucher.md

@@ -21,7 +21,7 @@
 | **validity_hours** | [**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] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
-| **metadata** | **Object** |  | [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] |
 | **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/RewardsCreateRequestBody.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Reward name. | [optional] |
 | **parameters** | [**RewardsCreateRequestBodyParameters**](RewardsCreateRequestBodyParameters.md) |  | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format. | [optional] |
 | **stock** | **Integer** | The number of units of the product that you want to share as a reward. | [optional] |
 | **attributes** | [**RewardsCreateRequestBodyAttributes**](RewardsCreateRequestBodyAttributes.md) |  | [optional] |
 

data/docs/RewardsUpdateRequestBody.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Reward name. | [optional] |
 | **parameters** | [**RewardsUpdateRequestBodyParameters**](RewardsUpdateRequestBodyParameters.md) |  | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format. | [optional] |
 | **stock** | **Integer** | The number of units of the product that you want to share as a reward. | [optional] |
 | **attributes** | [**RewardsUpdateRequestBodyAttributes**](RewardsUpdateRequestBodyAttributes.md) |  | [optional] |
 

data/docs/ValidationsValidateResponseBodyRedeemablesItem.md

@@ -11,6 +11,6 @@
 | **applicable_to** | [**ApplicableToResultList**](ApplicableToResultList.md) |  | [optional] |
 | **inapplicable_to** | [**InapplicableToResultList**](InapplicableToResultList.md) |  | [optional] |
 | **result** | [**ValidationsValidateResponseBodyRedeemablesItemResult**](ValidationsValidateResponseBodyRedeemablesItemResult.md) |  | [optional] |
-| **metadata** | **Object** |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redeemable. | [optional] |
 | **categories** | [**Array<CategoryWithStackingRulesType>**](CategoryWithStackingRulesType.md) |  | [optional] |