Merge pull request #54 from voucherifyio/versions/5.0.0

v5.0.0
voucherifyio · Nov 4, 2024 · d34662e · d34662e
2 parents f7cc66f + e144f71
commit d34662e
Show file tree

Hide file tree

Showing 103 changed files with 789 additions and 252 deletions.
diff --git a/README.md b/README.md
@@ -103,7 +103,13 @@ Remember that this SDK is auto generated (except of the tests) so changes made h
 
 ## 📅 Changelog
 
-- **2024-10-28** - `4.0.0`
+- **2024-10-28** - `5.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** - `4.0.0`
     - Fix object parsing in query. For example `filters` while listing redemptions.
     - !!! BREAKING CHANGES !!!
         - Remove support for `/client/v1/customers/{customerId}/consents` - put `Update Customer's consents (client-side) [Deprecated]`
@@ -597,6 +603,7 @@ Class | Method | HTTP request | Description
  - [CustomersUpdateResponseBodyAddress](docs/CustomersUpdateResponseBodyAddress.md)
  - [CustomersUpdateResponseBodyAssets](docs/CustomersUpdateResponseBodyAssets.md)
  - [Discount](docs/Discount.md)
+ - [DiscountProduct](docs/DiscountProduct.md)
  - [DiscountUnitMultipleOneUnit](docs/DiscountUnitMultipleOneUnit.md)
  - [EarningRule](docs/EarningRule.md)
  - [EarningRuleCustomEvent](docs/EarningRuleCustomEvent.md)
@@ -625,20 +632,16 @@ Class | Method | HTTP request | Description
  - [ExportOrderFields](docs/ExportOrderFields.md)
  - [ExportOrderOrder](docs/ExportOrderOrder.md)
  - [ExportParameters](docs/ExportParameters.md)
- - [ExportParametersFilters](docs/ExportParametersFilters.md)
  - [ExportResult](docs/ExportResult.md)
  - [ExportVoucherTransactionsFields](docs/ExportVoucherTransactionsFields.md)
  - [ExportVoucherTransactionsFilters](docs/ExportVoucherTransactionsFilters.md)
  - [ExportVoucherTransactionsOrder](docs/ExportVoucherTransactionsOrder.md)
  - [ExportsCreateRequestBody](docs/ExportsCreateRequestBody.md)
  - [ExportsCreateRequestBodyParameters](docs/ExportsCreateRequestBodyParameters.md)
- - [ExportsCreateRequestBodyParametersFilters](docs/ExportsCreateRequestBodyParametersFilters.md)
  - [ExportsCreateResponseBody](docs/ExportsCreateResponseBody.md)
  - [ExportsCreateResponseBodyParameters](docs/ExportsCreateResponseBodyParameters.md)
- - [ExportsCreateResponseBodyParametersFilters](docs/ExportsCreateResponseBodyParametersFilters.md)
  - [ExportsGetResponseBody](docs/ExportsGetResponseBody.md)
  - [ExportsGetResponseBodyParameters](docs/ExportsGetResponseBodyParameters.md)
- - [ExportsGetResponseBodyParametersFilters](docs/ExportsGetResponseBodyParametersFilters.md)
  - [ExportsGetResponseBodyResult](docs/ExportsGetResponseBodyResult.md)
  - [ExportsListResponseBody](docs/ExportsListResponseBody.md)
  - [FieldConditions](docs/FieldConditions.md)
@@ -1550,6 +1553,8 @@ Class | Method | HTTP request | Description
  - [VouchersBalanceUpdateRequestBody](docs/VouchersBalanceUpdateRequestBody.md)
  - [VouchersBalanceUpdateResponseBody](docs/VouchersBalanceUpdateResponseBody.md)
  - [VouchersBalanceUpdateResponseBodyRelatedObject](docs/VouchersBalanceUpdateResponseBodyRelatedObject.md)
+ - [VouchersCreateRequestBody](docs/VouchersCreateRequestBody.md)
+ - [VouchersCreateRequestBodyRedemption](docs/VouchersCreateRequestBodyRedemption.md)
  - [VouchersCreateResponseBody](docs/VouchersCreateResponseBody.md)
  - [VouchersCreateResponseBodyGift](docs/VouchersCreateResponseBodyGift.md)
  - [VouchersCreateResponseBodyLoyaltyCard](docs/VouchersCreateResponseBodyLoyaltyCard.md)

diff --git a/docs/CampaignsCreateRequestBody.md b/docs/CampaignsCreateRequestBody.md
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **activity_duration_after_publishing** | **str** | 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** | **str** | Unique category ID that this campaign belongs to. Either pass this parameter OR the &#x60;category&#x60;. | [optional] 
 **category** | **str** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [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** | **List[str]** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] 
 **campaign_type** | **str** |  | [optional] 
 **voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) |  | [optional] 

diff --git a/docs/CampaignsImportVoucherItem.md b/docs/CampaignsImportVoucherItem.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **code** | **str** | Value representing the imported code. | [optional] 
 **redemption** | [**CampaignsImportVoucherItemRedemption**](CampaignsImportVoucherItemRedemption.md) |  | [optional] 
 **active** | **bool** | A flag to toggle the voucher on or off. You can disable a voucher even though it&#39;s within the active period defined by the &#x60;start_date&#x60; and &#x60;expiration_date&#x60;.    - &#x60;true&#x60; indicates an *active* voucher - &#x60;false&#x60; 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** | **str** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](ref:list-vouchers) endpoint. | [optional] 
 **start_date** | **datetime** | 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** | **datetime** | 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] 

diff --git a/docs/CampaignsUpdateRequestBody.md b/docs/CampaignsUpdateRequestBody.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
 **category** | **str** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [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** | **List[str]** | Determine which metadata should be removed from campaign. | [optional] 
 **category_id** | **str** | Unique category ID that this campaign belongs to. Either pass this parameter OR the &#x60;category&#x60;. | [optional] 
 **activity_duration_after_publishing** | **str** | 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] 

diff --git a/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md b/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **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** | [**List[CategoryWithStackingRulesType]**](CategoryWithStackingRulesType.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md b/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md
@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**key** | **str** |  | [optional] 
 **message** | **str** |  | [optional] 
+**key** | **str** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Discount.md b/docs/Discount.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **unit_off** | **int** | Number of units to be granted a full value discount. | [optional] 
 **unit_off_formula** | **str** |  | [optional] 
 **unit_type** | **str** | 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** | [**List[DiscountUnitMultipleOneUnit]**](DiscountUnitMultipleOneUnit.md) |  | [optional] 
 **percent_off** | **float** | The percent discount that the customer will receive. | [optional] 

diff --git a/docs/DiscountProduct.md b/docs/DiscountProduct.md
@@ -0,0 +1,14 @@
+# DiscountProduct
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Unique product ID, assigned by Voucherify. | [optional] 
+**source_id** | **str** | Product&#39;s source ID. | [optional] 
+**name** | **str** | Product name. | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/EarningRuleLoyalty.md b/docs/EarningRuleLoyalty.md
@@ -6,12 +6,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **str** |  | [optional] 
+**points** | **int** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
 **calculation_type** | **str** |  | [optional] 
 **order** | [**EarningRuleLoyaltyOrder**](EarningRuleLoyaltyOrder.md) |  | [optional] 
 **order_items** | [**EarningRuleLoyaltyOrderItems**](EarningRuleLoyaltyOrderItems.md) |  | [optional] 
 **customer** | [**EarningRuleLoyaltyCustomer**](EarningRuleLoyaltyCustomer.md) |  | [optional] 
 **custom_event** | [**EarningRuleLoyaltyCustomEvent**](EarningRuleLoyaltyCustomEvent.md) |  | [optional] 
-**points** | **int** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ExportParameters.md b/docs/ExportParameters.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order** | **str** |  | [optional] 
 **fields** | **List[str]** | 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 \&quot;metadata.\&quot; or \&quot;redemption.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; or \&quot;address.\&quot; or \&quot;summary.\&quot; or \&quot;loyalty.\&quot; or \&quot;loyalty_tier.\&quot; or \&quot;loyalty_points.\&quot; or \&quot;system_metadata.\&quot; | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ExportsCreateRequestBodyParameters.md b/docs/ExportsCreateRequestBodyParameters.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order** | **str** |  | [optional] 
 **fields** | **List[str]** | 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 \&quot;metadata.\&quot; or \&quot;redemption.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; or \&quot;address.\&quot; or \&quot;summary.\&quot; or \&quot;loyalty.\&quot; or \&quot;loyalty_tier.\&quot; or \&quot;loyalty_points.\&quot; or \&quot;system_metadata.\&quot; | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ExportsCreateResponseBodyParameters.md b/docs/ExportsCreateResponseBodyParameters.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order** | **str** |  | [optional] 
 **fields** | **List[str]** | 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 \&quot;metadata.\&quot; or \&quot;redemption.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; or \&quot;address.\&quot; or \&quot;summary.\&quot; or \&quot;loyalty.\&quot; or \&quot;loyalty_tier.\&quot; or \&quot;loyalty_points.\&quot; or \&quot;system_metadata.\&quot; | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ExportsGetResponseBodyParameters.md b/docs/ExportsGetResponseBodyParameters.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order** | **str** |  | [optional] 
 **fields** | **List[str]** | 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 \&quot;metadata.\&quot; or \&quot;redemption.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; and Allowed additional properties must start with \&quot;metadata.\&quot; or \&quot;address.\&quot; or \&quot;summary.\&quot; or \&quot;loyalty.\&quot; or \&quot;loyalty_tier.\&quot; or \&quot;loyalty_points.\&quot; or \&quot;system_metadata.\&quot; | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md b/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
 **validity_day_of_week** | **List[int]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; 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] 

diff --git a/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md b/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
 **type** | **str** |  | [optional] 
 **points** | **int** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
 **calculation_type** | **str** |  | [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] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md b/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md
@@ -6,12 +6,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **str** |  | [optional] 
+**points** | **int** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
 **calculation_type** | **str** |  | [optional] 
 **order** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md) |  | [optional] 
 **order_items** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems.md) |  | [optional] 
 **customer** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md) |  | [optional] 
 **custom_event** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md) |  | [optional] 
-**points** | **int** | Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)