talon_one 1.3.0 → 2.2.0

data/docs/NewUser.md

@@ -1,6 +1,7 @@
 # TalonOne::NewUser
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **email** | **String** | The email address associated with your account. | 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **name** | **String** | Your name. | [optional] 
 **invite_token** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewUser.new(email: null,
+                                 password: null,
+                                 name: null,
+                                 invite_token: null)
+```
+
 

data/docs/NewWebhook.md

@@ -1,6 +1,7 @@
 # TalonOne::NewWebhook
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
@@ -10,6 +11,21 @@ Name | Type | Description | Notes
 **headers** | **Array<String>** | List of API HTTP headers for this webhook | 
 **payload** | **String** | API payload (supports templating using parameters) for this webhook | [optional] 
 **params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | 
-**enabled** | **BOOLEAN** | Enables or disables webhook from showing in rule builder | 
+**enabled** | **Boolean** | Enables or disables webhook from showing in rule builder | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewWebhook.new(application_ids: null,
+                                 title: null,
+                                 verb: null,
+                                 url: null,
+                                 headers: null,
+                                 payload: null,
+                                 params: null,
+                                 enabled: null)
+```
 
 

data/docs/Notification.md

@@ -1,10 +1,21 @@
 # TalonOne::Notification
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | id of the notification | 
 **name** | **String** | name of the notification | 
 **description** | **String** | description of the notification | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Notification.new(id: null,
+                                 name: null,
+                                 description: null)
+```
+
 

data/docs/RedeemReferralEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::RedeemReferralEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The id of the referral code that was redeemed | 
+**value** | **String** | The referral code that was redeemed | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RedeemReferralEffectProps.new(id: null,
+                                 value: null)
+```
+
+

data/docs/Referral.md

@@ -1,6 +1,7 @@
 # TalonOne::Referral
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -14,4 +15,21 @@ Name | Type | Description | Notes
 **usage_counter** | **Integer** | The number of times this referral code has been successfully used. | 
 **usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Referral.new(id: null,
+                                 created: null,
+                                 campaign_id: null,
+                                 advocate_profile_integration_id: null,
+                                 friend_profile_integration_id: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 code: null,
+                                 usage_counter: null,
+                                 usage_limit: null)
+```
+
 

data/docs/ReferralCreatedEffectProps.md

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

data/docs/ReferralRejectionReason.md

@@ -1,10 +1,21 @@
 # TalonOne::ReferralRejectionReason
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign_id** | **Integer** |  | 
 **referral_id** | **Integer** |  | 
 **reason** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ReferralRejectionReason.new(campaign_id: null,
+                                 referral_id: null,
+                                 reason: null)
+```
+
 

data/docs/RejectCouponEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::RejectCouponEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The coupon code that was rejected | 
+**rejection_reason** | **String** | The reason why this coupon was rejected | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RejectCouponEffectProps.new(value: null,
+                                 rejection_reason: null)
+```
+
+

data/docs/RejectReferralEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::RejectReferralEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The referral code that was rejected | 
+**rejection_reason** | **String** | The reason why this referral code was rejected | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RejectReferralEffectProps.new(value: null,
+                                 rejection_reason: null)
+```
+
+

data/docs/Role.md

@@ -1,13 +1,29 @@
 # TalonOne::Role
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | The ID of the role corresponding to the DB row | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this role. | 
+**campaign_group_id** | **Integer** | The ID of the Campaign Group this role was created for. | [optional] 
 **name** | **String** | Name of the role | [optional] 
 **description** | **String** | Description of the role | [optional] 
-**members** | **Array<Integer>** | A list of userid in this role | [optional] 
-**acl** | **String** | Role Policy this should be a stringified blob of json | [optional] 
+**members** | **Array<Integer>** | A list of user identifiers assigned to this role | [optional] 
+**acl** | [**Object**](.md) | Role ACL Policy | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Role.new(id: null,
+                                 account_id: null,
+                                 campaign_group_id: null,
+                                 name: null,
+                                 description: null,
+                                 members: null,
+                                 acl: null)
+```
 
 

data/docs/RoleAssign.md

@@ -1,9 +1,19 @@
 # TalonOne::RoleAssign
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **users** | **Array<Integer>** | An array of userIDs | 
 **roles** | **Array<Integer>** | An array of roleIDs | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RoleAssign.new(users: null,
+                                 roles: null)
+```
+
 

data/docs/RoleMembership.md

@@ -1,9 +1,19 @@
 # TalonOne::RoleMembership
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **role_id** | **Integer** | ID of role | 
 **user_id** | **Integer** | ID of User | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RoleMembership.new(role_id: null,
+                                 user_id: null)
+```
+
 

data/docs/RollbackCouponEffectProps.md

@@ -0,0 +1,17 @@
+# TalonOne::RollbackCouponEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The coupon code whose usage has been rolled back | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RollbackCouponEffectProps.new(value: null)
+```
+
+

data/docs/RollbackDiscountEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::RollbackDiscountEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the \"setDiscount\" effect that was rolled back | 
+**value** | **Float** | The value of the discount that was rolled back | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RollbackDiscountEffectProps.new(name: null,
+                                 value: null)
+```
+
+

data/docs/Rule.md

@@ -1,6 +1,7 @@
 # TalonOne::Rule
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **String** | A short description of the rule. | 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **condition** | **Array<Object>** | A Talang expression that will be evaluated in the context of the given event. | 
 **effects** | **Array<Object>** | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Rule.new(title: null,
+                                 description: null,
+                                 bindings: null,
+                                 condition: null,
+                                 effects: null)
+```
+
 

data/docs/Ruleset.md

@@ -1,6 +1,7 @@
 # TalonOne::Ruleset
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -10,7 +11,23 @@ Name | Type | Description | Notes
 **rules** | [**Array<Rule>**](Rule.md) | Set of rules to apply. | 
 **bindings** | [**Array<Binding>**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | 
 **rb_version** | **String** | A string indicating which version of the rulebuilder was used to create this ruleset. | [optional] 
-**activate** | **BOOLEAN** | A boolean indicating whether this newly created ruleset should also be activated for the campaign owns it | [optional] 
+**activate** | **Boolean** | A boolean indicating whether this newly created ruleset should also be activated for the campaign owns it | [optional] 
 **activated_at** | **DateTime** | Timestamp indicating when this Ruleset was activated. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Ruleset.new(id: null,
+                                 created: null,
+                                 campaign_id: null,
+                                 user_id: null,
+                                 rules: null,
+                                 bindings: null,
+                                 rb_version: null,
+                                 activate: null,
+                                 activated_at: null)
+```
+
 

data/docs/SamlConnection.md

@@ -1,19 +1,37 @@
 # TalonOne::SamlConnection
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** |  | 
-**created** | **DateTime** | Unix timestamp indicating when the session was first created. | 
-**account_id** | **Integer** | The ID of the account that owns this SAML Service. | 
 **assertion_consumer_service_url** | **String** | The location where the SAML assertion is sent with a HTTP POST. | 
+**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] 
-**x509certificate** | **String** | X.509 Certificate. | 
-**audience** | **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.  | 
+**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.  | 
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SamlConnection.new(assertion_consumer_service_url: null,
+                                 account_id: null,
+                                 name: null,
+                                 enabled: null,
+                                 issuer: null,
+                                 sign_on_url: null,
+                                 sign_out_url: null,
+                                 metadata_url: null,
+                                 audience_uri: null,
+                                 id: null,
+                                 created: null)
+```
 
 

data/docs/SamlConnectionMetadata.md

@@ -0,0 +1,23 @@
+# TalonOne::SamlConnectionMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | ID of the SAML service. | 
+**enabled** | **Boolean** | Determines if this SAML connection active. | 
+**account_id** | **Float** |  | 
+**metadata_document** | **String** | Identity Provider metadata XML document. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SamlConnectionMetadata.new(name: null,
+                                 enabled: null,
+                                 account_id: null,
+                                 metadata_document: null)
+```
+
+