talon_one 7.0.0 → 9.0.0

data/lib/talon_one/models/update_achievement.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class UpdateAchievement
-    # The internal name of the achievement used in API requests. 
+    # The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. 
     attr_accessor :name
 
     # The display name for the achievement in the Campaign Manager.
@@ -26,7 +26,7 @@ module TalonOne
     # The required number of actions or the transactional milestone to complete the achievement.
     attr_accessor :target
 
-    # The relative duration after which the achievement ends and resets for a particular customer profile. 
+    # The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** 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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period. 
     attr_accessor :period
 
     attr_accessor :period_end_override

data/lib/talon_one/models/update_loyalty_program.rb

@@ -56,7 +56,7 @@ module TalonOne
 
     attr_accessor :card_code_settings
 
-    # 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. 
+    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit. 
     attr_accessor :return_policy
 
     # The tiers in this loyalty program.
@@ -239,7 +239,7 @@ module TalonOne
       return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
       tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
       return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
-      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       return false unless return_policy_validator.valid?(@return_policy)
       true
     end
@@ -287,7 +287,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] return_policy Object to be assigned
     def return_policy=(return_policy)
-      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       unless validator.valid?(return_policy)
         fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module TalonOne
-  VERSION = '7.0.0'
+  VERSION = '9.0.0'
 end

data/lib/talon_one.rb

@@ -34,7 +34,10 @@ require 'talon_one/models/account_entity'
 require 'talon_one/models/account_limits'
 require 'talon_one/models/achievement'
 require 'talon_one/models/achievement_additional_properties'
+require 'talon_one/models/achievement_base'
 require 'talon_one/models/achievement_progress'
+require 'talon_one/models/achievement_progress_with_definition'
+require 'talon_one/models/achievement_status_entry'
 require 'talon_one/models/add_free_item_effect_props'
 require 'talon_one/models/add_item_catalog_action'
 require 'talon_one/models/add_loyalty_points'
@@ -48,13 +51,14 @@ require 'talon_one/models/analytics_data_point_with_trend'
 require 'talon_one/models/analytics_data_point_with_trend_and_influenced_rate'
 require 'talon_one/models/analytics_data_point_with_trend_and_uplift'
 require 'talon_one/models/analytics_product'
-require 'talon_one/models/analytics_product_sku'
+require 'talon_one/models/analytics_sku'
 require 'talon_one/models/application'
 require 'talon_one/models/application_api_key'
 require 'talon_one/models/application_analytics_data_point'
 require 'talon_one/models/application_api_health'
 require 'talon_one/models/application_cif'
 require 'talon_one/models/application_cif_expression'
+require 'talon_one/models/application_cif_references'
 require 'talon_one/models/application_campaign_analytics'
 require 'talon_one/models/application_campaign_stats'
 require 'talon_one/models/application_customer'
@@ -98,6 +102,7 @@ require 'talon_one/models/campaign_collection_without_payload'
 require 'talon_one/models/campaign_copy'
 require 'talon_one/models/campaign_created_notification'
 require 'talon_one/models/campaign_deleted_notification'
+require 'talon_one/models/campaign_detail'
 require 'talon_one/models/campaign_edited_notification'
 require 'talon_one/models/campaign_entity'
 require 'talon_one/models/campaign_evaluation_group'
@@ -115,6 +120,7 @@ require 'talon_one/models/campaign_set_leaf_node'
 require 'talon_one/models/campaign_set_node'
 require 'talon_one/models/campaign_state_changed_notification'
 require 'talon_one/models/campaign_store_budget'
+require 'talon_one/models/campaign_store_budget_limit_config'
 require 'talon_one/models/campaign_template'
 require 'talon_one/models/campaign_template_collection'
 require 'talon_one/models/campaign_template_coupon_reservation_settings'
@@ -171,9 +177,9 @@ require 'talon_one/models/customer_profile_search_query'
 require 'talon_one/models/customer_profile_update_v2_response'
 require 'talon_one/models/customer_session'
 require 'talon_one/models/customer_session_v2'
-require 'talon_one/models/deactivate_user_request'
 require 'talon_one/models/deduct_loyalty_points'
 require 'talon_one/models/deduct_loyalty_points_effect_props'
+require 'talon_one/models/delete_user_request'
 require 'talon_one/models/effect'
 require 'talon_one/models/effect_entity'
 require 'talon_one/models/email_entity'
@@ -207,6 +213,7 @@ require 'talon_one/models/generate_rule_title_rule'
 require 'talon_one/models/get_integration_coupon_request'
 require 'talon_one/models/giveaway'
 require 'talon_one/models/giveaways_pool'
+require 'talon_one/models/hidden_conditions_effects'
 require 'talon_one/models/identifiable_entity'
 require 'talon_one/models/import'
 require 'talon_one/models/import_entity'
@@ -253,6 +260,9 @@ require 'talon_one/models/inline_response20043'
 require 'talon_one/models/inline_response20044'
 require 'talon_one/models/inline_response20045'
 require 'talon_one/models/inline_response20046'
+require 'talon_one/models/inline_response20047'
+require 'talon_one/models/inline_response20048'
+require 'talon_one/models/inline_response20049'
 require 'talon_one/models/inline_response2005'
 require 'talon_one/models/inline_response2006'
 require 'talon_one/models/inline_response2007'
@@ -297,6 +307,7 @@ require 'talon_one/models/loyalty_dashboard_data'
 require 'talon_one/models/loyalty_dashboard_points_breakdown'
 require 'talon_one/models/loyalty_ledger'
 require 'talon_one/models/loyalty_ledger_entry'
+require 'talon_one/models/loyalty_ledger_entry_flags'
 require 'talon_one/models/loyalty_ledger_transactions'
 require 'talon_one/models/loyalty_membership'
 require 'talon_one/models/loyalty_program'
@@ -312,6 +323,7 @@ require 'talon_one/models/message_log_entries'
 require 'talon_one/models/message_log_entry'
 require 'talon_one/models/message_log_request'
 require 'talon_one/models/message_log_response'
+require 'talon_one/models/message_test'
 require 'talon_one/models/meta'
 require 'talon_one/models/model_return'
 require 'talon_one/models/multi_application_entity'
@@ -363,8 +375,8 @@ require 'talon_one/models/new_invite_email'
 require 'talon_one/models/new_loyalty_program'
 require 'talon_one/models/new_loyalty_tier'
 require 'talon_one/models/new_management_key'
+require 'talon_one/models/new_message_test'
 require 'talon_one/models/new_multiple_audiences_item'
-require 'talon_one/models/new_notification_test'
 require 'talon_one/models/new_notification_webhook'
 require 'talon_one/models/new_outgoing_integration_webhook'
 require 'talon_one/models/new_password'
@@ -385,7 +397,6 @@ require 'talon_one/models/new_webhook'
 require 'talon_one/models/notification'
 require 'talon_one/models/notification_activation'
 require 'talon_one/models/notification_list_item'
-require 'talon_one/models/notification_test'
 require 'talon_one/models/okta_event'
 require 'talon_one/models/okta_event_payload'
 require 'talon_one/models/okta_event_payload_data'
@@ -407,8 +418,9 @@ require 'talon_one/models/pending_points_notification_policy'
 require 'talon_one/models/picklist'
 require 'talon_one/models/product'
 require 'talon_one/models/product_search_match'
-require 'talon_one/models/product_sku_unit_analytics'
 require 'talon_one/models/product_unit_analytics'
+require 'talon_one/models/product_unit_analytics_data_point'
+require 'talon_one/models/product_unit_analytics_totals'
 require 'talon_one/models/profile_audiences_changes'
 require 'talon_one/models/projected_tier'
 require 'talon_one/models/redeem_referral_effect_props'
@@ -427,6 +439,7 @@ require 'talon_one/models/return_integration_request'
 require 'talon_one/models/returned_cart_item'
 require 'talon_one/models/revision'
 require 'talon_one/models/revision_activation'
+require 'talon_one/models/revision_activation_request'
 require 'talon_one/models/revision_version'
 require 'talon_one/models/role'
 require 'talon_one/models/role_assign'
@@ -475,6 +488,8 @@ require 'talon_one/models/set_discount_per_additional_cost_per_item_effect_props
 require 'talon_one/models/set_discount_per_item_effect_props'
 require 'talon_one/models/show_bundle_metadata_effect_props'
 require 'talon_one/models/show_notification_effect_props'
+require 'talon_one/models/sku_unit_analytics'
+require 'talon_one/models/sku_unit_analytics_data_point'
 require 'talon_one/models/slot_def'
 require 'talon_one/models/store'
 require 'talon_one/models/strikethrough_changed_item'

data/spec/api/integration_api_spec.rb

@@ -59,7 +59,7 @@ describe 'IntegrationApi' do
 
   # unit tests for create_referral
   # Create referral code for an advocate
-  # Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+  # Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.  **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint. 
   # @param body body
   # @param [Hash] opts the optional parameters
   # @return [Referral]
@@ -71,10 +71,10 @@ describe 'IntegrationApi' do
 
   # unit tests for create_referrals_for_multiple_advocates
   # Create referral codes for multiple advocates
-  # Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+  # Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.  **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint. 
   # @param body body
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
+  # @option opts [String] :silent 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. 
   # @return [InlineResponse201]
   describe 'create_referrals_for_multiple_advocates test' do
     it 'should work' do
@@ -144,6 +144,42 @@ describe 'IntegrationApi' do
     end
   end
 
+  # unit tests for get_customer_achievement_history
+  # List customer's achievement history
+  # Retrieve all progress history of a given customer in the given achievement. 
+  # @param integration_id 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. 
+  # @param achievement_id The achievement identifier. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :progress_status Filter by customer progress status in the achievement. 
+  # @option opts [DateTime] :start_date Timestamp that filters the results to only contain achievements created on or after the start date.
+  # @option opts [DateTime] :end_date Timestamp that filters the results to only contain achievements created before or on the end date.
+  # @option opts [Integer] :page_size The number of items in the response.
+  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
+  # @return [InlineResponse2002]
+  describe 'get_customer_achievement_history test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_customer_achievements
+  # List customer&#39;s available achievements
+  # Retrieve all the achievements available to a given customer and their progress in them. 
+  # @param integration_id 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. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :campaign_ids Filter by one or more Campaign IDs, separated by a comma.  **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. 
+  # @option opts [Array<String>] :achievement_ids Filter by one or more Achievement IDs, separated by a comma.  **Note:** If no achievements are specified, data for all the achievements in the Application is returned. 
+  # @option opts [Array<String>] :achievement_status Filter by status of the achievement.  **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned. 
+  # @option opts [Array<String>] :current_progress_status Filter by customer progress status in the achievement. 
+  # @option opts [Integer] :page_size The number of items in the response.
+  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
+  # @return [InlineResponse2001]
+  describe 'get_customer_achievements test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_customer_inventory
   # List customer data
   # Return the customer inventory regarding entities referencing this customer profile&#39;s &#x60;integrationId&#x60;.  Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons. 
@@ -216,7 +252,7 @@ describe 'IntegrationApi' do
   # @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
   # @option opts [Integer] :page_size The number of items in the response.
   # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
-  # @return [InlineResponse2003]
+  # @return [InlineResponse2005]
   describe 'get_loyalty_card_points test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -235,7 +271,7 @@ describe 'IntegrationApi' do
   # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. 
   # @option opts [Integer] :page_size The number of items in the response.
   # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
-  # @return [InlineResponse2001]
+  # @return [InlineResponse2003]
   describe 'get_loyalty_card_transactions test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -252,7 +288,7 @@ describe 'IntegrationApi' do
   # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
   # @option opts [Integer] :page_size The number of items in the response.
   # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
-  # @return [InlineResponse2004]
+  # @return [InlineResponse2006]
   describe 'get_loyalty_program_profile_points test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -271,7 +307,7 @@ describe 'IntegrationApi' do
   # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. 
   # @option opts [Integer] :page_size The number of items in the response.
   # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
-  # @return [InlineResponse2002]
+  # @return [InlineResponse2004]
   describe 'get_loyalty_program_profile_transactions test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -348,8 +384,9 @@ describe 'IntegrationApi' do
   # 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).  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;    &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt;    1. &#x60;profileId&#x60; 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 &#x60;customer_profile_created&#x60; [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).  &lt;/div&gt; 
   # @param body body
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :silent Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. 
+  # @option opts [String] :silent 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. 
   # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. 
+  # @option opts [Boolean] :force_complete_evaluation 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;. 
   # @return [TrackEventV2Response]
   describe 'track_event_v2 test' do
     it 'should work' do
@@ -415,7 +452,7 @@ describe 'IntegrationApi' do
   # Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request.  The &#x60;integrationId&#x60; must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions).  **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint. 
   # @param body body
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :silent Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. 
+  # @option opts [String] :silent 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. 
   # @return [MultipleCustomerProfileIntegrationResponseV2]
   describe 'update_customer_profiles_v2 test' do
     it 'should work' do