README.md in talon_one-1.4.0 vs README.md in talon_one-2.0.0
- old
+ new
@@ -1,16 +1,26 @@
# talon_one
TalonOne - the Ruby gem for the Talon.One API
-The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
+The Talon.One API is used to manage applications and campaigns, as well as to
+integrate with your application. The operations in the _Integration API_ section
+are used to integrate with our platform, while the other operations are
+used to manage applications and campaigns.
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+### Where is the API?
+The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`
+
+[updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
- API version: 1.0.0
-- Package version: 1.4.0
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
+- Package version: 2.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
## Installation
### Build a gem
@@ -21,25 +31,26 @@
```
Then either install the gem locally:
```shell
-gem install ./talon_one-1.4.0.gem
+gem install ./talon_one-2.0.0.gem
```
-(for development, run `gem install --dev ./talon_one-1.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./talon_one-2.0.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', '~> 1.4.0'
+ gem 'talon_one', '~> 2.0.0'
### Install from Git
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+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:
- gem 'talon_one', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+ gem 'talon_one', :git => 'https://github.com/talon-one/talon_one.rb.git'
### Include the Ruby code directly
Include the Ruby code directly using `-I` as follows:
@@ -50,10 +61,12 @@
## Getting Started
Please follow the [installation](#installation) procedure and then run the following code:
### Integration API
+
+### V2
```ruby
# Load the gem
require 'talon_one'
# Setup authorization
@@ -67,10 +80,100 @@
end
# Integration API example to send a session update
integration_api = TalonOne::IntegrationApi.new
+session_integration_id = '8fb7129e-68e6-4464-9631-09b588391619' # String | The integration identifier of the session
+
+# NewCustomerSessionV2 object
+customer_session_v2 = TalonOne::NewCustomerSessionV2.new(
+ profile_id: 'Some_1',
+ state: 'open',
+ cart_items: [
+ TalonOne::CartItem.new(
+ name: 'Nigiri Sake',
+ sku: 'sush1',
+ quantity: 2,
+ price: 3.7,
+ category: 'Sushi'
+ ),
+ TalonOne::CartItem.new(
+ name: 'Rainbow Roll I/O',
+ sku: 'sush2',
+ quantity: 1,
+ price: 6.5,
+ category: 'Sushi'
+ ),
+ TalonOne::CartItem.new(
+ name: 'Kirin',
+ sku: 'k1r',
+ quantity: 2,
+ price: 2.2,
+ category: 'Beverages'
+ ),
+ ],
+ coupon_codes: [
+ 'Cool-Stuff!'
+ ]
+)
+
+# Instantiating a new IntegrationRequest object
+integration_request = TalonOne::IntegrationRequest.new(
+ customer_session: customer_session_v2,
+ # Optional list of requested information to be present on the response.
+ # See docs/IntegrationRequest.md for full list
+ # response_content: [
+ # 'customerSession'
+ # ]
+)
+
+begin
+ # Create/update a customer session using `update_customer_session_v2` function
+ result = integration_api.update_customer_session_v2(session_integration_id, integration_request)
+
+ # Prints response to the console
+ puts result
+
+ # Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding properties
+ result.effects.each do |effect|
+ if effect.effect_type == 'setDiscount'
+ # Initiating right props instance according to the effect type
+ props = TalonOne::SetDiscountEffectProps.build_from_hash(effect.props)
+
+ # Access the specific effect's properties
+ puts "Set a discount '#{props.name}' of #{props.value}"
+ elsif effect.effect_type == 'rejectCoupon'
+ # Initiating right props instance according to the effect type
+ props = TalonOne::RejectCouponEffectProps.build_from_hash(effect.props)
+
+ # Work with AcceptCouponEffectProps' properties
+ # ...
+ end
+ end
+rescue TalonOne::ApiError => e
+ puts "Exception when calling IntegrationApi->update_customer_session_v2: #{e}"
+end
+```
+
+### V1
+```ruby
+# Load the gem
+require 'talon_one'
+
+# Setup authorization
+TalonOne.configure do |config|
+ # Configure the API host destination
+ config.host = 'mycompany.talon.one'
+
+ # Configure API key authorization: api_key_v1
+ config.api_key['Authorization'] = 'ca1890f0ec3bfa8ed4be04e2aec0c606c0df8ad464f17d3ea8b51df12ba60e5d'
+ config.api_key_prefix['Authorization'] = 'ApiKey-v1'
+end
+
+# Integration API example to send a session update
+integration_api = TalonOne::IntegrationApi.new
+
session_integration_id = 'f985583f-fa7d-4098-91dd-99c898ed3cd3' # String | The integration identifier of the session
# NewCustomerSession Object
customer_session = TalonOne::NewCustomerSession.new({
'coupon': 'Kewl',
@@ -130,11 +233,11 @@
end
```
## Documentation for API Endpoints
-All URIs are relative to *https://localhost*
+All URIs are relative to *http://localhost*
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
@@ -144,12 +247,14 @@
*TalonOne::IntegrationApi* | [**get_reserved_coupons**](docs/IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
*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
*TalonOne::IntegrationApi* | [**update_customer_profile**](docs/IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
*TalonOne::IntegrationApi* | [**update_customer_session**](docs/IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
+*TalonOne::IntegrationApi* | [**update_customer_session_v2**](docs/IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
*TalonOne::ManagementApi* | [**add_loyalty_points**](docs/ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
+*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Define a new additional cost
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
*TalonOne::ManagementApi* | [**create_ruleset**](docs/ManagementApi.md#create_ruleset) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create a Ruleset
@@ -161,10 +266,12 @@
*TalonOne::ManagementApi* | [**delete_ruleset**](docs/ManagementApi.md#delete_ruleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
*TalonOne::ManagementApi* | [**get_access_logs**](docs/ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application
*TalonOne::ManagementApi* | [**get_access_logs_without_total_count**](docs/ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
+*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
+*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
*TalonOne::ManagementApi* | [**get_application_api_health**](docs/ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
*TalonOne::ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
@@ -210,17 +317,17 @@
*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* | [**refresh_analytics**](docs/ManagementApi.md#refresh_analytics) | **POST** /v1/refresh_analytics | Trigger refresh on stale analytics.
*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
*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
*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
*TalonOne::ManagementApi* | [**search_coupons_advanced_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
+*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_campaign_set**](docs/ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
*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
@@ -228,15 +335,21 @@
## Documentation for Models
- [TalonOne::APIError](docs/APIError.md)
+ - [TalonOne::AcceptCouponEffectProps](docs/AcceptCouponEffectProps.md)
+ - [TalonOne::AcceptReferralEffectProps](docs/AcceptReferralEffectProps.md)
- [TalonOne::AccessLogEntry](docs/AccessLogEntry.md)
- [TalonOne::Account](docs/Account.md)
+ - [TalonOne::AccountAdditionalCost](docs/AccountAdditionalCost.md)
- [TalonOne::AccountAnalytics](docs/AccountAnalytics.md)
- [TalonOne::AccountEntity](docs/AccountEntity.md)
- [TalonOne::AccountLimits](docs/AccountLimits.md)
+ - [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
+ - [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::ApplicationCustomer](docs/ApplicationCustomer.md)
- [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md)
@@ -244,11 +357,10 @@
- [TalonOne::ApplicationEntity](docs/ApplicationEntity.md)
- [TalonOne::ApplicationEvent](docs/ApplicationEvent.md)
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
- [TalonOne::Attribute](docs/Attribute.md)
- - [TalonOne::AttributeQuery](docs/AttributeQuery.md)
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
- [TalonOne::Binding](docs/Binding.md)
- [TalonOne::Campaign](docs/Campaign.md)
@@ -261,13 +373,15 @@
- [TalonOne::CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
- [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
- [TalonOne::CartItem](docs/CartItem.md)
- [TalonOne::CartItemAdjustment](docs/CartItemAdjustment.md)
- [TalonOne::Change](docs/Change.md)
+ - [TalonOne::ChangeProfilePassword](docs/ChangeProfilePassword.md)
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
- [TalonOne::Coupon](docs/Coupon.md)
- [TalonOne::CouponConstraints](docs/CouponConstraints.md)
+ - [TalonOne::CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
- [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)
@@ -275,13 +389,18 @@
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
- [TalonOne::CustomerSession](docs/CustomerSession.md)
+ - [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
+ - [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
+ - [TalonOne::Effect](docs/Effect.md)
+ - [TalonOne::EffectEntity](docs/EffectEntity.md)
- [TalonOne::EmailEntity](docs/EmailEntity.md)
- [TalonOne::Entity](docs/Entity.md)
- [TalonOne::Environment](docs/Environment.md)
+ - [TalonOne::ErrorEffectProps](docs/ErrorEffectProps.md)
- [TalonOne::ErrorResponse](docs/ErrorResponse.md)
- [TalonOne::ErrorSource](docs/ErrorSource.md)
- [TalonOne::Event](docs/Event.md)
- [TalonOne::EventType](docs/EventType.md)
- [TalonOne::Export](docs/Export.md)
@@ -314,20 +433,23 @@
- [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::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::LedgerEntry](docs/LedgerEntry.md)
- [TalonOne::LibraryAttribute](docs/LibraryAttribute.md)
- [TalonOne::LimitConfig](docs/LimitConfig.md)
- [TalonOne::LoginParams](docs/LoginParams.md)
- [TalonOne::Loyalty](docs/Loyalty.md)
@@ -344,18 +466,20 @@
- [TalonOne::MiscUpdateUserLatestFeature](docs/MiscUpdateUserLatestFeature.md)
- [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md)
- [TalonOne::MutableEntity](docs/MutableEntity.md)
- [TalonOne::NewAccount](docs/NewAccount.md)
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
+ - [TalonOne::NewAdditionalCost](docs/NewAdditionalCost.md)
- [TalonOne::NewApplication](docs/NewApplication.md)
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
- [TalonOne::NewAttribute](docs/NewAttribute.md)
- [TalonOne::NewCampaign](docs/NewCampaign.md)
- [TalonOne::NewCampaignSet](docs/NewCampaignSet.md)
- [TalonOne::NewCoupons](docs/NewCoupons.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::NewImport](docs/NewImport.md)
- [TalonOne::NewInvitation](docs/NewInvitation.md)
@@ -369,26 +493,38 @@
- [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::Notifications](docs/Notifications.md)
+ - [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
- [TalonOne::Referral](docs/Referral.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)
- [TalonOne::RoleAssign](docs/RoleAssign.md)
- [TalonOne::RoleMembership](docs/RoleMembership.md)
+ - [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
+ - [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
- [TalonOne::Rule](docs/Rule.md)
- [TalonOne::Ruleset](docs/Ruleset.md)
- [TalonOne::SamlConnection](docs/SamlConnection.md)
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
+ - [TalonOne::SamlLoginEndpoint](docs/SamlLoginEndpoint.md)
- [TalonOne::Session](docs/Session.md)
+ - [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
+ - [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
+ - [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
+ - [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
- [TalonOne::SlotDef](docs/SlotDef.md)
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
- [TalonOne::TemplateDef](docs/TemplateDef.md)
+ - [TalonOne::TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md)
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
+ - [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
- [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
- [TalonOne::UpdateRole](docs/UpdateRole.md)
@@ -403,20 +539,23 @@
## Documentation for Authorization
### api_key_v1
+
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
### integration_auth
+
- **Type**: API key
- **API key parameter name**: Content-Signature
- **Location**: HTTP header
### manager_auth
+
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header