talon_one 2.3.0 → 2.4.0

data/docs/NewCustomEffect.md

@@ -0,0 +1,29 @@
+# TalonOne::NewCustomEffect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this effect. | 
+**title** | **String** | The title of this effect. | 
+**payload** | **String** | The JSON payload of this effect. | 
+**description** | **String** | The description of this effect. | [optional] 
+**enabled** | **Boolean** | Determines if this effect is active. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this effect is enabled for | [optional] 
+**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCustomEffect.new(name: null,
+                                 title: null,
+                                 payload: null,
+                                 description: null,
+                                 enabled: null,
+                                 subscribed_applications_ids: null,
+                                 params: null)
+```
+
+

data/docs/NewGiveawaysPool.md

@@ -0,0 +1,21 @@
+# TalonOne::NewGiveawaysPool
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this giveaways pool. | 
+**description** | **String** | The description of this giveaways pool. | [optional] 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewGiveawaysPool.new(name: null,
+                                 description: null,
+                                 subscribed_applications_ids: null)
+```
+
+

data/docs/NewLoyaltyTier.md

@@ -0,0 +1,19 @@
+# TalonOne::NewLoyaltyTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the tier | 
+**min_points** | **Float** | The minimum amount of points required to be eligible for the tier | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewLoyaltyTier.new(name: null,
+                                 min_points: null)
+```
+
+

data/docs/NewReferral.md

@@ -4,22 +4,26 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
-**advocate_profile_integration_id** | **String** | The Integration Id of the Advocate's Profile | 
-**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**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.  | [optional] 
+**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
+**advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 
+**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::NewReferral.new(campaign_id: null,
+instance = TalonOne::NewReferral.new(start_date: null,
+                                 expiry_date: null,
+                                 usage_limit: null,
+                                 campaign_id: null,
                                  advocate_profile_integration_id: null,
                                  friend_profile_integration_id: null,
-                                 start_date: null,
-                                 expiry_date: null)
+                                 attributes: null)
 ```
 
 

data/docs/NewReferralsForMultipleAdvocates.md

@@ -0,0 +1,31 @@
+# TalonOne::NewReferralsForMultipleAdvocates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
+**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**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.  | 
+**campaign_id** | **Integer** | The ID of the campaign from which the referral received the referral code. | 
+**advocate_profile_integration_ids** | **Array<String>** | An array containing all the respective advocate profiles. | 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 
+**valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] 
+**referral_pattern** | **String** | The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewReferralsForMultipleAdvocates.new(start_date: null,
+                                 expiry_date: null,
+                                 usage_limit: null,
+                                 campaign_id: null,
+                                 advocate_profile_integration_ids: null,
+                                 attributes: null,
+                                 valid_characters: null,
+                                 referral_pattern: null)
+```
+
+

data/docs/NewRole.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the role | 
 **description** | **String** | Description of the role | [optional] 
 **acl** | **String** | Role Policy this should be a stringified blob of json | 
-**users** | **Array<Integer>** | An array of userIDs | 
+**users** | **Array<Integer>** | An array of user identifiers | 
 
 ## Code Sample
 

data/docs/Referral.md

@@ -6,14 +6,17 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
-**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
-**advocate_profile_integration_id** | **String** | The Integration Id of the Advocate's Profile | 
-**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**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.  | 
+**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
+**advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 
+**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 
+**import_id** | **Integer** | The ID of the Import which created this referral. | [optional] 
 **code** | **String** | The actual referral code. | 
 **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.  | 
+**batch_id** | **String** | The ID of the batch the referrals belong to. | [optional] 
 
 ## Code Sample
 
@@ -22,14 +25,17 @@ require 'TalonOne'
 
 instance = TalonOne::Referral.new(id: null,
                                  created: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 usage_limit: null,
                                  campaign_id: null,
                                  advocate_profile_integration_id: null,
                                  friend_profile_integration_id: null,
-                                 start_date: null,
-                                 expiry_date: null,
+                                 attributes: null,
+                                 import_id: null,
                                  code: null,
                                  usage_counter: null,
-                                 usage_limit: null)
+                                 batch_id: null)
 ```
 
 

data/docs/ReferralConstraints.md

@@ -0,0 +1,21 @@
+# TalonOne::ReferralConstraints
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
+**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**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.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ReferralConstraints.new(start_date: null,
+                                 expiry_date: null,
+                                 usage_limit: null)
+```
+
+

data/docs/Role.md

@@ -4,13 +4,15 @@
 
 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. | 
+**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. | 
 **campaign_group_id** | **Integer** | The ID of the Campaign Group this role was created for. | [optional] 
-**name** | **String** | Name of the role | [optional] 
+**name** | **String** | Name of the role | 
 **description** | **String** | Description of the role | [optional] 
 **members** | **Array<Integer>** | A list of user identifiers assigned to this role | [optional] 
-**acl** | [**Object**](.md) | Role ACL Policy | [optional] 
+**acl** | [**Object**](.md) | Role ACL Policy | 
 
 ## Code Sample
 
@@ -18,6 +20,8 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::Role.new(id: null,
+                                 created: null,
+                                 modified: null,
                                  account_id: null,
                                  campaign_group_id: null,
                                  name: null,

data/docs/UpdateCustomEffect.md

@@ -0,0 +1,29 @@
+# TalonOne::UpdateCustomEffect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this effect. | 
+**title** | **String** | The title of this effect. | 
+**payload** | **String** | The JSON payload of this effect. | 
+**description** | **String** | The description of this effect. | [optional] 
+**enabled** | **Boolean** | Determines if this effect is active. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this effect is enabled for | [optional] 
+**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateCustomEffect.new(name: null,
+                                 title: null,
+                                 payload: null,
+                                 description: null,
+                                 enabled: null,
+                                 subscribed_applications_ids: null,
+                                 params: null)
+```
+
+

data/docs/UpdateLoyaltyTier.md

@@ -0,0 +1,19 @@
+# TalonOne::UpdateLoyaltyTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the tier | 
+**min_points** | **Float** | The minimum amount of points required to be eligible for the tier | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateLoyaltyTier.new(name: null,
+                                 min_points: null)
+```
+
+

data/docs/UpdateReferral.md

@@ -0,0 +1,25 @@
+# TalonOne::UpdateReferral
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
+**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
+**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**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.  | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateReferral.new(friend_profile_integration_id: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 usage_limit: null,
+                                 attributes: null)
+```
+
+

data/docs/UpdateRole.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the role | [optional] 
 **description** | **String** | Description of the role | [optional] 
 **acl** | **String** | Role Policy this should be a stringified blob of json | [optional] 
-**users** | **Array<Integer>** | an array of user identifiers | [optional] 
+**users** | **Array<Integer>** | An array of user identifiers | [optional] 
 
 ## Code Sample
 

data/docs/WillAwardGiveawayEffectProps.md

@@ -0,0 +1,21 @@
+# TalonOne::WillAwardGiveawayEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pool_id** | **Integer** | The ID of the giveaways pool the code will be taken from. | 
+**pool_name** | **String** | The name of the giveaways pool the code will be taken from. | 
+**recipient_integration_id** | **String** | The integration ID of the profile that will be awarded the giveaway. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WillAwardGiveawayEffectProps.new(pool_id: null,
+                                 pool_name: null,
+                                 recipient_integration_id: null)
+```
+
+

data/lib/talon_one.rb

@@ -32,11 +32,13 @@ require 'talon_one/models/additional_cost'
 require 'talon_one/models/application'
 require 'talon_one/models/application_api_key'
 require 'talon_one/models/application_api_health'
+require 'talon_one/models/application_campaign_stats'
 require 'talon_one/models/application_customer'
 require 'talon_one/models/application_customer_entity'
 require 'talon_one/models/application_customer_search'
 require 'talon_one/models/application_entity'
 require 'talon_one/models/application_event'
+require 'talon_one/models/application_referee'
 require 'talon_one/models/application_session'
 require 'talon_one/models/application_session_entity'
 require 'talon_one/models/attribute'
@@ -44,6 +46,7 @@ require 'talon_one/models/attributes_mandatory'
 require 'talon_one/models/attributes_settings'
 require 'talon_one/models/audience'
 require 'talon_one/models/audience_membership'
+require 'talon_one/models/award_giveaway_effect_props'
 require 'talon_one/models/base_saml_connection'
 require 'talon_one/models/binding'
 require 'talon_one/models/campaign'
@@ -69,6 +72,8 @@ require 'talon_one/models/coupon_reservations'
 require 'talon_one/models/coupon_search'
 require 'talon_one/models/coupon_value'
 require 'talon_one/models/create_application_api_key'
+require 'talon_one/models/custom_effect'
+require 'talon_one/models/custom_effect_props'
 require 'talon_one/models/customer_activity_report'
 require 'talon_one/models/customer_analytics'
 require 'talon_one/models/customer_inventory'
@@ -98,7 +103,10 @@ require 'talon_one/models/features_feed'
 require 'talon_one/models/feed_notification'
 require 'talon_one/models/func_arg_def'
 require 'talon_one/models/function_def'
+require 'talon_one/models/giveaway'
+require 'talon_one/models/giveaways_pool'
 require 'talon_one/models/import'
+require 'talon_one/models/import_entity'
 require 'talon_one/models/inline_response200'
 require 'talon_one/models/inline_response2001'
 require 'talon_one/models/inline_response20010'
@@ -123,19 +131,20 @@ require 'talon_one/models/inline_response20027'
 require 'talon_one/models/inline_response20028'
 require 'talon_one/models/inline_response20029'
 require 'talon_one/models/inline_response2003'
-require 'talon_one/models/inline_response20030'
 require 'talon_one/models/inline_response2004'
 require 'talon_one/models/inline_response2005'
 require 'talon_one/models/inline_response2006'
 require 'talon_one/models/inline_response2007'
 require 'talon_one/models/inline_response2008'
 require 'talon_one/models/inline_response2009'
+require 'talon_one/models/inline_response201'
 require 'talon_one/models/integration_entity'
 require 'talon_one/models/integration_event'
 require 'talon_one/models/integration_profile_entity'
 require 'talon_one/models/integration_request'
 require 'talon_one/models/integration_state'
 require 'talon_one/models/integration_state_v2'
+require 'talon_one/models/inventory_coupon'
 require 'talon_one/models/ledger_entry'
 require 'talon_one/models/library_attribute'
 require 'talon_one/models/limit_config'
@@ -147,9 +156,11 @@ require 'talon_one/models/loyalty_membership'
 require 'talon_one/models/loyalty_points'
 require 'talon_one/models/loyalty_program'
 require 'talon_one/models/loyalty_program_balance'
+require 'talon_one/models/loyalty_program_entity'
 require 'talon_one/models/loyalty_program_ledgers'
 require 'talon_one/models/loyalty_statistics'
 require 'talon_one/models/loyalty_sub_ledger'
+require 'talon_one/models/loyalty_tier'
 require 'talon_one/models/manager_config'
 require 'talon_one/models/meta'
 require 'talon_one/models/multi_application_entity'
@@ -169,18 +180,22 @@ require 'talon_one/models/new_campaign_group'
 require 'talon_one/models/new_campaign_set'
 require 'talon_one/models/new_coupons'
 require 'talon_one/models/new_coupons_for_multiple_recipients'
+require 'talon_one/models/new_custom_effect'
 require 'talon_one/models/new_customer_profile'
 require 'talon_one/models/new_customer_session'
 require 'talon_one/models/new_customer_session_v2'
 require 'talon_one/models/new_event'
 require 'talon_one/models/new_event_type'
 require 'talon_one/models/new_feature_flags'
+require 'talon_one/models/new_giveaways_pool'
 require 'talon_one/models/new_invitation'
 require 'talon_one/models/new_invite_email'
 require 'talon_one/models/new_loyalty_program'
+require 'talon_one/models/new_loyalty_tier'
 require 'talon_one/models/new_password'
 require 'talon_one/models/new_password_email'
 require 'talon_one/models/new_referral'
+require 'talon_one/models/new_referrals_for_multiple_advocates'
 require 'talon_one/models/new_role'
 require 'talon_one/models/new_ruleset'
 require 'talon_one/models/new_saml_connection'
@@ -191,6 +206,7 @@ require 'talon_one/models/notification'
 require 'talon_one/models/profile_audiences_changes'
 require 'talon_one/models/redeem_referral_effect_props'
 require 'talon_one/models/referral'
+require 'talon_one/models/referral_constraints'
 require 'talon_one/models/referral_created_effect_props'
 require 'talon_one/models/referral_rejection_reason'
 require 'talon_one/models/reject_coupon_effect_props'
@@ -226,7 +242,10 @@ require 'talon_one/models/update_campaign'
 require 'talon_one/models/update_campaign_group'
 require 'talon_one/models/update_coupon'
 require 'talon_one/models/update_coupon_batch'
+require 'talon_one/models/update_custom_effect'
 require 'talon_one/models/update_loyalty_program'
+require 'talon_one/models/update_loyalty_tier'
+require 'talon_one/models/update_referral'
 require 'talon_one/models/update_role'
 require 'talon_one/models/update_user'
 require 'talon_one/models/update_user_latest_feed_timestamp'
@@ -236,6 +255,7 @@ require 'talon_one/models/user_feed_notifications'
 require 'talon_one/models/webhook'
 require 'talon_one/models/webhook_activation_log_entry'
 require 'talon_one/models/webhook_log_entry'
+require 'talon_one/models/will_award_giveaway_effect_props'
 
 # APIs
 require 'talon_one/api/integration_api'