talon_one 1.4.0

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/APIError.md

@@ -0,0 +1,10 @@
+# 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) |  | 
+
+

data/docs/AccessLogEntry.md

@@ -0,0 +1,14 @@
+# TalonOne::AccessLogEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | UUID reference of request | 
+**status** | **Integer** | HTTP status code of response | 
+**method** | **String** | HTTP method of request | 
+**request_uri** | **String** | target URI of request | 
+**time** | **DateTime** | timestamp of request | 
+**request_payload** | **String** | payload of request | 
+**response_payload** | **String** | payload of response | 
+
+

data/docs/Account.md

@@ -0,0 +1,25 @@
+# TalonOne::Account
+
+## 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. | 
+**company_name** | **String** |  | 
+**domain_name** | **String** | Subdomain Name for yourcompany.talon.one | 
+**state** | **String** | State of the account (trial, active, trial_expired) | 
+**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] 
+**application_limit** | **Integer** | The maximum number of Applications covered by your plan. | [optional] 
+**user_limit** | **Integer** | The maximum number of Campaign Manager Users covered by your plan. | [optional] 
+**campaign_limit** | **Integer** | The maximum number of Campaigns covered by your plan. | [optional] 
+**api_limit** | **Integer** | The maximum number of Integration API calls covered by your plan per billing period. | [optional] 
+**application_count** | **Integer** | The current number of Applications in your account. | 
+**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] 
+
+

data/docs/AccountAnalytics.md

@@ -0,0 +1,22 @@
+# 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 | 
+**active_rules** | **Integer** | Total Number of active rules in the account | 
+
+

data/docs/AccountEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::AccountEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+
+

data/docs/AccountLimits.md

@@ -0,0 +1,19 @@
+# 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 | 
+**active_rules** | **Integer** | Total allowed active rulesets | [optional] 
+**promotion_types** | **Array<String>** | array of rulesets where webhook is used | 
+
+

data/docs/Application.md

@@ -0,0 +1,21 @@
+# TalonOne::Application
+
+## 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 application. | 
+**description** | **String** | A longer description of the application. | [optional] 
+**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] 
+**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
+**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
+
+

data/docs/ApplicationAPIKey.md

@@ -0,0 +1,14 @@
+# TalonOne::ApplicationAPIKey
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+
+

data/docs/ApplicationApiHealth.md

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

data/docs/ApplicationCustomer.md

@@ -0,0 +1,16 @@
+# 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 | 
+**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 | 
+
+

data/docs/ApplicationCustomerEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::ApplicationCustomerEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
+
+

data/docs/ApplicationCustomerSearch.md

@@ -0,0 +1,10 @@
+# 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] 
+**integration_i_ds** | **Array<String>** |  | [optional] 
+**profile_i_ds** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ApplicationEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::ApplicationEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+
+

data/docs/ApplicationEvent.md

@@ -0,0 +1,15 @@
+# TalonOne::ApplicationEvent
+
+## 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. | 
+**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. | 
+**effects** | **Array<Object>** | An array containing the effects that were applied as a result of this event. | 
+
+

data/docs/ApplicationSession.md

@@ -0,0 +1,19 @@
+# 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. | 
+**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] 
+
+

data/docs/ApplicationSessionEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::ApplicationSessionEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**session_id** | **Integer** | The globally unique Talon.One ID of the session where this entity was created. | 
+
+

data/docs/Attribute.md

@@ -0,0 +1,18 @@
+# TalonOne::Attribute
+
+## 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. | 
+**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.  | 
+**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. | 
+
+

data/docs/AttributeQuery.md

@@ -0,0 +1,7 @@
+# TalonOne::AttributeQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/AttributesMandatory.md

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

data/docs/AttributesSettings.md

@@ -0,0 +1,8 @@
+# TalonOne::AttributesSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mandatory** | [**AttributesMandatory**](AttributesMandatory.md) |  | [optional] 
+
+

data/docs/BaseSamlConnection.md

@@ -0,0 +1,15 @@
+# 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] 
+
+

data/docs/Binding.md

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

data/docs/Campaign.md

@@ -0,0 +1,32 @@
+# TalonOne::Campaign
+
+## 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. | 
+**user_id** | **Integer** | The ID of the account that owns this entity. | 
+**name** | **String** | A friendly name for this campaign. | 
+**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] 
+**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. | 
+**features** | **Array<String>** | A list of features for the campaign. | 
+**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 | 
+**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] 
+
+

data/docs/CampaignAnalytics.md

@@ -0,0 +1,28 @@
+# TalonOne::CampaignAnalytics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **DateTime** |  | 
+**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. | 
+**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. | 
+
+

data/docs/CampaignCopy.md

@@ -0,0 +1,13 @@
+# 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] 
+
+

data/docs/CampaignEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::CampaignEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
+
+

data/docs/CampaignSearch.md

@@ -0,0 +1,8 @@
+# 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 | 
+
+

data/docs/CampaignSet.md

@@ -0,0 +1,11 @@
+# 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. | 
+**set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
+
+