talon_one 5.0.0 → 7.0.0

data/docs/IntegrationApi.md

@@ -12,9 +12,10 @@ Method | HTTP request | Description
 [**delete_audience_v2**](IntegrationApi.md#delete_audience_v2) | **DELETE** /v2/audiences/{audienceId} | Delete audience
 [**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_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
@@ -95,7 +96,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
 
@@ -424,7 +425,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
 
@@ -471,6 +472,62 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## generate_loyalty_card
+
+> LoyaltyCard generate_loyalty_card(loyalty_program_id, body)
+
+Generate loyalty card
+
+Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview).  To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body.  **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier. 
+
+### 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
+loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. 
+body = TalonOne::GenerateLoyaltyCard.new # GenerateLoyaltyCard | body
+
+begin
+  #Generate loyalty card
+  result = api_instance.generate_loyalty_card(loyalty_program_id, body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->generate_loyalty_card: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.  | 
+ **body** | [**GenerateLoyaltyCard**](GenerateLoyaltyCard.md)| body | 
+
+### Return type
+
+[**LoyaltyCard**](LoyaltyCard.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_customer_inventory
 
 > CustomerInventory get_customer_inventory(integration_id, opts)
@@ -595,11 +652,11 @@ Name | Type | Description  | Notes
 
 ## get_loyalty_balances
 
-> LoyaltyBalances get_loyalty_balances(loyalty_program_id, integration_id, opts)
+> 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
 
@@ -619,11 +676,13 @@ loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty prog
 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 = {
   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.
+  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. 
 }
 
 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
@@ -640,10 +699,12 @@ 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.  | 
  **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, `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.  | [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 `true`, 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'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.  | [optional] [default to false]
 
 ### Return type
 
-[**LoyaltyBalances**](LoyaltyBalances.md)
+[**LoyaltyBalancesWithTiers**](LoyaltyBalancesWithTiers.md)
 
 ### Authorization
 
@@ -1221,7 +1282,7 @@ Name | Type | Description  | Notes
 
 Sync cart item catalog
 
-Perform one or more of the following actions for a given cart item catalog:  - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog.  You can add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`.  **Important**: Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code.  For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs).  ### Filtering cart items  Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time.  The `filters` array contains an object with the following properties:  - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes)   connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each   cart item in the catalog and the value of the `value` property for the attribute selected   in `attr`.    The value of `op` can be one of the following:    - `EQ`: Equal to `value`   - `LT`: Less than `value`   - `LE`: Less than or equal to `value`   - `GT`: Greater than `value`   - `GE`: Greater than or equal to `value`   - `IN`: One of the comma-separated values that `value` is set to.    **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only.  - `value`: The value of the attribute selected in `attr`.  ### Payload examples  Synchronization actions are sent as `PUT` requests. See the structure for each action:  <details>   <summary><strong>Adding an item to the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241028\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Adding several items to the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241027\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       },       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241028\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Editing the attributes of an item in the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"age\": 11,             \"origin\": \"germany\"           },           \"createIfNotExists\": false,           \"sku\": \"SKU1241028\",           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"PATCH\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Editing the attributes of several items in the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"red\"           },           \"filters\": [             {               \"attr\": \"color\",               \"op\": \"EQ\",               \"value\": \"blue\"             }           ]         },         \"type\": \"PATCH_MANY\"       }     ]   }   ```    </div> </details>  <details>   <summary><strong>Removing an item from the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"sku\": \"SKU1241028\"         },         \"type\": \"REMOVE\"       }     ]   }   ```    </div> </details>  <details>   <summary><strong>Removing several items from the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"filters\": [             {               \"attr\": \"color\",               \"op\": \"EQ\",               \"value\": \"blue\"             }           ]         },         \"type\": \"REMOVE_MANY\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary>   <div>   <p>   Let's imagine that we have a shoe store and we have decided to stop selling   shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45   with a single action:</p>    ```json   {     \"actions\": [       {         \"payload\": {           \"filters\": [             {               \"attr\": \"size\",               \"op\": \"GT\",               \"value\": \"45\"             }           ]         },         \"type\": \"REMOVE_MANY\"       }     ]   }   ```   </div> </details> 
+Perform the following actions for a given cart item catalog:  - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog.  You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`.  **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code.  For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs).  ### Filtering cart items  Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time.  The `filters` array contains an object with the following properties:  - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes)   connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each   cart item in the catalog and the value of the `value` property for the attribute selected   in `attr`.    The value of `op` can be one of the following:    - `EQ`: Equal to `value`   - `LT`: Less than `value`   - `LE`: Less than or equal to `value`   - `GT`: Greater than `value`   - `GE`: Greater than or equal to `value`   - `IN`: One of the comma-separated values that `value` is set to.    **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only.  - `value`: The value of the attribute selected in `attr`.  ### Payload examples  Synchronization actions are sent as `PUT` requests. See the structure for each action:  <details>   <summary><strong>Adding an item to the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241028\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Adding multiple items to the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241027\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       },       {         \"payload\": {           \"attributes\": {             \"color\": \"Navy blue\",             \"type\": \"shoes\"           },           \"replaceIfExists\": true,           \"sku\": \"SKU1241028\",           \"price\": 100,           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"ADD\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Updating the attributes of an item in the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"age\": 11,             \"origin\": \"germany\"           },           \"createIfNotExists\": false,           \"sku\": \"SKU1241028\",           \"product\": {             \"name\": \"sneakers\"           }         },         \"type\": \"PATCH\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"attributes\": {             \"color\": \"red\"           },           \"filters\": [             {               \"attr\": \"color\",               \"op\": \"EQ\",               \"value\": \"blue\"             }           ]         },         \"type\": \"PATCH_MANY\"       }     ]   }   ```    </div> </details>  <details>   <summary><strong>Removing an item from the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"sku\": \"SKU1241028\"         },         \"type\": \"REMOVE\"       }     ]   }   ```    </div> </details>  <details>   <summary><strong>Removing multiple items from the catalog</strong></summary>   <div>    ```json   {     \"actions\": [       {         \"payload\": {           \"filters\": [             {               \"attr\": \"color\",               \"op\": \"EQ\",               \"value\": \"blue\"             }           ]         },         \"type\": \"REMOVE_MANY\"       }     ]   }   ```   </div> </details>  <details>   <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary>   <div>   <p>   Let's imagine that we have a shoe store and we have decided to stop selling   shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45   with a single action:</p>    ```json   {     \"actions\": [       {         \"payload\": {           \"filters\": [             {               \"attr\": \"size\",               \"op\": \"GT\",               \"value\": \"45\"             }           ]         },         \"type\": \"REMOVE_MANY\"       }     ]   }   ```   </div> </details> 
 
 ### Example
 
@@ -1640,7 +1701,7 @@ api_instance = TalonOne::IntegrationApi.new
 customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session.  You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. 
 body = TalonOne::IntegrationRequest.new # IntegrationRequest | body
 opts = {
-  dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.  When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session.   When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run.  [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). 
+  dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.  When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session.   When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run.  [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). 
   now: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | A timestamp value of a future date that acts as a current date when included in the query.  Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)).  **Note:**  - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. 
 }
 
@@ -1660,7 +1721,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **customer_session_id** | **String**| The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session.  You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.  | 
  **body** | [**IntegrationRequest**](IntegrationRequest.md)| body | 
- **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;.  When set to &#x60;true&#x60;: - The endpoint will **only** consider the payload that you pass when **closing** the session.   When you do not use the &#x60;dry&#x60; parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the &#x60;evaluableCampaignIds&#x60; body property to select specific campaigns to run.  [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).  | [optional] 
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;.  When set to &#x60;true&#x60;: - The endpoint considers **only** the payload that you pass when **closing** the session.   When you do not use the &#x60;dry&#x60; parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the &#x60;evaluableCampaignIds&#x60; body property to select specific campaigns to run.  [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).  | [optional] 
  **now** | **DateTime**| A timestamp value of a future date that acts as a current date when included in the query.  Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)).  **Note:**  - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the &#x60;dry&#x60; parameter in the query is set to &#x60;true&#x60;.  | [optional] 
 
 ### Return type

data/docs/IntegrationCoupon.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.  | [optional] 
 **usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. | 
 **discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] 

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

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.  | [optional] 
 **usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. | 
 **discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] 

data/docs/InventoryReferral.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 
 **usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | 
 **campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
 **advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 

data/docs/LedgerInfo.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **pending_balance** | **Float** | Sum of pending points. | 
 **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] 
 **current_tier** | [**Tier**](Tier.md) |  | [optional] 
 **points_to_next_tier** | **Float** | Points required to move up a tier. | [optional] 
 

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

@@ -0,0 +1,31 @@
+# TalonOne::LoyaltyBalanceWithTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active_points** | **Float** | Total amount of points awarded to this customer and available to spend. | [optional] 
+**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] 
+**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] 
+**next_tier_name** | **String** | The name of the tier consecutive to the current tier. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyBalanceWithTier.new(active_points: 286.0,
+                                 pending_points: 50.0,
+                                 spent_points: 150.0,
+                                 expired_points: 286.0,
+                                 current_tier: null,
+                                 projected_tier: null,
+                                 points_to_next_tier: 20.0,
+                                 next_tier_name: silver)
+```
+
+

data/docs/LoyaltyBalancesWithTiers.md

@@ -0,0 +1,19 @@
+# TalonOne::LoyaltyBalancesWithTiers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | [**LoyaltyBalanceWithTier**](LoyaltyBalanceWithTier.md) |  | [optional] 
+**subledger_balances** | [**Hash<String, LoyaltyBalanceWithTier>**](LoyaltyBalanceWithTier.md) | Map of the loyalty balances of the subledgers of a ledger. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyBalancesWithTiers.new(balance: null,
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}})
+```
+
+

data/docs/LoyaltyCard.md

@@ -7,7 +7,10 @@ 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. | 
-**status** | **String** | Status of the loyalty card. Can be one of: ['active', 'inactive']  | 
+**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.  | 
 **users_per_card_limit** | **Integer** | The max amount of customer profiles that can be linked to the card. 0 means unlimited.  | 
 **profiles** | [**Array<LoyaltyCardProfileRegistration>**](LoyaltyCardProfileRegistration.md) | Integration IDs of the customers profiles linked to the card. | [optional] 
@@ -16,6 +19,7 @@ Name | Type | Description | Notes
 **modified** | **DateTime** | Timestamp of the most recent update of the loyalty card. | [optional] 
 **old_card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | [optional] 
 **new_card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | [optional] 
+**batch_id** | **String** | The ID of the batch in which the loyalty card was created. | [optional] 
 
 ## Code Sample
 
@@ -25,7 +29,10 @@ 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,
                                  users_per_card_limit: 111,
                                  profiles: null,
@@ -33,7 +40,8 @@ instance = TalonOne::LoyaltyCard.new(id: 6,
                                  subledgers: null,
                                  modified: 2021-09-12T10:12:42Z,
                                  old_card_identifier: summer-loyalty-card-0543,
-                                 new_card_identifier: summer-loyalty-card-0543)
+                                 new_card_identifier: summer-loyalty-card-0543,
+                                 batch_id: wdefpov)
 ```
 
 

data/docs/LoyaltyCardBatch.md

@@ -0,0 +1,23 @@
+# TalonOne::LoyaltyCardBatch
+
+## Properties
+
+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
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyCardBatch.new(number_of_cards: 5000,
+                                 batch_id: hwernpjz,
+                                 status: active,
+                                 card_code_settings: null)
+```
+
+

data/docs/LoyaltyCardBatchResponse.md

@@ -0,0 +1,19 @@
+# TalonOne::LoyaltyCardBatchResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_cards_generated** | **Integer** | Number of loyalty cards in the batch. | 
+**batch_id** | **String** | ID of the loyalty card batch. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyCardBatchResponse.new(number_of_cards_generated: 5000,
+                                 batch_id: hwernpjz)
+```
+
+

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}})
 ```
 
 

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)
 ```
 

data/docs/LoyaltyProgram.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | The ID of loyalty program. Internal ID of this entity. | 
+**id** | **Integer** | The ID of loyalty program. | 
 **created** | **DateTime** | The time this entity was created. | 
 **title** | **String** | The display title for the Loyalty Program. | 
 **description** | **String** | Description of our Loyalty Program. | 
@@ -14,25 +14,30 @@ Name | Type | Description | Notes
 **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | 
 **users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.  | [optional] 
 **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | 
-**tiers_expiration_policy** | **String** | The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.  | [optional] 
-**tiers_expire_in** | **String** | The amount of time after which the tier expires.  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** | Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.  | [optional] 
 **program_join_policy** | **String** | The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.  | [optional] 
+**tiers_expiration_policy** | **String** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.  | [optional] 
+**tier_cycle_start_date** | **DateTime** | Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.  | [optional] 
+**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] 
 **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] 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **card_based** | **Boolean** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based.  | [default to false]
 **can_update_tiers** | **Boolean** | `True` if the tier definitions can be updated.  | [optional] [default to false]
-**can_update_join_policy** | **Boolean** | Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`.  | [optional] 
+**can_update_join_policy** | **Boolean** | `True` if the program join policy can be updated.  | [optional] 
+**can_update_tier_expiration_policy** | **Boolean** | `True` if the tier expiration policy can be updated.  | [optional] 
 **can_upgrade_to_advanced_tiers** | **Boolean** | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties.  | [optional] [default to false]
+**can_update_subledgers** | **Boolean** | `True` if the `allowSubledger` property can be updated in the loyalty program.  | [optional] [default to false]
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::LoyaltyProgram.new(id: null,
+instance = TalonOne::LoyaltyProgram.new(id: 139,
                                  created: 2020-06-10T09:05:27.993483Z,
                                  title: Point collection,
                                  description: Customers collect 10 points per 1$ spent,
@@ -42,18 +47,23 @@ instance = TalonOne::LoyaltyProgram.new(id: null,
                                  allow_subledger: false,
                                  users_per_card_limit: 111,
                                  sandbox: true,
+                                 program_join_policy: null,
                                  tiers_expiration_policy: null,
+                                 tier_cycle_start_date: 2021-09-12T10:12:42Z,
                                  tiers_expire_in: 27W_U,
                                  tiers_downgrade_policy: null,
-                                 program_join_policy: null,
+                                 card_code_settings: null,
+                                 return_policy: null,
                                  account_id: 1,
                                  name: my_program,
-                                 tiers: [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}],
+                                 tiers: [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}],
                                  timezone: Europe/Berlin,
                                  card_based: true,
                                  can_update_tiers: true,
                                  can_update_join_policy: true,
-                                 can_upgrade_to_advanced_tiers: true)
+                                 can_update_tier_expiration_policy: true,
+                                 can_upgrade_to_advanced_tiers: true,
+                                 can_update_subledgers: true)
 ```
 
 

data/docs/LoyaltyProgramBalance.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **pending_balance** | **Float** | Sum of pending points. | 
 **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] 
 
 ## Code Sample
 

data/docs/LoyaltyProgramEntity.md

@@ -5,13 +5,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::LoyaltyProgramEntity.new(program_id: 125)
+instance = TalonOne::LoyaltyProgramEntity.new(program_id: 125,
+                                 program_name: Loyalty_program,
+                                 program_title: Loyalty program)
 ```
 
 

data/docs/LoyaltyTier.md

@@ -7,8 +7,10 @@ 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. | 
-**name** | **String** | The name of the tier | 
-**min_points** | **Float** | The minimum amount of points required to be eligible for the tier. | 
+**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] 
+**name** | **String** | The name of the tier. | 
+**min_points** | **Float** | The minimum amount of points required to enter the tier. | 
 
 ## Code Sample
 
@@ -18,6 +20,8 @@ require 'TalonOne'
 instance = TalonOne::LoyaltyTier.new(id: 6,
                                  created: 2020-06-10T09:05:27.993483Z,
                                  program_id: 125,
+                                 program_name: Loyalty_program,
+                                 program_title: Loyalty program,
                                  name: Gold,
                                  min_points: 300.0)
 ```