talon_one 6.0.0 → 8.0.0

data/docs/IntegrationApi.md

@@ -13,9 +13,11 @@ 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 points
+[**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances
 [**get_loyalty_card_balances**](IntegrationApi.md#get_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances
 [**get_loyalty_card_points**](IntegrationApi.md#get_loyalty_card_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points
 [**get_loyalty_card_transactions**](IntegrationApi.md#get_loyalty_card_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions
@@ -96,7 +98,7 @@ Name | Type | Description  | Notes
 
 Create coupon reservation
 
-Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code).  - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon will be associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store.  - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint.  To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. 
+Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect.  **Note:**  - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store.  - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint.  - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint.  To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. 
 
 ### Example
 
@@ -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
 
@@ -425,7 +427,7 @@ nil (empty response body)
 
 Delete customer's personal data
 
-Delete all attributes on the customer profile and on entities that reference this customer profile.  **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. 
+Delete all attributes on the customer profile and on entities that reference this customer profile.  **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments)   that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application,   customer data will be deleted from all sandbox Applications. This is because customer data is shared   between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. 
 
 ### Example
 
@@ -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)
@@ -654,9 +792,9 @@ Name | Type | Description  | Notes
 
 > LoyaltyBalancesWithTiers get_loyalty_balances(loyalty_program_id, integration_id, opts)
 
-Get customer's loyalty points
+Get customer's loyalty balances
 
-Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID.  **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID.  Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.  For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) 
+Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response.  **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID.  Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.  For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) 
 
 ### Example
 
@@ -678,11 +816,11 @@ opts = {
   end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.  **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. 
   subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
   include_tiers: false, # Boolean | Indicates whether tier information is included in the response.  When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. 
-  include_projected_tier: false # Boolean | Indicates whether the customer's projected tier information is included in the response.  When set to `true`, the response includes information about the customer’s active points and the name of the projected tier.  **Note** We recommend filtering by `subledgerId` for better performance. 
+  include_projected_tier: false # Boolean | Indicates whether the customer's projected tier information is included in the response.  When set to `true`, the response includes information about the customer's active points and the name of the projected tier.  **Note** We recommend filtering by `subledgerId` for better performance. 
 }
 
 begin
-  #Get customer's loyalty points
+  #Get customer's loyalty balances
   result = api_instance.get_loyalty_balances(loyalty_program_id, integration_id, opts)
   p result
 rescue TalonOne::ApiError => e
@@ -700,7 +838,7 @@ Name | Type | Description  | Notes
  **end_date** | **DateTime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.  **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] 
  **subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional] 
  **include_tiers** | **Boolean**| Indicates whether tier information is included in the response.  When set to &#x60;true&#x60;, the response includes information about the current tier and the number of points required to move to next tier.  | [optional] [default to false]
- **include_projected_tier** | **Boolean**| Indicates whether the customer&#39;s projected tier information is included in the response.  When set to &#x60;true&#x60;, the response includes information about the customer’s active points and the name of the projected tier.  **Note** We recommend filtering by &#x60;subledgerId&#x60; for better performance.  | [optional] [default to false]
+ **include_projected_tier** | **Boolean**| Indicates whether the customer&#39;s projected tier information is included in the response.  When set to &#x60;true&#x60;, the response includes information about the customer&#39;s active points and the name of the projected tier.  **Note** We recommend filtering by &#x60;subledgerId&#x60; for better performance.  | [optional] [default to false]
 
 ### Return type
 
@@ -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,7 +1494,7 @@ 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. 
+  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`. 
 }
 
@@ -1375,7 +1513,7 @@ 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] 
 
 ### Return type
@@ -1642,7 +1780,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 +1798,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/IntegrationCustomerSessionResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **customer_session** | [**CustomerSessionV2**](CustomerSessionV2.md) |  | [optional] 
-**effects** | [**Array<Effect>**](Effect.md) |  | [optional] 
+**effects** | [**Array<Effect>**](Effect.md) | The returned effects.  **Note:** This endpoint returns only the effects that are valid after any rollback effects and their corresponding non-rollback effects are removed.  | [optional] 
 
 ## Code Sample
 

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** | Sum of the tentative active points (including additions and deductions) inside the currently open session. The `currentBalance` is updated to this value when you close the session, and the effects are applied. | 
-**tentative_pending_balance** | **Float** | Sum of pending points (including additions and deductions) inside the currently open session. The `pendingBalance` is updated to this value when you close the session, and the effects are applied. | [optional] 
+**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/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/ListCampaignStoreBudgets.md

@@ -0,0 +1,23 @@
+# TalonOne::ListCampaignStoreBudgets
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store** | [**ListCampaignStoreBudgetsStore**](ListCampaignStoreBudgetsStore.md) |  | 
+**limit** | **Integer** |  | 
+**action** | **String** |  | 
+**period** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ListCampaignStoreBudgets.new(store: null,
+                                 limit: null,
+                                 action: null,
+                                 period: null)
+```
+
+

data/docs/ListCampaignStoreBudgetsStore.md

@@ -0,0 +1,21 @@
+# TalonOne::ListCampaignStoreBudgetsStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**integration_id** | **String** |  | 
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ListCampaignStoreBudgetsStore.new(id: null,
+                                 integration_id: null,
+                                 name: null)
+```
+
+

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/LoyaltyCard.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **program_id** | **Integer** | The ID of the loyalty program that owns this entity. | 
+**program_name** | **String** | The integration name of the loyalty program that owns this entity. | [optional] 
+**program_title** | **String** | The Campaign Manager-displayed name of the loyalty program that owns this entity. | [optional] 
 **status** | **String** | Status of the loyalty card. Can be `active` or `inactive`.  | 
 **block_reason** | **String** | Reason for transferring and blocking the loyalty card.  | [optional] 
 **identifier** | **String** | The alphanumeric identifier of the loyalty card.  | 
@@ -27,6 +29,8 @@ require 'TalonOne'
 instance = TalonOne::LoyaltyCard.new(id: 6,
                                  created: 2020-06-10T09:05:27.993483Z,
                                  program_id: 125,
+                                 program_name: Loyalty_program,
+                                 program_title: Loyalty program,
                                  status: active,
                                  block_reason: Current card lost. Customer needs a new card.,
                                  identifier: summer-loyalty-card-0543,

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/LoyaltyCardBatch.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **number_of_cards** | **Integer** | Number of loyalty cards in the batch. | 
 **batch_id** | **String** | ID of the loyalty card batch. | [optional] 
 **status** | **String** | Status of the loyalty cards in the batch. | [optional] [default to 'active']
+**card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TalonOne'
 
 instance = TalonOne::LoyaltyCardBatch.new(number_of_cards: 5000,
                                  batch_id: hwernpjz,
-                                 status: active)
+                                 status: active,
+                                 card_code_settings: null)
 ```
 
 

data/docs/LoyaltyLedger.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyLedger.new(ledger: null,
-                                 sub_ledgers: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":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/LoyaltyMembership.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::LoyaltyMembership.new(joined: null,
+instance = TalonOne::LoyaltyMembership.new(joined: 2012-03-20T14:15:22Z,
                                  loyalty_program_id: 323414846)
 ```