voucherifyio · p-zielinski · Jan 28, 2025
diff --git a/ENDPOINTS-COVERAGE.md b/ENDPOINTS-COVERAGE.md
diff --git a/README.md b/README.md
diff --git a/docs/AccessSettingsAssign.md b/docs/AccessSettingsAssign.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **areas_ids** | **List[str]** | List all area IDs to which the campaign will be assigned. | [optional] 
 **area_stores_ids** | **List[str]** | List all store IDs to which the campaign will be assigned. | [optional] 
+**area_all_stores_ids** | **List[str]** | List all area IDs where the campaign is assigned to all stores in the area. This assignment is not equal to the assignment to all &#x60;area_stores_ids&#x60; listed separately. | [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/AccessSettingsUnassign.md b/docs/AccessSettingsUnassign.md
@@ -7,7 +7,8 @@ Unassigns the campaign from an area or a store. Provide the area and/or store ID
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **areas_ids** | **List[str]** | List all area IDs from which the campaign will be unassigned. | [optional] 
-**area_stores_ids** | **List[str]** | List all store IDs to which the campaign will be unassigned. | [optional] 
+**area_stores_ids** | **List[str]** | List all store IDs from which the campaign will be unassigned. | [optional] 
+**area_all_stores_ids** | **List[str]** | List all area IDs where the campaign will be unassigned from all stores in the area. This unassignment is not equal to the unassignment from all &#x60;area_stores_ids&#x60; listed separately. | [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/ApplicableTo.md b/docs/ApplicableTo.md
@@ -18,10 +18,11 @@ Name | Type | Description | Notes
 **aggregated_quantity_limit** | **int** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] 
 **amount_limit** | **int** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] 
 **aggregated_amount_limit** | **int** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - &#x60;APPLY_TO_ITEMS&#x60; (each item subtotal is discounted equally) - &#x60;APPLY_TO_ITEMS_BY_QUANTITY&#x60; (each unit of matched products has the same discount value) | [optional] 
-**order_item_indices** | **List[int]** | Determines the order in which the discount is applied to the products or SKUs sent in the &#x60;order&#x60; object in the request. The counting begins from &#x60;0&#x60;. | [optional] 
+**order_item_indices** | **List[int]** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the &#x60;order&#x60; object in the request. The first order line is assigned &#x60;0&#x60;, the second order line is assigned &#x60;1&#x60;, and so on. | [optional] 
+**order_item_units** | [**List[ApplicableToOrderItemUnitsItem]**](ApplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the &#x60;index&#x60; corresponds to the order line sent in the &#x60;order&#x60; object in the request. | [optional] 
 **repeat** | **int** | Determines the recurrence of the discount, e.g. &#x60;\&quot;repeat\&quot;: 3&#x60; means that the discount is applied to every third item. | [optional] 
 **skip_initially** | **int** | Determines how many items are skipped before the discount is applied. | [optional] 
-**target** | **str** | Determines to which kinds of objects the discount is applicable. &#x60;\&quot;ITEM\&quot;&#x60; includes products and SKUs. | [optional] 
+**target** | **str** | Determines to which kinds of objects the discount is applicable. &#x60;ITEM&#x60; includes products and SKUs. &#x60;UNIT&#x60; means particular units within an order line. | [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/ApplicableToOrderItemUnitsItem.md b/docs/ApplicableToOrderItemUnitsItem.md
@@ -0,0 +1,13 @@
+# ApplicableToOrderItemUnitsItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **int** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] 
+**units** | **List[int]** | Numbers of units in the order line covered by the discount; e.g. &#x60;2, 5, 8&#x60; for 10 units with the setting &#x60;\&quot;skip_initially\&quot;: 1&#x60;, &#x60;\&quot;repeat\&quot;: 3&#x60;. The counting of units starts from &#x60;1&#x60;. | [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/ApplicationDetailsItem.md b/docs/ApplicationDetailsItem.md
@@ -0,0 +1,19 @@
+# ApplicationDetailsItem
+
+Object representing item replacement.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_index** | **int** | Index number of the source item that is replaced. The enumeration starts from &#x60;0&#x60;, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, &#x60;source_index&#x60; equals &#x60;3&#x60;. | [optional] 
+**source_applied_quantity** | **int** | Number of source units that are replaced. | [optional] 
+**source_applied_quantity_amount** | **int** | Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity. | [optional] 
+**target_index** | **int** | Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, &#x60;target_index&#x60; equals &#x60;3&#x60;, as enumeration starts from &#x60;0&#x60;. | [optional] 
+**target_applied_quantity** | **int** | Number of added target units that are replacements. | [optional] 
+**target_applied_quantity_amount** | **int** | Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity. | [optional] 
+**target_applied_discount_amount** | **int** | Discount amount applied to the target item with regard to the replacement. Equals the &#x60;target_applied_quantity_amount&#x60; minus &#x60;source_applied_quantity_amount&#x60;. | [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/AreaStoreCampaignAssignment.md b/docs/AreaStoreCampaignAssignment.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **str** | Unique identifier of the campaign assignment. | [optional] 
 **area_id** | **str** | Unique identifier of the area to which the campaign is assigned. | [optional] 
+**all_stores** | **bool** | Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the &#x60;access_settings.assign.area_all_stores_ids&#x60; in the request. | [optional] 
 **area_store_id** | **str** | Unique identifier of the store to which the campaign is assigned. | [optional] 
 **created_at** | **datetime** | Date and time when the assignment was made. The value is shown in the ISO 8601 format. | [optional] 
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores. | [optional] [default to 'area_store_campaign_assignment']

diff --git a/docs/BinApi.md b/docs/BinApi.md
@@ -139,8 +139,8 @@ with voucherify.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = voucherify.BinApi(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)
-    order = voucherify.ParameterOrderListBin() # ParameterOrderListBin | Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. (optional)
-    starting_after_id = 'starting_after_id_example' # str | A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)
+    order = voucherify.ParameterOrderListBin() # ParameterOrderListBin | Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. (optional)
+    starting_after_id = 'starting_after_id_example' # str | A cursor for pagination. It retrieves the results starting after a result with the given ID. (optional)
     filters = voucherify.ParameterFiltersListBin() # ParameterFiltersListBin | Filters for listing bin entries. (optional)
 
     try:
@@ -160,8 +160,8 @@ with voucherify.ApiClient(configuration) as api_client:
 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] 
- **order** | [**ParameterOrderListBin**](.md)| Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] 
- **starting_after_id** | **str**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] 
+ **order** | [**ParameterOrderListBin**](.md)| Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **starting_after_id** | **str**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] 
  **filters** | [**ParameterFiltersListBin**](.md)| Filters for listing bin entries. | [optional] 
 
 ### Return type

diff --git a/docs/Campaign.md b/docs/Campaign.md
@@ -35,9 +35,9 @@ Name | Type | Description | Notes
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
 **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
 **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
-**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.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/CampaignBase.md b/docs/CampaignBase.md
@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.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/CampaignsCreateRequestBody.md b/docs/CampaignsCreateRequestBody.md
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **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** | 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] 
+**access_settings** | [**AccessSettings**](AccessSettings.md) |  | [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/CampaignsCreateResponseBody.md b/docs/CampaignsCreateResponseBody.md
@@ -36,9 +36,9 @@ Name | Type | Description | Notes
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
 **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
 **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
-**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.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/CampaignsGetResponseBody.md b/docs/CampaignsGetResponseBody.md
@@ -36,9 +36,9 @@ Name | Type | Description | Notes
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
 **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
 **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
-**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.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/CampaignsUpdateRequestBody.md b/docs/CampaignsUpdateRequestBody.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **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] 
+**access_settings** | [**AccessSettings**](AccessSettings.md) |  | [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 &#x60;true&#x60;, customers will be able to join the campaign only once. It is always &#x60;false&#x60; 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] 

diff --git a/docs/CampaignsUpdateResponseBody.md b/docs/CampaignsUpdateResponseBody.md
@@ -36,9 +36,9 @@ Name | Type | Description | Notes
 **object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
 **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
 **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
 **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
 **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
-**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.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/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md b/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md
@@ -6,10 +6,11 @@ Object representing loyalty card parameters. Child attributes are present only i
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**points** | **int** | Total points incurred over the lifespan of the loyalty card. | [optional] 
+**points** | **int** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] 
 **balance** | **int** | Points available for reward redemption. | [optional] 
 **next_expiration_date** | **date** | The next closest date when the next set of points are due to expire. | [optional] 
 **next_expiration_points** | **int** | The amount of points that are set to expire next. | [optional] 
+**pending_points** | **int** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [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/CampaignsVouchersCreateResponseBodyLoyaltyCard.md b/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md
@@ -6,10 +6,11 @@ Object representing loyalty card parameters. Child attributes are present only i
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**points** | **int** | Total points incurred over the lifespan of the loyalty card. | [optional] 
+**points** | **int** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] 
 **balance** | **int** | Points available for reward redemption. | [optional] 
 **next_expiration_date** | **date** | The next closest date when the next set of points are due to expire. | [optional] 
 **next_expiration_points** | **int** | The amount of points that are set to expire next. | [optional] 
+**pending_points** | **int** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [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)