v8.0.0 (#74)

Co-authored-by: p-zielinski <[email protected]>

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
 

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

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)

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] |

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] |

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] |

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] |
 

docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md

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

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] |

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] |
+

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] |
 

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] |
 

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] |
 

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] |
 

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] |
 

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] |

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] |