talon_one 8.0.0 → 10.0.0

data/docs/InlineResponse20049.md

@@ -0,0 +1,17 @@
+# TalonOne::InlineResponse20049
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<SummaryCampaignStoreBudget>**](SummaryCampaignStoreBudget.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::InlineResponse20049.new(data: null)
+```
+
+

data/docs/InlineResponse20050.md

@@ -0,0 +1,19 @@
+# TalonOne::InlineResponse20050
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **Boolean** |  | [optional] 
+**data** | [**Array<Achievement>**](Achievement.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::InlineResponse20050.new(has_more: null,
+                                 data: null)
+```
+
+

data/docs/InlineResponse20051.md

@@ -0,0 +1,19 @@
+# TalonOne::InlineResponse20051
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **Boolean** |  | 
+**data** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::InlineResponse20051.new(has_more: true,
+                                 data: null)
+```
+
+

data/docs/IntegrationApi.md

@@ -1476,7 +1476,7 @@ Name | Type | Description  | Notes
 
 Track event
 
-Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  <div class=\"redoc-section\">    <p class=\"title\">Important</p>    1. `profileId` is required even though the schema does not say it.   1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).  </div> 
+Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  <div class=\"redoc-section\">    <p class=\"title\">Important</p>    1. `profileId` is required even though the schema does not specify it.   1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).   1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.  </div> 
 
 ### Example
 
@@ -1495,7 +1495,8 @@ api_instance = TalonOne::IntegrationApi.new
 body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
 opts = {
   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`. 
+  dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. 
+  force_complete_evaluation: false # Boolean | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. 
 }
 
 begin
@@ -1515,6 +1516,7 @@ 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 performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  | [optional] [default to &#39;yes&#39;]
  **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;.  | [optional] 
+ **force_complete_evaluation** | **Boolean**| Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires &#x60;dry&#x3D;true&#x60;.  | [optional] [default to false]
 
 ### Return type
 
@@ -1700,7 +1702,7 @@ nil (empty response body)
 
 Update customer profile
 
-Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer profile returns a response with the requested integration state.   - You can use the `responseContent` property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> 
+Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer profile returns a response with the requested integration state.   - You can use the `responseContent` property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> 
 
 ### Example
 
@@ -1820,7 +1822,7 @@ Name | Type | Description  | Notes
 
 Update customer session
 
-Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One.  **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
+Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One.  **Note:**  - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
 
 ### Example
 

data/docs/IntegrationCoupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/IntegrationCustomerProfileAudienceRequest.md

@@ -0,0 +1,17 @@
+# TalonOne::IntegrationCustomerProfileAudienceRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<IntegrationCustomerProfileAudienceRequestItem>**](IntegrationCustomerProfileAudienceRequestItem.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationCustomerProfileAudienceRequest.new(data: null)
+```
+
+

data/docs/IntegrationCustomerProfileAudienceRequestItem.md

@@ -0,0 +1,21 @@
+# TalonOne::IntegrationCustomerProfileAudienceRequestItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience.    **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application   until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience.  | 
+**profile_integration_id** | **String** | The ID of this customer profile in the third-party integration. | 
+**integration_id** | **String** | The ID of this audience in the third-party integration. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationCustomerProfileAudienceRequestItem.new(action: add,
+                                 profile_integration_id: R195412,
+                                 integration_id: 382370BKDB946)
+```
+
+

data/docs/IntegrationEventV2Request.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.  These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.  | [optional] 
 **type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.  | 
 **attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] 
+**loyalty_cards** | **Array<String>** | Identifier of the loyalty card used during this event. | [optional] 
 **response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the tracking custom event.  | [optional] 
 
 ## Code Sample
@@ -21,6 +22,7 @@ instance = TalonOne::IntegrationEventV2Request.new(profile_id: URNGV8294NV,
                                  evaluable_campaign_ids: [10, 12],
                                  type: pageViewed,
                                  attributes: {"myAttribute":"myValue"},
+                                 loyalty_cards: [loyalty-card-1],
                                  response_content: [triggeredCampaigns, customerProfile])
 ```
 

data/docs/InventoryCoupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/InventoryReferral.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The 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. | [optional] 

data/docs/LedgerEntry.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **profile_id** | **String** | ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.  | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. | 

data/docs/LedgerInfo.md

@@ -6,12 +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`. | 
+**negative_balance** | **Float** | Sum of negative points. This implies that `currentBalance` is `0`. | [optional] 
 **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **tentative_current_balance** | **Float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | [optional] 
-**tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
+**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.  | [optional] 
 **current_tier** | [**Tier**](Tier.md) |  | [optional] 
 **points_to_next_tier** | **Float** | Points required to move up a tier. | [optional] 
 

data/docs/LedgerTransactionLogEntryIntegrationAPI.md

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

data/docs/LoyaltyCard.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The 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] 

data/docs/LoyaltyLedgerEntryFlags.md

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

data/docs/LoyaltyProgramBalance.md

@@ -6,12 +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`. | 
+**negative_balance** | **Float** | Sum of negative points. This implies that `currentBalance` is `0`. | [optional] 
 **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **tentative_current_balance** | **Float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | [optional] 
-**tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
+**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.  | [optional] 
 
 ## Code Sample
 

data/docs/LoyaltyProgramTransaction.md

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

data/docs/LoyaltyTier.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The 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]