talon_one 1.1.2 → 2.1.0

data/docs/ApplicationCustomerSearch.md

@@ -1,10 +1,21 @@
 # TalonOne::ApplicationCustomerSearch
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] 
+**attributes** | [**Object**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] 
 **integration_i_ds** | **Array<String>** |  | [optional] 
 **profile_i_ds** | **Array<Integer>** |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCustomerSearch.new(attributes: null,
+                                 integration_i_ds: null,
+                                 profile_i_ds: null)
+```
+
 

data/docs/ApplicationEntity.md

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

data/docs/ApplicationEvent.md

@@ -1,6 +1,7 @@
 # TalonOne::ApplicationEvent
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -9,7 +10,22 @@ Name | Type | Description | Notes
 **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
 **session_id** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional] 
 **type** | **String** | A string representing the event. Must not be a reserved event name. | 
-**attributes** | **Object** | Additional JSON serialized data associated with the event. | 
+**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. | 
 **effects** | **Array<Object>** | An array containing the effects that were applied as a result of this event. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationEvent.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 profile_id: null,
+                                 session_id: null,
+                                 type: null,
+                                 attributes: null,
+                                 effects: null)
+```
+
 

data/docs/ApplicationSession.md

@@ -1,6 +1,7 @@
 # TalonOne::ApplicationSession
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -8,11 +9,33 @@ Name | Type | Description | Notes
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
 **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
 **integration_id** | **String** | The ID used for this entity in the application system. | 
+**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional] 
 **coupon** | **String** | Any coupon code entered. | 
-**referral** | **String** | Any referal code entered. | 
+**referral** | **String** | Any referral code entered. | 
 **state** | **String** | Indicating if the customer session is in progress (\"open\"), \"closed\", or \"cancelled\". | 
 **cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | 
 **discounts** | **Hash<String, Float>** | A map of labelled discount values, in the same currency as the session. | 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**total** | **Float** | The total sum of the session before any discounts applied. | 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationSession.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 profile_id: null,
+                                 integration_id: null,
+                                 profileintegrationid: null,
+                                 coupon: null,
+                                 referral: null,
+                                 state: null,
+                                 cart_items: null,
+                                 discounts: null,
+                                 total: null,
+                                 attributes: null)
+```
 
 

data/docs/ApplicationSessionEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::ApplicationSessionEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **session_id** | **Integer** | The globally unique Talon.One ID of the session where this entity was created. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationSessionEntity.new(session_id: null)
+```
+
 

data/docs/Attribute.md

@@ -1,6 +1,7 @@
 # TalonOne::Attribute
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -8,13 +9,31 @@ Name | Type | Description | Notes
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. | 
 **event_type** | **String** |  | [optional] 
-**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if `name == \"region\"` then you would set the region attribute by including an `attributes.region` property in your request payload.  | 
+**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if `name == \"region\"` then you would set the region attribute by including an `attributes.region` property in your request payload. | 
 **title** | **String** | The human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | 
 **type** | **String** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. | 
 **description** | **String** | A description of this attribute. | 
 **suggestions** | **Array<String>** | A list of suggestions for the attribute. | 
-**editable** | **BOOLEAN** | Whether or not this attribute can be edited. | 
-**locked** | **BOOLEAN** | Indicates whether this attribute is in use. If in use only title can be changed and other operations are prohibited. | [default to false]
-**used_at** | **Array<String>** | array of rulesets where the attribute is used | 
+**editable** | **Boolean** | Whether or not this attribute can be edited. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this attribute | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Attribute.new(id: null,
+                                 created: null,
+                                 account_id: null,
+                                 entity: null,
+                                 event_type: null,
+                                 name: null,
+                                 title: null,
+                                 type: null,
+                                 description: null,
+                                 suggestions: null,
+                                 editable: null,
+                                 subscribed_applications_ids: null)
+```
 
 

data/docs/AttributesMandatory.md

@@ -0,0 +1,19 @@
+# TalonOne::AttributesMandatory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaigns** | **Array<String>** | List of mandatory attributes for campaigns. | [optional] 
+**coupons** | **Array<String>** | List of mandatory attributes for campaigns. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AttributesMandatory.new(campaigns: null,
+                                 coupons: null)
+```
+
+

data/docs/AttributesSettings.md

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

data/docs/BaseSamlConnection.md

@@ -0,0 +1,31 @@
+# TalonOne::BaseSamlConnection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**name** | **String** | ID of the SAML service. | 
+**enabled** | **Boolean** | Determines if this SAML connection active. | 
+**issuer** | **String** | Identity Provider Entity ID. | 
+**sign_on_url** | **String** | Single Sign-On URL. | 
+**sign_out_url** | **String** | Single Sign-Out URL. | [optional] 
+**metadata_url** | **String** | Metadata URL. | [optional] 
+**audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::BaseSamlConnection.new(account_id: null,
+                                 name: null,
+                                 enabled: null,
+                                 issuer: null,
+                                 sign_on_url: null,
+                                 sign_out_url: null,
+                                 metadata_url: null,
+                                 audience_uri: null)
+```
+
+

data/docs/Binding.md

@@ -1,9 +1,19 @@
 # TalonOne::Binding
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | A descriptive name for the value to be bound. | 
 **expression** | **Array<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Binding.new(name: null,
+                                 expression: null)
+```
+
 

data/docs/Campaign.md

@@ -1,6 +1,7 @@
 # TalonOne::Campaign
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -11,7 +12,7 @@ Name | Type | Description | Notes
 **description** | **String** | A detailed description of the campaign. | 
 **start_time** | **DateTime** | Datetime when the campaign will become active. | [optional] 
 **end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons.  | [default to 'enabled']
 **active_ruleset_id** | **Integer** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] 
 **tags** | **Array<String>** | A list of tags for the campaign. | 
@@ -22,9 +23,43 @@ Name | Type | Description | Notes
 **coupon_redemption_count** | **Integer** | Number of coupons redeemed in the campaign. | [optional] 
 **referral_redemption_count** | **Integer** | Number of referral codes redeemed in the campaign. | [optional] 
 **discount_count** | **Integer** | Total amount of discounts redeemed in the campaign. | [optional] 
+**discount_effect_count** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional] 
+**coupon_creation_count** | **Integer** | Total number of coupons created by rules in this campaign. | [optional] 
 **last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional] 
 **updated** | **DateTime** | Timestamp of the most recent update to the campaign or any of its elements. | [optional] 
 **created_by** | **String** | Name of the user who created this campaign if available. | [optional] 
 **updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Campaign.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 user_id: null,
+                                 name: null,
+                                 description: null,
+                                 start_time: null,
+                                 end_time: null,
+                                 attributes: null,
+                                 state: null,
+                                 active_ruleset_id: null,
+                                 tags: null,
+                                 features: null,
+                                 coupon_settings: null,
+                                 referral_settings: null,
+                                 limits: null,
+                                 coupon_redemption_count: null,
+                                 referral_redemption_count: null,
+                                 discount_count: null,
+                                 discount_effect_count: null,
+                                 coupon_creation_count: null,
+                                 last_activity: null,
+                                 updated: null,
+                                 created_by: null,
+                                 updated_by: null)
+```
+
 

data/docs/CampaignAnalytics.md

@@ -1,17 +1,24 @@
 # 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. | 
@@ -19,4 +26,32 @@ Name | Type | Description | Notes
 **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. | 
 
+## 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)
+```
+
 

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 | 
+**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/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)
+```