README.md in talon_one-2.3.0 vs README.md in talon_one-2.4.0

- old
+ new

@@ -15,11 +15,11 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.0 -- Package version: 2.3.0 +- Package version: 2.4.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation ### Build a gem @@ -31,20 +31,20 @@ ``` Then either install the gem locally: ```shell -gem install ./talon_one-2.3.0.gem +gem install ./talon_one-2.4.0.gem ``` -(for development, run `gem install --dev ./talon_one-2.3.0.gem` to install the development dependencies) +(for development, run `gem install --dev ./talon_one-2.4.0.gem` to install the development dependencies) or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). Finally add this to the Gemfile: - gem 'talon_one', '~> 2.3.0' + gem 'talon_one', '~> 2.4.0' ### Install from Git If the Ruby gem is hosted at a git repository: https://github.com/talon-one/talon_one.rb, then add the following in the Gemfile: @@ -239,10 +239,11 @@ Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *TalonOne::IntegrationApi* | [**create_coupon_reservation**](docs/IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation *TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate +*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 *TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations *TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer *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 *TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved *TalonOne::IntegrationApi* | [**track_event**](docs/IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event @@ -326,10 +327,14 @@ *TalonOne::ManagementApi* | [**get_users**](docs/ManagementApi.md#get_users) | **GET** /v1/users | List Users in your account *TalonOne::ManagementApi* | [**get_webhook**](docs/ManagementApi.md#get_webhook) | **GET** /v1/webhooks/{webhookId} | Get Webhook *TalonOne::ManagementApi* | [**get_webhook_activation_logs**](docs/ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries *TalonOne::ManagementApi* | [**get_webhook_logs**](docs/ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries *TalonOne::ManagementApi* | [**get_webhooks**](docs/ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List Webhooks +*TalonOne::ManagementApi* | [**import_coupons**](docs/ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file +*TalonOne::ManagementApi* | [**import_loyalty_points**](docs/ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file +*TalonOne::ManagementApi* | [**import_pool_giveaways**](docs/ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaways codes into a giveaways pool +*TalonOne::ManagementApi* | [**import_referrals**](docs/ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file *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 *TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password *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) *TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide**](docs/ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) *TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application @@ -337,10 +342,11 @@ *TalonOne::ManagementApi* | [**update_additional_cost**](docs/ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost *TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute *TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign *TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon *TalonOne::ManagementApi* | [**update_coupon_batch**](docs/ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons +*TalonOne::ManagementApi* | [**update_referral**](docs/ManagementApi.md#update_referral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update one Referral *TalonOne::ManagementApi* | [**update_ruleset**](docs/ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset ## Documentation for Models @@ -357,22 +363,25 @@ - [TalonOne::AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) - [TalonOne::AdditionalCost](docs/AdditionalCost.md) - [TalonOne::Application](docs/Application.md) - [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md) - [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md) + - [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md) - [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md) - [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) - [TalonOne::ApplicationCustomerSearch](docs/ApplicationCustomerSearch.md) - [TalonOne::ApplicationEntity](docs/ApplicationEntity.md) - [TalonOne::ApplicationEvent](docs/ApplicationEvent.md) + - [TalonOne::ApplicationReferee](docs/ApplicationReferee.md) - [TalonOne::ApplicationSession](docs/ApplicationSession.md) - [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md) - [TalonOne::Attribute](docs/Attribute.md) - [TalonOne::AttributesMandatory](docs/AttributesMandatory.md) - [TalonOne::AttributesSettings](docs/AttributesSettings.md) - [TalonOne::Audience](docs/Audience.md) - [TalonOne::AudienceMembership](docs/AudienceMembership.md) + - [TalonOne::AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md) - [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md) - [TalonOne::Binding](docs/Binding.md) - [TalonOne::Campaign](docs/Campaign.md) - [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md) - [TalonOne::CampaignCopy](docs/CampaignCopy.md) @@ -394,10 +403,12 @@ - [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md) - [TalonOne::CouponReservations](docs/CouponReservations.md) - [TalonOne::CouponSearch](docs/CouponSearch.md) - [TalonOne::CouponValue](docs/CouponValue.md) - [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md) + - [TalonOne::CustomEffect](docs/CustomEffect.md) + - [TalonOne::CustomEffectProps](docs/CustomEffectProps.md) - [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md) - [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md) - [TalonOne::CustomerInventory](docs/CustomerInventory.md) - [TalonOne::CustomerProfile](docs/CustomerProfile.md) - [TalonOne::CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md) @@ -423,11 +434,14 @@ - [TalonOne::FeatureFlags](docs/FeatureFlags.md) - [TalonOne::FeaturesFeed](docs/FeaturesFeed.md) - [TalonOne::FeedNotification](docs/FeedNotification.md) - [TalonOne::FuncArgDef](docs/FuncArgDef.md) - [TalonOne::FunctionDef](docs/FunctionDef.md) + - [TalonOne::Giveaway](docs/Giveaway.md) + - [TalonOne::GiveawaysPool](docs/GiveawaysPool.md) - [TalonOne::Import](docs/Import.md) + - [TalonOne::ImportEntity](docs/ImportEntity.md) - [TalonOne::InlineResponse200](docs/InlineResponse200.md) - [TalonOne::InlineResponse2001](docs/InlineResponse2001.md) - [TalonOne::InlineResponse20010](docs/InlineResponse20010.md) - [TalonOne::InlineResponse20011](docs/InlineResponse20011.md) - [TalonOne::InlineResponse20012](docs/InlineResponse20012.md) @@ -448,23 +462,24 @@ - [TalonOne::InlineResponse20026](docs/InlineResponse20026.md) - [TalonOne::InlineResponse20027](docs/InlineResponse20027.md) - [TalonOne::InlineResponse20028](docs/InlineResponse20028.md) - [TalonOne::InlineResponse20029](docs/InlineResponse20029.md) - [TalonOne::InlineResponse2003](docs/InlineResponse2003.md) - - [TalonOne::InlineResponse20030](docs/InlineResponse20030.md) - [TalonOne::InlineResponse2004](docs/InlineResponse2004.md) - [TalonOne::InlineResponse2005](docs/InlineResponse2005.md) - [TalonOne::InlineResponse2006](docs/InlineResponse2006.md) - [TalonOne::InlineResponse2007](docs/InlineResponse2007.md) - [TalonOne::InlineResponse2008](docs/InlineResponse2008.md) - [TalonOne::InlineResponse2009](docs/InlineResponse2009.md) + - [TalonOne::InlineResponse201](docs/InlineResponse201.md) - [TalonOne::IntegrationEntity](docs/IntegrationEntity.md) - [TalonOne::IntegrationEvent](docs/IntegrationEvent.md) - [TalonOne::IntegrationProfileEntity](docs/IntegrationProfileEntity.md) - [TalonOne::IntegrationRequest](docs/IntegrationRequest.md) - [TalonOne::IntegrationState](docs/IntegrationState.md) - [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md) + - [TalonOne::InventoryCoupon](docs/InventoryCoupon.md) - [TalonOne::LedgerEntry](docs/LedgerEntry.md) - [TalonOne::LibraryAttribute](docs/LibraryAttribute.md) - [TalonOne::LimitConfig](docs/LimitConfig.md) - [TalonOne::LoginParams](docs/LoginParams.md) - [TalonOne::Loyalty](docs/Loyalty.md) @@ -472,13 +487,15 @@ - [TalonOne::LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md) - [TalonOne::LoyaltyMembership](docs/LoyaltyMembership.md) - [TalonOne::LoyaltyPoints](docs/LoyaltyPoints.md) - [TalonOne::LoyaltyProgram](docs/LoyaltyProgram.md) - [TalonOne::LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) + - [TalonOne::LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) - [TalonOne::LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) - [TalonOne::LoyaltyStatistics](docs/LoyaltyStatistics.md) - [TalonOne::LoyaltySubLedger](docs/LoyaltySubLedger.md) + - [TalonOne::LoyaltyTier](docs/LoyaltyTier.md) - [TalonOne::ManagerConfig](docs/ManagerConfig.md) - [TalonOne::Meta](docs/Meta.md) - [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md) - [TalonOne::MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md) - [TalonOne::MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md) @@ -494,32 +511,37 @@ - [TalonOne::NewCampaign](docs/NewCampaign.md) - [TalonOne::NewCampaignGroup](docs/NewCampaignGroup.md) - [TalonOne::NewCampaignSet](docs/NewCampaignSet.md) - [TalonOne::NewCoupons](docs/NewCoupons.md) - [TalonOne::NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md) + - [TalonOne::NewCustomEffect](docs/NewCustomEffect.md) - [TalonOne::NewCustomerProfile](docs/NewCustomerProfile.md) - [TalonOne::NewCustomerSession](docs/NewCustomerSession.md) - [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md) - [TalonOne::NewEvent](docs/NewEvent.md) - [TalonOne::NewEventType](docs/NewEventType.md) - [TalonOne::NewFeatureFlags](docs/NewFeatureFlags.md) + - [TalonOne::NewGiveawaysPool](docs/NewGiveawaysPool.md) - [TalonOne::NewInvitation](docs/NewInvitation.md) - [TalonOne::NewInviteEmail](docs/NewInviteEmail.md) - [TalonOne::NewLoyaltyProgram](docs/NewLoyaltyProgram.md) + - [TalonOne::NewLoyaltyTier](docs/NewLoyaltyTier.md) - [TalonOne::NewPassword](docs/NewPassword.md) - [TalonOne::NewPasswordEmail](docs/NewPasswordEmail.md) - [TalonOne::NewReferral](docs/NewReferral.md) + - [TalonOne::NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md) - [TalonOne::NewRole](docs/NewRole.md) - [TalonOne::NewRuleset](docs/NewRuleset.md) - [TalonOne::NewSamlConnection](docs/NewSamlConnection.md) - [TalonOne::NewTemplateDef](docs/NewTemplateDef.md) - [TalonOne::NewUser](docs/NewUser.md) - [TalonOne::NewWebhook](docs/NewWebhook.md) - [TalonOne::Notification](docs/Notification.md) - [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) - [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - [TalonOne::Referral](docs/Referral.md) + - [TalonOne::ReferralConstraints](docs/ReferralConstraints.md) - [TalonOne::ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md) - [TalonOne::ReferralRejectionReason](docs/ReferralRejectionReason.md) - [TalonOne::RejectCouponEffectProps](docs/RejectCouponEffectProps.md) - [TalonOne::RejectReferralEffectProps](docs/RejectReferralEffectProps.md) - [TalonOne::Role](docs/Role.md) @@ -551,19 +573,23 @@ - [TalonOne::UpdateAudience](docs/UpdateAudience.md) - [TalonOne::UpdateCampaign](docs/UpdateCampaign.md) - [TalonOne::UpdateCampaignGroup](docs/UpdateCampaignGroup.md) - [TalonOne::UpdateCoupon](docs/UpdateCoupon.md) - [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md) + - [TalonOne::UpdateCustomEffect](docs/UpdateCustomEffect.md) - [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) + - [TalonOne::UpdateLoyaltyTier](docs/UpdateLoyaltyTier.md) + - [TalonOne::UpdateReferral](docs/UpdateReferral.md) - [TalonOne::UpdateRole](docs/UpdateRole.md) - [TalonOne::UpdateUser](docs/UpdateUser.md) - [TalonOne::UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md) - [TalonOne::User](docs/User.md) - [TalonOne::UserEntity](docs/UserEntity.md) - [TalonOne::UserFeedNotifications](docs/UserFeedNotifications.md) - [TalonOne::Webhook](docs/Webhook.md) - [TalonOne::WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md) - [TalonOne::WebhookLogEntry](docs/WebhookLogEntry.md) + - [TalonOne::WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md) ## Documentation for Authorization