talon_one 1.3.0 → 2.2.0

data/docs/CampaignAnalytics.md

@@ -1,22 +1,65 @@
 # TalonOne::CampaignAnalytics
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **date** | **DateTime** |  | 
-**campaign_revenue** | **Float** | Amount of revenue in this campaign. | 
-**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began. | 
+**campaign_revenue** | **Float** | Amount of revenue in this campaign (for coupon or discount sessions). | 
+**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began (for coupon or discount sessions). | 
+**campaign_refund** | **Float** | Amount of refunds in this campaign (for coupon or discount sessions). | 
+**total_campaign_refund** | **Float** | Amount of refunds in this campaign since it began (for coupon or discount sessions). | 
 **campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign. | 
 **total_campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign since it began. | 
+**campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign. | 
+**total_campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign since it began. | 
 **campaign_free_items** | **Integer** | Amount of free items given in the campaign. | 
 **total_campaign_free_items** | **Integer** | Amount of free items given in the campaign since it began. | 
-**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign (only accepted referrals on sessions that were closed are considered). | 
+**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign. | 
 **total_coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. | 
+**coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. | 
+**total_coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. | 
 **referral_redemptions** | **Integer** | Number of referral redemptions in the campaign. | 
 **total_referral_redemptions** | **Integer** | Number of referral redemptions in the campaign since it began. | 
 **coupons_created** | **Integer** | Number of coupons created in the campaign by the rule engine. | 
 **total_coupons_created** | **Integer** | Number of coupons created in the campaign by the rule engine since it began. | 
 **referrals_created** | **Integer** | Number of referrals created in the campaign by the rule engine. | 
 **total_referrals_created** | **Integer** | Number of referrals created in the campaign by the rule engine since it began. | 
+**added_loyalty_points** | **Float** | Number of added loyalty points in the campaign in a specific interval. | 
+**total_added_loyalty_points** | **Float** | Number of added loyalty points in the campaign since it began. | 
+**deducted_loyalty_points** | **Float** | Number of deducted loyalty points in the campaign in a specific interval. | 
+**total_deducted_loyalty_points** | **Float** | Number of deducted loyalty points in the campaign since it began. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignAnalytics.new(date: null,
+                                 campaign_revenue: null,
+                                 total_campaign_revenue: null,
+                                 campaign_refund: null,
+                                 total_campaign_refund: null,
+                                 campaign_discount_costs: null,
+                                 total_campaign_discount_costs: null,
+                                 campaign_refunded_discounts: null,
+                                 total_campaign_refunded_discounts: null,
+                                 campaign_free_items: null,
+                                 total_campaign_free_items: null,
+                                 coupon_redemptions: null,
+                                 total_coupon_redemptions: null,
+                                 coupon_rolledback_redemptions: null,
+                                 total_coupon_rolledback_redemptions: null,
+                                 referral_redemptions: null,
+                                 total_referral_redemptions: null,
+                                 coupons_created: null,
+                                 total_coupons_created: null,
+                                 referrals_created: null,
+                                 total_referrals_created: null,
+                                 added_loyalty_points: null,
+                                 total_added_loyalty_points: null,
+                                 deducted_loyalty_points: null,
+                                 total_deducted_loyalty_points: null)
+```
 
 

data/docs/CampaignCopy.md

@@ -1,9 +1,27 @@
 # TalonOne::CampaignCopy
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional] 
-**application_ids** | **Array<String>** | Application IDs of the applications to which a campaign should be copied to | 
+**application_ids** | **Array<Integer>** | Application IDs of the applications to which a campaign should be copied to | 
+**description** | **String** | A detailed description of the campaign. | [optional] 
+**start_time** | **DateTime** | Datetime when the campaign will become active. | [optional] 
+**end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional] 
+**tags** | **Array<String>** | A list of tags for the campaign. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignCopy.new(name: null,
+                                 application_ids: null,
+                                 description: null,
+                                 start_time: null,
+                                 end_time: null,
+                                 tags: null)
+```
 
 

data/docs/CampaignEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::CampaignEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignEntity.new(campaign_id: null)
+```
+
 

data/docs/CampaignGroup.md

@@ -0,0 +1,31 @@
+# TalonOne::CampaignGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**modified** | **DateTime** | The exact moment this entity was last modified. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**name** | **String** | The name of this campaign group. | 
+**description** | **String** | A longer description of the campaign group. | [optional] 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for | [optional] 
+**campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignGroup.new(id: null,
+                                 created: null,
+                                 modified: null,
+                                 account_id: null,
+                                 name: null,
+                                 description: null,
+                                 subscribed_applications_ids: null,
+                                 campaign_ids: null)
+```
+
+

data/docs/CampaignGroupEntity.md

@@ -0,0 +1,17 @@
+# TalonOne::CampaignGroupEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignGroupEntity.new(campaign_groups: null)
+```
+
+

data/docs/CampaignSearch.md

@@ -1,8 +1,17 @@
 # TalonOne::CampaignSearch
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes | 
+**attributes** | [**Object**](.md) | Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignSearch.new(attributes: null)
+```
 
 

data/docs/CampaignSet.md

@@ -1,11 +1,25 @@
 # TalonOne::CampaignSet
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
+**version** | **Integer** | Version of the campaign set | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignSet.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 version: null,
+                                 set: null)
+```
+
 

data/docs/CampaignSetBranchNode.md

@@ -1,6 +1,7 @@
 # TalonOne::CampaignSetBranchNode
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | Indicates the node type | 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **operator** | **String** | How does the set operates on its elements | 
 **elements** | [**Array<CampaignSetNode>**](CampaignSetNode.md) | Child elements of this set | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignSetBranchNode.new(type: null,
+                                 name: null,
+                                 operator: null,
+                                 elements: null)
+```
+
 

data/docs/CampaignSetLeafNode.md

@@ -1,9 +1,19 @@
 # TalonOne::CampaignSetLeafNode
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | Indicates the node type | 
 **campaign_id** | **Integer** | ID of the campaign | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignSetLeafNode.new(type: null,
+                                 campaign_id: null)
+```
+
 

data/docs/CampaignSetNode.md

@@ -1,8 +1,17 @@
 # TalonOne::CampaignSetNode
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CampaignSetNode.new(type: null)
+```
+
 

data/docs/CartItem.md

@@ -1,6 +1,7 @@
 # TalonOne::CartItem
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | 
@@ -13,7 +14,26 @@ Name | Type | Description | Notes
 **width** | **Float** | Width of item in mm | [optional] 
 **length** | **Float** | Length of item in mm | [optional] 
 **position** | **Float** | Position of the Cart Item in the Cart (calculated internally) | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
 **adjustment** | [**CartItemAdjustment**](CartItemAdjustment.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CartItem.new(name: null,
+                                 sku: null,
+                                 quantity: null,
+                                 price: null,
+                                 category: null,
+                                 weight: null,
+                                 height: null,
+                                 width: null,
+                                 length: null,
+                                 position: null,
+                                 attributes: null,
+                                 adjustment: null)
+```
+
 

data/docs/CartItemAdjustment.md

@@ -1,10 +1,21 @@
 # TalonOne::CartItemAdjustment
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pay_from_loyalty_program** | **Integer** | Loyalty Program to be used for payment | 
 **point_payment** | **Integer** | Amount of points to be spend | 
 **remaining_price** | **Float** | Remaining price in currency after payment in points has been made | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CartItemAdjustment.new(pay_from_loyalty_program: null,
+                                 point_payment: null,
+                                 remaining_price: null)
+```
+
 

data/docs/Change.md

@@ -1,13 +1,27 @@
 # TalonOne::Change
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
 **user_id** | **Integer** | The ID of the account that owns this entity. | 
 **entity** | **String** | API endpoint on which the change was initiated. | 
-**old** | **Object** | Resource before the change occured. | [optional] 
-**new** | **Object** | Resource after the change occured. | [optional] 
+**old** | [**Object**](.md) | Resource before the change occurred. | [optional] 
+**new** | [**Object**](.md) | Resource after the change occurred. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Change.new(id: null,
+                                 created: null,
+                                 user_id: null,
+                                 entity: null,
+                                 old: null,
+                                 new: null)
+```
 
 

data/docs/ChangeProfilePassword.md

@@ -0,0 +1,19 @@
+# TalonOne::ChangeProfilePassword
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **String** | Your old password. | 
+**new_password** | **String** | Your new password. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ChangeProfilePassword.new(password: null,
+                                 new_password: null)
+```
+
+

data/docs/CodeGeneratorSettings.md

@@ -1,9 +1,19 @@
 # TalonOne::CodeGeneratorSettings
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | 
 **coupon_pattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CodeGeneratorSettings.new(valid_characters: null,
+                                 coupon_pattern: null)
+```
+
 

data/docs/Coupon.md

@@ -1,6 +1,7 @@
 # TalonOne::Coupon
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -8,14 +9,41 @@ Name | Type | Description | Notes
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The actual coupon code. | 
 **usage_limit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | 
+**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
 **usage_counter** | **Integer** | The number of times this coupon has been successfully used. | 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] 
+**discount_remainder** | **Float** | The remaining discount this coupon can give. | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
 **referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] 
-**recipient_integration_id** | **String** | The integration ID of a referred customer profile. | [optional] 
+**recipient_integration_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] 
 **import_id** | **Integer** | The ID of the Import which created this coupon. | [optional] 
-**reservation** | **BOOLEAN** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] 
+**reservation** | **Boolean** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] 
 **batch_id** | **String** | The id of the batch the coupon belongs to. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Coupon.new(id: null,
+                                 created: null,
+                                 campaign_id: null,
+                                 value: null,
+                                 usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 usage_counter: null,
+                                 discount_counter: null,
+                                 discount_remainder: null,
+                                 attributes: null,
+                                 referral_id: null,
+                                 recipient_integration_id: null,
+                                 import_id: null,
+                                 reservation: null,
+                                 batch_id: null)
+```
+