v5.0.2 (#56)

README.md

@@ -103,6 +103,12 @@ Remember that this SDK is auto generated (except of the tests) so changes made h
 
 ## 📅 Changelog
 
+- **2024-11-26** - `5.0.2`
+  - Added support for `STANDALONE` campaign type.
+  - Added optional `metadata` in `OrderCalculatedItemSku`
+  - New possible value of `ParameterExpandListCampaigns`
+  - New optional `error` parameter in `Error`
+  - Updated `LoyaltyCardTransactionDetailsBalance`
 - **2024-11-04** - `5.0.1`
   - Added support for returning `campaign_id` and `campaign_name` in stackable validation endpoint, when `redeemable` option is expanded
 - **2024-10-28** - `5.0.0`
@@ -626,6 +632,7 @@ Class | Method | HTTP request | Description
  - [EarningRuleSegment](docs/EarningRuleSegment.md)
  - [EarningRuleSource](docs/EarningRuleSource.md)
  - [Error](docs/Error.md)
+ - [ErrorError](docs/ErrorError.md)
  - [EventsCreateRequestBody](docs/EventsCreateRequestBody.md)
  - [EventsCreateRequestBodyLoyalty](docs/EventsCreateRequestBodyLoyalty.md)
  - [EventsCreateRequestBodyReferral](docs/EventsCreateRequestBodyReferral.md)
@@ -911,6 +918,8 @@ Class | Method | HTTP request | Description
  - [LoyaltyMemberLoyaltyCard](docs/LoyaltyMemberLoyaltyCard.md)
  - [LoyaltyMemberPublish](docs/LoyaltyMemberPublish.md)
  - [LoyaltyMemberRedemption](docs/LoyaltyMemberRedemption.md)
+ - [LoyaltyPointsBucket](docs/LoyaltyPointsBucket.md)
+ - [LoyaltyPointsBucketBucket](docs/LoyaltyPointsBucketBucket.md)
  - [LoyaltyTier](docs/LoyaltyTier.md)
  - [LoyaltyTierBase](docs/LoyaltyTierBase.md)
  - [LoyaltyTierBasePoints](docs/LoyaltyTierBasePoints.md)
@@ -1523,6 +1532,8 @@ Class | Method | HTTP request | Description
  - [VoucherAssets](docs/VoucherAssets.md)
  - [VoucherAssetsBarcode](docs/VoucherAssetsBarcode.md)
  - [VoucherAssetsQr](docs/VoucherAssetsQr.md)
+ - [VoucherBalance](docs/VoucherBalance.md)
+ - [VoucherBalanceRelatedObject](docs/VoucherBalanceRelatedObject.md)
  - [VoucherGift](docs/VoucherGift.md)
  - [VoucherLoyaltyCard](docs/VoucherLoyaltyCard.md)
  - [VoucherPublish](docs/VoucherPublish.md)

docs/AccessSettingsCampaignAssignmentsList.md

@@ -1,6 +1,6 @@
 # AccessSettingsCampaignAssignmentsList
 
-Lists all assignments of the campaign to areas and stores.  **NOTE**: This object is returned only if the Areas and Stores enterprise feature is enabled. Contact [Voucherify Sales](https://www.voucherify.io/contact-sales) to learn more.
+Lists all assignments of the campaign to areas and stores. For [GET List Campaigns](ref:list-campaigns), this is returned if the `expand=access_settings_assignments` query parameter is passed in the request.  **NOTE**: This object is returned only if the Areas and Stores enterprise feature is enabled. Contact [Voucherify Sales](https://www.voucherify.io/contact-sales) to learn more.
 
 ## Properties
 

docs/Campaign.md

@@ -9,10 +9,10 @@ Name | Type | Description | Notes
 **name** | **str** | Campaign name. | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
 **campaign_type** | **str** | Type of campaign. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
 **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
-**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
+**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] 
 **use_voucher_metadata_schema** | **bool** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
 **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.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 

docs/CampaignBase.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **name** | **str** | Campaign name. | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
 **campaign_type** | **str** | Type of campaign. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
 **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
-**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
+**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] 
 **use_voucher_metadata_schema** | **bool** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
 **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.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 

docs/CampaignsApi.md

@@ -204,7 +204,7 @@ Name | Type | Description  | Notes
 
 Create Campaign
 
-Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.    📘 Global uniqueness  All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.    🚧 Code generation status  This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description.
+Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.    📘 Global uniqueness  All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.    🚧 Code generation status  This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
 
 ### Example
 
@@ -859,7 +859,7 @@ with voucherify.ApiClient(configuration) as api_client:
     limit = 56 # int | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
     page = 56 # int | Which page of results to return. The lowest value is 1. (optional)
     campaign_type = voucherify.ParameterCampaignType() # ParameterCampaignType | This attribute allows filtering by campaign type. (optional)
-    expand = category # ParameterExpandListCampaigns | Include an expanded categories object in the response. (optional) (default to category)
+    expand = voucherify.ParameterExpandListCampaigns() # ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. (optional)
     order = voucherify.ParameterOrderListCampaigns() # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
     filters = voucherify.ParameterFiltersListCampaigns() # ParameterFiltersListCampaigns | Filters the results by campaign status or whether the campaign is a referral campaign. (optional)
 
@@ -882,7 +882,7 @@ Name | Type | Description  | Notes
  **limit** | **int**| Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] 
  **page** | **int**| Which page of results to return. The lowest value is 1. | [optional] 
  **campaign_type** | [**ParameterCampaignType**](.md)| This attribute allows filtering by campaign type. | [optional] 
- **expand** | [**ParameterExpandListCampaigns**](.md)| Include an expanded categories object in the response. | [optional] [default to category]
+ **expand** | [**ParameterExpandListCampaigns**](.md)| Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. | [optional] 
  **order** | [**ParameterOrderListCampaigns**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
  **filters** | [**ParameterFiltersListCampaigns**](.md)| Filters the results by campaign status or whether the campaign is a referral campaign. | [optional] 
 

docs/CampaignsCreateRequestBody.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | Campaign name. | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  `STATIC`: vouchers need to be manually published. | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published | [optional] 
 **join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
 **use_voucher_metadata_schema** | **bool** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 

docs/CampaignsCreateResponseBody.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **name** | **str** | Campaign name. | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
 **campaign_type** | **str** | Type of campaign. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
 **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
-**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
+**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] 
 **use_voucher_metadata_schema** | **bool** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
 **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.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 

docs/CampaignsGetResponseBody.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **name** | **str** | Campaign name. | [optional] 
 **description** | **str** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
 **campaign_type** | **str** | Type of campaign. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
 **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
-**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
+**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] 
 **use_voucher_metadata_schema** | **bool** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
 **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.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 

docs/CampaignsUpdateRequestBody.md

@@ -16,9 +16,9 @@ Name | Type | Description | Notes
 **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 `category`. | [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] 
-**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] 
+**join_once** | **bool** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] 
 **auto_join** | **bool** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
-**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  `STATIC`: vouchers need to be manually published. | [optional] 
+**type** | **str** | Defines whether the campaign can be updated with new vouchers after campaign creation.  - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). -  `STATIC`: vouchers need to be manually published.  If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] 
 **discount** | [**Discount**](Discount.md) |  | [optional] 
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **gift** | [**Gift**](Gift.md) |  | [optional]