talon_one 7.0.0 → 9.0.0

data/docs/IntegrationApi.md

@@ -13,6 +13,8 @@ Method | HTTP request | Description
 [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
 [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
 [**generate_loyalty_card**](IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card
+[**get_customer_achievement_history**](IntegrationApi.md#get_customer_achievement_history) | **GET** /v1/customer_profiles/{integrationId}/achievements/{achievementId} | List customer's achievement history
+[**get_customer_achievements**](IntegrationApi.md#get_customer_achievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements
 [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
 [**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
 [**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances
@@ -152,7 +154,7 @@ Name | Type | Description  | Notes
 
 Create referral code for an advocate
 
-Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.  **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint. 
 
 ### Example
 
@@ -206,7 +208,7 @@ Name | Type | Description  | Notes
 
 Create referral codes for multiple advocates
 
-Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.  **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint. 
 
 ### Example
 
@@ -224,7 +226,7 @@ end
 api_instance = TalonOne::IntegrationApi.new
 body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates | body
 opts = {
-  silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
+  silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
 }
 
 begin
@@ -242,7 +244,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)| body | 
- **silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to 'yes']
+ **silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to 'yes']
 
 ### Return type
 
@@ -528,6 +530,142 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_customer_achievement_history
+
+> InlineResponse2002 get_customer_achievement_history(integration_id, achievement_id, opts)
+
+List customer's achievement history
+
+Retrieve all progress history of a given customer in the given achievement. 
+
+### Example
+
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
+achievement_id = 56 # Integer | The achievement identifier. 
+opts = {
+  progress_status: ['progress_status_example'], # Array<String> | Filter by customer progress status in the achievement. 
+  start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain achievements created on or after the start date.
+  end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain achievements created before or on the end date.
+  page_size: 1000, # Integer | The number of items in the response.
+  skip: 56 # Integer | The number of items to skip when paging through large result sets.
+}
+
+begin
+  #List customer's achievement history
+  result = api_instance.get_customer_achievement_history(integration_id, achievement_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->get_customer_achievement_history: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier.  | 
+ **achievement_id** | **Integer**| The achievement identifier.  | 
+ **progress_status** | [**Array&lt;String&gt;**](String.md)| Filter by customer progress status in the achievement.  | [optional] 
+ **start_date** | **DateTime**| Timestamp that filters the results to only contain achievements created on or after the start date. | [optional] 
+ **end_date** | **DateTime**| Timestamp that filters the results to only contain achievements created before or on the end date. | [optional] 
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer_achievements
+
+> InlineResponse2001 get_customer_achievements(integration_id, opts)
+
+List customer's available achievements
+
+Retrieve all the achievements available to a given customer and their progress in them. 
+
+### Example
+
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
+opts = {
+  campaign_ids: ['campaign_ids_example'], # Array<String> | Filter by one or more Campaign IDs, separated by a comma.  **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. 
+  achievement_ids: ['achievement_ids_example'], # Array<String> | Filter by one or more Achievement IDs, separated by a comma.  **Note:** If no achievements are specified, data for all the achievements in the Application is returned. 
+  achievement_status: ['achievement_status_example'], # Array<String> | Filter by status of the achievement.  **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned. 
+  current_progress_status: ['current_progress_status_example'], # Array<String> | Filter by customer progress status in the achievement. 
+  page_size: 1000, # Integer | The number of items in the response.
+  skip: 56 # Integer | The number of items to skip when paging through large result sets.
+}
+
+begin
+  #List customer's available achievements
+  result = api_instance.get_customer_achievements(integration_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->get_customer_achievements: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier.  | 
+ **campaign_ids** | [**Array&lt;String&gt;**](String.md)| Filter by one or more Campaign IDs, separated by a comma.  **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.  | [optional] 
+ **achievement_ids** | [**Array&lt;String&gt;**](String.md)| Filter by one or more Achievement IDs, separated by a comma.  **Note:** If no achievements are specified, data for all the achievements in the Application is returned.  | [optional] 
+ **achievement_status** | [**Array&lt;String&gt;**](String.md)| Filter by status of the achievement.  **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned.  | [optional] 
+ **current_progress_status** | [**Array&lt;String&gt;**](String.md)| Filter by customer progress status in the achievement.  | [optional] 
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_customer_inventory
 
 > CustomerInventory get_customer_inventory(integration_id, opts)
@@ -780,7 +918,7 @@ Name | Type | Description  | Notes
 
 ## get_loyalty_card_points
 
-> InlineResponse2003 get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
+> InlineResponse2005 get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
 
 List card's unused loyalty points
 
@@ -832,7 +970,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2003**](InlineResponse2003.md)
+[**InlineResponse2005**](InlineResponse2005.md)
 
 ### Authorization
 
@@ -846,7 +984,7 @@ Name | Type | Description  | Notes
 
 ## get_loyalty_card_transactions
 
-> InlineResponse2001 get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
+> InlineResponse2003 get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
 
 List card's transactions
 
@@ -873,7 +1011,7 @@ opts = {
   loyalty_transaction_type: 'loyalty_transaction_type_example', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. 
   start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. 
   end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. 
-  page_size: 1000, # Integer | The number of items in the response.
+  page_size: 50, # Integer | The number of items in the response.
   skip: 56 # Integer | The number of items to skip when paging through large result sets.
 }
 
@@ -897,12 +1035,12 @@ Name | Type | Description  | Notes
  **loyalty_transaction_type** | **String**| Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file.  | [optional] 
  **start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] 
  **end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] 
- **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional] 
 
 ### Return type
 
-[**InlineResponse2001**](InlineResponse2001.md)
+[**InlineResponse2003**](InlineResponse2003.md)
 
 ### Authorization
 
@@ -916,7 +1054,7 @@ Name | Type | Description  | Notes
 
 ## get_loyalty_program_profile_points
 
-> InlineResponse2004 get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
+> InlineResponse2006 get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
 
 List customer's unused loyalty points
 
@@ -968,7 +1106,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2004**](InlineResponse2004.md)
+[**InlineResponse2006**](InlineResponse2006.md)
 
 ### Authorization
 
@@ -982,7 +1120,7 @@ Name | Type | Description  | Notes
 
 ## get_loyalty_program_profile_transactions
 
-> InlineResponse2002 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
+> InlineResponse2004 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
 
 List customer's loyalty transactions
 
@@ -1038,7 +1176,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2002**](InlineResponse2002.md)
+[**InlineResponse2004**](InlineResponse2004.md)
 
 ### Authorization
 
@@ -1356,8 +1494,9 @@ end
 api_instance = TalonOne::IntegrationApi.new
 body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
 opts = {
-  silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
-  dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. 
+  silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
+  dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. 
+  force_complete_evaluation: false # Boolean | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. 
 }
 
 begin
@@ -1375,8 +1514,9 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md)| body | 
- **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to &#39;yes&#39;]
+ **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to &#39;yes&#39;]
  **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;.  | [optional] 
+ **force_complete_evaluation** | **Boolean**| Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires &#x60;dry&#x3D;true&#x60;.  | [optional] [default to false]
 
 ### Return type
 
@@ -1642,7 +1782,7 @@ end
 api_instance = TalonOne::IntegrationApi.new
 body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest | body
 opts = {
-  silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
+  silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
 }
 
 begin
@@ -1660,7 +1800,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| body | 
- **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to &#39;yes&#39;]
+ **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to &#39;yes&#39;]
 
 ### Return type
 

data/docs/LedgerInfo.md

@@ -6,10 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current_balance** | **Float** | Sum of currently active points. | 
 **pending_balance** | **Float** | Sum of pending points. | 
+**negative_balance** | **Float** | Sum of negative points. This implies that `currentBalance` is `0`. | 
 **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **tentative_current_balance** | **Float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | [optional] 
+**tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **current_tier** | [**Tier**](Tier.md) |  | [optional] 
 **points_to_next_tier** | **Float** | Points required to move up a tier. | [optional] 
 
@@ -20,10 +22,12 @@ require 'TalonOne'
 
 instance = TalonOne::LedgerInfo.new(current_balance: 100.0,
                                  pending_balance: 10.0,
+                                 negative_balance: 10.0,
                                  expired_balance: 0.0,
                                  spent_balance: 0.0,
                                  tentative_current_balance: 100.0,
                                  tentative_pending_balance: 20.0,
+                                 tentative_negative_balance: 100.0,
                                  current_tier: null,
                                  points_to_next_tier: 20.0)
 ```

data/docs/LedgerTransactionLogEntryIntegrationAPI.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **id** | **Integer** | ID of the loyalty ledger transaction. | 
 **ruleset_id** | **Integer** | The ID of the ruleset containing the rule that triggered this effect. | [optional] 
 **rule_name** | **String** | The name of the rule that triggered this effect. | [optional] 
+**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) |  | [optional] 
 
 ## Code Sample
 
@@ -33,7 +34,8 @@ instance = TalonOne::LedgerTransactionLogEntryIntegrationAPI.new(created: null,
                                  amount: 10.25,
                                  id: 123,
                                  ruleset_id: 11,
-                                 rule_name: Add 2 points)
+                                 rule_name: Add 2 points,
+                                 flags: null)
 ```
 
 

data/docs/LimitCounter.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **id** | **Integer** | Unique ID for this entity. | 
 **action** | **String** | The limitable action of the limit counter. | 

data/docs/LoyaltyBalance.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **pending_points** | **Float** | Total amount of points awarded to this customer but not available until their start date. | [optional] 
 **spent_points** | **Float** | Total amount of points already spent by this customer. | [optional] 
 **expired_points** | **Float** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional] 
+**negative_points** | **Float** | Total amount of negative points. This implies that `activePoints` is `0`. | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'TalonOne'
 instance = TalonOne::LoyaltyBalance.new(active_points: 286.0,
                                  pending_points: 50.0,
                                  spent_points: 150.0,
-                                 expired_points: 286.0)
+                                 expired_points: 286.0,
+                                 negative_points: 286.0)
 ```
 
 

data/docs/LoyaltyBalanceWithTier.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **pending_points** | **Float** | Total amount of points awarded to this customer but not available until their start date. | [optional] 
 **spent_points** | **Float** | Total amount of points already spent by this customer. | [optional] 
 **expired_points** | **Float** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional] 
+**negative_points** | **Float** | Total amount of negative points. This implies that `activePoints` is `0`. | [optional] 
 **current_tier** | [**Tier**](Tier.md) |  | [optional] 
 **projected_tier** | [**ProjectedTier**](ProjectedTier.md) |  | [optional] 
 **points_to_next_tier** | **Float** | The number of points required to move up a tier. | [optional] 
@@ -22,6 +23,7 @@ instance = TalonOne::LoyaltyBalanceWithTier.new(active_points: 286.0,
                                  pending_points: 50.0,
                                  spent_points: 150.0,
                                  expired_points: 286.0,
+                                 negative_points: 286.0,
                                  current_tier: null,
                                  projected_tier: null,
                                  points_to_next_tier: 20.0,

data/docs/LoyaltyBalances.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyBalances.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}})
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}})
 ```
 
 

data/docs/LoyaltyBalancesWithTiers.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyBalancesWithTiers.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}})
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}})
 ```
 
 

data/docs/LoyaltyCardBalances.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyCardBalances.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}},
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}},
                                  profiles: null)
 ```
 

data/docs/LoyaltyLedger.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyLedger.new(ledger: null,
-                                 sub_ledgers: {"mysubledger":{"total":0,"totalActivePoints":286,"totalPendingPoints":50,"totalSpentPoints":150,"totalExpiredPoints":25}})
+                                 sub_ledgers: {"mysubledger":{"total":0,"totalActivePoints":286,"totalPendingPoints":50,"totalSpentPoints":150,"totalExpiredPoints":25,"totalNegativePoints":0}})
 ```
 
 

data/docs/LoyaltyLedgerEntry.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **sub_ledger_id** | **String** | This specifies if we are adding loyalty points to the main ledger or a subledger. | 
 **user_id** | **Integer** | This is the ID of the user who created this entry, if the addition or subtraction was done manually. | [optional] 
 **archived** | **Boolean** | Indicates if the entry belongs to the archived session. | [optional] 
+**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) |  | [optional] 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = TalonOne::LoyaltyLedgerEntry.new(created: 2021-07-20T22:00Z,
                                  name: Add points on purchase,
                                  sub_ledger_id: mysubledger,
                                  user_id: 499,
-                                 archived: false)
+                                 archived: false,
+                                 flags: null)
 ```
 
 

data/docs/LoyaltyLedgerEntryFlags.md

@@ -0,0 +1,17 @@
+# TalonOne::LoyaltyLedgerEntryFlags
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**creates_negative_balance** | **Boolean** | Set to true if the entry creates negative balance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyLedgerEntryFlags.new(creates_negative_balance: null)
+```
+
+

data/docs/LoyaltyProgram.md

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
 **tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
 **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
-**return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative.  | [optional] 
+**return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit.  | [optional] 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this program. | 
 **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | 
 **tiers** | [**Array<LoyaltyTier>**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] 

data/docs/LoyaltyProgramBalance.md

@@ -6,10 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current_balance** | **Float** | Sum of currently active points. | 
 **pending_balance** | **Float** | Sum of pending points. | 
+**negative_balance** | **Float** | Sum of negative points. This implies that `currentBalance` is `0`. | 
 **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **tentative_current_balance** | **Float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | [optional] 
+**tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 
 ## Code Sample
 
@@ -18,10 +20,12 @@ require 'TalonOne'
 
 instance = TalonOne::LoyaltyProgramBalance.new(current_balance: 100.0,
                                  pending_balance: 10.0,
+                                 negative_balance: 10.0,
                                  expired_balance: 0.0,
                                  spent_balance: 0.0,
                                  tentative_current_balance: 100.0,
-                                 tentative_pending_balance: 20.0)
+                                 tentative_pending_balance: 20.0,
+                                 tentative_negative_balance: 100.0)
 ```
 
 

data/docs/LoyaltyProgramTransaction.md

@@ -22,6 +22,7 @@ Name | Type | Description | Notes
 **user_email** | **String** | The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions. | [optional] 
 **ruleset_id** | **Integer** | ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] 
 **rule_name** | **String** | Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. | [optional] 
+**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) |  | [optional] 
 
 ## Code Sample
 
@@ -45,7 +46,8 @@ instance = TalonOne::LoyaltyProgramTransaction.new(id: 123,
                                  user_id: 5,
                                  user_email: john.doe@example.com,
                                  ruleset_id: 11,
-                                 rule_name: 10 points for every $100 spent)
+                                 rule_name: 10 points for every $100 spent,
+                                 flags: null)
 ```
 
 

data/docs/LoyaltySubLedger.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **total_pending_points** | **Float** | Total amount of pending points, which are not active yet but will become active in the future. | 
 **total_spent_points** | **Float** | Total amount of points already spent by this customer. | 
 **total_expired_points** | **Float** | Total amount of points, that expired without ever being spent. | 
+**total_negative_points** | **Float** | Total amount of negative points. This implies that `totalActivePoints` is `0`. | 
 **transactions** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all events that have happened such as additions, subtractions and expiries. | [optional] 
 **expiring_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points that will expire. | [optional] 
 **active_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all currently active points. | [optional] 
@@ -26,6 +27,7 @@ instance = TalonOne::LoyaltySubLedger.new(total: null,
                                  total_pending_points: null,
                                  total_spent_points: null,
                                  total_expired_points: null,
+                                 total_negative_points: null,
                                  transactions: null,
                                  expiring_points: null,
                                  active_points: null,