6.0.1 • Published 1 month ago

talon_one v6.0.1

Weekly downloads
2,913
License
MIT
Repository
github
Last release
1 month ago

talon_one

TalonOne - JavaScript client for talon_one Use the Talon.One API to integrate with your application and 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: 6.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
            // ...
            break
          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

ClassMethodHTTP requestDescription
TalonOne.IntegrationApicreateAudienceV2POST /v2/audiencesCreate audience
TalonOne.IntegrationApicreateCouponReservationPOST /v1/coupon_reservations/{couponValue}Create coupon reservation
TalonOne.IntegrationApicreateReferralPOST /v1/referralsCreate referral code for an advocate
TalonOne.IntegrationApicreateReferralsForMultipleAdvocatesPOST /v1/referrals_for_multiple_advocatesCreate referral codes for multiple advocates
TalonOne.IntegrationApideleteAudienceMembershipsV2DELETE /v2/audiences/{audienceId}/membershipsDelete audience memberships
TalonOne.IntegrationApideleteAudienceV2DELETE /v2/audiences/{audienceId}Delete audience
TalonOne.IntegrationApideleteCouponReservationDELETE /v1/coupon_reservations/{couponValue}Delete coupon reservations
TalonOne.IntegrationApideleteCustomerDataDELETE /v1/customer_data/{integrationId}Delete customer's personal data
TalonOne.IntegrationApigetCustomerInventoryGET /v1/customer_profiles/{integrationId}/inventoryList customer data
TalonOne.IntegrationApigetCustomerSessionGET /v2/customer_sessions/{customerSessionId}Get customer session
TalonOne.IntegrationApigetLoyaltyBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balancesGet customer's loyalty points
TalonOne.IntegrationApigetLoyaltyCardBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balancesGet card's point balances
TalonOne.IntegrationApigetLoyaltyCardPointsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/pointsList card's unused loyalty points
TalonOne.IntegrationApigetLoyaltyCardTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactionsList card's transactions
TalonOne.IntegrationApigetLoyaltyProgramProfilePointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/pointsList customer's unused loyalty points
TalonOne.IntegrationApigetLoyaltyProgramProfileTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactionsList customer's loyalty transactions
TalonOne.IntegrationApigetReservedCustomersGET /v1/coupon_reservations/customerprofiles/{couponValue}List customers that have this coupon reserved
TalonOne.IntegrationApilinkLoyaltyCardToProfilePOST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profileLink customer profile to card
TalonOne.IntegrationApireopenCustomerSessionPUT /v2/customer_sessions/{customerSessionId}/reopenReopen customer session
TalonOne.IntegrationApireturnCartItemsPOST /v2/customer_sessions/{customerSessionId}/returnsReturn cart items
TalonOne.IntegrationApisyncCatalogPUT /v1/catalogs/{catalogId}/syncSync cart item catalog
TalonOne.IntegrationApitrackEventV2POST /v2/eventsTrack event
TalonOne.IntegrationApiupdateAudienceCustomersAttributesPUT /v2/audience_customers/{audienceId}/attributesUpdate profile attributes for all customers in audience
TalonOne.IntegrationApiupdateAudienceV2PUT /v2/audiences/{audienceId}Update audience name
TalonOne.IntegrationApiupdateCustomerProfileAudiencesPOST /v2/customer_audiencesUpdate multiple customer profiles' audiences
TalonOne.IntegrationApiupdateCustomerProfileV2PUT /v2/customer_profiles/{integrationId}Update customer profile
TalonOne.IntegrationApiupdateCustomerProfilesV2PUT /v2/customer_profilesUpdate multiple customer profiles
TalonOne.IntegrationApiupdateCustomerSessionV2PUT /v2/customer_sessions/{customerSessionId}Update customer session
TalonOne.ManagementApiaddLoyaltyCardPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_pointsAdd points to card
TalonOne.ManagementApiaddLoyaltyPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_pointsAdd points to customer profile
TalonOne.ManagementApicopyCampaignToApplicationsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/copyCopy the campaign into the specified Application
TalonOne.ManagementApicreateAccountCollectionPOST /v1/collectionsCreate account-level collection
TalonOne.ManagementApicreateAdditionalCostPOST /v1/additional_costsCreate additional cost
TalonOne.ManagementApicreateAttributePOST /v1/attributesCreate custom attribute
TalonOne.ManagementApicreateCampaignFromTemplatePOST /v1/applications/{applicationId}/create_campaign_from_templateCreate campaign from campaign template
TalonOne.ManagementApicreateCollectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsCreate campaign-level collection
TalonOne.ManagementApicreateCouponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/couponsCreate coupons
TalonOne.ManagementApicreateCouponsAsyncPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_asyncCreate coupons asynchronously
TalonOne.ManagementApicreateCouponsForMultipleRecipientsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipientsCreate coupons for multiple recipients
TalonOne.ManagementApicreatePasswordRecoveryEmailPOST /v1/password_recovery_emailsRequest a password reset
TalonOne.ManagementApicreateSessionPOST /v1/sessionsCreate session
TalonOne.ManagementApicreateStorePOST /v1/applications/{applicationId}/storesCreate store
TalonOne.ManagementApideductLoyaltyCardPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_pointsDeduct points from card
TalonOne.ManagementApideleteAccountCollectionDELETE /v1/collections/{collectionId}Delete account-level collection
TalonOne.ManagementApideleteCampaignDELETE /v1/applications/{applicationId}/campaigns/{campaignId}Delete campaign
TalonOne.ManagementApideleteCollectionDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Delete campaign-level collection
TalonOne.ManagementApideleteCouponDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Delete coupon
TalonOne.ManagementApideleteCouponsDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/couponsDelete coupons
TalonOne.ManagementApideleteLoyaltyCardDELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Delete loyalty card
TalonOne.ManagementApideleteReferralDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Delete referral
TalonOne.ManagementApideleteStoreDELETE /v1/applications/{applicationId}/stores/{storeId}Delete store
TalonOne.ManagementApidestroySessionDELETE /v1/sessionsDestroy session
TalonOne.ManagementApiexportAccountCollectionItemsGET /v1/collections/{collectionId}/exportExport account-level collection's items
TalonOne.ManagementApiexportCollectionItemsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/exportExport campaign-level collection's items
TalonOne.ManagementApiexportCouponsGET /v1/applications/{applicationId}/export_couponsExport coupons
TalonOne.ManagementApiexportCustomerSessionsGET /v1/applications/{applicationId}/export_customer_sessionsExport customer sessions
TalonOne.ManagementApiexportCustomersTiersGET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiersExport customers' tier data
TalonOne.ManagementApiexportEffectsGET /v1/applications/{applicationId}/export_effectsExport triggered effects
TalonOne.ManagementApiexportLoyaltyBalanceGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balanceExport customer loyalty balance to CSV
TalonOne.ManagementApiexportLoyaltyBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balancesExport customer loyalty balances
TalonOne.ManagementApiexportLoyaltyCardBalancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balancesExport all card transaction logs
TalonOne.ManagementApiexportLoyaltyCardLedgerGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_logExport card's ledger log
TalonOne.ManagementApiexportLoyaltyLedgerGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_logExport customer's transaction logs
TalonOne.ManagementApiexportPoolGiveawaysGET /v1/giveaways/pools/{poolId}/exportExport giveaway codes of a giveaway pool
TalonOne.ManagementApiexportReferralsGET /v1/applications/{applicationId}/export_referralsExport referrals
TalonOne.ManagementApigetAccessLogsWithoutTotalCountGET /v1/applications/{applicationId}/access_logs/no_totalGet access logs for Application
TalonOne.ManagementApigetAccountGET /v1/accounts/{accountId}Get account details
TalonOne.ManagementApigetAccountAnalyticsGET /v1/accounts/{accountId}/analyticsGet account analytics
TalonOne.ManagementApigetAccountCollectionGET /v1/collections/{collectionId}Get account-level collection
TalonOne.ManagementApigetAdditionalCostGET /v1/additional_costs/{additionalCostId}Get additional cost
TalonOne.ManagementApigetAdditionalCostsGET /v1/additional_costsList additional costs
TalonOne.ManagementApigetAllAccessLogsGET /v1/access_logsList access logs
TalonOne.ManagementApigetAllRolesGET /v1/rolesList roles
TalonOne.ManagementApigetApplicationGET /v1/applications/{applicationId}Get Application
TalonOne.ManagementApigetApplicationApiHealthGET /v1/applications/{applicationId}/health_reportGet Application health
TalonOne.ManagementApigetApplicationCustomerGET /v1/applications/{applicationId}/customers/{customerId}Get application's customer
TalonOne.ManagementApigetApplicationCustomerFriendsGET /v1/applications/{applicationId}/profile/{integrationId}/friendsList friends referred by customer profile
TalonOne.ManagementApigetApplicationCustomersGET /v1/applications/{applicationId}/customersList application's customers
TalonOne.ManagementApigetApplicationCustomersByAttributesPOST /v1/applications/{applicationId}/customer_searchList application customers matching the given attributes
TalonOne.ManagementApigetApplicationEventTypesGET /v1/applications/{applicationId}/event_typesList Applications event types
TalonOne.ManagementApigetApplicationEventsWithoutTotalCountGET /v1/applications/{applicationId}/events/no_totalList Applications events
TalonOne.ManagementApigetApplicationSessionGET /v1/applications/{applicationId}/sessions/{sessionId}Get Application session
TalonOne.ManagementApigetApplicationSessionsGET /v1/applications/{applicationId}/sessionsList Application sessions
TalonOne.ManagementApigetApplicationsGET /v1/applicationsList Applications
TalonOne.ManagementApigetAttributeGET /v1/attributes/{attributeId}Get custom attribute
TalonOne.ManagementApigetAttributesGET /v1/attributesList custom attributes
TalonOne.ManagementApigetAudiencesGET /v1/audiencesList audiences
TalonOne.ManagementApigetCampaignGET /v1/applications/{applicationId}/campaigns/{campaignId}Get campaign
TalonOne.ManagementApigetCampaignAnalyticsGET /v1/applications/{applicationId}/campaigns/{campaignId}/analyticsGet analytics of campaigns
TalonOne.ManagementApigetCampaignByAttributesPOST /v1/applications/{applicationId}/campaigns_searchList campaigns that match the given attributes
TalonOne.ManagementApigetCampaignTemplatesGET /v1/campaign_templatesList campaign templates
TalonOne.ManagementApigetCampaignsGET /v1/applications/{applicationId}/campaignsList campaigns
TalonOne.ManagementApigetChangesGET /v1/changesGet audit logs for an account
TalonOne.ManagementApigetCollectionGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Get campaign-level collection
TalonOne.ManagementApigetCollectionItemsGET /v1/collections/{collectionId}/itemsGet collection items
TalonOne.ManagementApigetCouponsWithoutTotalCountGET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_totalList coupons
TalonOne.ManagementApigetCustomerActivityReportGET /v1/applications/{applicationId}/customer_activity_reports/{customerId}Get customer's activity report
TalonOne.ManagementApigetCustomerActivityReportsWithoutTotalCountGET /v1/applications/{applicationId}/customer_activity_reports/no_totalGet Activity Reports for Application Customers
TalonOne.ManagementApigetCustomerAnalyticsGET /v1/applications/{applicationId}/customers/{customerId}/analyticsGet customer's analytics report
TalonOne.ManagementApigetCustomerProfileGET /v1/customers/{customerId}Get customer profile
TalonOne.ManagementApigetCustomerProfilesGET /v1/customers/no_totalList customer profiles
TalonOne.ManagementApigetCustomersByAttributesPOST /v1/customer_search/no_totalList customer profiles matching the given attributes
TalonOne.ManagementApigetEventTypesGET /v1/event_typesList event types
TalonOne.ManagementApigetExportsGET /v1/exportsGet exports
TalonOne.ManagementApigetLoyaltyCardGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Get loyalty card
TalonOne.ManagementApigetLoyaltyCardTransactionLogsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logsList card's transactions
TalonOne.ManagementApigetLoyaltyCardsGET /v1/loyalty_programs/{loyaltyProgramId}/cardsList loyalty cards
TalonOne.ManagementApigetLoyaltyPointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}Get customer's full loyalty ledger
TalonOne.ManagementApigetLoyaltyProgramGET /v1/loyalty_programs/{loyaltyProgramId}Get loyalty program
TalonOne.ManagementApigetLoyaltyProgramTransactionsGET /v1/loyalty_programs/{loyaltyProgramId}/transactionsList loyalty program transactions
TalonOne.ManagementApigetLoyaltyProgramsGET /v1/loyalty_programsList loyalty programs
TalonOne.ManagementApigetLoyaltyStatisticsGET /v1/loyalty_programs/{loyaltyProgramId}/statisticsGet loyalty program statistics
TalonOne.ManagementApigetReferralsWithoutTotalCountGET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_totalList referrals
TalonOne.ManagementApigetRoleGET /v1/roles/{roleId}Get role
TalonOne.ManagementApigetRulesetGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}Get ruleset
TalonOne.ManagementApigetRulesetsGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesetsList campaign rulesets
TalonOne.ManagementApigetStoreGET /v1/applications/{applicationId}/stores/{storeId}Get store
TalonOne.ManagementApigetUserGET /v1/users/{userId}Get user
TalonOne.ManagementApigetUsersGET /v1/usersList users in account
TalonOne.ManagementApigetWebhookGET /v1/webhooks/{webhookId}Get webhook
TalonOne.ManagementApigetWebhookActivationLogsGET /v1/webhook_activation_logsList webhook activation log entries
TalonOne.ManagementApigetWebhookLogsGET /v1/webhook_logsList webhook log entries
TalonOne.ManagementApigetWebhooksGET /v1/webhooksList webhooks
TalonOne.ManagementApiimportAccountCollectionPOST /v1/collections/{collectionId}/importImport data into existing account-level collection
TalonOne.ManagementApiimportAllowedListPOST /v1/attributes/{attributeId}/allowed_list/importImport allowed values for attribute
TalonOne.ManagementApiimportCollectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/importImport data into existing campaign-level collection
TalonOne.ManagementApiimportCouponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_couponsImport coupons
TalonOne.ManagementApiimportLoyaltyCardsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_cardsImport loyalty cards
TalonOne.ManagementApiimportLoyaltyCustomersTiersPOST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiersImport customers into loyalty tiers
TalonOne.ManagementApiimportLoyaltyPointsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_pointsImport loyalty points
TalonOne.ManagementApiimportPoolGiveawaysPOST /v1/giveaways/pools/{poolId}/importImport giveaway codes into a giveaway pool
TalonOne.ManagementApiimportReferralsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referralsImport referrals
TalonOne.ManagementApilistAccountCollectionsGET /v1/collectionsList collections in account
TalonOne.ManagementApilistCatalogItemsGET /v1/catalogs/{catalogId}/itemsList items in a catalog
TalonOne.ManagementApilistCollectionsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsList collections in campaign
TalonOne.ManagementApilistCollectionsInApplicationGET /v1/applications/{applicationId}/collectionsList collections in Application
TalonOne.ManagementApilistStoresGET /v1/applications/{applicationId}/storesList stores
TalonOne.ManagementApinotificationActivationPUT /v1/notifications/{notificationId}/activationActivate or deactivate notification
TalonOne.ManagementApipostAddedDeductedPointsNotificationPOST /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_pointsCreate notification about added or deducted loyalty points
TalonOne.ManagementApipostCatalogsStrikethroughNotificationPOST /v1/applications/{applicationId}/catalogs/notifications/strikethroughCreate strikethrough notification
TalonOne.ManagementApipostPendingPointsNotificationPOST /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_pointsCreate notification about pending loyalty points
TalonOne.ManagementApiremoveLoyaltyPointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_pointsDeduct points from customer profile
TalonOne.ManagementApiresetPasswordPOST /v1/reset_passwordReset password
TalonOne.ManagementApisearchCouponsAdvancedApplicationWideWithoutTotalCountPOST /v1/applications/{applicationId}/coupons_search_advanced/no_totalList coupons that match the given attributes (without total count)
TalonOne.ManagementApisearchCouponsAdvancedWithoutTotalCountPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_totalList coupons that match the given attributes in campaign (without total count)
TalonOne.ManagementApitransferLoyaltyCardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transferTransfer card data
TalonOne.ManagementApiupdateAccountCollectionPUT /v1/collections/{collectionId}Update account-level collection
TalonOne.ManagementApiupdateAdditionalCostPUT /v1/additional_costs/{additionalCostId}Update additional cost
TalonOne.ManagementApiupdateAttributePUT /v1/attributes/{attributeId}Update custom attribute
TalonOne.ManagementApiupdateCampaignPUT /v1/applications/{applicationId}/campaigns/{campaignId}Update campaign
TalonOne.ManagementApiupdateCollectionPUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Update campaign-level collection's description
TalonOne.ManagementApiupdateCouponPUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Update coupon
TalonOne.ManagementApiupdateCouponBatchPUT /v1/applications/{applicationId}/campaigns/{campaignId}/couponsUpdate coupons
TalonOne.ManagementApiupdateLoyaltyCardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Update loyalty card status
TalonOne.ManagementApiupdateReferralPUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Update referral
TalonOne.ManagementApiupdateStorePUT /v1/applications/{applicationId}/stores/{storeId}Update store

Documentation for Models

Documentation for Authorization

api_key_v1

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

management_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

manager_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
superagent
@infinitebrahmanuniverse/nolb-tal@everything-registry/sub-chunk-2875@flashcoffee/fctalononefctalonone
6.0.1

1 month ago

6.0.0

5 months ago

5.0.1-rc

11 months ago

5.0.0

1 year ago

4.5.0

2 years ago

4.6.0

2 years ago

4.4.0

3 years ago

4.3.0

3 years ago

4.2.0

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.0

4 years ago

3.4.0

4 years ago

3.3.0

4 years ago

3.2.0

5 years ago

3.1.2

5 years ago

3.1.1

5 years ago

3.1.0

5 years ago

3.0.0

5 years ago

2.0.0

5 years ago

1.1.0

5 years ago

1.0.1

6 years ago

1.0.0

6 years ago