RubyGems - talon_one_sdk - Versions diffs - 26.20.0 → 26.22.0 - Mend

talon_one_sdk 26.20.0 → 26.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2041) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d13dee7b7f4a36e847868b58954e0dbc87e7ab4f1942e93725a20004db94d5a
-  data.tar.gz: 938aa75e8538e551a617c9eeb558e5c029f2f4ba5fad408b3321ebd26d3a84b2
+  metadata.gz: 0675bf6ab341b59d4d2f2ad96102b840fc533e6175084fbcad044716e22629ea
+  data.tar.gz: 8e3ca8c671957987c9ec03c5c24880a38857938a50b0b7bd8f03cd546d2163ef
 SHA512:
-  metadata.gz: fd68e843933e6cdc7a7c4cc4b2be8342eb28695f8109bd36e8e488342bfc9934060ed4fb00dbe9d02c0ba76fd9979cd32aaf67bcee1a170529580f77ce425f85
-  data.tar.gz: 154fbc3dd75aa1e7729bd5d314265ea2915fc14c114b399bd9904392ccdd665a0faa1574206d0c99226c25a11bc812d050bbf75ab3bc3e20961aa831c44eb6cb
+  metadata.gz: e86b93a011362730df4c1a92f1d43f5d07ef77ad10b8edf96b38b4f2667c2d7d2890fb3e341e803f2e8786bc5af6cb35dd8d732e3e521d729d71b1a80bd3f43a
+  data.tar.gz: 7f3efbeec0e065e3ca3dbc8b12cad2e285c8526e30824b8e288c28c0003215ba587137248b8d2e6bf74054ef81058bf19f6c4262f6e9752304a6cf66a8780796

data/README.md CHANGED Viewed

@@ -16,7 +16,7 @@ See our [migration guide](MIGRATION.md).
 Add this to the Gemfile:
 ```shell
-gem 'talon_one_sdk', '~> 26.20.0'
+gem 'talon_one_sdk', '~> 26.22.0'
 ```
 ### Build a gem
@@ -32,10 +32,10 @@ gem build talon_one_sdk.gemspec
 To install the gem locally:
 ```shell
-gem install ./talon_one_sdk-26.20.0.gem
+gem install ./talon_one_sdk-26.22.0.gem
 ```
-For development, run `gem install --dev ./talon_one_sdk-26.20.0.gem` to install the development dependencies.
+For development, run `gem install --dev ./talon_one_sdk-26.22.0.gem` to install the development dependencies.
 ### RubyGems
@@ -207,6 +207,7 @@ Class | Method | HTTP request | Description
 *TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
 *TalonOne::IntegrationApi* | [**integration_get_all_campaigns**](docs/IntegrationApi.md#integration_get_all_campaigns) | **GET** /v1/integration/campaigns | List all running campaigns
 *TalonOne::IntegrationApi* | [**integration_rewards_catalog**](docs/IntegrationApi.md#integration_rewards_catalog) | **GET** /v1/rewards/catalog | List rewards in the catalog
+*TalonOne::IntegrationApi* | [**integration_update_loyalty_card**](docs/IntegrationApi.md#integration_update_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/update | Update loyalty card
 *TalonOne::IntegrationApi* | [**join_loyalty_program**](docs/IntegrationApi.md#join_loyalty_program) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/join | Join customer profile to loyalty program
 *TalonOne::IntegrationApi* | [**link_loyalty_card_to_profile**](docs/IntegrationApi.md#link_loyalty_card_to_profile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card
 *TalonOne::IntegrationApi* | [**reopen_customer_session**](docs/IntegrationApi.md#reopen_customer_session) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session
@@ -324,6 +325,7 @@ Class | Method | HTTP request | Description
 *TalonOne::ManagementApi* | [**get_collection**](docs/ManagementApi.md#get_collection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection
 *TalonOne::ManagementApi* | [**get_collection_items**](docs/ManagementApi.md#get_collection_items) | **GET** /v1/collections/{collectionId}/items | Get collection items
 *TalonOne::ManagementApi* | [**get_coupons_without_total_count**](docs/ManagementApi.md#get_coupons_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons
+*TalonOne::ManagementApi* | [**get_current_revision**](docs/ManagementApi.md#get_current_revision) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/revisions/current | Get current revision version
 *TalonOne::ManagementApi* | [**get_customer_activity_report**](docs/ManagementApi.md#get_customer_activity_report) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report
 *TalonOne::ManagementApi* | [**get_customer_activity_reports_without_total_count**](docs/ManagementApi.md#get_customer_activity_reports_without_total_count) | **GET** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers
 *TalonOne::ManagementApi* | [**get_customer_analytics**](docs/ManagementApi.md#get_customer_analytics) | **GET** /v1/applications/{applicationId}/customers/{customerId}/analytics | Get customer's analytics report
@@ -381,6 +383,7 @@ Class | Method | HTTP request | Description
 *TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
 *TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
 *TalonOne::ManagementApi* | [**list_experiments**](docs/ManagementApi.md#list_experiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments
+*TalonOne::ManagementApi* | [**list_giveaways_pool**](docs/ManagementApi.md#list_giveaways_pool) | **GET** /v1/giveaways/pools | List giveaway pools
 *TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
 *TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
 *TalonOne::ManagementApi* | [**price_history**](docs/ManagementApi.md#price_history) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history
@@ -625,6 +628,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::CatalogActionRemoveMany](docs/CatalogActionRemoveMany.md)
 - [TalonOne::CatalogItem](docs/CatalogItem.md)
 - [TalonOne::CatalogRule](docs/CatalogRule.md)
+- [TalonOne::CatalogRuleset](docs/CatalogRuleset.md)
 - [TalonOne::CatalogSyncRequest](docs/CatalogSyncRequest.md)
 - [TalonOne::CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md)
 - [TalonOne::Change](docs/Change.md)
@@ -687,6 +691,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::CustomEffectBlockReference](docs/CustomEffectBlockReference.md)
 - [TalonOne::CustomEffectProps](docs/CustomEffectProps.md)
 - [TalonOne::CustomerAchievement](docs/CustomerAchievement.md)
+- [TalonOne::CustomerAchievementHistoryEntry](docs/CustomerAchievementHistoryEntry.md)
 - [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
 - [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
 - [TalonOne::CustomerInventory](docs/CustomerInventory.md)
@@ -729,6 +734,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::EffectError](docs/EffectError.md)
 - [TalonOne::EffectExtendLoyaltyPointsExpiryDate](docs/EffectExtendLoyaltyPointsExpiryDate.md)
 - [TalonOne::EffectIncreaseAchievementProgress](docs/EffectIncreaseAchievementProgress.md)
+- [TalonOne::EffectIncreaseAchievementProgressPerItem](docs/EffectIncreaseAchievementProgressPerItem.md)
 - [TalonOne::EffectJoinLoyaltyProgram](docs/EffectJoinLoyaltyProgram.md)
 - [TalonOne::EffectOffsetNegativeLoyaltyPoints](docs/EffectOffsetNegativeLoyaltyPoints.md)
 - [TalonOne::EffectRedeemReferral](docs/EffectRedeemReferral.md)
@@ -742,7 +748,9 @@ Class | Method | HTTP request | Description
 - [TalonOne::EffectRollbackDeductedLoyaltyPoints](docs/EffectRollbackDeductedLoyaltyPoints.md)
 - [TalonOne::EffectRollbackDiscount](docs/EffectRollbackDiscount.md)
 - [TalonOne::EffectRollbackIncreasedAchievementProgress](docs/EffectRollbackIncreasedAchievementProgress.md)
+- [TalonOne::EffectRollbackIncreasedAchievementProgressPerItem](docs/EffectRollbackIncreasedAchievementProgressPerItem.md)
 - [TalonOne::EffectRollbackReferral](docs/EffectRollbackReferral.md)
+- [TalonOne::EffectRollbackTierBoost](docs/EffectRollbackTierBoost.md)
 - [TalonOne::EffectRollbackUseReward](docs/EffectRollbackUseReward.md)
 - [TalonOne::EffectSet](docs/EffectSet.md)
 - [TalonOne::EffectSetDiscount](docs/EffectSetDiscount.md)
@@ -759,6 +767,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::EmailEntity](docs/EmailEntity.md)
 - [TalonOne::EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
 - [TalonOne::EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
+- [TalonOne::EmbeddedAnalyticsToken](docs/EmbeddedAnalyticsToken.md)
 - [TalonOne::EmbeddedDashboardConfiguration](docs/EmbeddedDashboardConfiguration.md)
 - [TalonOne::Endpoint](docs/Endpoint.md)
 - [TalonOne::Entity](docs/Entity.md)
@@ -780,6 +789,8 @@ Class | Method | HTTP request | Description
 - [TalonOne::EventV3RequestEntity](docs/EventV3RequestEntity.md)
 - [TalonOne::ExcludePriceObservationsRequest](docs/ExcludePriceObservationsRequest.md)
 - [TalonOne::Experiment](docs/Experiment.md)
+- [TalonOne::ExperimentBlueprint](docs/ExperimentBlueprint.md)
+- [TalonOne::ExperimentBlueprintVariant](docs/ExperimentBlueprintVariant.md)
 - [TalonOne::ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
 - [TalonOne::ExperimentConfidenceTimeline](docs/ExperimentConfidenceTimeline.md)
 - [TalonOne::ExperimentConfidenceTimelineDataPoint](docs/ExperimentConfidenceTimelineDataPoint.md)
@@ -894,6 +905,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::Import](docs/Import.md)
 - [TalonOne::ImportEntity](docs/ImportEntity.md)
 - [TalonOne::IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md)
+- [TalonOne::IncreaseAchievementProgressPerItemEffectProps](docs/IncreaseAchievementProgressPerItemEffectProps.md)
 - [TalonOne::InfluencingCampaignDetails](docs/InfluencingCampaignDetails.md)
 - [TalonOne::IntegrationCampaign](docs/IntegrationCampaign.md)
 - [TalonOne::IntegrationCampaignBase](docs/IntegrationCampaignBase.md)
@@ -963,6 +975,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::ListCatalogItems200Response](docs/ListCatalogItems200Response.md)
 - [TalonOne::ListCheckAttributeBlock](docs/ListCheckAttributeBlock.md)
 - [TalonOne::ListExperiments200Response](docs/ListExperiments200Response.md)
+- [TalonOne::ListGiveawaysPool200Response](docs/ListGiveawaysPool200Response.md)
 - [TalonOne::ListStores200Response](docs/ListStores200Response.md)
 - [TalonOne::ListWithCountCheckAttributeBlock](docs/ListWithCountCheckAttributeBlock.md)
 - [TalonOne::LocationCheckAttributeBlock](docs/LocationCheckAttributeBlock.md)
@@ -1060,6 +1073,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::NewEventType](docs/NewEventType.md)
 - [TalonOne::NewEventV3Entity](docs/NewEventV3Entity.md)
 - [TalonOne::NewExperiment](docs/NewExperiment.md)
+- [TalonOne::NewExperimentBlueprint](docs/NewExperimentBlueprint.md)
 - [TalonOne::NewExperimentVariant](docs/NewExperimentVariant.md)
 - [TalonOne::NewExperimentVariantArray](docs/NewExperimentVariantArray.md)
 - [TalonOne::NewExternalInvitation](docs/NewExternalInvitation.md)
@@ -1201,6 +1215,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
 - [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
 - [TalonOne::RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md)
+- [TalonOne::RollbackIncreasedAchievementProgressPerItemEffectProps](docs/RollbackIncreasedAchievementProgressPerItemEffectProps.md)
 - [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
 - [TalonOne::RollbackTierBoostEffectProps](docs/RollbackTierBoostEffectProps.md)
 - [TalonOne::RollbackUseRewardEffectProps](docs/RollbackUseRewardEffectProps.md)
@@ -1306,6 +1321,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::UpdateAccount](docs/UpdateAccount.md)
 - [TalonOne::UpdateAchievement](docs/UpdateAchievement.md)
 - [TalonOne::UpdateAchievementProgressBlock](docs/UpdateAchievementProgressBlock.md)
+- [TalonOne::UpdateAchievementProgressBlock1Value](docs/UpdateAchievementProgressBlock1Value.md)
 - [TalonOne::UpdateAchievementV2](docs/UpdateAchievementV2.md)
 - [TalonOne::UpdateApplication](docs/UpdateApplication.md)
 - [TalonOne::UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
@@ -1330,6 +1346,7 @@ Class | Method | HTTP request | Description
 - [TalonOne::UpdateCustomerProfileV2409Response](docs/UpdateCustomerProfileV2409Response.md)
 - [TalonOne::UpdateCustomerSessionV2409Response](docs/UpdateCustomerSessionV2409Response.md)
 - [TalonOne::UpdateExperiment](docs/UpdateExperiment.md)
+- [TalonOne::UpdateExperimentBlueprint](docs/UpdateExperimentBlueprint.md)
 - [TalonOne::UpdateExperimentVariant](docs/UpdateExperimentVariant.md)
 - [TalonOne::UpdateExperimentVariantArray](docs/UpdateExperimentVariantArray.md)
 - [TalonOne::UpdateExperimentVariantName](docs/UpdateExperimentVariantName.md)

data/docs/AchievementBlockReference.md CHANGED Viewed

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The ID of the achievement. |  |
-| **title** | **String** | The display name for the achievement in the Campaign Manager. |  |
-| **name** | **String** | The internal name of the achievement used in API requests. |  |
-| **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |  |
+| **title** | **String** | The display name for the achievement in the Campaign Manager. | [optional][readonly] |
+| **name** | **String** | The internal name of the achievement used in API requests. | [optional][readonly] |
+| **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional][readonly] |
 ## Example

data/docs/AddedDeductedPointsBalancesAction.md CHANGED Viewed

@@ -10,6 +10,9 @@
 | **start_date** | **Time** | The start date for loyalty points. | [optional] |
 | **expiry_date** | **Time** | The expiration date for loyalty points. | [optional] |
 | **transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |  |
+| **created** | **Time** | The timestamp when the loyalty transaction occurred. | [optional] |
+| **awaits_activation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. | [optional] |
+| **validity_duration** | **String** | The duration for which the points remain active, calculated relative to their start date.   **Note**: This only applies to points for which &#x60;AwaitsActivation&#x60; is &#x60;true&#x60; and &#x60;ExpiryDate&#x60; is not set.  | [optional] |
 ## Example
@@ -22,7 +25,10 @@ instance = TalonOne::AddedDeductedPointsBalancesAction.new(
   operation: null,
   start_date: 2023-01-24T14:15:22Z,
   expiry_date: 2024-01-24T14:15:22Z,
-  transaction_uuid: null
+  transaction_uuid: null,
+  created: 2023-01-24T14:15:22Z,
+  awaits_activation: false,
+  validity_duration: 30D
 )
 ```

data/docs/AddedDeductedPointsNotification.md CHANGED Viewed

@@ -18,6 +18,9 @@
 | **reason** | **String** | The reason for the points addition or deduction. |  |
 | **start_date** | **Time** | The start date for loyalty points. | [optional] |
 | **transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |  |
+| **created** | **Time** | The timestamp when the loyalty transaction occurred. | [optional] |
+| **awaits_activation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. | [optional] |
+| **validity_duration** | **String** | The duration for which the points remain active, relative to the activation date.  **Note**: This only applies to points for which &#x60;AwaitsActivation&#x60; is &#x60;true&#x60; and &#x60;ExpiryDate&#x60; is not set.  | [optional] |
 ## Example
@@ -38,7 +41,10 @@ instance = TalonOne::AddedDeductedPointsNotification.new(
   operation: null,
   reason: Compensation,
   start_date: 2023-01-24T14:15:22Z,
-  transaction_uuid: null
+  transaction_uuid: null,
+  created: 2023-01-24T14:15:22Z,
+  awaits_activation: false,
+  validity_duration: 30D
 )
 ```

data/docs/ApplicationCustomer.md CHANGED Viewed

@@ -16,6 +16,7 @@
 | **last_activity** | **Time** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn&#39;t impact this field.  |  |
 | **sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).  | [optional] |
 | **advocate_integration_id** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] |
+| **loyalty_program_join_dates** | [**Array&lt;LoyaltyMembership&gt;**](LoyaltyMembership.md) | The dates on which the customer joined the profile-based loyalty programs they are part of. Returned only when the &#x60;withLoyaltyMemberships&#x60; query parameter is &#x60;true&#x60;. | [optional] |
 ## Example
@@ -34,7 +35,8 @@ instance = TalonOne::ApplicationCustomer.new(
   audience_memberships: null,
   last_activity: 2020-02-08T14:15:20Z,
   sandbox: false,
-  advocate_integration_id: null
+  advocate_integration_id: null,
+  loyalty_program_join_dates: null
 )
 ```

data/docs/AttributeBlockReference.md CHANGED Viewed

@@ -7,8 +7,8 @@
 | **id** | **Integer** | The internal ID of the attribute. Reverts to &#x60;0&#x60; when the attribute is deleted or does not exist. |  |
 | **entity** | **String** | The entity type that owns the attribute. Reverts to an empty string when the attribute is deleted or does not exist. |  |
 | **name** | **String** | The attribute name as used in API requests. |  |
-| **title** | **String** | The human-readable name of the attribute. |  |
-| **type** | **String** | The data type of the attribute. |  |
+| **title** | **String** | The human-readable name of the attribute. | [optional][readonly] |
+| **type** | **String** | The data type of the attribute. | [optional][readonly] |
 ## Example

data/docs/AudienceBlockReference.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The ID of the audience. |  |
-| **name** | **String** | The display name of the audience. |  |
+| **name** | **String** | The display name of the audience. | [optional][readonly] |
 | **integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in.  For example, &#x60;mParticle&#x60;, &#x60;Segment&#x60;, &#x60;Shopify&#x60;, &#x60;Braze&#x60;, or &#x60;Iterable&#x60;.  **Note:** If you do not integrate with any of these platforms, do not use this property.  | [optional] |
 | **integration_id** | **String** | The ID of this audience in the third-party integration.  **Note:** To create an audience that doesn&#39;t come from a 3rd party platform, do not use this property.  | [optional] |

data/docs/AwardGiveawayBlock.md CHANGED Viewed

@@ -9,7 +9,6 @@
 | **tags** | **Array&lt;String&gt;** | Semantic labels attached to this block. | [optional][readonly] |
 | **giveaway_pool** | [**GiveawayPoolBlockReference**](GiveawayPoolBlockReference.md) | The giveaway pool from which an item is awarded. |  |
 | **profile** | **String** | The customer profile to award the giveaway to. &#x60;Current&#x60; targets the customer in the current session; &#x60;Advocate&#x60; targets the person who invited their friend via referral program. |  |
-| **on_failure** | [**Array&lt;Block&gt;**](Block.md) | Blocks evaluated when this block fails or returns false. | [optional] |
 | **on_error** | **Hash&lt;String, Array&lt;Block&gt;&gt;** | Named error handlers evaluated when a specific error occurs. | [optional] |
 ## Example
@@ -23,7 +22,6 @@ instance = TalonOne::AwardGiveawayBlock.new(
   tags: null,
   giveaway_pool: null,
   profile: Current,
-  on_failure: null,
   on_error: null
 )
 ```

data/docs/AwardItemBlock.md CHANGED Viewed

@@ -10,7 +10,7 @@
 | **sku** | **String** | The stock keeping unit of the item to award. |  |
 | **name** | **String** | The display name of the item to award. |  |
 | **quantity** | **String** | The number of items to award. Supports template placeholders (e.g. \&quot;{{$Session.Total / 2}}\&quot;) for dynamic quantities. |  |
-| **partial** | **Boolean** | When set to &#x60;true&#x60;, applies a partial item reward if the remaining budget is insufficient to award the full reward. | [optional] |
+| **partial** | **Boolean** | When set to &#x60;true&#x60;, applies a partial item reward if the remaining budget is insufficient to award the full reward. When omitted, the Application&#39;s partial discounts setting applies. | [optional] |
 | **on_failure** | [**Array&lt;Block&gt;**](Block.md) | Blocks evaluated when this block fails or returns false. | [optional] |
 | **on_error** | **Hash&lt;String, Array&lt;Block&gt;&gt;** | Named error handlers evaluated when a specific error occurs. | [optional] |

data/docs/AwardLoyaltyPointsBlock.md CHANGED Viewed

@@ -19,7 +19,6 @@
 | **validity_duration** | **String** | Relative duration (e.g. &#x60;30D&#x60;) after which the awarded points expire. Mutually exclusive with &#x60;expiryDate&#x60;. | [optional] |
 | **expiry_date** | **Object** | Timestamp at which the awarded points expire. Mutually exclusive with &#x60;validityDuration&#x60;. | [optional] |
 | **pending_duration** | **String** | Relative duration (e.g. &#x60;3D&#x60;) the awarded points remain pending before activation. | [optional] |
-| **on_failure** | [**Array&lt;Block&gt;**](Block.md) | Promotion blocks evaluated when this block fails or returns false. | [optional] |
 ## Example
@@ -41,8 +40,7 @@ instance = TalonOne::AwardLoyaltyPointsBlock.new(
   start_date: 2026-12-24T14:15:22Z,
   validity_duration: 30D,
   expiry_date: 2026-12-31T00:00:00Z,
-  pending_duration: 3D,
-  on_failure: null
+  pending_duration: 3D
 )
 ```

data/docs/AwardLoyaltyPointsBlock1Program.md CHANGED Viewed

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The ID of the loyalty program. |  |
-| **name** | **String** | The internal name of the loyalty program. |  |
-| **title** | **String** | The display name of the loyalty program. |  |
+| **name** | **String** | The internal name of the loyalty program. | [optional][readonly] |
+| **title** | **String** | The display name of the loyalty program. | [optional][readonly] |
 ## Example

data/docs/Campaign.md CHANGED Viewed

@@ -53,7 +53,7 @@
 | **revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional] |
 | **active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign.  | [optional] |
 | **active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign.  | [optional] |
-| **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.  | [optional] |
+| **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign. Starts from &#x60;0&#x60; for a new campaign.  | [optional] |
 | **current_revision_id** | **Integer** | ID of the revision currently being modified for the campaign.  | [optional] |
 | **current_revision_version_id** | **Integer** | ID of the latest version applied on the current revision.  | [optional] |
 | **stage_revision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key.  | [optional][default to false] |

data/docs/CampaignEligibilityDetails.md CHANGED Viewed

@@ -14,8 +14,8 @@
 require 'talon_one_sdk'
 instance = TalonOne::CampaignEligibilityDetails.new(
-  passed: null,
-  coupon_code: null,
+  passed: false,
+  coupon_code: XMAS-20-2021,
   details: null
 )
 ```

data/docs/CampaignVersions.md CHANGED Viewed

@@ -7,7 +7,7 @@
 | **revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional] |
 | **active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign.  | [optional] |
 | **active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign.  | [optional] |
-| **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.  | [optional] |
+| **version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign. Starts from &#x60;0&#x60; for a new campaign.  | [optional] |
 | **current_revision_id** | **Integer** | ID of the revision currently being modified for the campaign.  | [optional] |
 | **current_revision_version_id** | **Integer** | ID of the latest version applied on the current revision.  | [optional] |
 | **stage_revision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key.  | [optional][default to false] |

data/docs/CardAddedDeductedPointsNotification.md CHANGED Viewed

@@ -20,6 +20,9 @@
 | **reason** | **String** | The reason for the points addition or deduction. |  |
 | **start_date** | **Time** | The start date for loyalty points. | [optional] |
 | **transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |  |
+| **created** | **Time** | The timestamp when the loyalty transaction occurred. | [optional] |
+| **awaits_activation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. | [optional] |
+| **validity_duration** | **String** | The duration for which the points remain active, relative to the activation date.  **Note**: This only applies to points for which &#x60;AwaitsActivation&#x60; is &#x60;true&#x60; and &#x60;ExpiryDate&#x60; is not set.  | [optional] |
 ## Example
@@ -42,7 +45,10 @@ instance = TalonOne::CardAddedDeductedPointsNotification.new(
   operation: null,
   reason: Compensation,
   start_date: 2023-01-24T14:15:22Z,
-  transaction_uuid: null
+  transaction_uuid: null,
+  created: 2023-01-24T14:15:22Z,
+  awaits_activation: false,
+  validity_duration: 30D
 )
 ```

data/docs/CatalogRuleset.md ADDED Viewed

@@ -0,0 +1,22 @@
+# TalonOne::CatalogRuleset
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rules** | [**Array&lt;CatalogRule&gt;**](CatalogRule.md) | Array of rule templates in this ruleset. Rules only contain title (no description, as description is at the catalog entry level). |  |
+| **bindings** | [**Array&lt;Binding&gt;**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | [optional] |
+| **rb_version** | **String** | The version of the rulebuilder used to create this ruleset. | [optional] |
+## Example
+```ruby
+require 'talon_one_sdk'
+instance = TalonOne::CatalogRuleset.new(
+  rules: null,
+  bindings: [],
+  rb_version: v2
+)
+```

data/docs/CheckLoyaltyBalanceBlock.md CHANGED Viewed

@@ -9,8 +9,8 @@
 | **tags** | **Array&lt;String&gt;** | Semantic labels attached to this block. | [optional][readonly] |
 | **operator** | **String** | An indicator of how the block compares the balance to the value. |  |
 | **program** | [**CheckLoyaltyBalanceBlock1Program**](CheckLoyaltyBalanceBlock1Program.md) |  |  |
-| **subledger** | **String** | The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program&#39;s main ledger balance instead of a subledger. |  |
-| **balance** | **String** | The type of balance to check:  - &#x60;current&#x60; is the sum of currently active points  - &#x60;pending&#x60; is the sum of pending points.  - &#x60;negative&#x60; is the sum of negative points.  - &#x60;tentativeCurrent&#x60; is the tentative points balance within the current open customer session. |  |
+| **subledger** | **String** | The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program&#39;s main ledger balance instead of a subledger. A subledger can only be used when the loyalty program has subledgers enabled. |  |
+| **balance** | **String** | The type of balance to check:  - &#x60;current&#x60; is the sum of currently active points  - &#x60;pending&#x60; is the sum of pending points.  - &#x60;negative&#x60; is the sum of negative points. It cannot be used with a subledger.  - &#x60;tentativeCurrent&#x60; is the tentative points balance within the current open customer session. |  |
 | **value** | **Float** | The numeric value to compare the balance against. |  |
 | **on_failure** | [**Array&lt;Block&gt;**](Block.md) | Promotion blocks evaluated when this block fails or returns false. | [optional] |

data/docs/CheckLoyaltyBalanceBlock1Program.md CHANGED Viewed

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The ID of the loyalty program. |  |
-| **name** | **String** | The internal name of the loyalty program. |  |
-| **title** | **String** | The display name of the loyalty program. |  |
+| **name** | **String** | The internal name of the loyalty program. | [optional][readonly] |
+| **title** | **String** | The display name of the loyalty program. | [optional][readonly] |
 ## Example

data/docs/CheckTierBlock.md CHANGED Viewed

@@ -8,7 +8,7 @@
 | **type** | **String** | Identifies the block variant and determines which additional properties are present in it. |  |
 | **tags** | **Array&lt;String&gt;** | Semantic labels attached to this block. | [optional][readonly] |
 | **operator** | **String** | An indicator of how the block compares its elements. |  |
-| **subledger** | **String** | The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program&#39;s main ledger balance instead of a subledger. |  |
+| **subledger** | **String** | The name of the subledger to check a customer&#39;s tier in. Can be empty if this block checks the loyalty program&#39;s main ledger instead of a subledger. A subledger can only be used when the loyalty program that the tier is in has subledgers enabled. To specify the main ledger, provide an empty string (\&quot;\&quot;). |  |
 | **tier** | [**TierBlockReference**](TierBlockReference.md) | The tier to check for. |  |
 | **on_failure** | [**Array&lt;Block&gt;**](Block.md) | Promotion blocks evaluated when this block fails or returns false. | [optional] |

data/docs/CustomEffectBlockReference.md CHANGED Viewed

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The unique identifier of the custom effect. |  |
-| **name** | **String** | The name of the custom effect, as used in API requests. |  |
-| **title** | **String** | The display name of the custom effect. |  |
+| **name** | **String** | The name of the custom effect, as used in API requests. | [optional][readonly] |
+| **title** | **String** | The display name of the custom effect. | [optional][readonly] |
 ## Example

data/docs/CustomerAchievementHistoryEntry.md ADDED Viewed

@@ -0,0 +1,28 @@
+# TalonOne::CustomerAchievementHistoryEntry
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The status of the achievement. |  |
+| **progress** | **Float** | The current progress of the customer in the achievement. |  |
+| **start_date** | **Time** | Timestamp at which the customer started the achievement. | [optional] |
+| **completion_date** | **Time** | Timestamp at which point the customer completed the achievement. | [optional] |
+| **end_date** | **Time** | Timestamp at which point the achievement ends and resets for the customer. | [optional] |
+| **progress_tracker_id** | **Integer** | The ID of the customer&#39;s progress tracker for this achievement. |  |
+## Example
+```ruby
+require 'talon_one_sdk'
+instance = TalonOne::CustomerAchievementHistoryEntry.new(
+  status: completed,
+  progress: 10,
+  start_date: 2024-01-01T15:04:05Z07:00,
+  completion_date: 2024-01-15T15:04:05Z07:00,
+  end_date: 2024-02-01T15:04:05Z07:00,
+  progress_tracker_id: 42
+)
+```

data/docs/Effect.md CHANGED Viewed

@@ -30,6 +30,7 @@ TalonOne::Effect.openapi_one_of
 #   :'EffectError',
 #   :'EffectExtendLoyaltyPointsExpiryDate',
 #   :'EffectIncreaseAchievementProgress',
+#   :'EffectIncreaseAchievementProgressPerItem',
 #   :'EffectJoinLoyaltyProgram',
 #   :'EffectOffsetNegativeLoyaltyPoints',
 #   :'EffectRedeemReferral',
@@ -43,7 +44,9 @@ TalonOne::Effect.openapi_one_of
 #   :'EffectRollbackDeductedLoyaltyPoints',
 #   :'EffectRollbackDiscount',
 #   :'EffectRollbackIncreasedAchievementProgress',
+#   :'EffectRollbackIncreasedAchievementProgressPerItem',
 #   :'EffectRollbackReferral',
+#   :'EffectRollbackTierBoost',
 #   :'EffectRollbackUseReward',
 #   :'EffectSet',
 #   :'EffectSetDiscount',
@@ -101,6 +104,7 @@ TalonOne::Effect.openapi_discriminator_mapping
 #   :'error' => :'EffectError',
 #   :'extendLoyaltyPointsExpiryDate' => :'EffectExtendLoyaltyPointsExpiryDate',
 #   :'increaseAchievementProgress' => :'EffectIncreaseAchievementProgress',
+#   :'increaseAchievementProgressPerItem' => :'EffectIncreaseAchievementProgressPerItem',
 #   :'joinLoyaltyProgram' => :'EffectJoinLoyaltyProgram',
 #   :'offsetNegativeLoyaltyPoints' => :'EffectOffsetNegativeLoyaltyPoints',
 #   :'redeemReferral' => :'EffectRedeemReferral',
@@ -114,7 +118,9 @@ TalonOne::Effect.openapi_discriminator_mapping
 #   :'rollbackDeductedLoyaltyPoints' => :'EffectRollbackDeductedLoyaltyPoints',
 #   :'rollbackDiscount' => :'EffectRollbackDiscount',
 #   :'rollbackIncreasedAchievementProgress' => :'EffectRollbackIncreasedAchievementProgress',
+#   :'rollbackIncreasedAchievementProgressPerItem' => :'EffectRollbackIncreasedAchievementProgressPerItem',
 #   :'rollbackReferral' => :'EffectRollbackReferral',
+#   :'rollbackTierBoost' => :'EffectRollbackTierBoost',
 #   :'rollbackUseReward' => :'EffectRollbackUseReward',
 #   :'set' => :'EffectSet',
 #   :'setDiscount' => :'EffectSetDiscount',
@@ -171,6 +177,7 @@ TalonOne::Effect.build(data_that_doesnt_match)
 - `EffectError`
 - `EffectExtendLoyaltyPointsExpiryDate`
 - `EffectIncreaseAchievementProgress`
+- `EffectIncreaseAchievementProgressPerItem`
 - `EffectJoinLoyaltyProgram`
 - `EffectOffsetNegativeLoyaltyPoints`
 - `EffectRedeemReferral`
@@ -184,7 +191,9 @@ TalonOne::Effect.build(data_that_doesnt_match)
 - `EffectRollbackDeductedLoyaltyPoints`
 - `EffectRollbackDiscount`
 - `EffectRollbackIncreasedAchievementProgress`
+- `EffectRollbackIncreasedAchievementProgressPerItem`
 - `EffectRollbackReferral`
+- `EffectRollbackTierBoost`
 - `EffectRollbackUseReward`
 - `EffectSet`
 - `EffectSetDiscount`

data/docs/EffectAcceptCoupon.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AcceptCouponEffectProps**](AcceptCouponEffectProps.md) | The properties of the &#x60;acceptCoupon&#x60; effect. |  |
+| **props** | [**AcceptCouponEffectProps**](AcceptCouponEffectProps.md) |  |  |
 ## Example

data/docs/EffectAcceptReferral.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AcceptReferralEffectProps**](AcceptReferralEffectProps.md) | The properties of the &#x60;acceptReferral&#x60; effect. |  |
+| **props** | [**AcceptReferralEffectProps**](AcceptReferralEffectProps.md) |  |  |
 ## Example

data/docs/EffectAddFreeItem.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AddFreeItemEffectProps**](AddFreeItemEffectProps.md) | The properties of the &#x60;addFreeItem&#x60; effect. |  |
+| **props** | [**AddFreeItemEffectProps**](AddFreeItemEffectProps.md) |  |  |
 ## Example

data/docs/EffectAddLoyaltyPoints.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AddLoyaltyPointsEffectProps**](AddLoyaltyPointsEffectProps.md) | The properties of the &#x60;addLoyaltyPoints&#x60; effect. |  |
+| **props** | [**AddLoyaltyPointsEffectProps**](AddLoyaltyPointsEffectProps.md) |  |  |
 ## Example

data/docs/EffectAddToAudience.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AddToAudienceEffectProps**](AddToAudienceEffectProps.md) | The properties of the &#x60;addToAudience&#x60; effect. |  |
+| **props** | [**AddToAudienceEffectProps**](AddToAudienceEffectProps.md) |  |  |
 ## Example

data/docs/EffectAwardGiveaway.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**AwardGiveawayEffectProps**](AwardGiveawayEffectProps.md) | The properties of the &#x60;awardGiveaway&#x60; effect. |  |
+| **props** | [**AwardGiveawayEffectProps**](AwardGiveawayEffectProps.md) |  |  |
 ## Example

data/docs/EffectBoostLoyaltyTier.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**BoostLoyaltyTierEffectProps**](BoostLoyaltyTierEffectProps.md) | The properties of the &#x60;boostLoyaltyTier&#x60; effect. |  |
+| **props** | [**BoostLoyaltyTierEffectProps**](BoostLoyaltyTierEffectProps.md) |  |  |
 ## Example

data/docs/EffectCallApi.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**TriggerWebhookEffectProps**](TriggerWebhookEffectProps.md) | The properties of the &#x60;callApi&#x60; effect. |  |
+| **props** | [**TriggerWebhookEffectProps**](TriggerWebhookEffectProps.md) |  |  |
 ## Example

data/docs/EffectChangeLoyaltyTierLevel.md CHANGED Viewed

@@ -22,7 +22,7 @@
 | **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the &#x60;selectedPrice&#x60; resulted from a price adjustment. | [optional] |
 | **reward_id** | **Integer** | The ID of the reward that was being evaluated when this effect was triggered. | [optional] |
 | **reward_integration_id** | **String** | The integration ID of the specific customer reward whose usage produced this effect. | [optional] |
-| **props** | [**ChangeLoyaltyTierLevelEffectProps**](ChangeLoyaltyTierLevelEffectProps.md) | The properties of the &#x60;changeLoyaltyTierLevel&#x60; effect. |  |
+| **props** | [**ChangeLoyaltyTierLevelEffectProps**](ChangeLoyaltyTierLevelEffectProps.md) |  |  |
 ## Example