talon_one 7.0.0 → 9.0.0

data/docs/ManagementKey.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **created_by** | **Integer** | ID of the user who created it. | 
 **account_id** | **Integer** | ID of account the key is used for. | 
 **created** | **DateTime** | The date the management key was created. | 
+**disabled** | **Boolean** | The management key is disabled (this property is set to `true`) when the user who created the key is disabled or deleted. | [optional] 
 
 ## Code Sample
 
@@ -25,7 +26,8 @@ instance = TalonOne::ManagementKey.new(name: My generated key,
                                  id: 34,
                                  created_by: 280,
                                  account_id: 13,
-                                 created: 2022-03-02T16:46:17.758585Z)
+                                 created: 2022-03-02T16:46:17.758585Z,
+                                 disabled: true)
 ```
 
 

data/docs/MessageTest.md

@@ -0,0 +1,27 @@
+# TalonOne::MessageTest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**http_response** | **String** | The returned http response. | 
+**http_status** | **Integer** | The returned http status code. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MessageTest.new(http_response: HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 256
+
+{
+  "message": "Hello, world!",
+  "status": "success"
+}
+,
+                                 http_status: 200)
+```
+
+

data/docs/ModelReturn.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **returned_cart_items** | [**Array<ReturnedCartItem>**](ReturnedCartItem.md) | List of cart items to be returned. | 
 **event_id** | **Integer** | The event ID of that was generated for this return. | 

data/docs/NewAudience.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The human-friendly display name for this audience. | 
 **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] 
 **description** | **String** | A description of the audience. | [optional] 
-**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, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`.  **Note:** If you do not integrate with any of these platforms, do not use this property.  | [optional] 
+**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, `mParticle`, `Segment`, `Shopify`, `Braze`, or `Iterable`.  **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't come from a 3rd party platform, do not use this property.  | [optional] 
 **created_in3rd_party** | **Boolean** | Determines if this audience is a 3rd party audience or not. | [optional] 
 **last_update** | **DateTime** | The last time that the audience memberships changed. | [optional] 

data/docs/NewCampaignSet.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **version** | **Integer** | Version of the campaign set. | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
 

data/docs/NewLoyaltyProgram.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
 **tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
 **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
-**return_policy** | **String** | 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.  | [optional] 
+**return_policy** | **String** | 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.  | [optional] 
 **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | 
 **tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 

data/docs/NewManagementKey.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **created_by** | **Integer** | ID of the user who created it. | 
 **account_id** | **Integer** | ID of account the key is used for. | 
 **created** | **DateTime** | The date the management key was created. | 
+**disabled** | **Boolean** | The management key is disabled (this property is set to `true`) when the user who created the key is disabled or deleted. | [optional] 
 **key** | **String** | The management key. | 
 
 ## Code Sample
@@ -27,6 +28,7 @@ instance = TalonOne::NewManagementKey.new(name: My generated key,
                                  created_by: 280,
                                  account_id: 13,
                                  created: 2022-03-02T16:46:17.758585Z,
+                                 disabled: true,
                                  key: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01)
 ```
 

data/docs/NewMessageTest.md

@@ -0,0 +1,29 @@
+# TalonOne::NewMessageTest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The message type. | 
+**_query_params** | **Hash<String, String>** | Array of query parameters. | [optional] 
+**headers** | **Hash<String, String>** | List of API HTTP headers for the given message. | [optional] 
+**verb** | **String** | API method for this message. | 
+**url** | **String** | API URL for the given message. | 
+**payload** | **String** | API payload of this message. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewMessageTest.new(type: loyalty_added_deducted_points,
+                                 _query_params: {"param1":"value1","param2":"value2"},
+                                 headers: {"content-type":"application/json"},
+                                 verb: POST,
+                                 url: www.my-company.com/my-endpoint-name,
+                                 payload: {
+	"integrationId": "${$Profile.IntegrationId}"
+})
+```
+
+

data/docs/PendingPointsNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Notification name. | 
 **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::PendingPointsNotificationPolicy.new(name: Christmas Sale,
-                                 batching_enabled: false)
+                                 batching_enabled: false,
+                                 batch_size: 1000)
 ```
 
 

data/docs/ProductSearchMatch.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**product_id** | **Integer** | The ID of the product. | 
+**product_id** | **Integer** | The ID of the product. | [optional] 
 **value** | **String** | The string matching the given value. Either a product name or SKU. | 
-**product_sku_id** | **Integer** | The ID of the SKU linked to a product. If empty, this is an analytics-level product. | [optional] 
+**product_sku_id** | **Integer** | The ID of the SKU linked to a product. If empty, this is an product. | [optional] 
 
 ## Code Sample
 

data/docs/ProductUnitAnalytics.md

@@ -4,22 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
-**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
-**purchased_units** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | 
-**product_id** | **Integer** | The ID of the analytics-level product. | 
-**product_name** | **String** | The name of the analytics-level product. | 
+**data** | [**Array<ProductUnitAnalyticsDataPoint>**](ProductUnitAnalyticsDataPoint.md) |  | 
+**totals** | [**ProductUnitAnalyticsTotals**](ProductUnitAnalyticsTotals.md) |  | 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::ProductUnitAnalytics.new(start_time: 2024-02-01T00:00Z,
-                                 end_time: null,
-                                 purchased_units: null,
-                                 product_id: 1,
-                                 product_name: MyProduct)
+instance = TalonOne::ProductUnitAnalytics.new(data: null,
+                                 totals: null)
 ```
 
 

data/docs/ProductUnitAnalyticsDataPoint.md

@@ -0,0 +1,25 @@
+# TalonOne::ProductUnitAnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | 
+**product_id** | **Integer** | The ID of the product. | 
+**product_name** | **String** | The name of the product. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ProductUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
+                                 end_time: null,
+                                 units_sold: null,
+                                 product_id: 1,
+                                 product_name: MyProduct)
+```
+
+

data/docs/ProductUnitAnalyticsTotals.md

@@ -0,0 +1,17 @@
+# TalonOne::ProductUnitAnalyticsTotals
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ProductUnitAnalyticsTotals.new(units_sold: null)
+```
+
+

data/docs/SkuUnitAnalytics.md

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

data/docs/SkuUnitAnalyticsDataPoint.md

@@ -0,0 +1,23 @@
+# TalonOne::SkuUnitAnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **DateTime** | The start of the aggregation time frame in UTC. | 
+**end_time** | **DateTime** | The end of the aggregation time frame in UTC. | 
+**units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | 
+**sku** | **String** | The SKU linked to the application. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SkuUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
+                                 end_time: null,
+                                 units_sold: null,
+                                 sku: SKU-123)
+```
+
+

data/docs/Store.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **description** | **String** | The description of the store. | 
 **attributes** | [**Object**](.md) | The attributes of the store. | [optional] 
 **integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store.  **Note**: You cannot edit the `integrationId` after the store has been created.  | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **updated** | **DateTime** | Timestamp of the most recent update on this entity. | 
 **linked_campaign_ids** | **Array<Integer>** | A list of IDs of the campaigns that are linked with current store. | [optional] 
 

data/docs/StrikethroughEffect.md

@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **rule_name** | **String** | The name of the rule that triggered this effect. | 
 **type** | **String** | The type of this effect. | 
 **props** | [**Object**](.md) |  | 
+**start_time** | **DateTime** | The start of the time frame where the effect is active in UTC. | [optional] 
+**end_time** | **DateTime** | The end of the time frame where the effect is active in UTC. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +23,9 @@ instance = TalonOne::StrikethroughEffect.new(campaign_id: 3,
                                  rule_index: 2,
                                  rule_name: Add 2 points,
                                  type: setDiscountPerItem,
-                                 props: null)
+                                 props: null,
+                                 start_time: 2021-07-20T22:00Z,
+                                 end_time: 2021-10-01T02:00Z)
 ```
 
 

data/docs/StrikethroughLabelingNotification.md

@@ -4,7 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_id** | **Integer** | The ID of the application that catalog items labels belongs to. | 
+**version** | **String** | The version of the strikethrough pricing notification. | [optional] 
+**valid_from** | **DateTime** | Timestamp at which the strikethrough pricing update becomes valid. Set for **scheduled** strikethrough pricing updates (version: v2) only.  | [optional] 
+**application_id** | **Integer** | The ID of the Application to which the catalog items labels belongs. | 
 **current_batch** | **Integer** | The batch number of the notification. Notifications might be sent in different batches. | 
 **total_batches** | **Integer** | The total number of batches for the notification. | 
 **trigger** | [**StrikethroughTrigger**](StrikethroughTrigger.md) |  | 
@@ -15,7 +17,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::StrikethroughLabelingNotification.new(application_id: 322,
+instance = TalonOne::StrikethroughLabelingNotification.new(version: null,
+                                 valid_from: 2021-07-20T22:00Z,
+                                 application_id: 322,
                                  current_batch: 1,
                                  total_batches: 10,
                                  trigger: null,

data/docs/SummaryCampaignStoreBudget.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **action** | **String** |  | 
 **period** | **String** |  | [optional] 
 **store_count** | **Integer** |  | 
+**imported** | **Boolean** |  | 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TalonOne'
 
 instance = TalonOne::SummaryCampaignStoreBudget.new(action: null,
                                  period: null,
-                                 store_count: null)
+                                 store_count: null,
+                                 imported: null)
 ```
 
 

data/docs/TemplateDef.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
-**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **title** | **String** | Campaigner-friendly name for the template that will be shown in the rule editor. | 
 **description** | **String** | A short description of the template that will be shown in the rule editor. | 
 **help** | **String** | Extended help text for the template. | 

data/docs/TierDowngradeNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the notification. | 
 **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::TierDowngradeNotificationPolicy.new(name: Christmas Sale,
-                                 batching_enabled: false)
+                                 batching_enabled: false,
+                                 batch_size: 1000)
 ```
 
 

data/docs/TierUpgradeNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Notification name. | 
 **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::TierUpgradeNotificationPolicy.new(name: Christmas Sale,
-                                 batching_enabled: false)
+                                 batching_enabled: false,
+                                 batch_size: 1000)
 ```
 
 

data/docs/TierWillDowngradeNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the notification. | 
 **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] 
 **triggers** | [**Array<TierWillDowngradeNotificationTrigger>**](TierWillDowngradeNotificationTrigger.md) |  | 
 
 ## Code Sample
@@ -15,6 +16,7 @@ require 'TalonOne'
 
 instance = TalonOne::TierWillDowngradeNotificationPolicy.new(name: Notification to Google,
                                  batching_enabled: false,
+                                 batch_size: 1000,
                                  triggers: null)
 ```
 

data/docs/UpdateAchievement.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The internal name of the achievement used in API requests.  | [optional] 
+**name** | **String** | 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.  | [optional] 
 **title** | **String** | The display name for the achievement in the Campaign Manager. | [optional] 
 **description** | **String** | A description of the achievement. | [optional] 
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 
-**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile.  | [optional] 
+**period** | **String** | 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.  | [optional] 
 **period_end_override** | [**TimePoint**](TimePoint.md) |  | [optional] 
 **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again.  | [optional] 
 **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.  | [optional] 

data/docs/UpdateLoyaltyProgram.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
 **tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
 **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
-**return_policy** | **String** | 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.  | [optional] 
+**return_policy** | **String** | 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.  | [optional] 
 **tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] 
 
 ## Code Sample