Merge pull request #36 from talon-one/sc-42168-update-ruby-sdk

Quarterly sdk update
talon-one · Sep 24, 2024 · e47603e · e47603e
2 parents 5242a11 + f55a4e5
commit e47603e
Show file tree

Hide file tree

Showing 326 changed files with 21,933 additions and 671 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -10,4 +10,4 @@ script:
   - bundle install --path vendor/bundle
   - bundle exec rspec
   - gem build talon_one.gemspec
-  - gem install ./talon_one-5.0.0.gem
+  - gem install ./talon_one-6.0.0.gem
diff --git a/README.md b/README.md
diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **achievement_id** | **Integer** | The internal ID of the achievement. | 
 **name** | **String** | The internal name of the achievement used in API requests.  | 
 **title** | **String** | The display name of the achievement in the Campaign Manager. | 
+**description** | **String** | The description of the achievement in the Campaign Manager. | 
 **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | 
 **status** | **String** | The status of the achievement. | 
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 
@@ -23,6 +24,7 @@ require 'TalonOne'
 instance = TalonOne::AchievementProgress.new(achievement_id: 3,
                                  name: FreeCoffee10Orders,
                                  title: 50% off on 50th purchase.,
+                                 description: 50% off for every 50th purchase in a year.,
                                  campaign_id: 3,
                                  status: completed,
                                  target: 10.0,

diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional] 
 **template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional] 
 **frontend_state** | **String** | A campaign state described exactly as in the Campaign Manager. | 
+**stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
 
 ## Code Sample
 
@@ -53,7 +54,8 @@ instance = TalonOne::AdditionalCampaignProperties.new(budgets: null,
                                  created_by: John Doe,
                                  updated_by: Jane Doe,
                                  template_id: 3,
-                                 frontend_state: running)
+                                 frontend_state: running,
+                                 stores_imported: true)
 ```
 
 
diff --git a/docs/AnalyticsDataPoint.md b/docs/AnalyticsDataPoint.md
@@ -0,0 +1,19 @@
+# TalonOne::AnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** |  | 
+**influenced** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPoint.new(total: 12.0,
+                                 influenced: 12.0)
+```
+
+
diff --git a/docs/AnalyticsDataPointWithTrend.md b/docs/AnalyticsDataPointWithTrend.md
@@ -0,0 +1,19 @@
+# TalonOne::AnalyticsDataPointWithTrend
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrend.new(value: 12.0,
+                                 trend: 3.25)
+```
+
+
diff --git a/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md b/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md
@@ -0,0 +1,21 @@
+# TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**influenced_rate** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate.new(value: 12.0,
+                                 influenced_rate: 12.0,
+                                 trend: 3.25)
+```
+
+
diff --git a/docs/AnalyticsDataPointWithTrendAndUplift.md b/docs/AnalyticsDataPointWithTrendAndUplift.md
@@ -0,0 +1,21 @@
+# TalonOne::AnalyticsDataPointWithTrendAndUplift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | 
+**uplift** | **Float** |  | 
+**trend** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AnalyticsDataPointWithTrendAndUplift.new(value: 12.0,
+                                 uplift: 3.25,
+                                 trend: 3.25)
+```
+
+
diff --git a/docs/Application.md b/docs/Application.md
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] 
 **default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply &#x60;setDiscountPerItem&#x60; effects on if no scope was provided with the effect.  | [optional] 
 **default_evaluation_group_id** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional] 
+**default_cart_item_filter_id** | **Integer** | The ID of the default Cart-Item-Filter for this application. | [optional] 
+**enable_campaign_state_management** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  | [optional] 
 **loyalty_programs** | [**Array&lt;LoyaltyProgram&gt;**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 
 ## Code Sample
@@ -49,6 +51,8 @@ instance = TalonOne::Application.new(id: 6,
                                  enable_partial_discounts: false,
                                  default_discount_additional_cost_per_item_scope: price,
                                  default_evaluation_group_id: 3,
+                                 default_cart_item_filter_id: 3,
+                                 enable_campaign_state_management: false,
                                  loyalty_programs: null)
 ```
 

diff --git a/docs/ApplicationAnalyticsDataPoint.md b/docs/ApplicationAnalyticsDataPoint.md
@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | [optional] 
-**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | [optional] 
-**total_revenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) |  | [optional] 
-**sessions_count** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) |  | [optional] 
-**avg_items_per_session** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) |  | [optional] 
-**avg_session_value** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) |  | [optional] 
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**total_revenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**sessions_count** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avg_items_per_session** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avg_session_value** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
 **total_discounts** | **Float** | The total value of discounts given for cart items in influenced sessions. | [optional] 
 **coupons_count** | **Float** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional] 
 

diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md
@@ -0,0 +1,33 @@
+# TalonOne::ApplicationCIF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**name** | **String** | The name of the Application cart item filter used in API requests. | 
+**description** | **String** | A short description of the Application cart item filter. | [optional] 
+**active_expression_id** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCIF.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 name: Filter items by product,
+                                 description: This filter allows filtering by shoes,
+                                 active_expression_id: 1,
+                                 modified_by: 334,
+                                 created_by: 216,
+                                 modified: null,
+                                 application_id: 322)
+```
+
+
diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md
@@ -0,0 +1,27 @@
+# TalonOne::ApplicationCIFExpression
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**expression** | **Array&lt;Object&gt;** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCIFExpression.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 cart_item_filter_id: 216,
+                                 created_by: 216,
+                                 expression: {expr&#x3D;[filter, [., Session, CartItems], [[Item], [catch, false, [&#x3D;, [., Item, Category], Kitchen]]]]},
+                                 application_id: 322)
+```
+
+
diff --git a/docs/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md
@@ -4,21 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | [optional] 
-**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | [optional] 
-**campaign_id** | **Integer** | The ID of the campaign. | [optional] 
-**campaign_name** | **String** | The name of the campaign. | [optional] 
-**campaign_tags** | **Array&lt;String&gt;** | A list of tags for the campaign. | [optional] 
-**campaign_state** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | [optional] [default to &#39;enabled&#39;]
-**campaign_active_ruleset_id** | **Integer** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.  | [optional] 
-**campaign_start_time** | **DateTime** | Date and time when the campaign becomes active. | [optional] 
-**campaign_end_time** | **DateTime** | Date and time when the campaign becomes inactive. | [optional] 
-**total_revenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) |  | [optional] 
-**sessions_count** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) |  | [optional] 
-**avg_items_per_session** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) |  | [optional] 
-**avg_session_value** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) |  | [optional] 
-**total_discounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) |  | [optional] 
-**coupons_count** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) |  | [optional] 
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**campaign_id** | **Integer** | The ID of the campaign. | 
+**campaign_name** | **String** | The name of the campaign. | 
+**campaign_tags** | **Array&lt;String&gt;** | A list of tags for the campaign. | 
+**campaign_state** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | 
+**total_revenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**sessions_count** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**avg_items_per_session** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**avg_session_value** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**total_discounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+**coupons_count** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
 
 ## Code Sample
 
@@ -30,10 +27,7 @@ instance = TalonOne::ApplicationCampaignAnalytics.new(start_time: 2024-02-01T00:
                                  campaign_id: 1,
                                  campaign_name: Summer promotions,
                                  campaign_tags: [summer],
-                                 campaign_state: enabled,
-                                 campaign_active_ruleset_id: 2,
-                                 campaign_start_time: 2021-07-20T22:00Z,
-                                 campaign_end_time: 2021-10-01T02:00Z,
+                                 campaign_state: running,
                                  total_revenue: null,
                                  sessions_count: null,
                                  avg_items_per_session: null,

diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**draft** | **Integer** | Number of draft campaigns. | 
 **disabled** | **Integer** | Number of disabled campaigns. | 
 **scheduled** | **Integer** | Number of scheduled campaigns. | 
 **running** | **Integer** | Number of running campaigns. | 
@@ -16,8 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::ApplicationCampaignStats.new(draft: null,
-                                 disabled: null,
+instance = TalonOne::ApplicationCampaignStats.new(disabled: null,
                                  scheduled: null,
                                  running: null,
                                  expired: null,

diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md
@@ -0,0 +1,17 @@
+# TalonOne::AsyncCouponDeletionJobResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AsyncCouponDeletionJobResponse.new(id: 6)
+```
+
+