talon_one 1.3.0 → 2.2.0

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 begin
   require 'rspec/core/rake_task'
 

data/docs/APIError.md

@@ -1,10 +1,21 @@
 # TalonOne::APIError
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **String** | Short description of the problem. | 
 **details** | **String** | Longer description of this specific instance of the problem. | [optional] 
 **source** | [**ErrorSource**](ErrorSource.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::APIError.new(title: null,
+                                 details: null,
+                                 source: null)
+```
+
 

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,21 +1,51 @@
 # TalonOne::AccountAnalytics
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**applications** | **Integer** | Total Number of Applications inside the account | 
-**active_campaigns** | **Integer** | Total Number of Active Applications inside the account | 
-**campaigns** | **Integer** | Total Number of campaigns inside the account | 
-**coupons** | **Integer** | Total Number of coupons inside the account | 
-**active_coupons** | **Integer** | Total Number of active coupons inside the account | 
-**expired_coupons** | **Integer** | Total Number of expired coupons inside the account | 
-**custom_attributes** | **Integer** | Total Number of custom attributes inside the account | 
-**referral_codes** | **Integer** | Total Number of referral codes inside the account | 
-**active_referral_codes** | **Integer** | Total Number of active referral codes inside the account | 
-**expired_referral_codes** | **Integer** | Total Number of expired referral codes inside the account | 
-**users** | **Integer** | Total Number of users inside the account | 
-**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 | 
+**applications** | **Integer** | Total number of applications in the account | 
+**live_applications** | **Integer** | Total number of live applications in the account | 
+**sandbox_applications** | **Integer** | Total number of sandbox applications in the account | 
+**campaigns** | **Integer** | Total number of campaigns in the account | 
+**active_campaigns** | **Integer** | Total number of active campaigns in the account | 
+**live_active_campaigns** | **Integer** | Total number of active campaigns in live applications in the account | 
+**coupons** | **Integer** | Total number of coupons in the account | 
+**active_coupons** | **Integer** | Total number of active coupons in the account | 
+**expired_coupons** | **Integer** | Total number of expired coupons in the account | 
+**referral_codes** | **Integer** | Total number of referral codes in the account | 
+**active_referral_codes** | **Integer** | Total number of active referral codes in the account | 
+**expired_referral_codes** | **Integer** | Total number of expired referral codes in the account | 
+**active_rules** | **Integer** | Total number of active rules in the account | 
+**users** | **Integer** | Total number of users in the account | 
+**roles** | **Integer** | Total number of roles in the account | 
+**custom_attributes** | **Integer** | Total number of custom attributes in the account | 
+**webhooks** | **Integer** | Total number of webhooks in the account | 
+**loyalty_programs** | **Integer** | Total number of loyalty programs in the account | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccountAnalytics.new(applications: null,
+                                 live_applications: null,
+                                 sandbox_applications: null,
+                                 campaigns: null,
+                                 active_campaigns: null,
+                                 live_active_campaigns: null,
+                                 coupons: null,
+                                 active_coupons: null,
+                                 expired_coupons: null,
+                                 referral_codes: null,
+                                 active_referral_codes: null,
+                                 expired_referral_codes: null,
+                                 active_rules: null,
+                                 users: null,
+                                 roles: null,
+                                 custom_attributes: null,
+                                 webhooks: null,
+                                 loyalty_programs: 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,18 +1,39 @@
 # TalonOne::AccountLimits
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**live_applications** | **Integer** | Total Number of allowed live applications in the account | 
-**sandbox_applications** | **Integer** | Total Number of allowed sandbox applications in the account | 
-**active_campaigns** | **Integer** | Total Number of allowed active campaigns in the account | 
-**coupons** | **Integer** | Total Number of allowed coupons in the account | 
-**referral_codes** | **Integer** | Total Number of allowed referral codes in the account | 
-**live_loyalty_programs** | **Integer** | Total Number of allowed live loyalty programs in the account | 
-**sandbox_loyalty_programs** | **Integer** | Total Number of allowed sandbox loyalty programs in the account | 
-**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 | 
-**promotion_types** | **Array<String>** | array of rulesets where webhook is used | 
+**live_applications** | **Integer** | Total number of allowed live applications in the account | 
+**sandbox_applications** | **Integer** | Total number of allowed sandbox applications in the account | 
+**active_campaigns** | **Integer** | Total number of allowed active campaigns in live applications in the account | 
+**coupons** | **Integer** | Total number of allowed coupons in the account | 
+**referral_codes** | **Integer** | Total number of allowed referral codes in the account | 
+**active_rules** | **Integer** | Total number of allowed active rulesets in the account | 
+**live_loyalty_programs** | **Integer** | Total number of allowed live loyalty programs in the account | 
+**sandbox_loyalty_programs** | **Integer** | Total number of allowed sandbox loyalty programs in the account | 
+**webhooks** | **Integer** | Total number of allowed webhooks in the account | 
+**users** | **Integer** | Total number of allowed users in the account | 
+**api_volume** | **Integer** | Allowed volume of API requests to the account | 
+**promotion_types** | **Array<String>** | Array of promotion types that are employed in the account | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AccountLimits.new(live_applications: null,
+                                 sandbox_applications: null,
+                                 active_campaigns: null,
+                                 coupons: null,
+                                 referral_codes: null,
+                                 active_rules: null,
+                                 live_loyalty_programs: null,
+                                 sandbox_loyalty_programs: null,
+                                 webhooks: null,
+                                 users: null,
+                                 api_volume: 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,29 @@
+# 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 | 
+**start_date** | **DateTime** | Date after which points will be valid | [optional] 
+**expiry_date** | **DateTime** | Date after which points will expire | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::AddLoyaltyPointsEffectProps.new(name: null,
+                                 program_id: null,
+                                 sub_ledger_id: null,
+                                 value: null,
+                                 recipient_integration_id: null,
+                                 start_date: null,
+                                 expiry_date: 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. | 
@@ -12,9 +13,39 @@ Name | Type | Description | Notes
 **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] 
-**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
+**campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] 
+**exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] 
+**enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
+**enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
+**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**sandbox** | **Boolean** | Flag indicating if this is a live or sandbox application | [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,
+                                 exclusive_campaigns_strategy: null,
+                                 enable_cascading_discounts: null,
+                                 enable_flattened_cart_items: null,
+                                 attributes_settings: null,
+                                 sandbox: null,
+                                 loyalty_programs: null)
+```
+
 

data/docs/ApplicationAPIKey.md

@@ -1,14 +1,31 @@
 # TalonOne::ApplicationAPIKey
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**title** | **String** | Title for API Key | 
+**expires** | **DateTime** | The date the API key expired | 
+**platform** | **String** | Platform the API key is valid for. | [optional] 
 **id** | **Integer** | ID of the API Key | 
 **created_by** | **Integer** | ID of user who created | 
-**title** | **String** | Title for API Key | 
 **account_id** | **Integer** | ID of account the key is used for | 
 **application_id** | **Integer** | ID of application the key is used for | 
 **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(title: null,
+                                 expires: null,
+                                 platform: null,
+                                 id: null,
+                                 created_by: null,
+                                 account_id: null,
+                                 application_id: null,
+                                 created: null)
+```