voucherify 8.1.0 → 8.2.0

data/docs/CustomerWithSummaryLoyaltyReferrals.md

@@ -8,6 +8,7 @@
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
 | **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
 | **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **loyalty_memberships** | [**Array<CustomerLoyaltyMembership>**](CustomerLoyaltyMembership.md) | List of Loyalty v2 program memberships for the customer. Lists only existing `ACTIVE` memberships. `null` when no memberships are stored. Absent or `null` for `v1/orders` and `v1/publications` endpoints and events. | [optional] |
 | **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/CustomersApi.md

@@ -25,7 +25,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Create Customer
 
-Creates a customer object.  📘 Upsert Mode  If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields.
+Creates a customer object. <Note> <Badge color blue>Upsert Mode</Badge> If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. </Note>
 
 ### Examples
 
@@ -85,7 +85,7 @@ end
 
 Delete Customer Permanently
 
-The organization user can remove consumer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify.
+The organization user can remove customer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify as per the GDPR.
 
 ### Examples
 
@@ -143,7 +143,7 @@ end
 
 Delete Customer
 
-This method deletes a customer.
+This method deletes a customer. The customer is permanently deleted. This means that a new customer with the same source_id can be created. <Note> <Badge color blue>GDPR compliance</Badge> This method does NOT delete all related data, including personal data, from Voucherify databases. To delete these records and fulfil the right to be forgotten in the sense of the GDPR, use the [Delete Customer Permanently](/api-reference/customers/delete-customer-permanently) endpoint or go to [Delete people data](/manage/team-settings#delete-people-data) in the Voucherify [Team settings](/manage/team-settings). </Note>
 
 ### Examples
 
@@ -258,7 +258,7 @@ end
 
 Import and Update Customers using CSV
 
-This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas.   # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object.  📘 Standard customer fields mapping  **No spaces allowed in field names**    Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
+This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas.   # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. <Note> <Badge color blue>Standard customer fields mapping</Badge> **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 </Note> # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
 
 ### Examples
 
@@ -318,7 +318,7 @@ end
 
 List Customer Activities
 
-> ❗️ Deprecated    This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. Retrieve customer activities.
+<Danger> <Badge color red>Deprecated</Badge> This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. </Danger> Retrieve customer activities.
 
 ### Examples
 
@@ -633,7 +633,8 @@ opts = {
   updated_at_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was updated last time.
   updated_at_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was updated last time.
   order: VoucherifySdk::ParameterOrderListCustomers::CREATED_AT, # ParameterOrderListCustomers | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
-  starting_after: Time.parse('2013-10-20T19:20:30+01:00') # Time | A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.  
+  starting_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.  
+  filters: { key: 3.56} # Object | Filters customers by field conditions. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for examples.
 }
 
 begin
@@ -661,6 +662,7 @@ end
 | **updated_at_after** | **Time** | Filter customers by date customer was updated last time. | [optional] |
 | **order** | [**ParameterOrderListCustomers**](.md) | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
 | **starting_after** | **Time** | A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list.   | [optional] |
+| **filters** | [**Object**](.md) | Filters customers by field conditions. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for examples. | [optional] |
 
 ### Return type
 

data/docs/CustomersCreateResponseBody.md

@@ -8,6 +8,7 @@
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
 | **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
 | **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **loyalty_memberships** | [**Array<CustomerLoyaltyMembership>**](CustomerLoyaltyMembership.md) | List of Loyalty v2 program memberships for the customer. Lists only existing `ACTIVE` memberships. `null` when no memberships are stored. Absent or `null` for `v1/orders` and `v1/publications` endpoints and events. | [optional] |
 | **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/CustomersGetResponseBody.md

@@ -8,6 +8,7 @@
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
 | **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
 | **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **loyalty_memberships** | [**Array<CustomerLoyaltyMembership>**](CustomerLoyaltyMembership.md) | List of Loyalty v2 program memberships for the customer. Lists only existing `ACTIVE` memberships. `null` when no memberships are stored. Absent or `null` for `v1/orders` and `v1/publications` endpoints and events. | [optional] |
 | **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/CustomersRedeemablesListResponseBody.md

@@ -7,7 +7,7 @@
 | **object** | **String** | The type of the object represented by JSON. This object stores information about customer redeemables. | [optional][default to 'list'] |
 | **data_ref** | **String** | Identifies the name of the JSON property that contains the array of redeemables. | [optional][default to 'data'] |
 | **data** | [**Array<CustomerRedeemable>**](CustomerRedeemable.md) | A dictionary that contains an array of redeemables. | [optional] |
-| **total** | **Integer** | Total number of results returned. | [optional] |
+| **total** | **Integer** | Total number of results returned on this page. | [optional] |
 | **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results. | [optional] |
 | **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID. | [optional] |
 

data/docs/CustomersUpdateResponseBody.md

@@ -8,6 +8,7 @@
 | **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
 | **summary** | [**CustomerSummary**](CustomerSummary.md) |  | [optional] |
 | **loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) |  | [optional] |
+| **loyalty_memberships** | [**Array<CustomerLoyaltyMembership>**](CustomerLoyaltyMembership.md) | List of Loyalty v2 program memberships for the customer. Lists only existing `ACTIVE` memberships. `null` when no memberships are stored. Absent or `null` for `v1/orders` and `v1/publications` endpoints and events. | [optional] |
 | **referrals** | [**CustomerReferrals**](CustomerReferrals.md) |  | [optional] |
 | **system_metadata** | **Object** | Object used to store system metadata information. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/DateFilter.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::DateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**DateFilterConditions**](DateFilterConditions.md) |  | [optional] |
+

data/docs/DateFilterConditions.md

@@ -0,0 +1,14 @@
+# VoucherifySdk::DateFilterConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **before** | **Object** |  | [optional] |
+| **after** | **Object** |  | [optional] |
+| **is** | **Object** |  | [optional] |
+| **more_than** | **Object** |  | [optional] |
+| **less_than** | **Object** |  | [optional] |
+| **has_value** | **Object** |  | [optional] |
+| **is_unknown** | **Object** |  | [optional] |
+

data/docs/EarningRuleDailyReportEntry.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRuleDailyReportEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
+| **count** | **Float** | Counts successful earning-rule triggers for the member in the period. A trigger rejected by its limit check is not included. | [optional] |
+| **object** | **String** | Object type marker. Always `earning_rule_daily_report`. | [optional][default to 'earning_rule_daily_report'] |
+

data/docs/EarningRuleEarning.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::EarningRuleEarning
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Earning item ID (`lernei_...`). | [optional] |
+| **name** | **String** | Earning item name. Can be `null`. | [optional] |
+| **rules** | **Object** | Group of rule definitions combined by a logical formula. Besides `logic`, only positive-integer keys are allowed (property names must match `^[1-9]\\d*$`), each referencing a rule definition. The `logic` value is a logical expression referencing the numbered rules, e.g. `\"1 and 2\"` or `\"1 and (2 or 3)\"`. At least one numbered rule is required (`minProperties: 2` including `logic`). | [optional] |
+| **tier_rules** | [**EarningRuleTierRules**](EarningRuleTierRules.md) |  |  |
+| **effects** | [**Array<EarningRuleEffect>**](EarningRuleEffect.md) | Effects applied when the rules match. Contains 1 to 10 effects. | [optional] |
+

data/docs/EarningRuleEffect.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::EarningRuleEffect
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Effect type. | [optional] |
+| **points** | [**EarningRuleEffectPoints**](EarningRuleEffectPoints.md) |  | [optional] |
+| **points_proportional** | [**EarningRuleEffectPointsProportional**](EarningRuleEffectPointsProportional.md) |  | [optional] |
+| **benefit** | [**LoyaltyV2ActivityEarningRuleEffectBenefit**](LoyaltyV2ActivityEarningRuleEffectBenefit.md) |  | [optional] |
+

data/docs/EarningRuleEffectPoints.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRuleEffectPoints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Integer** | Fixed number of points to award. | [optional] |
+| **card_definition_id** | **String** | Card definition ID (`lcdef_...`) the points are awarded to. | [optional] |
+| **points_expiration** | [**EarningRuleEffectPointsExpiration**](EarningRuleEffectPointsExpiration.md) |  | [optional] |
+

data/docs/EarningRuleEffectPointsExpiration.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::EarningRuleEffectPointsExpiration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Points expiration type. | [optional] |
+| **rolling_expiration** | [**EarningRuleEffectPointsExpirationRollingExpiration**](EarningRuleEffectPointsExpirationRollingExpiration.md) |  | [optional] |
+| **calendar_expiration** | [**EarningRuleEffectPointsExpirationCalendarExpiration**](EarningRuleEffectPointsExpirationCalendarExpiration.md) |  | [optional] |
+| **sliding_expiration** | [**EarningRuleEffectPointsExpirationSlidingExpiration**](EarningRuleEffectPointsExpirationSlidingExpiration.md) |  | [optional] |
+

data/docs/EarningRuleEffectPointsExpirationCalendarExpiration.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EarningRuleEffectPointsExpirationCalendarExpiration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expiration_dates** | [**Array<LoyaltyV2ActivityEarningRuleEffectPointsExpirationCalendarExpirationDate>**](LoyaltyV2ActivityEarningRuleEffectPointsExpirationCalendarExpirationDate.md) | Fixed expiration dates (day + month). | [optional] |
+

data/docs/EarningRuleEffectPointsExpirationRollingExpiration.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleEffectPointsExpirationRollingExpiration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period** | [**LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationPeriod**](LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationPeriod.md) |  |  |
+| **rounding** | [**LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationRounding**](LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationRounding.md) |  | [optional] |
+

data/docs/EarningRuleEffectPointsExpirationSlidingExpiration.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleEffectPointsExpirationSlidingExpiration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **earning_activity** | **Boolean** | Whether earning activity resets the expiration window. | [optional] |
+| **period** | [**LoyaltyV2ActivityEarningRuleEffectPointsExpirationSlidingExpirationPeriod**](LoyaltyV2ActivityEarningRuleEffectPointsExpirationSlidingExpirationPeriod.md) |  |  |
+

data/docs/EarningRuleEffectPointsProportional.md

@@ -0,0 +1,14 @@
+# VoucherifySdk::EarningRuleEffectPointsProportional
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **calculation_type** | **String** | How the proportional points are calculated. | [optional] |
+| **card_definition_id** | **String** | Card definition ID (`lcdef_...`) the points are awarded to. | [optional] |
+| **points_expiration** | [**EarningRuleEffectPointsExpiration**](EarningRuleEffectPointsExpiration.md) |  | [optional] |
+| **order** | [**EarningRulePointsProportionalOrder**](EarningRulePointsProportionalOrder.md) |  | [optional] |
+| **customer** | [**EarningRulePointsProportionalCustomer**](EarningRulePointsProportionalCustomer.md) |  | [optional] |
+| **custom_event** | [**EarningRulePointsProportionalCustomEvent**](EarningRulePointsProportionalCustomEvent.md) |  | [optional] |
+| **order_items** | [**EarningRulePointsProportionalOrderItems**](EarningRulePointsProportionalOrderItems.md) |  | [optional] |
+

data/docs/EarningRuleIdFilterConditions.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EarningRuleIdFilterConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**EarningRuleIdFilterConditionsConditions**](EarningRuleIdFilterConditionsConditions.md) |  | [optional] |
+

data/docs/EarningRuleIdFilterConditionsConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::EarningRuleIdFilterConditionsConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Object** |  | [optional] |
+| **is_not** | **Object** |  | [optional] |
+| **_in** | **Object** |  | [optional] |
+| **not_in** | **Object** |  | [optional] |
+

data/docs/EarningRulePointsProportionalApplicableTo.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::EarningRulePointsProportionalApplicableTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the referenced object. | [optional] |
+| **product** | [**LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProduct**](LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProduct.md) |  | [optional] |
+| **sku** | [**LoyaltyV2ActivityEarningRulePointsProportionalApplicableToSku**](LoyaltyV2ActivityEarningRulePointsProportionalApplicableToSku.md) |  | [optional] |
+| **products_collection** | [**LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProductsCollection**](LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProductsCollection.md) |  | [optional] |
+

data/docs/EarningRulePointsProportionalCustomEvent.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EarningRulePointsProportionalCustomEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**LoyaltyV2ActivityEarningRulePointsProportionalMetadata**](LoyaltyV2ActivityEarningRulePointsProportionalMetadata.md) |  |  |
+

data/docs/EarningRulePointsProportionalCustomer.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EarningRulePointsProportionalCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**LoyaltyV2ActivityEarningRulePointsProportionalMetadata**](LoyaltyV2ActivityEarningRulePointsProportionalMetadata.md) |  |  |
+

data/docs/EarningRulePointsProportionalOrder.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRulePointsProportionalOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | [**LoyaltyV2ActivityEarningRulePointsProportionalEvery**](LoyaltyV2ActivityEarningRulePointsProportionalEvery.md) |  | [optional] |
+| **total_amount** | [**LoyaltyV2ActivityEarningRulePointsProportionalEvery**](LoyaltyV2ActivityEarningRulePointsProportionalEvery.md) |  | [optional] |
+| **metadata** | [**LoyaltyV2ActivityEarningRulePointsProportionalMetadata**](LoyaltyV2ActivityEarningRulePointsProportionalMetadata.md) |  | [optional] |
+

data/docs/EarningRulePointsProportionalOrderItems.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRulePointsProportionalOrderItems
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | [**EarningRulePointsProportionalOrderItemsCalculation**](EarningRulePointsProportionalOrderItemsCalculation.md) |  | [optional] |
+| **subtotal_amount** | [**EarningRulePointsProportionalOrderItemsCalculation**](EarningRulePointsProportionalOrderItemsCalculation.md) |  | [optional] |
+| **quantity** | [**EarningRulePointsProportionalOrderItemsCalculation**](EarningRulePointsProportionalOrderItemsCalculation.md) |  | [optional] |
+

data/docs/EarningRulePointsProportionalOrderItemsCalculation.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRulePointsProportionalOrderItemsCalculation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **every** | **Integer** | The divisor - every this amount/quantity awards `value` points. | [optional] |
+| **value** | **Float** | Points awarded per `every` unit. | [optional] |
+| **applicable_to** | [**Array<EarningRulePointsProportionalApplicableTo>**](EarningRulePointsProportionalApplicableTo.md) | Product/SKU/collection criteria selecting matching order items. | [optional] |
+

data/docs/EarningRuleTierRules.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleTierRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Tier requirement type. | [optional] |
+| **any_of** | [**Array<LoyaltyV2ActivityEarningRuleTierRulesAnyOfEntry>**](LoyaltyV2ActivityEarningRuleTierRulesAnyOfEntry.md) | Tier structure/tier combinations, any of which satisfies the requirement. Can be `null`. | [optional] |
+

data/docs/EarningRuleTrigger.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EarningRuleTrigger
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** | Triggering event type. | [optional] |
+| **custom_event** | [**LoyaltyV2ActivityEarningRuleTriggerCustomEvent**](LoyaltyV2ActivityEarningRuleTriggerCustomEvent.md) |  | [optional] |
+| **segment** | [**LoyaltyV2ActivityEarningRuleTriggerSegment**](LoyaltyV2ActivityEarningRuleTriggerSegment.md) |  | [optional] |
+

data/docs/EarningRuleTriggerLimitsCooldown.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleTriggerLimitsCooldown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Cooldown type. | [optional] |
+| **fixed_cooldown** | [**EarningRuleTriggerLimitsCooldownFixedCooldown**](EarningRuleTriggerLimitsCooldownFixedCooldown.md) |  | [optional] |
+

data/docs/EarningRuleTriggerLimitsCooldownFixedCooldown.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EarningRuleTriggerLimitsCooldownFixedCooldown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period** | [**LoyaltyV2ActivityEarningRuleTriggerLimitsCooldownFixedCooldownPeriod**](LoyaltyV2ActivityEarningRuleTriggerLimitsCooldownFixedCooldownPeriod.md) |  |  |
+

data/docs/EarningRuleTriggerLimitsFrequency.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleTriggerLimitsFrequency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Frequency limit type. | [optional] |
+| **limits** | **Array<Object>** | Frequency limits (at most one). Can be `null`. | [optional] |
+

data/docs/EarningRuleValidityHours.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRuleValidityHours
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Validity hours type. | [optional] |
+| **daily** | [**Array<LoyaltyV2ActivityEarningRuleValidityDailyHours>**](LoyaltyV2ActivityEarningRuleValidityDailyHours.md) | Daily validity windows. Can be `null`. | [optional] |
+

data/docs/EarningRulesReportDailyEntry.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::EarningRulesReportDailyEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
+| **earning_rule_id** | **String** | Identifies the earning rule (format `lern_...`). | [optional] |
+| **success_count** | **Float** | Counts eligibility checks that passed the trigger limit in the period. | [optional] |
+| **failures_count** | **Float** | Counts eligibility checks that failed the trigger limit in the period. | [optional] |
+| **failures_breakdown** | **Object** | Always an empty object even if `failures_count` is above zero. | [optional] |
+| **object** | **String** | Object type marker. Always `program_earning_rules_daily_report`. | [optional][default to 'program_earning_rules_daily_report'] |
+

data/docs/EarningRulesReportFailuresBreakdown.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRulesReportFailuresBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cooldown** | **Float** | Counts failures caused by the cooldown limit. | [optional] |
+| **frequency** | **Float** | Counts failures caused by the frequency limit. | [optional] |
+

data/docs/EarningRulesReportListFilters.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRulesReportListFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **junction** | **String** | Joins the field filters. Allowed values are `AND` and `OR`. Defaults to `AND`. | [optional] |
+| **earning_rule_id** | [**EarningRuleIdFilterConditions**](EarningRuleIdFilterConditions.md) |  | [optional] |
+

data/docs/EarningRulesReportSummaryEntry.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::EarningRulesReportSummaryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifies the summary row (format: `lpers_` followed by hexadecimal characters). | [optional] |
+| **earning_rule_id** | **String** | Identifies the earning rule (format `lern_...`). | [optional] |
+| **success_count** | **Float** | Counts eligibility checks that passed the trigger limit. | [optional] |
+| **failures_count** | **Float** | Counts eligibility checks that failed the trigger limit. | [optional] |
+| **failures_breakdown** | [**EarningRulesReportFailuresBreakdown**](EarningRulesReportFailuresBreakdown.md) |  |  |
+| **object** | **String** | Object type marker. Always `program_earning_rules_summary_report`. | [optional][default to 'program_earning_rules_summary_report'] |
+

data/docs/ErrorError.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **message** | **String** | The message configured by the user in a validation rule. | [optional] |
+| **message** | **String** | Resolved custom validation-rule error message for `options.language`, falling back to the Error Message Library default language. Present only when a custom message can be resolved. | [optional] |
 

data/docs/ExamineCardReference.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::ExamineCardReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique card ID (`lcrd_...`). | [optional] |
+| **card_definition_id** | **String** | Unique card definition ID (`lcdef_...`). | [optional] |
+| **card_type** | **String** | Card type. Currently only `INDIVIDUAL` exists. | [optional][default to 'INDIVIDUAL'] |
+| **code** | **String** | Card code. May be `null` right after member creation because card codes are generated asynchronously. | [optional] |
+| **object** | **String** | Object type marker. Always `card`. | [optional][default to 'card'] |
+

data/docs/ExamineCustomerIdentification.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ExamineCustomerIdentification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Identification method. | [optional] |
+| **customer_id** | **String** | Unique customer ID (`cust_...`). Required when `type` is `customer_id`. | [optional] |
+| **customer_source_id** | **String** | Customer source ID, e.g. from an external system. May be provided as a string or a number. Required when `type` is `customer_source_id`. | [optional] |
+| **member_id** | **String** | Loyalty member ID (`lmbr_...`). Required when `type` is `member_id`. | [optional] |
+

data/docs/ExamineCustomerReference.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ExamineCustomerReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique customer ID (`cust_...`). | [optional] |
+| **source_id** | **String** | Customer source ID. | [optional] |
+| **metadata** | **Hash<String, Object>** | Customer metadata (empty object when unset). | [optional] |
+| **object** | **String** | Object type marker. Always `customer`. | [optional][default to 'customer'] |
+

data/docs/ExamineMemberReference.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::ExamineMemberReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique member ID (`lmbr_...`). | [optional] |
+| **customer_id** | **String** | Unique customer ID the member belongs to. | [optional] |
+| **program_id** | **String** | Unique program ID the member belongs to. | [optional] |
+| **metadata** | **Hash<String, Object>** | Member metadata (empty object when unset). | [optional] |
+| **object** | **String** | Object type marker. Always `member`. | [optional][default to 'member'] |
+

data/docs/ExamineProgramReference.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ExamineProgramReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique program ID (`lprg_...`). | [optional] |
+| **name** | **String** | Program name. | [optional] |
+| **metadata** | **Hash<String, Object>** | Program metadata (empty object when unset). | [optional] |
+| **object** | **String** | Object type marker. Always `program`. | [optional][default to 'program'] |
+

data/docs/ExportParameters.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **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** | **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] |
+| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. and Array of strings containing the data in the export. These fields define the headers in the CSV file. The `metadata` field expands into one CSV column per metadata property. You can also pass specific properties as `metadata.<property_name>`. | [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.\" and Allowed additional properties must start with \"metadata.\" or \"attributes.\" | [optional] |
 | **campaign_id** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] |
 

data/docs/ExportsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Create Export
 
-Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.   # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:    📘 Date and time in the export API  The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders     # Vouchers        # Publications   # Redemptions    # Customers       # Points Expirations    # Gift Card Transactions    # Loyalty Card Transactions   
+Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.   # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:   <Note> <Badge color blue>Date and time in the export API</Badge> The exported date and times are always provided in the UTC time zone. </Note> # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders     # Vouchers        # Publications   # Redemptions    # Customers       # Points Expirations    # Gift Card Transactions    # Loyalty Card Transactions    # Products   # SKUs   
 
 ### Examples
 
@@ -98,7 +98,7 @@ VoucherifySdk.configure do |config|
 end
 
 api_instance = VoucherifySdk::ExportsApi.new
-export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.
+export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.
 
 begin
   # Delete Export
@@ -112,7 +112,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. |  |
+| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. |  |
 
 ### Return type
 
@@ -134,7 +134,7 @@ nil (empty response body)
 
 Download Export
 
-Download the contents of the exported CSV file.   📘 Important notes  **Base URL:**   - https://download.voucherify.io (Europe)   - https://us1.download.voucherify.io (US)   - https://as1.download.voucherify.io (Asia)   **Token:** Can be found within the result parameter of the [Get Export](/api-reference/exports/get-export) method response.
+Download the contents of the exported CSV file.  <Note> <Badge color blue>Important notes</Badge> **Base URL:** - https://download.voucherify.io (Europe) - https://us1.download.voucherify.io (US) - https://as1.download.voucherify.io (Asia) **Token:** Can be found within the result parameter of the [Get Export](/api-reference/exports/get-export) method response. </Note>
 
 ### Examples
 
@@ -217,7 +217,7 @@ VoucherifySdk.configure do |config|
 end
 
 api_instance = VoucherifySdk::ExportsApi.new
-export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.
+export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.
 
 begin
   # Get Export
@@ -232,7 +232,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. |  |
+| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. |  |
 
 ### Return type