talon_one 2.3.0 → 2.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +31 -5
- data/docs/ApplicationCampaignStats.md +27 -0
- data/docs/ApplicationReferee.md +27 -0
- data/docs/AwardGiveawayEffectProps.md +25 -0
- data/docs/Campaign.md +2 -0
- data/docs/Coupon.md +1 -1
- data/docs/CustomEffect.md +41 -0
- data/docs/CustomEffectProps.md +19 -0
- data/docs/CustomerInventory.md +4 -2
- data/docs/CustomerProfileIntegrationRequestV2.md +1 -1
- data/docs/Environment.md +10 -0
- data/docs/Giveaway.md +33 -0
- data/docs/GiveawaysPool.md +33 -0
- data/docs/ImportEntity.md +17 -0
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +4 -2
- data/docs/InlineResponse20012.md +2 -4
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +2 -2
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +5 -3
- data/docs/InlineResponse20020.md +2 -2
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +4 -2
- data/docs/InlineResponse20028.md +2 -4
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +2 -2
- data/docs/{InlineResponse20030.md → InlineResponse201.md} +3 -3
- data/docs/IntegrationApi.md +77 -11
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +3 -1
- data/docs/InventoryCoupon.md +53 -0
- data/docs/LoyaltyProgram.md +3 -1
- data/docs/LoyaltyProgramEntity.md +17 -0
- data/docs/LoyaltyTier.md +25 -0
- data/docs/ManagementApi.md +370 -69
- data/docs/NewCustomEffect.md +29 -0
- data/docs/NewGiveawaysPool.md +21 -0
- data/docs/NewLoyaltyTier.md +19 -0
- data/docs/NewReferral.md +10 -6
- data/docs/NewReferralsForMultipleAdvocates.md +31 -0
- data/docs/NewRole.md +1 -1
- data/docs/Referral.md +13 -7
- data/docs/ReferralConstraints.md +21 -0
- data/docs/Role.md +8 -4
- data/docs/UpdateCustomEffect.md +29 -0
- data/docs/UpdateLoyaltyTier.md +19 -0
- data/docs/UpdateReferral.md +25 -0
- data/docs/UpdateRole.md +1 -1
- data/docs/WillAwardGiveawayEffectProps.md +21 -0
- data/lib/talon_one.rb +21 -1
- data/lib/talon_one/api/integration_api.rb +80 -10
- data/lib/talon_one/api/management_api.rb +460 -97
- data/lib/talon_one/models/application_campaign_stats.rb +288 -0
- data/lib/talon_one/models/application_referee.rb +288 -0
- data/lib/talon_one/models/attribute.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +273 -0
- data/lib/talon_one/models/campaign.rb +11 -1
- data/lib/talon_one/models/coupon.rb +1 -1
- data/lib/talon_one/models/custom_effect.rb +377 -0
- data/lib/talon_one/models/custom_effect_props.rb +228 -0
- data/lib/talon_one/models/customer_inventory.rb +15 -4
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +1 -1
- data/lib/talon_one/models/environment.rb +61 -1
- data/lib/talon_one/models/export.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +308 -0
- data/lib/talon_one/models/giveaways_pool.rb +315 -0
- data/lib/talon_one/models/import_entity.rb +207 -0
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -7
- data/lib/talon_one/models/inline_response20012.rb +6 -10
- data/lib/talon_one/models/inline_response20013.rb +11 -11
- data/lib/talon_one/models/inline_response20014.rb +10 -10
- data/lib/talon_one/models/inline_response20015.rb +1 -6
- data/lib/talon_one/models/inline_response20016.rb +13 -8
- data/lib/talon_one/models/inline_response20017.rb +10 -10
- data/lib/talon_one/models/inline_response20018.rb +11 -11
- data/lib/talon_one/models/inline_response20019.rb +11 -7
- data/lib/talon_one/models/inline_response20020.rb +6 -1
- data/lib/talon_one/models/inline_response20021.rb +1 -1
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -1
- data/lib/talon_one/models/inline_response20027.rb +11 -7
- data/lib/talon_one/models/inline_response20028.rb +7 -11
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +10 -10
- data/lib/talon_one/models/inline_response2007.rb +11 -11
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +10 -10
- data/lib/talon_one/models/{inline_response20030.rb → inline_response201.rb} +4 -4
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +15 -4
- data/lib/talon_one/models/inventory_coupon.rb +499 -0
- data/lib/talon_one/models/loyalty_program.rb +16 -4
- data/lib/talon_one/models/loyalty_program_entity.rb +212 -0
- data/lib/talon_one/models/loyalty_tier.rb +301 -0
- data/lib/talon_one/models/new_attribute.rb +2 -2
- data/lib/talon_one/models/new_custom_effect.rb +291 -0
- data/lib/talon_one/models/new_giveaways_pool.rb +234 -0
- data/lib/talon_one/models/new_loyalty_tier.rb +256 -0
- data/lib/talon_one/models/new_referral.rb +64 -19
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +349 -0
- data/lib/talon_one/models/new_role.rb +1 -1
- data/lib/talon_one/models/referral.rb +86 -47
- data/lib/talon_one/models/referral_constraints.rb +251 -0
- data/lib/talon_one/models/role.rb +44 -4
- data/lib/talon_one/models/update_custom_effect.rb +292 -0
- data/lib/talon_one/models/update_loyalty_tier.rb +256 -0
- data/lib/talon_one/models/update_referral.rb +271 -0
- data/lib/talon_one/models/update_role.rb +1 -1
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +243 -0
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +19 -5
- data/spec/api/management_api_spec.rb +102 -33
- data/spec/models/application_campaign_stats_spec.rb +71 -0
- data/spec/models/application_referee_spec.rb +71 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/award_giveaway_effect_props_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +7 -1
- data/spec/models/custom_effect_props_spec.rb +47 -0
- data/spec/models/custom_effect_spec.rb +113 -0
- data/spec/models/customer_inventory_spec.rb +6 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/environment_spec.rb +30 -0
- data/spec/models/export_spec.rb +1 -1
- data/spec/models/giveaway_spec.rb +89 -0
- data/spec/models/giveaways_pool_spec.rb +89 -0
- data/spec/models/import_entity_spec.rb +41 -0
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +6 -0
- data/spec/models/inline_response20012_spec.rb +0 -6
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +1 -1
- data/spec/models/inline_response20019_spec.rb +6 -0
- data/spec/models/inline_response20027_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +0 -6
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/{inline_response20030_spec.rb → inline_response201_spec.rb} +6 -6
- data/spec/models/integration_request_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +6 -0
- data/spec/models/inventory_coupon_spec.rb +149 -0
- data/spec/models/loyalty_program_entity_spec.rb +41 -0
- data/spec/models/loyalty_program_spec.rb +6 -0
- data/spec/models/loyalty_tier_spec.rb +65 -0
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_custom_effect_spec.rb +77 -0
- data/spec/models/new_giveaways_pool_spec.rb +53 -0
- data/spec/models/new_loyalty_tier_spec.rb +47 -0
- data/spec/models/new_referral_spec.rb +17 -5
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +83 -0
- data/spec/models/referral_constraints_spec.rb +53 -0
- data/spec/models/referral_spec.rb +21 -3
- data/spec/models/role_spec.rb +12 -0
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_custom_effect_spec.rb +77 -0
- data/spec/models/update_loyalty_tier_spec.rb +47 -0
- data/spec/models/update_referral_spec.rb +65 -0
- data/spec/models/will_award_giveaway_effect_props_spec.rb +53 -0
- metadata +86 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b804df9a2b599cb22e110557b86693240b2ff0a14c993bd5897c95542eda1369
|
4
|
+
data.tar.gz: eeda373b61c3ce8c86288d41e94b58a883256751e29fb5bc8745494be7137a2c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 612f92b442dffba7ad9825722e4fadff8c18f7987c5f56bb8f508c8f59ae7e605e3207058118379bdf28eff6c0948df39c91893ce6fccb6af233dde669124b14
|
7
|
+
data.tar.gz: c8c11829b792bb8712647e164db5a0349996ab975c97b28fb8d3737d06f6fcadbfe7a875c909483aa6e9d5126d3a7beb28b59f1d061070f543ce0b5e56fff9d3
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ The API is available at the same hostname as these docs. For example, if you are
|
|
17
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
18
|
|
19
19
|
- API version: 1.0.0
|
20
|
-
- Package version: 2.
|
20
|
+
- Package version: 2.4.0
|
21
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
22
|
|
23
23
|
## Installation
|
@@ -33,16 +33,16 @@ gem build talon_one.gemspec
|
|
33
33
|
Then either install the gem locally:
|
34
34
|
|
35
35
|
```shell
|
36
|
-
gem install ./talon_one-2.
|
36
|
+
gem install ./talon_one-2.4.0.gem
|
37
37
|
```
|
38
38
|
|
39
|
-
(for development, run `gem install --dev ./talon_one-2.
|
39
|
+
(for development, run `gem install --dev ./talon_one-2.4.0.gem` to install the development dependencies)
|
40
40
|
|
41
41
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
42
42
|
|
43
43
|
Finally add this to the Gemfile:
|
44
44
|
|
45
|
-
gem 'talon_one', '~> 2.
|
45
|
+
gem 'talon_one', '~> 2.4.0'
|
46
46
|
|
47
47
|
### Install from Git
|
48
48
|
|
@@ -241,6 +241,7 @@ Class | Method | HTTP request | Description
|
|
241
241
|
------------ | ------------- | ------------- | -------------
|
242
242
|
*TalonOne::IntegrationApi* | [**create_coupon_reservation**](docs/IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
|
243
243
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
244
|
+
*TalonOne::IntegrationApi* | [**create_referrals_for_multiple_advocates**](docs/IntegrationApi.md#create_referrals_for_multiple_advocates) | **POST** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates
|
244
245
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
245
246
|
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
|
246
247
|
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
|
@@ -328,6 +329,10 @@ Class | Method | HTTP request | Description
|
|
328
329
|
*TalonOne::ManagementApi* | [**get_webhook_activation_logs**](docs/ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
|
329
330
|
*TalonOne::ManagementApi* | [**get_webhook_logs**](docs/ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
|
330
331
|
*TalonOne::ManagementApi* | [**get_webhooks**](docs/ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List Webhooks
|
332
|
+
*TalonOne::ManagementApi* | [**import_coupons**](docs/ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file
|
333
|
+
*TalonOne::ManagementApi* | [**import_loyalty_points**](docs/ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file
|
334
|
+
*TalonOne::ManagementApi* | [**import_pool_giveaways**](docs/ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaways codes into a giveaways pool
|
335
|
+
*TalonOne::ManagementApi* | [**import_referrals**](docs/ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file
|
331
336
|
*TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer
|
332
337
|
*TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
333
338
|
*TalonOne::ManagementApi* | [**search_coupons_advanced**](docs/ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count)
|
@@ -339,6 +344,7 @@ Class | Method | HTTP request | Description
|
|
339
344
|
*TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
340
345
|
*TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
341
346
|
*TalonOne::ManagementApi* | [**update_coupon_batch**](docs/ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
|
347
|
+
*TalonOne::ManagementApi* | [**update_referral**](docs/ManagementApi.md#update_referral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update one Referral
|
342
348
|
*TalonOne::ManagementApi* | [**update_ruleset**](docs/ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
|
343
349
|
|
344
350
|
|
@@ -359,11 +365,13 @@ Class | Method | HTTP request | Description
|
|
359
365
|
- [TalonOne::Application](docs/Application.md)
|
360
366
|
- [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
|
361
367
|
- [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
|
368
|
+
- [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md)
|
362
369
|
- [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md)
|
363
370
|
- [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md)
|
364
371
|
- [TalonOne::ApplicationCustomerSearch](docs/ApplicationCustomerSearch.md)
|
365
372
|
- [TalonOne::ApplicationEntity](docs/ApplicationEntity.md)
|
366
373
|
- [TalonOne::ApplicationEvent](docs/ApplicationEvent.md)
|
374
|
+
- [TalonOne::ApplicationReferee](docs/ApplicationReferee.md)
|
367
375
|
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
|
368
376
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
369
377
|
- [TalonOne::Attribute](docs/Attribute.md)
|
@@ -371,6 +379,7 @@ Class | Method | HTTP request | Description
|
|
371
379
|
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
372
380
|
- [TalonOne::Audience](docs/Audience.md)
|
373
381
|
- [TalonOne::AudienceMembership](docs/AudienceMembership.md)
|
382
|
+
- [TalonOne::AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md)
|
374
383
|
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
375
384
|
- [TalonOne::Binding](docs/Binding.md)
|
376
385
|
- [TalonOne::Campaign](docs/Campaign.md)
|
@@ -396,6 +405,8 @@ Class | Method | HTTP request | Description
|
|
396
405
|
- [TalonOne::CouponSearch](docs/CouponSearch.md)
|
397
406
|
- [TalonOne::CouponValue](docs/CouponValue.md)
|
398
407
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
408
|
+
- [TalonOne::CustomEffect](docs/CustomEffect.md)
|
409
|
+
- [TalonOne::CustomEffectProps](docs/CustomEffectProps.md)
|
399
410
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
400
411
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
401
412
|
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
@@ -425,7 +436,10 @@ Class | Method | HTTP request | Description
|
|
425
436
|
- [TalonOne::FeedNotification](docs/FeedNotification.md)
|
426
437
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
427
438
|
- [TalonOne::FunctionDef](docs/FunctionDef.md)
|
439
|
+
- [TalonOne::Giveaway](docs/Giveaway.md)
|
440
|
+
- [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
|
428
441
|
- [TalonOne::Import](docs/Import.md)
|
442
|
+
- [TalonOne::ImportEntity](docs/ImportEntity.md)
|
429
443
|
- [TalonOne::InlineResponse200](docs/InlineResponse200.md)
|
430
444
|
- [TalonOne::InlineResponse2001](docs/InlineResponse2001.md)
|
431
445
|
- [TalonOne::InlineResponse20010](docs/InlineResponse20010.md)
|
@@ -450,19 +464,20 @@ Class | Method | HTTP request | Description
|
|
450
464
|
- [TalonOne::InlineResponse20028](docs/InlineResponse20028.md)
|
451
465
|
- [TalonOne::InlineResponse20029](docs/InlineResponse20029.md)
|
452
466
|
- [TalonOne::InlineResponse2003](docs/InlineResponse2003.md)
|
453
|
-
- [TalonOne::InlineResponse20030](docs/InlineResponse20030.md)
|
454
467
|
- [TalonOne::InlineResponse2004](docs/InlineResponse2004.md)
|
455
468
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
456
469
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
457
470
|
- [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
|
458
471
|
- [TalonOne::InlineResponse2008](docs/InlineResponse2008.md)
|
459
472
|
- [TalonOne::InlineResponse2009](docs/InlineResponse2009.md)
|
473
|
+
- [TalonOne::InlineResponse201](docs/InlineResponse201.md)
|
460
474
|
- [TalonOne::IntegrationEntity](docs/IntegrationEntity.md)
|
461
475
|
- [TalonOne::IntegrationEvent](docs/IntegrationEvent.md)
|
462
476
|
- [TalonOne::IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
|
463
477
|
- [TalonOne::IntegrationRequest](docs/IntegrationRequest.md)
|
464
478
|
- [TalonOne::IntegrationState](docs/IntegrationState.md)
|
465
479
|
- [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md)
|
480
|
+
- [TalonOne::InventoryCoupon](docs/InventoryCoupon.md)
|
466
481
|
- [TalonOne::LedgerEntry](docs/LedgerEntry.md)
|
467
482
|
- [TalonOne::LibraryAttribute](docs/LibraryAttribute.md)
|
468
483
|
- [TalonOne::LimitConfig](docs/LimitConfig.md)
|
@@ -474,9 +489,11 @@ Class | Method | HTTP request | Description
|
|
474
489
|
- [TalonOne::LoyaltyPoints](docs/LoyaltyPoints.md)
|
475
490
|
- [TalonOne::LoyaltyProgram](docs/LoyaltyProgram.md)
|
476
491
|
- [TalonOne::LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md)
|
492
|
+
- [TalonOne::LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md)
|
477
493
|
- [TalonOne::LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md)
|
478
494
|
- [TalonOne::LoyaltyStatistics](docs/LoyaltyStatistics.md)
|
479
495
|
- [TalonOne::LoyaltySubLedger](docs/LoyaltySubLedger.md)
|
496
|
+
- [TalonOne::LoyaltyTier](docs/LoyaltyTier.md)
|
480
497
|
- [TalonOne::ManagerConfig](docs/ManagerConfig.md)
|
481
498
|
- [TalonOne::Meta](docs/Meta.md)
|
482
499
|
- [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md)
|
@@ -496,18 +513,22 @@ Class | Method | HTTP request | Description
|
|
496
513
|
- [TalonOne::NewCampaignSet](docs/NewCampaignSet.md)
|
497
514
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
498
515
|
- [TalonOne::NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md)
|
516
|
+
- [TalonOne::NewCustomEffect](docs/NewCustomEffect.md)
|
499
517
|
- [TalonOne::NewCustomerProfile](docs/NewCustomerProfile.md)
|
500
518
|
- [TalonOne::NewCustomerSession](docs/NewCustomerSession.md)
|
501
519
|
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
502
520
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
503
521
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
504
522
|
- [TalonOne::NewFeatureFlags](docs/NewFeatureFlags.md)
|
523
|
+
- [TalonOne::NewGiveawaysPool](docs/NewGiveawaysPool.md)
|
505
524
|
- [TalonOne::NewInvitation](docs/NewInvitation.md)
|
506
525
|
- [TalonOne::NewInviteEmail](docs/NewInviteEmail.md)
|
507
526
|
- [TalonOne::NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
|
527
|
+
- [TalonOne::NewLoyaltyTier](docs/NewLoyaltyTier.md)
|
508
528
|
- [TalonOne::NewPassword](docs/NewPassword.md)
|
509
529
|
- [TalonOne::NewPasswordEmail](docs/NewPasswordEmail.md)
|
510
530
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
531
|
+
- [TalonOne::NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md)
|
511
532
|
- [TalonOne::NewRole](docs/NewRole.md)
|
512
533
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
513
534
|
- [TalonOne::NewSamlConnection](docs/NewSamlConnection.md)
|
@@ -518,6 +539,7 @@ Class | Method | HTTP request | Description
|
|
518
539
|
- [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
|
519
540
|
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
520
541
|
- [TalonOne::Referral](docs/Referral.md)
|
542
|
+
- [TalonOne::ReferralConstraints](docs/ReferralConstraints.md)
|
521
543
|
- [TalonOne::ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md)
|
522
544
|
- [TalonOne::ReferralRejectionReason](docs/ReferralRejectionReason.md)
|
523
545
|
- [TalonOne::RejectCouponEffectProps](docs/RejectCouponEffectProps.md)
|
@@ -553,7 +575,10 @@ Class | Method | HTTP request | Description
|
|
553
575
|
- [TalonOne::UpdateCampaignGroup](docs/UpdateCampaignGroup.md)
|
554
576
|
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
|
555
577
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
578
|
+
- [TalonOne::UpdateCustomEffect](docs/UpdateCustomEffect.md)
|
556
579
|
- [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
|
580
|
+
- [TalonOne::UpdateLoyaltyTier](docs/UpdateLoyaltyTier.md)
|
581
|
+
- [TalonOne::UpdateReferral](docs/UpdateReferral.md)
|
557
582
|
- [TalonOne::UpdateRole](docs/UpdateRole.md)
|
558
583
|
- [TalonOne::UpdateUser](docs/UpdateUser.md)
|
559
584
|
- [TalonOne::UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md)
|
@@ -563,6 +588,7 @@ Class | Method | HTTP request | Description
|
|
563
588
|
- [TalonOne::Webhook](docs/Webhook.md)
|
564
589
|
- [TalonOne::WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md)
|
565
590
|
- [TalonOne::WebhookLogEntry](docs/WebhookLogEntry.md)
|
591
|
+
- [TalonOne::WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md)
|
566
592
|
|
567
593
|
|
568
594
|
## Documentation for Authorization
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# TalonOne::ApplicationCampaignStats
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**draft** | **Integer** | Number of draft campaigns |
|
8
|
+
**disabled** | **Integer** | Number of disabled campaigns |
|
9
|
+
**scheduled** | **Integer** | Number of scheduled campaigns |
|
10
|
+
**running** | **Integer** | Number of running campaigns |
|
11
|
+
**expired** | **Integer** | Number of expired campaigns |
|
12
|
+
**archived** | **Integer** | Number of archived campaigns |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'TalonOne'
|
18
|
+
|
19
|
+
instance = TalonOne::ApplicationCampaignStats.new(draft: null,
|
20
|
+
disabled: null,
|
21
|
+
scheduled: null,
|
22
|
+
running: null,
|
23
|
+
expired: null,
|
24
|
+
archived: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# TalonOne::ApplicationReferee
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
8
|
+
**session_id** | **String** | Integration ID of the session in which the customer redeemed the referral |
|
9
|
+
**advocate_integration_id** | **String** | Integration ID of the Advocate's Profile |
|
10
|
+
**friend_integration_id** | **String** | Integration ID of the Friend's Profile |
|
11
|
+
**code** | **String** | Advocate's referral code. |
|
12
|
+
**created** | **DateTime** | Timestamp of the moment the customer redeemed the referral |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'TalonOne'
|
18
|
+
|
19
|
+
instance = TalonOne::ApplicationReferee.new(application_id: null,
|
20
|
+
session_id: null,
|
21
|
+
advocate_integration_id: null,
|
22
|
+
friend_integration_id: null,
|
23
|
+
code: null,
|
24
|
+
created: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# TalonOne::AwardGiveawayEffectProps
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pool_id** | **Integer** | The ID of the giveaways pool the code was taken from. |
|
8
|
+
**pool_name** | **String** | The name of the giveaways pool the code was taken from. |
|
9
|
+
**recipient_integration_id** | **String** | The integration ID of the profile that was awarded the giveaway. |
|
10
|
+
**giveaway_id** | **Integer** | The internal ID for the giveaway that was awarded. |
|
11
|
+
**code** | **String** | The giveaway code that was awarded. |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'TalonOne'
|
17
|
+
|
18
|
+
instance = TalonOne::AwardGiveawayEffectProps.new(pool_id: null,
|
19
|
+
pool_name: null,
|
20
|
+
recipient_integration_id: null,
|
21
|
+
giveaway_id: null,
|
22
|
+
code: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/Campaign.md
CHANGED
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
|
27
27
|
**discount_effect_count** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional]
|
28
28
|
**coupon_creation_count** | **Integer** | Total number of coupons created by rules in this campaign. | [optional]
|
29
29
|
**referral_creation_count** | **Integer** | Total number of referrals created by rules in this campaign. | [optional]
|
30
|
+
**awarded_giveaways_count** | **Integer** | Total number of giveaways awarded by rules in this campaign. | [optional]
|
30
31
|
**created_loyalty_points_count** | **Float** | Total number of loyalty points created by rules in this campaign. | [optional]
|
31
32
|
**created_loyalty_points_effect_count** | **Integer** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
|
32
33
|
**redeemed_loyalty_points_count** | **Float** | Total number of loyalty points redeemed by rules in this campaign. | [optional]
|
@@ -64,6 +65,7 @@ instance = TalonOne::Campaign.new(id: null,
|
|
64
65
|
discount_effect_count: null,
|
65
66
|
coupon_creation_count: null,
|
66
67
|
referral_creation_count: null,
|
68
|
+
awarded_giveaways_count: null,
|
67
69
|
created_loyalty_points_count: null,
|
68
70
|
created_loyalty_points_effect_count: null,
|
69
71
|
redeemed_loyalty_points_count: null,
|
data/docs/Coupon.md
CHANGED
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
|
|
19
19
|
**referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
|
20
20
|
**recipient_integration_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
|
21
21
|
**import_id** | **Integer** | The ID of the Import which created this coupon. | [optional]
|
22
|
-
**reservation** | **Boolean** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a
|
22
|
+
**reservation** | **Boolean** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional]
|
23
23
|
**batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
|
24
24
|
|
25
25
|
## Code Sample
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# TalonOne::CustomEffect
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
9
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
|
+
**modified** | **DateTime** | The exact moment this entity was last modified. |
|
11
|
+
**name** | **String** | The name of this effect. |
|
12
|
+
**title** | **String** | The title of this effect. |
|
13
|
+
**payload** | **String** | The JSON payload of this effect. |
|
14
|
+
**description** | **String** | The description of this effect. | [optional]
|
15
|
+
**enabled** | **Boolean** | Determines if this effect is active. |
|
16
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this effect is enabled for | [optional]
|
17
|
+
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional]
|
18
|
+
**modified_by** | **Integer** | ID of the user who last updated this effect if available. | [optional]
|
19
|
+
**created_by** | **Integer** | ID of the user who created this effect. |
|
20
|
+
|
21
|
+
## Code Sample
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'TalonOne'
|
25
|
+
|
26
|
+
instance = TalonOne::CustomEffect.new(id: null,
|
27
|
+
created: null,
|
28
|
+
account_id: null,
|
29
|
+
modified: null,
|
30
|
+
name: null,
|
31
|
+
title: null,
|
32
|
+
payload: null,
|
33
|
+
description: null,
|
34
|
+
enabled: null,
|
35
|
+
subscribed_applications_ids: null,
|
36
|
+
params: null,
|
37
|
+
modified_by: null,
|
38
|
+
created_by: null)
|
39
|
+
```
|
40
|
+
|
41
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CustomEffectProps
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**type** | **String** | The type of the custom effect. |
|
8
|
+
**payload** | [**Object**](.md) | The JSON payload of the custom effect. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CustomEffectProps.new(type: null,
|
16
|
+
payload: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CustomerInventory.md
CHANGED
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
|
8
8
|
**loyalty** | [**Loyalty**](Loyalty.md) | | [optional]
|
9
9
|
**referrals** | [**Array<Referral>**](Referral.md) | | [optional]
|
10
|
-
**coupons** | [**Array<
|
10
|
+
**coupons** | [**Array<InventoryCoupon>**](InventoryCoupon.md) | | [optional]
|
11
|
+
**giveaways** | [**Array<Giveaway>**](Giveaway.md) | | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'TalonOne'
|
|
17
18
|
instance = TalonOne::CustomerInventory.new(profile: null,
|
18
19
|
loyalty: null,
|
19
20
|
referrals: null,
|
20
|
-
coupons: null
|
21
|
+
coupons: null,
|
22
|
+
giveaways: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
8
8
|
**audiences_changes** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
|
9
|
-
**response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\"
|
9
|
+
**response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
data/docs/Environment.md
CHANGED
@@ -10,6 +10,11 @@ Name | Type | Description | Notes
|
|
10
10
|
**slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. |
|
11
11
|
**functions** | [**Array<FunctionDef>**](FunctionDef.md) | The functions defined for this application. |
|
12
12
|
**templates** | [**Array<TemplateDef>**](TemplateDef.md) | The templates defined for this application. |
|
13
|
+
**giveaways_pools** | [**Array<GiveawaysPool>**](GiveawaysPool.md) | The giveaways pools that the application is subscribed to. | [optional]
|
14
|
+
**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | The loyalty programs that the application is subscribed to. | [optional]
|
15
|
+
**attributes** | [**Array<Attribute>**](Attribute.md) | The attributes that the application is subscribed to. | [optional]
|
16
|
+
**additional_costs** | [**Array<AccountAdditionalCost>**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional]
|
17
|
+
**audiences** | [**Array<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional]
|
13
18
|
**variables** | **String** | |
|
14
19
|
|
15
20
|
## Code Sample
|
@@ -23,6 +28,11 @@ instance = TalonOne::Environment.new(id: null,
|
|
23
28
|
slots: null,
|
24
29
|
functions: null,
|
25
30
|
templates: null,
|
31
|
+
giveaways_pools: null,
|
32
|
+
loyalty_programs: null,
|
33
|
+
attributes: null,
|
34
|
+
additional_costs: null,
|
35
|
+
audiences: null,
|
26
36
|
variables: null)
|
27
37
|
```
|
28
38
|
|
data/docs/Giveaway.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# TalonOne::Giveaway
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
9
|
+
**code** | **String** | The code value of this giveaway. |
|
10
|
+
**pool_id** | **Integer** | The ID of the pool to return giveaway codes from. |
|
11
|
+
**start_date** | **DateTime** | Timestamp at which point the giveaway becomes valid. | [optional]
|
12
|
+
**end_date** | **DateTime** | Timestamp at which point the giveaway becomes invalid. | [optional]
|
13
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this giveaway. | [optional]
|
14
|
+
**used** | **Boolean** | Flag indicating whether this giveaway code was given before. | [optional]
|
15
|
+
**import_id** | **Integer** | The ID of the Import which created this giveaway. | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'TalonOne'
|
21
|
+
|
22
|
+
instance = TalonOne::Giveaway.new(id: null,
|
23
|
+
created: null,
|
24
|
+
code: null,
|
25
|
+
pool_id: null,
|
26
|
+
start_date: null,
|
27
|
+
end_date: null,
|
28
|
+
attributes: null,
|
29
|
+
used: null,
|
30
|
+
import_id: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|