Skip to content

Commit 24c04a5

Browse files
authored
v5.0.3 (#58)
1 parent a078868 commit 24c04a5

File tree

212 files changed

+8060
-2022
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

212 files changed

+8060
-2022
lines changed

ENDPOINTS-COVERAGE.md

Lines changed: 53 additions & 48 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 44 additions & 2 deletions
Large diffs are not rendered by default.

docs/AccessSettingsAssign.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**areas_ids** | **List[str]** | List all area IDs to which the campaign will be assigned. | [optional]
1010
**area_stores_ids** | **List[str]** | List all store IDs to which the campaign will be assigned. | [optional]
11+
**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 `area_stores_ids` listed separately. | [optional]
1112

1213
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1314

docs/AccessSettingsUnassign.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Unassigns the campaign from an area or a store. Provide the area and/or store ID
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**areas_ids** | **List[str]** | List all area IDs from which the campaign will be unassigned. | [optional]
10-
**area_stores_ids** | **List[str]** | List all store IDs to which the campaign will be unassigned. | [optional]
10+
**area_stores_ids** | **List[str]** | List all store IDs from which the campaign will be unassigned. | [optional]
11+
**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 `area_stores_ids` listed separately. | [optional]
1112

1213
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1314

docs/ApplicableTo.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@ Name | Type | Description | Notes
1818
**aggregated_quantity_limit** | **int** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional]
1919
**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]
2020
**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: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional]
21-
**order_item_indices** | **List[int]** | Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`. | [optional]
21+
**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 `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional]
22+
**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 `index` corresponds to the order line sent in the `order` object in the request. | [optional]
2223
**repeat** | **int** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional]
2324
**skip_initially** | **int** | Determines how many items are skipped before the discount is applied. | [optional]
24-
**target** | **str** | Determines to which kinds of objects the discount is applicable. `\"ITEM\"` includes products and SKUs. | [optional]
25+
**target** | **str** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional]
2526

2627
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2728

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ApplicableToOrderItemUnitsItem
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**index** | **int** | Number assigned to the order line item in accordance with the order sent in the request. | [optional]
9+
**units** | **List[int]** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

docs/ApplicationDetailsItem.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# ApplicationDetailsItem
2+
3+
Object representing item replacement.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**source_index** | **int** | Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`. | [optional]
10+
**source_applied_quantity** | **int** | Number of source units that are replaced. | [optional]
11+
**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]
12+
**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, `target_index` equals `3`, as enumeration starts from `0`. | [optional]
13+
**target_applied_quantity** | **int** | Number of added target units that are replacements. | [optional]
14+
**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]
15+
**target_applied_discount_amount** | **int** | Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`. | [optional]
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

docs/AreaStoreCampaignAssignment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**id** | **str** | Unique identifier of the campaign assignment. | [optional]
1010
**area_id** | **str** | Unique identifier of the area to which the campaign is assigned. | [optional]
11+
**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 `access_settings.assign.area_all_stores_ids` in the request. | [optional]
1112
**area_store_id** | **str** | Unique identifier of the store to which the campaign is assigned. | [optional]
1213
**created_at** | **datetime** | Date and time when the assignment was made. The value is shown in the ISO 8601 format. | [optional]
1314
**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']

docs/BinApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ with voucherify.ApiClient(configuration) as api_client:
139139
# Create an instance of the API class
140140
api_instance = voucherify.BinApi(api_client)
141141
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)
142-
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)
143-
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)
142+
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)
143+
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)
144144
filters = voucherify.ParameterFiltersListBin() # ParameterFiltersListBin | Filters for listing bin entries. (optional)
145145

146146
try:
@@ -160,8 +160,8 @@ with voucherify.ApiClient(configuration) as api_client:
160160
Name | Type | Description | Notes
161161
------------- | ------------- | ------------- | -------------
162162
**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]
163-
**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]
164-
**starting_after_id** | **str**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional]
163+
**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]
164+
**starting_after_id** | **str**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional]
165165
**filters** | [**ParameterFiltersListBin**](.md)| Filters for listing bin entries. | [optional]
166166

167167
### Return type

docs/Campaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ Name | Type | Description | Notes
3535
**object** | **str** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
3636
**referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional]
3737
**loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional]
38+
**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional]
3839
**promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional]
3940
**validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional]
40-
**access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional]
4141

4242
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4343

0 commit comments

Comments
 (0)