talon_one 1.2.0 → 2.1.1

data/docs/AcceptCouponEffectProps.md

@@ -0,0 +1,17 @@
+# TalonOne::AcceptCouponEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The coupon code that was accepted | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AcceptCouponEffectProps.new(value: null)
+```
+
+

data/docs/AcceptReferralEffectProps.md

@@ -0,0 +1,17 @@
+# TalonOne::AcceptReferralEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The referral code that was accepted | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AcceptReferralEffectProps.new(value: null)
+```
+
+

data/docs/AccessLogEntry.md

@@ -1,6 +1,7 @@
 # TalonOne::AccessLogEntry
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **uuid** | **String** | UUID reference of request | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **request_payload** | **String** | payload of request | 
 **response_payload** | **String** | payload of response | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccessLogEntry.new(uuid: null,
+                                 status: null,
+                                 method: null,
+                                 request_uri: null,
+                                 time: null,
+                                 request_payload: null,
+                                 response_payload: null)
+```
+
 

data/docs/Account.md

@@ -1,6 +1,7 @@
 # TalonOne::Account
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -8,7 +9,7 @@ Name | Type | Description | Notes
 **modified** | **DateTime** | The exact moment this entity was last modified. | 
 **company_name** | **String** |  | 
 **domain_name** | **String** | Subdomain Name for yourcompany.talon.one | 
-**state** | **String** | State of the account (trial, active, trial_expired) | 
+**state** | **String** | State of the account (active, deactivated) | 
 **billing_email** | **String** | The billing email address associated with your company account. | 
 **plan_name** | **String** | The name of your booked plan. | [optional] 
 **plan_expires** | **DateTime** | The point in time at which your current plan expires. | [optional] 
@@ -20,6 +21,31 @@ Name | Type | Description | Notes
 **user_count** | **Integer** | The current number of Campaign Manager Users in your account. | 
 **campaigns_active_count** | **Integer** | The current number of active Campaigns in your account. | 
 **campaigns_inactive_count** | **Integer** | The current number of inactive Campaigns in your account. | 
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Account.new(id: null,
+                                 created: null,
+                                 modified: null,
+                                 company_name: null,
+                                 domain_name: null,
+                                 state: null,
+                                 billing_email: null,
+                                 plan_name: null,
+                                 plan_expires: null,
+                                 application_limit: null,
+                                 user_limit: null,
+                                 campaign_limit: null,
+                                 api_limit: null,
+                                 application_count: null,
+                                 user_count: null,
+                                 campaigns_active_count: null,
+                                 campaigns_inactive_count: null,
+                                 attributes: null)
+```
 
 

data/docs/AccountAdditionalCost.md

@@ -0,0 +1,29 @@
+# TalonOne::AccountAdditionalCost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**name** | **String** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. | 
+**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | 
+**description** | **String** | A description of this additional cost. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccountAdditionalCost.new(id: null,
+                                 created: null,
+                                 account_id: null,
+                                 name: null,
+                                 title: null,
+                                 description: null,
+                                 subscribed_applications_ids: null)
+```
+
+

data/docs/AccountAnalytics.md

@@ -1,6 +1,7 @@
 # TalonOne::AccountAnalytics
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **applications** | **Integer** | Total Number of Applications inside the account | 
@@ -17,5 +18,28 @@ Name | Type | Description | Notes
 **roles** | **Integer** | Total Number of roles inside the account | 
 **webhooks** | **Integer** | Total Number of webhooks inside the account | 
 **loyalty_programs** | **Integer** | Total Number of loyalty programs inside the account | 
+**active_rules** | **Integer** | Total Number of active rules in the account | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccountAnalytics.new(applications: null,
+                                 active_campaigns: null,
+                                 campaigns: null,
+                                 coupons: null,
+                                 active_coupons: null,
+                                 expired_coupons: null,
+                                 custom_attributes: null,
+                                 referral_codes: null,
+                                 active_referral_codes: null,
+                                 expired_referral_codes: null,
+                                 users: null,
+                                 roles: null,
+                                 webhooks: null,
+                                 loyalty_programs: null,
+                                 active_rules: null)
+```
 
 

data/docs/AccountEntity.md

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

data/docs/AccountLimits.md

@@ -1,6 +1,7 @@
 # TalonOne::AccountLimits
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **live_applications** | **Integer** | Total Number of allowed live applications in the account | 
@@ -13,6 +14,26 @@ Name | Type | Description | Notes
 **webhooks** | **Integer** | Total Number of allowed webhooks in the account | 
 **users** | **Integer** | Total Number of allowed users in the account | 
 **api_volume** | **Integer** | Total allowed api volume | 
+**active_rules** | **Integer** | Total allowed active rulesets | [optional] 
 **promotion_types** | **Array<String>** | array of rulesets where webhook is used | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccountLimits.new(live_applications: null,
+                                 sandbox_applications: null,
+                                 active_campaigns: null,
+                                 coupons: null,
+                                 referral_codes: null,
+                                 live_loyalty_programs: null,
+                                 sandbox_loyalty_programs: null,
+                                 webhooks: null,
+                                 users: null,
+                                 api_volume: null,
+                                 active_rules: null,
+                                 promotion_types: null)
+```
+
 

data/docs/AddFreeItemEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::AddFreeItemEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **String** | SKU of the item that needs to be added | 
+**name** | **String** | The name/description of the effect | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AddFreeItemEffectProps.new(sku: null,
+                                 name: null)
+```
+
+

data/docs/AddLoyaltyPointsEffectProps.md

@@ -0,0 +1,27 @@
+# TalonOne::AddLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name/description of this loyalty point addition | 
+**program_id** | **Integer** | The ID of the loyalty program where these points were added | 
+**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added | 
+**value** | **Float** | The amount of points that were added | 
+**recipient_integration_id** | **String** | The user for whom these points were added | 
+**expiry_condition** | **String** | The amount of time (in days) these points are valid | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AddLoyaltyPointsEffectProps.new(name: null,
+                                 program_id: null,
+                                 sub_ledger_id: null,
+                                 value: null,
+                                 recipient_integration_id: null,
+                                 expiry_condition: null)
+```
+
+

data/docs/AdditionalCost.md

@@ -0,0 +1,17 @@
+# TalonOne::AdditionalCost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AdditionalCost.new(price: null)
+```
+
+

data/docs/Application.md

@@ -1,6 +1,7 @@
 # TalonOne::Application
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -9,12 +10,34 @@ Name | Type | Description | Notes
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **name** | **String** | The name of this application. | 
 **description** | **String** | A longer description of the application. | [optional] 
-**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **currency** | **String** | A string describing a default currency for new customer sessions. | 
 **case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+**campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] 
+**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
 **loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Application.new(id: null,
+                                 created: null,
+                                 modified: null,
+                                 account_id: null,
+                                 name: null,
+                                 description: null,
+                                 timezone: null,
+                                 currency: null,
+                                 case_sensitivity: null,
+                                 attributes: null,
+                                 limits: null,
+                                 campaign_priority: null,
+                                 attributes_settings: null,
+                                 loyalty_programs: null)
+```
+
 

data/docs/ApplicationAPIKey.md

@@ -1,6 +1,7 @@
 # TalonOne::ApplicationAPIKey
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | ID of the API Key | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **created** | **DateTime** | The date the API key was created | 
 **expires** | **DateTime** | The date the API key expired | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ApplicationAPIKey.new(id: null,
+                                 created_by: null,
+                                 title: null,
+                                 account_id: null,
+                                 application_id: null,
+                                 created: null,
+                                 expires: null)
+```
+
 

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,33 @@
 # 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 | 
+**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] 
 **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,
+                                 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)
+```
+