talon_one 1.4.0 → 2.3.0

data/docs/ApplicationApiHealth.md

@@ -1,9 +1,19 @@
 # TalonOne::ApplicationApiHealth
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **summary** | **String** | One-word summary of the health of the API connection of an application | 
 **last_used** | **DateTime** | time of last request relevant to the API health test | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationApiHealth.new(summary: null,
+                                 last_used: null)
+```
+
 

data/docs/ApplicationCustomer.md

@@ -1,16 +1,35 @@
 # TalonOne::ApplicationCustomer
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | 
-**integration_id** | **String** | The ID used for this entity in the application system. The ID used for this entity in the application system. | 
-**attributes** | **Object** | Arbitrary properties associated with this item | 
+**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. | 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | 
 **closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **total_sales** | **Float** | Sum of all purchases made by this customer | 
 **loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] 
+**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] 
 **last_activity** | **DateTime** | Timestamp of the most recent event received from this customer | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCustomer.new(id: null,
+                                 created: null,
+                                 integration_id: null,
+                                 attributes: null,
+                                 account_id: null,
+                                 closed_sessions: null,
+                                 total_sales: null,
+                                 loyalty_memberships: null,
+                                 audience_memberships: null,
+                                 last_activity: null)
+```
+
 

data/docs/ApplicationCustomerEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::ApplicationCustomerEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationCustomerEntity.new(profile_id: null)
+```
+
 

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,24 @@ 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. | 
+**rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional] 
+
+## 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,
+                                 rule_failure_reasons: null)
+```
 
 

data/docs/ApplicationSession.md

@@ -1,19 +1,41 @@
 # TalonOne::ApplicationSession
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. The exact moment this entity was created. | 
 **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. | 
+**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. | 
+**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional] 
 **coupon** | **String** | Any coupon 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. | 
-**total** | **Float** | The total sum of the session before any discounts applied. | [optional] 
-**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,11 +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. | 
+**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

@@ -1,9 +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

@@ -1,8 +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/Audience.md

@@ -0,0 +1,27 @@
+# TalonOne::Audience
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**name** | **String** | The human-friendly display name for this Audience. | 
+**integration** | **String** | Integration that this audience was created in. | 
+**integration_id** | **String** | The ID of this Audience in the third-party integration | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Audience.new(account_id: null,
+                                 id: null,
+                                 created: null,
+                                 name: null,
+                                 integration: null,
+                                 integration_id: null)
+```
+
+

data/docs/AudienceMembership.md

@@ -0,0 +1,19 @@
+# TalonOne::AudienceMembership
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the audience belonging to this entity. | 
+**name** | **String** | The Name of the audience belonging to this entity. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AudienceMembership.new(id: null,
+                                 name: null)
+```
+
+

data/docs/BaseSamlConnection.md

@@ -1,15 +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. | 
+**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,21 @@
 # TalonOne::Binding
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | A descriptive name for the value to be bound. | 
+**type** | **String** | The kind of binding. Possible values are cartItemFilter, subledgerBalance. | [optional] 
 **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,
+                                 type: 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. | 
@@ -19,14 +20,58 @@ Name | Type | Description | Notes
 **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign | 
+**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional] 
 **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_count** | **Float** | 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] 
+**referral_creation_count** | **Integer** | Total number of referrals created by rules in this campaign. | [optional] 
+**created_loyalty_points_count** | **Float** | Total number of loyalty points created by rules in this campaign. | [optional] 
+**created_loyalty_points_effect_count** | **Integer** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] 
+**redeemed_loyalty_points_count** | **Float** | Total number of loyalty points redeemed by rules in this campaign. | [optional] 
+**redeemed_loyalty_points_effect_count** | **Integer** | Total number of loyalty point redemption effects triggered 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,
+                                 campaign_groups: null,
+                                 coupon_redemption_count: null,
+                                 referral_redemption_count: null,
+                                 discount_count: null,
+                                 discount_effect_count: null,
+                                 coupon_creation_count: null,
+                                 referral_creation_count: null,
+                                 created_loyalty_points_count: null,
+                                 created_loyalty_points_effect_count: null,
+                                 redeemed_loyalty_points_count: null,
+                                 redeemed_loyalty_points_effect_count: null,
+                                 last_activity: null,
+                                 updated: null,
+                                 created_by: null,
+                                 updated_by: null)
+```
+