talon_one
v9.0.1
Published
Talon.One API SDK for Javascript
Downloads
11,824
Readme
talon_one
TalonOne - JavaScript client for talon_one Use the Talon.One API to integrate with your application and to manage applications and campaigns:
- Use the operations in the Integration API section are used to integrate with our platform
- Use the operation in the Management API section to manage applications and campaigns.
Determining the base URL of the endpoints
The API is available at the same hostname as your Campaign Manager deployment.
For example, if you access the Campaign Manager at https://yourbaseurl.talon.one/
,
the URL for the updateCustomerSessionV2 endpoint
is https://yourbaseurl.talon.one/v2/customer_sessions/{Id}
This SDK is automatically generated by the OpenAPI Generator project:
- Package version: 9.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install talon_one --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your talon_one from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/talon-one/talon_one.js then install it via:
npm install talon-one/talon_one.js --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
Integration API
const TalonOne = require("talon_one");
const defaultClient = TalonOne.ApiClient.instance;
defaultClient.basePath = "https://yourbaseurl.talon.one";
// Configure API key authorization: api_key_v1
const api_key_v1 = defaultClient.authentications["api_key_v1"];
api_key_v1.apiKey =
"dbc644d33aa74d582bd9479c59e16f970fe13bf34a208c39d6c7fa7586968468";
api_key_v1.apiKeyPrefix = "ApiKey-v1";
// Integration API example to send a session update
const integrationApi = new TalonOne.IntegrationApi();
// Initializing a customer session object
const customerSession = TalonOne.NewCustomerSessionV2.constructFromObject({
profileId: 'example_prof_id',
cartItems: [
{
name: 'Döner King',
sku: 'kd-100',
quantity: 1,
price: 2.00,
category: 'pizzas'
},
{
name: 'Spezi 500ml',
sku: 'sp-50',
quantity: 1,
price: 2,
category: 'beverages'
},
{
name: 'Queen Döner',
sku: 'qd-100',
quantity: 1,
price: 2.50,
category: 'pizzas'
},
{
name: 'Club Mate 330ml',
sku: 'cm-33',
quantity: 1,
price: 1.80,
category: 'beverages'
}
],
couponCodes: [
'Cool-Summer!'
]
});
//Initializing an integration request wrapping the customer session
const integrationRequest = new TalonOne.IntegrationRequest(customerSession);
// Optional list of requested information to be present on the response.
// See src/model/IntegrationRequest#ResponseContentEnum for full list of supported values
// integrationRequest.responseContent = [
// TalonOne.IntegrationRequest.ResponseContentEnum.customerSession,
// TalonOne.IntegrationRequest.ResponseContentEnum.customerProfile
// ]
integrationApi
.updateCustomerSessionV2("example_integration_v2_id", integrationRequest)
.then(
data => {
console.log(JSON.stringify(data, null, 2));
// 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
data.effects.forEach(effect => {
switch(effect.effectType) {
case 'setDiscount':
// Initiating right props instance according to the effect type
const setDiscountProps = TalonOne.SetDiscountEffectProps.constructFromObject(effect.props)
// Initiating the right props class is not a necessity, it is only a suggestion here that could help in case of unexpected returned values from the API
// Access the specific effect's properties
console.log(`Set a discount '${setDiscountProps.name}' of ${setDiscountProps.value}`)
break
case 'acceptCoupon':
// Work with AcceptCouponEffectProps' properties
// ...
default:
throw new Error(`Unhandled effect type from Talon.One integration: ${effect.effectType}`)
}
})
},
err => {
console.error(err);
}
);
Management API
const TalonOne = require("talon_one");
const defaultClient = TalonOne.ApiClient.instance;
defaultClient.basePath = "https://yourbaseurl.talon.one";
// Configure API key authorization: management_key
const management_key = defaultClient.authentications["management_key"];
management_key.apiKey =
"2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07";
management_key.apiKeyPrefix = "ManagementKey-v1";
// Management API example to load application with id 7
const managementApi = new TalonOne.ManagementApi();
// Calling `getApplication` function with the desired id (7)
managementApi.getApplication(7).then(
function(data) {
console.log(
"API called successfully. Returned data:\n" + JSON.stringify(data)
);
},
function(error) {
console.error("Error while fetching the application:\n" + error);
}
);
Documentation for API Endpoints
All URIs are relative to https://yourbaseurl.talon.one
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TalonOne.IntegrationApi | createAudienceV2 | POST /v2/audiences | Create audience TalonOne.IntegrationApi | createCouponReservation | POST /v1/coupon_reservations/{couponValue} | Create coupon reservation TalonOne.IntegrationApi | createReferral | POST /v1/referrals | Create referral code for an advocate TalonOne.IntegrationApi | createReferralsForMultipleAdvocates | POST /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates TalonOne.IntegrationApi | deleteAudienceMembershipsV2 | DELETE /v2/audiences/{audienceId}/memberships | Delete audience memberships TalonOne.IntegrationApi | deleteAudienceV2 | DELETE /v2/audiences/{audienceId} | Delete audience TalonOne.IntegrationApi | deleteCouponReservation | DELETE /v1/coupon_reservations/{couponValue} | Delete coupon reservations TalonOne.IntegrationApi | deleteCustomerData | DELETE /v1/customer_data/{integrationId} | Delete customer's personal data TalonOne.IntegrationApi | generateLoyaltyCard | POST /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card TalonOne.IntegrationApi | getCustomerInventory | GET /v1/customer_profiles/{integrationId}/inventory | List customer data TalonOne.IntegrationApi | getCustomerSession | GET /v2/customer_sessions/{customerSessionId} | Get customer session TalonOne.IntegrationApi | getLoyaltyBalances | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points TalonOne.IntegrationApi | getLoyaltyCardBalances | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances TalonOne.IntegrationApi | getLoyaltyCardPoints | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points TalonOne.IntegrationApi | getLoyaltyCardTransactions | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions TalonOne.IntegrationApi | getLoyaltyProgramProfilePoints | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points TalonOne.IntegrationApi | getLoyaltyProgramProfileTransactions | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions TalonOne.IntegrationApi | getReservedCustomers | GET /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved TalonOne.IntegrationApi | linkLoyaltyCardToProfile | POST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card TalonOne.IntegrationApi | reopenCustomerSession | PUT /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session TalonOne.IntegrationApi | returnCartItems | POST /v2/customer_sessions/{customerSessionId}/returns | Return cart items TalonOne.IntegrationApi | syncCatalog | PUT /v1/catalogs/{catalogId}/sync | Sync cart item catalog TalonOne.IntegrationApi | trackEventV2 | POST /v2/events | Track event TalonOne.IntegrationApi | updateAudienceCustomersAttributes | PUT /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience TalonOne.IntegrationApi | updateAudienceV2 | PUT /v2/audiences/{audienceId} | Update audience name TalonOne.IntegrationApi | updateCustomerProfileAudiences | POST /v2/customer_audiences | Update multiple customer profiles' audiences TalonOne.IntegrationApi | updateCustomerProfileV2 | PUT /v2/customer_profiles/{integrationId} | Update customer profile TalonOne.IntegrationApi | updateCustomerProfilesV2 | PUT /v2/customer_profiles | Update multiple customer profiles TalonOne.IntegrationApi | updateCustomerSessionV2 | PUT /v2/customer_sessions/{customerSessionId} | Update customer session TalonOne.ManagementApi | activateUserByEmail | POST /v1/users/activate | Enable user by email address TalonOne.ManagementApi | addLoyaltyCardPoints | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card TalonOne.ManagementApi | addLoyaltyPoints | PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile TalonOne.ManagementApi | copyCampaignToApplications | POST /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application TalonOne.ManagementApi | createAccountCollection | POST /v1/collections | Create account-level collection TalonOne.ManagementApi | createAchievement | POST /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement TalonOne.ManagementApi | createAdditionalCost | POST /v1/additional_costs | Create additional cost TalonOne.ManagementApi | createAttribute | POST /v1/attributes | Create custom attribute TalonOne.ManagementApi | createBatchLoyaltyCards | POST /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards TalonOne.ManagementApi | createCampaignFromTemplate | POST /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template TalonOne.ManagementApi | createCollection | POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection TalonOne.ManagementApi | createCoupons | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons TalonOne.ManagementApi | createCouponsAsync | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously TalonOne.ManagementApi | createCouponsDeletionJob | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job TalonOne.ManagementApi | createCouponsForMultipleRecipients | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients TalonOne.ManagementApi | createInviteEmail | POST /v1/invite_emails | Resend invitation email TalonOne.ManagementApi | createInviteV2 | POST /v2/invites | Invite user TalonOne.ManagementApi | createPasswordRecoveryEmail | POST /v1/password_recovery_emails | Request a password reset TalonOne.ManagementApi | createSession | POST /v1/sessions | Create session TalonOne.ManagementApi | createStore | POST /v1/applications/{applicationId}/stores | Create store TalonOne.ManagementApi | deactivateUserByEmail | POST /v1/users/deactivate | Disable user by email address TalonOne.ManagementApi | deductLoyaltyCardPoints | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card TalonOne.ManagementApi | deleteAccountCollection | DELETE /v1/collections/{collectionId} | Delete account-level collection TalonOne.ManagementApi | deleteAchievement | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement TalonOne.ManagementApi | deleteCampaign | DELETE /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign TalonOne.ManagementApi | deleteCollection | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection TalonOne.ManagementApi | deleteCoupon | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon TalonOne.ManagementApi | deleteCoupons | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons TalonOne.ManagementApi | deleteLoyaltyCard | DELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card TalonOne.ManagementApi | deleteReferral | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral TalonOne.ManagementApi | deleteStore | DELETE /v1/applications/{applicationId}/stores/{storeId} | Delete store TalonOne.ManagementApi | deleteUser | DELETE /v1/users/{userId} | Delete user TalonOne.ManagementApi | deleteUserByEmail | POST /v1/users/delete | Delete user by email address TalonOne.ManagementApi | destroySession | DELETE /v1/sessions | Destroy session TalonOne.ManagementApi | disconnectCampaignStores | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores TalonOne.ManagementApi | exportAccountCollectionItems | GET /v1/collections/{collectionId}/export | Export account-level collection's items TalonOne.ManagementApi | exportAchievements | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data TalonOne.ManagementApi | exportAudiencesMemberships | GET /v1/audiences/{audienceId}/memberships/export | Export audience members TalonOne.ManagementApi | exportCampaignStores | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores TalonOne.ManagementApi | exportCollectionItems | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items TalonOne.ManagementApi | exportCoupons | GET /v1/applications/{applicationId}/export_coupons | Export coupons TalonOne.ManagementApi | exportCustomerSessions | GET /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions TalonOne.ManagementApi | exportCustomersTiers | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers | Export customers' tier data TalonOne.ManagementApi | exportEffects | GET /v1/applications/{applicationId}/export_effects | Export triggered effects TalonOne.ManagementApi | exportLoyaltyBalance | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV TalonOne.ManagementApi | exportLoyaltyBalances | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances TalonOne.ManagementApi | exportLoyaltyCardBalances | GET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs TalonOne.ManagementApi | exportLoyaltyCardLedger | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log TalonOne.ManagementApi | exportLoyaltyCards | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards TalonOne.ManagementApi | exportLoyaltyLedger | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs TalonOne.ManagementApi | exportPoolGiveaways | GET /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool TalonOne.ManagementApi | exportReferrals | GET /v1/applications/{applicationId}/export_referrals | Export referrals TalonOne.ManagementApi | getAccessLogsWithoutTotalCount | GET /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application TalonOne.ManagementApi | getAccount | GET /v1/accounts/{accountId} | Get account details TalonOne.ManagementApi | getAccountAnalytics | GET /v1/accounts/{accountId}/analytics | Get account analytics TalonOne.ManagementApi | getAccountCollection | GET /v1/collections/{collectionId} | Get account-level collection TalonOne.ManagementApi | getAchievement | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement TalonOne.ManagementApi | getAdditionalCost | GET /v1/additional_costs/{additionalCostId} | Get additional cost TalonOne.ManagementApi | getAdditionalCosts | GET /v1/additional_costs | List additional costs TalonOne.ManagementApi | getAllAccessLogs | GET /v1/access_logs | List access logs TalonOne.ManagementApi | getApplication | GET /v1/applications/{applicationId} | Get Application TalonOne.ManagementApi | getApplicationApiHealth | GET /v1/applications/{applicationId}/health_report | Get Application health TalonOne.ManagementApi | getApplicationCustomer | GET /v1/applications/{applicationId}/customers/{customerId} | Get application's customer TalonOne.ManagementApi | getApplicationCustomerFriends | GET /v1/applications/{applicationId}/profile/{integrationId}/friends | List friends referred by customer profile TalonOne.ManagementApi | getApplicationCustomers | GET /v1/applications/{applicationId}/customers | List application's customers TalonOne.ManagementApi | getApplicationCustomersByAttributes | POST /v1/applications/{applicationId}/customer_search | List application customers matching the given attributes TalonOne.ManagementApi | getApplicationEventTypes | GET /v1/applications/{applicationId}/event_types | List Applications event types TalonOne.ManagementApi | getApplicationEventsWithoutTotalCount | GET /v1/applications/{applicationId}/events/no_total | List Applications events TalonOne.ManagementApi | getApplicationSession | GET /v1/applications/{applicationId}/sessions/{sessionId} | Get Application session TalonOne.ManagementApi | getApplicationSessions | GET /v1/applications/{applicationId}/sessions | List Application sessions TalonOne.ManagementApi | getApplications | GET /v1/applications | List Applications TalonOne.ManagementApi | getAttribute | GET /v1/attributes/{attributeId} | Get custom attribute TalonOne.ManagementApi | getAttributes | GET /v1/attributes | List custom attributes TalonOne.ManagementApi | getAudienceMemberships | GET /v1/audiences/{audienceId}/memberships | List audience members TalonOne.ManagementApi | getAudiences | GET /v1/audiences | List audiences TalonOne.ManagementApi | getAudiencesAnalytics | GET /v1/audiences/analytics | List audience analytics TalonOne.ManagementApi | getCampaign | GET /v1/applications/{applicationId}/campaigns/{campaignId} | Get campaign TalonOne.ManagementApi | getCampaignAnalytics | GET /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns TalonOne.ManagementApi | getCampaignByAttributes | POST /v1/applications/{applicationId}/campaigns_search | List campaigns that match the given attributes TalonOne.ManagementApi | getCampaignGroup | GET /v1/campaign_groups/{campaignGroupId} | Get campaign access group TalonOne.ManagementApi | getCampaignGroups | GET /v1/campaign_groups | List campaign access groups TalonOne.ManagementApi | getCampaignTemplates | GET /v1/campaign_templates | List campaign templates TalonOne.ManagementApi | getCampaigns | GET /v1/applications/{applicationId}/campaigns | List campaigns TalonOne.ManagementApi | getChanges | GET /v1/changes | Get audit logs for an account TalonOne.ManagementApi | getCollection | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection TalonOne.ManagementApi | getCollectionItems | GET /v1/collections/{collectionId}/items | Get collection items TalonOne.ManagementApi | getCouponsWithoutTotalCount | GET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons TalonOne.ManagementApi | getCustomerActivityReport | GET /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report TalonOne.ManagementApi | getCustomerActivityReportsWithoutTotalCount | GET /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers TalonOne.ManagementApi | getCustomerAnalytics | GET /v1/applications/{applicationId}/customers/{customerId}/analytics | Get customer's analytics report TalonOne.ManagementApi | getCustomerProfile | GET /v1/customers/{customerId} | Get customer profile TalonOne.ManagementApi | getCustomerProfileAchievementProgress | GET /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements TalonOne.ManagementApi | getCustomerProfiles | GET /v1/customers/no_total | List customer profiles TalonOne.ManagementApi | getCustomersByAttributes | POST /v1/customer_search/no_total | List customer profiles matching the given attributes TalonOne.ManagementApi | getEventTypes | GET /v1/event_types | List event types TalonOne.ManagementApi | getExports | GET /v1/exports | Get exports TalonOne.ManagementApi | getLoyaltyCard | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card TalonOne.ManagementApi | getLoyaltyCardTransactionLogs | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions TalonOne.ManagementApi | getLoyaltyCards | GET /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards TalonOne.ManagementApi | getLoyaltyPoints | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger TalonOne.ManagementApi | getLoyaltyProgram | GET /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program TalonOne.ManagementApi | getLoyaltyProgramTransactions | GET /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions TalonOne.ManagementApi | getLoyaltyPrograms | GET /v1/loyalty_programs | List loyalty programs TalonOne.ManagementApi | getLoyaltyStatistics | GET /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics TalonOne.ManagementApi | getReferralsWithoutTotalCount | GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals TalonOne.ManagementApi | getRoleV2 | GET /v2/roles/{roleId} | Get role TalonOne.ManagementApi | getRuleset | GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset TalonOne.ManagementApi | getRulesets | GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets TalonOne.ManagementApi | getStore | GET /v1/applications/{applicationId}/stores/{storeId} | Get store TalonOne.ManagementApi | getUser | GET /v1/users/{userId} | Get user TalonOne.ManagementApi | getUsers | GET /v1/users | List users in account TalonOne.ManagementApi | getWebhook | GET /v1/webhooks/{webhookId} | Get webhook TalonOne.ManagementApi | getWebhookActivationLogs | GET /v1/webhook_activation_logs | List webhook activation log entries TalonOne.ManagementApi | getWebhookLogs | GET /v1/webhook_logs | List webhook log entries TalonOne.ManagementApi | getWebhooks | GET /v1/webhooks | List webhooks TalonOne.ManagementApi | importAccountCollection | POST /v1/collections/{collectionId}/import | Import data into existing account-level collection TalonOne.ManagementApi | importAllowedList | POST /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute TalonOne.ManagementApi | importAudiencesMemberships | POST /v1/audiences/{audienceId}/memberships/import | Import audience members TalonOne.ManagementApi | importCampaignStores | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores TalonOne.ManagementApi | importCollection | POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection TalonOne.ManagementApi | importCoupons | POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons TalonOne.ManagementApi | importLoyaltyCards | POST /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards TalonOne.ManagementApi | importLoyaltyCustomersTiers | POST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers TalonOne.ManagementApi | importLoyaltyPoints | POST /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points TalonOne.ManagementApi | importPoolGiveaways | POST /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool TalonOne.ManagementApi | importReferrals | POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals TalonOne.ManagementApi | inviteUserExternal | POST /v1/users/invite | Invite user from identity provider TalonOne.ManagementApi | listAccountCollections | GET /v1/collections | List collections in account TalonOne.ManagementApi | listAchievements | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements TalonOne.ManagementApi | listAllRolesV2 | GET /v2/roles | List roles TalonOne.ManagementApi | listCatalogItems | GET /v1/catalogs/{catalogId}/items | List items in a catalog TalonOne.ManagementApi | listCollections | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign TalonOne.ManagementApi | listCollectionsInApplication | GET /v1/applications/{applicationId}/collections | List collections in Application TalonOne.ManagementApi | listStores | GET /v1/applications/{applicationId}/stores | List stores TalonOne.ManagementApi | notificationActivation | PUT /v1/notifications/{notificationId}/activation | Activate or deactivate notification TalonOne.ManagementApi | oktaEventHandlerChallenge | GET /v1/provisioning/okta | Validate Okta API ownership TalonOne.ManagementApi | postAddedDeductedPointsNotification | POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points TalonOne.ManagementApi | postCatalogsStrikethroughNotification | POST /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification TalonOne.ManagementApi | postPendingPointsNotification | POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points TalonOne.ManagementApi | removeLoyaltyPoints | PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile TalonOne.ManagementApi | resetPassword | POST /v1/reset_password | Reset password TalonOne.ManagementApi | scimCreateUser | POST /v1/provisioning/scim/Users | Create SCIM user TalonOne.ManagementApi | scimDeleteUser | DELETE /v1/provisioning/scim/Users/{userId} | Delete SCIM user TalonOne.ManagementApi | scimGetResourceTypes | GET /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types TalonOne.ManagementApi | scimGetSchemas | GET /v1/provisioning/scim/Schemas | List supported SCIM schemas TalonOne.ManagementApi | scimGetServiceProviderConfig | GET /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration TalonOne.ManagementApi | scimGetUser | GET /v1/provisioning/scim/Users/{userId} | Get SCIM user TalonOne.ManagementApi | scimGetUsers | GET /v1/provisioning/scim/Users | List SCIM users TalonOne.ManagementApi | scimPatchUser | PATCH /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes TalonOne.ManagementApi | scimReplaceUserAttributes | PUT /v1/provisioning/scim/Users/{userId} | Update SCIM user TalonOne.ManagementApi | searchCouponsAdvancedApplicationWideWithoutTotalCount | POST /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) TalonOne.ManagementApi | searchCouponsAdvancedWithoutTotalCount | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) TalonOne.ManagementApi | transferLoyaltyCard | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data TalonOne.ManagementApi | updateAccountCollection | PUT /v1/collections/{collectionId} | Update account-level collection TalonOne.ManagementApi | updateAchievement | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement TalonOne.ManagementApi | updateAdditionalCost | PUT /v1/additional_costs/{additionalCostId} | Update additional cost TalonOne.ManagementApi | updateAttribute | PUT /v1/attributes/{attributeId} | Update custom attribute TalonOne.ManagementApi | updateCampaign | PUT /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign TalonOne.ManagementApi | updateCollection | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update campaign-level collection's description TalonOne.ManagementApi | updateCoupon | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon TalonOne.ManagementApi | updateCouponBatch | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons TalonOne.ManagementApi | updateLoyaltyCard | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status TalonOne.ManagementApi | updateReferral | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral TalonOne.ManagementApi | updateRoleV2 | PUT /v2/roles/{roleId} | Update role TalonOne.ManagementApi | updateStore | PUT /v1/applications/{applicationId}/stores/{storeId} | Update store TalonOne.ManagementApi | updateUser | PUT /v1/users/{userId} | Update user
Documentation for Models
- TalonOne.APIError
- TalonOne.AcceptCouponEffectProps
- TalonOne.AcceptReferralEffectProps
- TalonOne.AccessLogEntry
- TalonOne.Account
- TalonOne.AccountAdditionalCost
- TalonOne.AccountAnalytics
- TalonOne.AccountDashboardStatistic
- TalonOne.AccountDashboardStatisticCampaigns
- TalonOne.AccountDashboardStatisticDiscount
- TalonOne.AccountDashboardStatisticLoyaltyPoints
- TalonOne.AccountDashboardStatisticReferrals
- TalonOne.AccountDashboardStatisticRevenue
- TalonOne.AccountEntity
- TalonOne.AccountLimits
- TalonOne.Achievement
- TalonOne.AchievementAdditionalProperties
- TalonOne.AchievementProgress
- TalonOne.ActivateUserRequest
- TalonOne.AddFreeItemEffectProps
- TalonOne.AddItemCatalogAction
- TalonOne.AddLoyaltyPoints
- TalonOne.AddLoyaltyPointsEffectProps
- TalonOne.AddToAudienceEffectProps
- TalonOne.AddedDeductedPointsNotificationPolicy
- TalonOne.AdditionalCampaignProperties
- TalonOne.AdditionalCost
- TalonOne.AnalyticsDataPoint
- TalonOne.AnalyticsDataPointWithTrend
- TalonOne.AnalyticsDataPointWithTrendAndInfluencedRate
- TalonOne.AnalyticsDataPointWithTrendAndUplift
- TalonOne.Application
- TalonOne.ApplicationAPIKey
- TalonOne.ApplicationAnalyticsDataPoint
- TalonOne.ApplicationApiHealth
- TalonOne.ApplicationCIF
- TalonOne.ApplicationCIFExpression
- TalonOne.ApplicationCampaignAnalytics
- TalonOne.ApplicationCampaignStats
- TalonOne.ApplicationCustomer
- TalonOne.ApplicationCustomerEntity
- TalonOne.ApplicationEntity
- TalonOne.ApplicationEvent
- TalonOne.ApplicationNotification
- TalonOne.ApplicationReferee
- TalonOne.ApplicationSession
- TalonOne.ApplicationSessionEntity
- TalonOne.ApplicationStoreEntity
- TalonOne.AsyncCouponCreationResponse
- TalonOne.AsyncCouponDeletionJobResponse
- TalonOne.Attribute
- TalonOne.AttributesMandatory
- TalonOne.AttributesSettings
- TalonOne.Audience
- TalonOne.AudienceAnalytics
- TalonOne.AudienceCustomer
- TalonOne.AudienceIntegrationID
- TalonOne.AudienceMembership
- TalonOne.AwardGiveawayEffectProps
- TalonOne.BaseCampaign
- TalonOne.BaseLoyaltyProgram
- TalonOne.BaseNotification
- TalonOne.BaseNotificationEntity
- TalonOne.BaseNotificationWebhook
- TalonOne.BaseNotifications
- TalonOne.BaseSamlConnection
- TalonOne.Binding
- TalonOne.BulkApplicationNotification
- TalonOne.BulkCampaignNotification
- TalonOne.BulkOperationOnCampaigns
- TalonOne.Campaign
- TalonOne.CampaignActivationRequest
- TalonOne.CampaignAnalytics
- TalonOne.CampaignBudget
- TalonOne.CampaignCollection
- TalonOne.CampaignCollectionEditedNotification
- TalonOne.CampaignCollectionWithoutPayload
- TalonOne.CampaignCopy
- TalonOne.CampaignCreatedNotification
- TalonOne.CampaignDeletedNotification
- TalonOne.CampaignEditedNotification
- TalonOne.CampaignEntity
- TalonOne.CampaignEvaluationGroup
- TalonOne.CampaignEvaluationPosition
- TalonOne.CampaignEvaluationTreeChangedNotification
- TalonOne.CampaignGroup
- TalonOne.CampaignGroupEntity
- TalonOne.CampaignNotification
- TalonOne.CampaignNotificationPolicy
- TalonOne.CampaignRulesetChangedNotification
- TalonOne.CampaignSearch
- TalonOne.CampaignSet
- TalonOne.CampaignSetBranchNode
- TalonOne.CampaignSetLeafNode
- TalonOne.CampaignSetNode
- TalonOne.CampaignStateChangedNotification
- TalonOne.CampaignStoreBudget
- TalonOne.CampaignTemplate
- TalonOne.CampaignTemplateCollection
- TalonOne.CampaignTemplateParams
- TalonOne.CampaignVersions
- TalonOne.CardAddedDeductedPointsNotificationPolicy
- TalonOne.CardExpiringPointsNotificationPolicy
- TalonOne.CardExpiringPointsNotificationTrigger
- TalonOne.CardLedgerPointsEntryIntegrationAPI
- TalonOne.CardLedgerTransactionLogEntry
- TalonOne.CardLedgerTransactionLogEntryIntegrationAPI
- TalonOne.CartItem
- TalonOne.Catalog
- TalonOne.CatalogAction
- TalonOne.CatalogActionFilter
- TalonOne.CatalogItem
- TalonOne.CatalogSyncRequest
- TalonOne.CatalogsStrikethroughNotificationPolicy
- TalonOne.Change
- TalonOne.ChangeLoyaltyTierLevelEffectProps
- TalonOne.ChangeProfilePassword
- TalonOne.CodeGeneratorSettings
- TalonOne.Collection
- TalonOne.CollectionItem
- TalonOne.CollectionWithoutPayload
- TalonOne.Coupon
- TalonOne.CouponConstraints
- TalonOne.CouponCreatedEffectProps
- TalonOne.CouponCreationJob
- TalonOne.CouponDeletionFilters
- TalonOne.CouponDeletionJob
- TalonOne.CouponLimitConfigs
- TalonOne.CouponRejectionReason
- TalonOne.CouponReservations
- TalonOne.CouponSearch
- TalonOne.CouponValue
- TalonOne.CouponsNotificationPolicy
- TalonOne.CreateAchievement
- TalonOne.CreateApplicationAPIKey
- TalonOne.CreateManagementKey
- TalonOne.CreateTemplateCampaign
- TalonOne.CreateTemplateCampaignResponse
- TalonOne.CustomEffect
- TalonOne.CustomEffectProps
- TalonOne.CustomerActivityReport
- TalonOne.CustomerAnalytics
- TalonOne.CustomerInventory
- TalonOne.CustomerProfile
- TalonOne.CustomerProfileAudienceRequest
- TalonOne.CustomerProfileAudienceRequestItem
- TalonOne.CustomerProfileIntegrationRequestV2
- TalonOne.CustomerProfileIntegrationResponseV2
- TalonOne.CustomerProfileSearchQuery
- TalonOne.CustomerProfileUpdateV2Response
- TalonOne.CustomerSession
- TalonOne.CustomerSessionV2
- TalonOne.DeactivateUserRequest
- TalonOne.DeductLoyaltyPoints
- TalonOne.DeductLoyaltyPointsEffectProps
- TalonOne.DeleteUserRequest
- TalonOne.Effect
- TalonOne.EffectEntity
- TalonOne.EmailEntity
- TalonOne.Endpoint
- TalonOne.Entity
- TalonOne.EntityWithTalangVisibleID
- TalonOne.Environment
- TalonOne.ErrorEffectProps
- TalonOne.ErrorResponse
- TalonOne.ErrorResponseWithStatus
- TalonOne.ErrorSource
- TalonOne.EvaluableCampaignIds
- TalonOne.Event
- TalonOne.EventType
- TalonOne.EventV2
- TalonOne.ExpiringCouponsNotificationPolicy
- TalonOne.ExpiringCouponsNotificationTrigger
- TalonOne.ExpiringPointsNotificationPolicy
- TalonOne.ExpiringPointsNotificationTrigger
- TalonOne.FeatureFlag
- TalonOne.FeaturesFeed
- TalonOne.FuncArgDef
- TalonOne.FunctionDef
- TalonOne.GenerateCampaignDescription
- TalonOne.GenerateCampaignTags
- TalonOne.GenerateItemFilterDescription
- TalonOne.GenerateLoyaltyCard
- TalonOne.GenerateRuleTitle
- TalonOne.GenerateRuleTitleRule
- TalonOne.GetIntegrationCouponRequest
- TalonOne.Giveaway
- TalonOne.GiveawaysPool
- TalonOne.IdentifiableEntity
- TalonOne.ImportEntity
- TalonOne.IncreaseAchievementProgressEffectProps
- TalonOne.InlineResponse200
- TalonOne.InlineResponse2001
- TalonOne.InlineResponse20010
- TalonOne.InlineResponse20011
- TalonOne.InlineResponse20012
- TalonOne.InlineResponse20013
- TalonOne.InlineResponse20014
- TalonOne.InlineResponse20015
- TalonOne.InlineResponse20016
- TalonOne.InlineResponse20017
- TalonOne.InlineResponse20018
- TalonOne.InlineResponse20019
- TalonOne.InlineResponse2002
- TalonOne.InlineResponse20020
- TalonOne.InlineResponse20021
- TalonOne.InlineResponse20022
- TalonOne.InlineResponse20023
- TalonOne.InlineResponse20024
- TalonOne.InlineResponse20025
- TalonOne.InlineResponse20026
- TalonOne.InlineResponse20027
- TalonOne.InlineResponse20028
- TalonOne.InlineResponse20029
- TalonOne.InlineResponse2003
- TalonOne.InlineResponse20030
- TalonOne.InlineResponse20031
- TalonOne.InlineResponse20032
- TalonOne.InlineResponse20033
- TalonOne.InlineResponse20034
- TalonOne.InlineResponse20035
- TalonOne.InlineResponse20036
- TalonOne.InlineResponse20037
- TalonOne.InlineResponse20038
- TalonOne.InlineResponse20039
- TalonOne.InlineResponse2004
- TalonOne.InlineResponse20040
- TalonOne.InlineResponse20041
- TalonOne.InlineResponse20042
- TalonOne.InlineResponse20043
- TalonOne.InlineResponse20044
- TalonOne.InlineResponse20045
- TalonOne.InlineResponse20046
- TalonOne.InlineResponse20047
- TalonOne.InlineResponse2005
- TalonOne.InlineResponse2006
- TalonOne.InlineResponse2007
- TalonOne.InlineResponse2008
- TalonOne.InlineResponse2009
- TalonOne.InlineResponse201
- TalonOne.IntegrationCoupon
- TalonOne.IntegrationCustomerSessionResponse
- TalonOne.IntegrationEntity
- TalonOne.IntegrationEvent
- TalonOne.IntegrationEventV2Request
- TalonOne.IntegrationProfileEntity
- TalonOne.IntegrationRequest
- TalonOne.IntegrationState
- TalonOne.IntegrationStateV2
- TalonOne.IntegrationStoreEntity
- TalonOne.InventoryCoupon
- TalonOne.InventoryReferral
- TalonOne.ItemAttribute
- TalonOne.LedgerEntry
- TalonOne.LedgerInfo
- TalonOne.LedgerPointsEntryIntegrationAPI
- TalonOne.LedgerTransactionLogEntryIntegrationAPI
- TalonOne.LibraryAttribute
- TalonOne.LimitConfig
- TalonOne.LimitCounter
- TalonOne.LoginParams
- TalonOne.Loyalty
- TalonOne.LoyaltyBalance
- TalonOne.LoyaltyBalanceWithTier
- TalonOne.LoyaltyBalances
- TalonOne.LoyaltyBalancesWithTiers
- TalonOne.LoyaltyCard
- TalonOne.LoyaltyCardBalances
- TalonOne.LoyaltyCardBatch
- TalonOne.LoyaltyCardBatchResponse
- TalonOne.LoyaltyCardProfileRegistration
- TalonOne.LoyaltyCardRegistration
- TalonOne.LoyaltyDashboardData
- TalonOne.LoyaltyDashboardPointsBreakdown
- TalonOne.LoyaltyLedger
- TalonOne.LoyaltyLedgerEntry
- TalonOne.LoyaltyLedgerTransactions
- TalonOne.LoyaltyMembership
- TalonOne.LoyaltyProgram
- TalonOne.LoyaltyProgramBalance
- TalonOne.LoyaltyProgramEntity
- TalonOne.LoyaltyProgramLedgers
- TalonOne.LoyaltyProgramTransaction
- TalonOne.LoyaltySubLedger
- TalonOne.LoyaltyTier
- TalonOne.ManagementKey
- TalonOne.ManagerConfig
- TalonOne.MessageLogEntries
- TalonOne.MessageLogEntry
- TalonOne.MessageLogRequest
- TalonOne.MessageLogResponse
- TalonOne.Meta
- TalonOne.ModelExport
- TalonOne.ModelImport
- TalonOne.ModelReturn
- TalonOne.MultiApplicationEntity
- TalonOne.MultipleAttribute
- TalonOne.MultipleAudiences
- TalonOne.MultipleAudiencesItem
- TalonOne.MultipleCustomerProfileIntegrationRequest
- TalonOne.MultipleCustomerProfileIntegrationRequestItem
- TalonOne.MultipleCustomerProfileIntegrationResponseV2
- TalonOne.MultipleNewAttribute
- TalonOne.MultipleNewAudiences
- TalonOne.MutableEntity
- TalonOne.NewAccount
- TalonOne.NewAccountSignUp
- TalonOne.NewAdditionalCost
- TalonOne.NewAppWideCouponDeletionJob
- TalonOne.NewApplication
- TalonOne.NewApplicationAPIKey
- TalonOne.NewApplicationCIF
- TalonOne.NewApplicationCIFExpression
- TalonOne.NewAttribute
- TalonOne.NewAudience
- TalonOne.NewBaseNotification
- TalonOne.NewCampaign
- TalonOne.NewCampaignCollection
- TalonOne.NewCampaignEvaluationGroup
- TalonOne.NewCampaignGroup
- TalonOne.NewCampaignSet
- TalonOne.NewCampaignTemplate
- TalonOne.NewCatalog
- TalonOne.NewCollection
- TalonOne.NewCouponCreationJob
- TalonOne.NewCouponDeletionJob
- TalonOne.NewCoupons
- TalonOne.NewCouponsForMultipleRecipients
- TalonOne.NewCustomEffect
- TalonOne.NewCustomerProfile
- TalonOne.NewCustomerSession
- TalonOne.NewCustomerSessionV2
- TalonOne.NewEvent
- TalonOne.NewEventType
- TalonOne.NewExternalInvitation
- TalonOne.NewGiveawaysPool
- TalonOne.NewInternalAudience
- TalonOne.NewInvitation
- TalonOne.NewInviteEmail
- TalonOne.NewLoyaltyProgram
- TalonOne.NewLoyaltyTier
- TalonOne.NewManagementKey
- TalonOne.NewMultipleAudiencesItem
- TalonOne.NewNotificationTest
- TalonOne.NewNotificationWebhook
- TalonOne.NewOutgoingIntegrationWebhook
- TalonOne.NewPassword
- TalonOne.NewPasswordEmail
- TalonOne.NewPicklist
- TalonOne.NewReferral
- [TalonOne.NewReferralsForMultipleAdvocates