talon_one 8.0.0 → 9.0.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 (59) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -8
  3. data/docs/AchievementBase.md +35 -0
  4. data/docs/AchievementProgressWithDefinition.md +45 -0
  5. data/docs/AchievementStatusEntry.md +45 -0
  6. data/docs/AnalyticsSKU.md +23 -0
  7. data/docs/ApplicationCIFReferences.md +19 -0
  8. data/docs/CampaignDetail.md +19 -0
  9. data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
  10. data/docs/CampaignTemplate.md +3 -1
  11. data/docs/HiddenConditionsEffects.md +23 -0
  12. data/docs/InlineResponse20048.md +19 -0
  13. data/docs/InlineResponse20049.md +19 -0
  14. data/docs/IntegrationApi.md +3 -1
  15. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
  16. data/docs/LoyaltyLedgerEntryFlags.md +17 -0
  17. data/docs/LoyaltyProgramTransaction.md +3 -1
  18. data/docs/ManagementApi.md +164 -323
  19. data/docs/MessageTest.md +27 -0
  20. data/docs/NewMessageTest.md +29 -0
  21. data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
  22. data/docs/ProductUnitAnalyticsTotals.md +17 -0
  23. data/docs/SkuUnitAnalytics.md +19 -0
  24. data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
  25. data/docs/StrikethroughLabelingNotification.md +2 -0
  26. data/lib/talon_one/api/integration_api.rb +3 -0
  27. data/lib/talon_one/api/management_api.rb +191 -354
  28. data/lib/talon_one/models/achievement_base.rb +377 -0
  29. data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
  30. data/lib/talon_one/models/achievement_status_entry.rb +472 -0
  31. data/lib/talon_one/models/analytics_sku.rb +246 -0
  32. data/lib/talon_one/models/application_cif_references.rb +219 -0
  33. data/lib/talon_one/models/campaign_detail.rb +232 -0
  34. data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
  35. data/lib/talon_one/models/campaign_template.rb +16 -4
  36. data/lib/talon_one/models/delete_user_request.rb +0 -1
  37. data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
  38. data/lib/talon_one/models/inline_response20048.rb +222 -0
  39. data/lib/talon_one/models/inline_response20049.rb +227 -0
  40. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
  41. data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
  42. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
  43. data/lib/talon_one/models/message_test.rb +227 -0
  44. data/lib/talon_one/models/new_message_test.rb +322 -0
  45. data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
  46. data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
  47. data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
  48. data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
  49. data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
  50. data/lib/talon_one/version.rb +1 -1
  51. data/lib/talon_one.rb +2 -1
  52. data/spec/api/integration_api_spec.rb +1 -0
  53. data/spec/api/management_api_spec.rb +60 -87
  54. data/spec/models/campaign_template_spec.rb +6 -0
  55. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
  56. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  57. data/spec/models/revision_activation_request_spec.rb +47 -0
  58. data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
  59. metadata +563 -527
@@ -0,0 +1,27 @@
1
+ # TalonOne::MessageTest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **http_response** | **String** | The returned http response. |
8
+ **http_status** | **Integer** | The returned http status code. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::MessageTest.new(http_response: HTTP/1.1 200 OK
16
+ Content-Type: application/json
17
+ Content-Length: 256
18
+
19
+ {
20
+ "message": "Hello, world!",
21
+ "status": "success"
22
+ }
23
+ ,
24
+ http_status: 200)
25
+ ```
26
+
27
+
@@ -0,0 +1,29 @@
1
+ # TalonOne::NewMessageTest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The message type. |
8
+ **_query_params** | **Hash<String, String>** | Array of query parameters. | [optional]
9
+ **headers** | **Hash<String, String>** | List of API HTTP headers for the given message. | [optional]
10
+ **verb** | **String** | API method for this message. |
11
+ **url** | **String** | API URL for the given message. |
12
+ **payload** | **String** | API payload of this message. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::NewMessageTest.new(type: loyalty_added_deducted_points,
20
+ _query_params: {"param1":"value1","param2":"value2"},
21
+ headers: {"content-type":"application/json"},
22
+ verb: POST,
23
+ url: www.my-company.com/my-endpoint-name,
24
+ payload: {
25
+ "integrationId": "${$Profile.IntegrationId}"
26
+ })
27
+ ```
28
+
29
+
@@ -0,0 +1,25 @@
1
+ # TalonOne::ProductUnitAnalyticsDataPoint
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
8
+ **end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
9
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | |
10
+ **product_id** | **Integer** | The ID of the product. |
11
+ **product_name** | **String** | The name of the product. |
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'TalonOne'
17
+
18
+ instance = TalonOne::ProductUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
19
+ end_time: null,
20
+ units_sold: null,
21
+ product_id: 1,
22
+ product_name: MyProduct)
23
+ ```
24
+
25
+
@@ -0,0 +1,17 @@
1
+ # TalonOne::ProductUnitAnalyticsTotals
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TalonOne'
13
+
14
+ instance = TalonOne::ProductUnitAnalyticsTotals.new(units_sold: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::SkuUnitAnalytics
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**Array<SkuUnitAnalyticsDataPoint>**](SkuUnitAnalyticsDataPoint.md) | |
8
+ **totals** | [**ProductUnitAnalyticsTotals**](ProductUnitAnalyticsTotals.md) | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::SkuUnitAnalytics.new(data: null,
16
+ totals: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,23 @@
1
+ # TalonOne::SkuUnitAnalyticsDataPoint
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
8
+ **end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
9
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | |
10
+ **sku** | **String** | The SKU linked to the application. |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::SkuUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
18
+ end_time: null,
19
+ units_sold: null,
20
+ sku: SKU-123)
21
+ ```
22
+
23
+
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **version** | **String** | The version of the strikethrough pricing notification. | [optional]
8
+ **valid_from** | **DateTime** | Timestamp at which the strikethrough pricing update becomes valid. Set for **scheduled** strikethrough pricing updates (version: v2) only. | [optional]
8
9
  **application_id** | **Integer** | The ID of the Application to which the catalog items labels belongs. |
9
10
  **current_batch** | **Integer** | The batch number of the notification. Notifications might be sent in different batches. |
10
11
  **total_batches** | **Integer** | The total number of batches for the notification. |
@@ -17,6 +18,7 @@ Name | Type | Description | Notes
17
18
  require 'TalonOne'
18
19
 
19
20
  instance = TalonOne::StrikethroughLabelingNotification.new(version: null,
21
+ valid_from: 2021-07-20T22:00Z,
20
22
  application_id: 322,
21
23
  current_batch: 1,
22
24
  total_batches: 10,
@@ -1842,6 +1842,7 @@ module TalonOne
1842
1842
  # @param [Hash] opts the optional parameters
1843
1843
  # @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. (default to 'yes')
1844
1844
  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
1845
+ # @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 `dry=true`. (default to false)
1845
1846
  # @return [TrackEventV2Response]
1846
1847
  def track_event_v2(body, opts = {})
1847
1848
  data, _status_code, _headers = track_event_v2_with_http_info(body, opts)
@@ -1854,6 +1855,7 @@ module TalonOne
1854
1855
  # @param [Hash] opts the optional parameters
1855
1856
  # @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.
1856
1857
  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
1858
+ # @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 `dry=true`.
1857
1859
  # @return [Array<(TrackEventV2Response, Integer, Hash)>] TrackEventV2Response data, response status code and response headers
1858
1860
  def track_event_v2_with_http_info(body, opts = {})
1859
1861
  if @api_client.config.debugging
@@ -1870,6 +1872,7 @@ module TalonOne
1870
1872
  query_params = opts[:query_params] || {}
1871
1873
  query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?
1872
1874
  query_params[:'dry'] = opts[:'dry'] if !opts[:'dry'].nil?
1875
+ query_params[:'forceCompleteEvaluation'] = opts[:'force_complete_evaluation'] if !opts[:'force_complete_evaluation'].nil?
1873
1876
 
1874
1877
  # header parameters
1875
1878
  header_params = opts[:header_params] || {}