talon_one 9.0.0 → 11.0.0

data/docs/CampaignCreatedNotificationItem.md

@@ -0,0 +1,23 @@
+# TalonOne::CampaignCreatedNotificationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**evaluation_position** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignCreatedNotificationItem.new(event: campaign_state_changed,
+                                 campaign: null,
+                                 ruleset: null,
+                                 evaluation_position: null)
+```
+
+

data/docs/CampaignDeactivationRequest.md

@@ -0,0 +1,17 @@
+# TalonOne::CampaignDeactivationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_ids** | **Array<Integer>** | The list of IDs of the users receiving the deactivation request emails. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignDeactivationRequest.new(user_ids: [1, 2, 3])
+```
+
+

data/docs/CampaignDeletedNotification.md

@@ -4,16 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign** | [**Campaign**](Campaign.md) |  | 
-**deleted_at** | **DateTime** | Time when the campaign was deleted. | 
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | [**Array<CampaignDeletedNotificationItem>**](CampaignDeletedNotificationItem.md) | A list of campaign notification data. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignDeletedNotification.new(campaign: null,
-                                 deleted_at: 2022-11-10T23:00Z)
+instance = TalonOne::CampaignDeletedNotification.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
 ```
 
 

data/docs/CampaignDeletedNotificationItem.md

@@ -0,0 +1,21 @@
+# TalonOne::CampaignDeletedNotificationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**deleted_at** | **DateTime** | Time when the campaign was deleted. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignDeletedNotificationItem.new(event: campaign_state_changed,
+                                 campaign: null,
+                                 deleted_at: 2022-11-10T23:00Z)
+```
+
+

data/docs/CampaignEditedNotification.md

@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign** | [**Campaign**](Campaign.md) |  | 
-**old_campaign** | [**Campaign**](Campaign.md) |  | 
-**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | [**Array<CampaignEditedNotificationItem>**](CampaignEditedNotificationItem.md) | A list of campaign notification data. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignEditedNotification.new(campaign: null,
-                                 old_campaign: null,
-                                 ruleset: null)
+instance = TalonOne::CampaignEditedNotification.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
 ```
 
 

data/docs/CampaignEditedNotificationItem.md

@@ -0,0 +1,23 @@
+# TalonOne::CampaignEditedNotificationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**old_campaign** | [**Campaign**](Campaign.md) |  | 
+**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignEditedNotificationItem.new(event: campaign_state_changed,
+                                 campaign: null,
+                                 old_campaign: null,
+                                 ruleset: null)
+```
+
+

data/docs/CampaignEvaluationTreeChangedMessage.md

@@ -0,0 +1,21 @@
+# TalonOne::CampaignEvaluationTreeChangedMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | [**Array<ApplicationNotification>**](ApplicationNotification.md) | The array of changes. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignEvaluationTreeChangedMessage.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
+```
+
+

data/docs/CampaignGroup.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 

data/docs/CampaignNotificationBase.md

@@ -0,0 +1,19 @@
+# TalonOne::CampaignNotificationBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignNotificationBase.new(notification_type: CampaignNotification,
+                                 total_result_size: null)
+```
+
+

data/docs/CampaignNotificationGeneric.md

@@ -0,0 +1,21 @@
+# TalonOne::CampaignNotificationGeneric
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | **Array<Object>** | A list of campaign notification data. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignNotificationGeneric.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
+```
+
+

data/docs/CampaignNotificationItemBase.md

@@ -0,0 +1,17 @@
+# TalonOne::CampaignNotificationItemBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignNotificationItemBase.new(event: campaign_state_changed)
+```
+
+

data/docs/CampaignNotificationPolicy.md

@@ -6,7 +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] 
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 5]
 
 ## Code Sample
 

data/docs/CampaignRulesetChangedNotification.md

@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign** | [**Campaign**](Campaign.md) |  | 
-**old_ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
-**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | [**Array<CampaignRulesetChangedNotificationItem>**](CampaignRulesetChangedNotificationItem.md) | A list of campaign notification data. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignRulesetChangedNotification.new(campaign: null,
-                                 old_ruleset: null,
-                                 ruleset: null)
+instance = TalonOne::CampaignRulesetChangedNotification.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
 ```
 
 

data/docs/CampaignRulesetChangedNotificationItem.md

@@ -0,0 +1,23 @@
+# TalonOne::CampaignRulesetChangedNotificationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**old_ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignRulesetChangedNotificationItem.new(event: campaign_state_changed,
+                                 campaign: null,
+                                 old_ruleset: null,
+                                 ruleset: null)
+```
+
+

data/docs/CampaignSet.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_id** | **Integer** | The ID of the Application that owns this entity. | 
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **version** | **Integer** | Version of the campaign set. | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
 **updated_by** | **String** | Name of the user who last updated this campaign set, if available. | [optional] 

data/docs/CampaignStateChangedNotification.md

@@ -4,20 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign** | [**Campaign**](Campaign.md) |  | 
-**old_state** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
-**new_state** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
-**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+**notification_type** | **String** | The type of the notification | 
+**total_result_size** | **Integer** | The total size of the result set. | 
+**data** | [**Array<CampaignStateChangedNotificationItem>**](CampaignStateChangedNotificationItem.md) | A list of campaign notification data. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CampaignStateChangedNotification.new(campaign: null,
-                                 old_state: disabled,
-                                 new_state: running,
-                                 ruleset: null)
+instance = TalonOne::CampaignStateChangedNotification.new(notification_type: CampaignNotification,
+                                 total_result_size: null,
+                                 data: null)
 ```
 
 

data/docs/CampaignStateChangedNotificationItem.md

@@ -0,0 +1,25 @@
+# TalonOne::CampaignStateChangedNotificationItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**old_state** | **String** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
+**new_state** | **String** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived']  | 
+**ruleset** | [**Ruleset**](Ruleset.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignStateChangedNotificationItem.new(event: campaign_state_changed,
+                                 campaign: null,
+                                 old_state: disabled,
+                                 new_state: running,
+                                 ruleset: null)
+```
+
+

data/docs/CampaignStoreBudget.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **store_id** | **Integer** | The ID of the store. | 

data/docs/CampaignTemplate.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 

data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md

@@ -0,0 +1,19 @@
+# TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. | 
+**scopes** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy.new(name: Christmas Sale,
+                                 scopes: null)
+```
+
+

data/docs/CardAddedDeductedPointsNotification.md

@@ -0,0 +1,45 @@
+# TalonOne::CardAddedDeductedPointsNotification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile_integration_i_ds** | **Array<String>** | The integration ID of the customer profile to whom points were added or deducted. | 
+**loyalty_program_id** | **Integer** | The ID of the loyalty program. | 
+**subledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added or deducted. | 
+**amount** | **Float** | The amount of added or deducted loyalty points. | 
+**reason** | **String** | The reason for the points addition or deduction. | 
+**type_of_change** | **String** | The notification source, that is, it indicates whether the points were added or deducted via one of the following routes:  - [The Campaign Manager](/docs/product/getting-started)  - [Management API](/management-api#tag/Loyalty)  - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters)  | 
+**employee_name** | **String** | The name of the employee who added or deducted points. | 
+**user_id** | **Integer** | The ID of the employee who added or deducted points. | 
+**operation** | **String** | The action (addition or deduction) made with loyalty points. | 
+**start_date** | **DateTime** | The start date for loyalty points. | [optional] 
+**expiry_date** | **DateTime** | The expiration date for loyalty points. | [optional] 
+**session_integration_id** | **String** | The integration ID of the session through which the points were earned or lost. | 
+**notification_type** | **String** | The type of notification. | 
+**card_identifier** | **String** | Loyalty card identification number. | 
+**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to `0` for no limit. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CardAddedDeductedPointsNotification.new(profile_integration_i_ds: [yJSObdNNtOetCHWHPFuz, test-user-4zoj1c],
+                                 loyalty_program_id: 5,
+                                 subledger_id: sub-123,
+                                 amount: 10.99,
+                                 reason: Compensation,
+                                 type_of_change: null,
+                                 employee_name: Franziska Schneider,
+                                 user_id: 25,
+                                 operation: null,
+                                 start_date: 2023-01-24T14:15:22Z,
+                                 expiry_date: 2024-01-24T14:15:22Z,
+                                 session_integration_id: cc53e4fa-547f-4f5e-8333-76e05c381f67,
+                                 notification_type: null,
+                                 card_identifier: 123-456-789ATBC,
+                                 users_per_card_limit: 10)
+```
+
+

data/docs/CardExpiringPointsNotificationPolicy.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | Notification name. | 
 **triggers** | [**Array<CardExpiringPointsNotificationTrigger>**](CardExpiringPointsNotificationTrigger.md) |  | 
 **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] 
+**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
 
 ## Code Sample
 

data/docs/CardLedgerPointsEntryIntegrationAPI.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | ID of the transaction that adds loyalty points. | 
+**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. | 
 **created** | **DateTime** | Date and time the loyalty card points were added. | 
 **program_id** | **Integer** | ID of the loyalty program. | 
 **customer_profile_id** | **String** | Integration ID of the customer profile linked to the card. | [optional] 
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::CardLedgerPointsEntryIntegrationAPI.new(id: 123,
+                                 transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
                                  created: null,
                                  program_id: 324,
                                  customer_profile_id: URNGV8294NV,

data/docs/CardLedgerTransactionLogEntry.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. | 
 **created** | **DateTime** | Date and time the loyalty card transaction occurred. | 
 **program_id** | **Integer** | ID of the loyalty program. | 
 **card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | 
@@ -23,7 +24,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CardLedgerTransactionLogEntry.new(created: null,
+instance = TalonOne::CardLedgerTransactionLogEntry.new(transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
+                                 created: null,
                                  program_id: 324,
                                  card_identifier: summer-loyalty-card-0543,
                                  application_id: 322,

data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**transaction_uuid** | **String** | Unique identifier of the transaction in the UUID format. | 
 **created** | **DateTime** | Date and time the loyalty card transaction occurred. | 
 **program_id** | **Integer** | ID of the loyalty program. | 
 **card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | 
@@ -23,7 +24,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::CardLedgerTransactionLogEntryIntegrationAPI.new(created: null,
+instance = TalonOne::CardLedgerTransactionLogEntryIntegrationAPI.new(transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
+                                 created: null,
                                  program_id: 324,
                                  card_identifier: summer-loyalty-card-0543,
                                  customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,

data/docs/CartItem.md

@@ -19,7 +19,12 @@ Name | Type | Description | Notes
 **position** | **Float** | Position of the Cart Item in the Cart (calculated internally). | [optional] 
 **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property.  **Note:** Any previously defined attributes that you do not include in the array will be removed.  | [optional] 
 **additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).  | [optional] 
-**catalog_item_id** | **Integer** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional] 
+**catalog_item_id** | **Integer** | The catalog item ID. | [optional] 
+**selected_price_type** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional] 
+**adjustment_reference_id** | **String** | The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. | [optional] 
+**adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] 
+**adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] 
+**prices** | [**Hash<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names.  | [optional] 
 
 ## Code Sample
 
@@ -41,7 +46,12 @@ instance = TalonOne::CartItem.new(name: Air Glide,
                                  position: null,
                                  attributes: {"image":"11.jpeg","material":"leather"},
                                  additional_costs: {"shipping":{"price":9}},
-                                 catalog_item_id: null)
+                                 catalog_item_id: null,
+                                 selected_price_type: member,
+                                 adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
+                                 adjustment_effective_from: 2021-09-12T10:12:42Z,
+                                 adjustment_effective_until: 2021-09-12T10:12:42Z,
+                                 prices: {"member":{"price":90,"adjustmentReferenceId":"68851723-e6fa-488f-ace9-112581e6c19b","effectiveFrom":"2025-05-25T00:00:00Z","effectiveUntil":"2025-05-30T00:00:00Z"},"base":{"price":100}})
 ```
 
 

data/docs/Catalog.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/CatalogItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **sku** | **String** | The stock keeping unit of the item. | 
 **price** | **Float** | Price of the item. | [optional] 

data/docs/CatalogsStrikethroughNotificationPolicy.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Notification name. | 
 **ahead_of_days_trigger** | **Integer** | The number of days in advance that strikethrough pricing updates should be sent. | [optional] 
+**batch_size** | **Integer** | The required size of each batch of data. | [optional] [default to 1000]
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::CatalogsStrikethroughNotificationPolicy.new(name: Christmas Sale,
-                                 ahead_of_days_trigger: null)
+                                 ahead_of_days_trigger: null,
+                                 batch_size: 1000)
 ```
 
 

data/docs/Change.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 
 **application_id** | **Integer** | ID of application associated with change. | [optional] 

data/docs/Collection.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/CollectionWithoutPayload.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/Coupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/CouponCreationJob.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **application_id** | **Integer** | The ID of the Application that owns this entity. |