Go API client for talon

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 2.2.0
Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./talon"

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Getting Started

Integration API

V2

package main

import (
	"context"
	"encoding/json"
	"fmt"

	talon "github.com/talon-one/talon_go"
)

func main() {
	configuration := talon.NewConfiguration()
	// Set API base path
	configuration.Servers = talon.ServerConfigurations{
		{
			// Notice that there is no trailing '/'
			URL:         "https://mycompany.talon.one",
			Description: "Talon.One's API base URL",
		},
	}
	// If you wish to inject a custom implementation of HTTPClient
	// configuration.HTTPClient = &customHTTPClient

	integrationClient := talon.NewAPIClient(configuration)

	// Create integration authentication context using api key
	integrationAuthContext := context.WithValue(context.Background(), talon.ContextAPIKeys, map[string]talon.APIKey{
		"Authorization": talon.APIKey{
			Prefix: "ApiKey-v1",
			Key:    "fd1fd219b1e953a6b2700e8034de5bfc877462ae106127311ddd710978654312",
		},
	})

	// Instantiating a NewCustomerSessionV2 struct
	customerSession := talon.NewCustomerSession{
		// You can use both struct literals
		ProfileId:   talon.PtrString("DEADBEEF"),
		CouponCodes: &[]string{"Cool-Stuff!"},
	}

	// Or alternatively, using the relevant setter in a later stage in the code
	newCustomerSession.SetCartItems([]talon.CartItem{
		talon.CartItem{
			Name:     "Pad Thai - Veggie",
			Sku:      "pad-332",
			Quantity: 1,
			Price:    5.5,
			Category: talon.PtrString("Noodles"),
		},
		talon.CartItem{
			Name:     "Chang",
			Sku:      "chang-br-42",
			Quantity: 1,
			Price:    2.3,
			Category: talon.PtrString("Beverages"),
		},
	})

	// Instantiating a new IntegrationRequest
	integrationRequest := talon.IntegrationRequest{
		CustomerSession: newCustomerSession,
	}

	// Optional list of requested information to be present on the response.
  // See docs/IntegrationRequest.md for full list of supported values
	// integrationRequest.SetResponseContent([]string{
	// 	"customerSession",
	// 	"customerProfile",
	// 	"loyalty",
	// })

	// Create/update a customer session using `UpdateCustomerSessionV2` function
	integrationState, _, err := integrationClient.IntegrationApi.
		UpdateCustomerSessionV2(integrationAuthContext, "deetdoot_2").
		Body(integrationRequest).
		Execute()

	if err != nil {
		fmt.Printf("ERROR while calling UpdateCustomerSessionV2: %s\n", err)
		return
	}
	fmt.Printf("%#v\n", integrationState)

	// 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
	for _, effect := range integrationState.GetEffects() {
		effectType := effect.GetEffectType()
		switch {
		case "setDiscount" == effectType:
			// Initiating right props instance according to the effect type
			effectProps := talon.SetDiscountEffectProps{}
			if err := decodeHelper(effect.GetProps(), &effectProps); err != nil {
				fmt.Printf("ERROR while decoding 'setDiscount' props: %s\n", err)
				continue
			}

			// Access the specific effect's properties
			fmt.Printf("Set a discount '%s' of %2.3f\n", effectProps.GetName(), effectProps.GetValue())
		case "acceptCoupon" == effectType:
			// Initiating right props instance according to the effect type
			effectProps := talon.AcceptCouponEffectProps{}
			if err := decodeHelper(effect.GetProps(), &effectProps); err != nil {
				fmt.Printf("ERROR while decoding props: %s\n", err)
				continue
			}

			// Work with AcceptCouponEffectProps' properties
			// ...
		default:
			fmt.Printf("Encounter unknown effect type: %s\n", effectType)
		}
	}
}

// quick decoding of props-map into our library structures using JSON marshaling,
// or alternatively using a library like https://github.com/mitchellh/mapstructure
func decodeHelper(propsMap map[string]interface{}, v interface{}) error {
	propsJSON, err := json.Marshal(propsMap)
	if err != nil {
		return err
	}
	return json.Unmarshal(propsJSON, v)
}

V1

package main

import (
	"context"
	"fmt"

	talon "github.com/talon-one/talon_go"
)

func main() {
	configuration := talon.NewConfiguration()
	// Set API base path
	configuration.Servers = talon.ServerConfigurations{
		{
			// Notice that there is no trailing '/'
			URL:         "https://mycompany.talon.one",
			Description: "Talon.One's API base URL",
		},
	}
	// If you wish to inject a custom implementation of HTTPClient
	// configuration.HTTPClient = &customHTTPClient

	integrationClient := talon.NewAPIClient(configuration)

	// Create integration authentication context using api key
	integrationAuthContext := context.WithValue(context.Background(), talon.ContextAPIKeys, map[string]talon.APIKey{
		"Authorization": talon.APIKey{
			Prefix: "ApiKey-v1",
			Key:    "fd1fd219b1e953a6b2700e8034de5bfc877462ae106127311ddd710978654312",
		},
	})

	// Instantiating a NewCustomerSession struct
	customerSession := talon.NewCustomerSession{
		// You can use both struct literals
		ProfileId: talon.PtrString("DEADBEEF"),
		State:     talon.PtrString("open"),
	}

	// Or alternatively, using the relevant setter in a later stage in the code
	customerSession.SetTotal(42.0)

	// Create/update a customer session using `UpdateCustomerSession` function
	integrationState, response, err := integrationClient.IntegrationApi.
		UpdateCustomerSession(integrationAuthContext, "deetdoot").
		Body(customerSession).
		Execute()

	if err != nil {
		fmt.Printf("ERROR while calling UpdateCustomerSession: %s\n", err)
		return
	}

	fmt.Printf("%#v\n\n", integrationState.Session)
	fmt.Printf("%#v\n\n", response)
}

Management API

package main

import (
	"context"
	"fmt"

	talon "github.com/talon-one/talon_go"
)

func main() {
	configuration := talon.NewConfiguration()
	// Set API base path
	configuration.Servers = talon.ServerConfigurations{
		{
			// Notice that there is no trailing '/'
			URL:         "https://mycompany.talon.one",
			Description: "Talon.One's API base URL",
		},
	}
	// If you wish to inject a custom implementation of HTTPClient
	// configuration.HTTPClient = &customHTTPClient

	managementClient := talon.NewAPIClient(configuration)

	session, _, err := managementClient.ManagementApi.
		CreateSession(context.Background()).
		Body(talon.LoginParams{
			Email:    "[email protected]",
			Password: "50meSecureVeryPa$$w0rd!",
		}).
		Execute()

	if err != nil {
		fmt.Printf("ERROR while creating a new session using CreateSession: %s\n", err)
		return
	}

	// Create integration authentication context using the logged-in session
	managerAuthContext := context.WithValue(context.Background(), talon.ContextAPIKeys, map[string]talon.APIKey{
		"Authorization": talon.APIKey{
			Prefix: "Bearer",
			Key:    session.GetToken(),
		},
	})

	// Calling `GetApplication` function with the desired id (7)
	application, response, err := managementClient.ManagementApi.
		GetApplication(managerAuthContext, 7).
		Execute()

	if err != nil {
		fmt.Printf("ERROR while calling GetApplication: %s\n", err)
		return
	}

	fmt.Printf("%#v\n\n", application)
	fmt.Printf("%#v\n\n", response)
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
IntegrationApi	CreateCouponReservation	Post /v1/coupon_reservations/{couponValue}	Create a new coupon reservation
IntegrationApi	CreateReferral	Post /v1/referrals	Create a referral code for an advocate
IntegrationApi	DeleteCouponReservation	Delete /v1/coupon_reservations/{couponValue}	Delete coupon reservations
IntegrationApi	DeleteCustomerData	Delete /v1/customer_data/{integrationId}	Delete the personal data of a customer.
IntegrationApi	GetCustomerInventory	Get /v1/customer_profiles/{integrationId}/inventory	Get an inventory of all data associated with a specific customer profile.
IntegrationApi	GetReservedCustomers	Get /v1/coupon_reservations/customerprofiles/{couponValue}	Get the users that have this coupon reserved
IntegrationApi	TrackEvent	Post /v1/events	Track an Event
IntegrationApi	UpdateCustomerProfile	Put /v1/customer_profiles/{integrationId}	Update a Customer Profile V1
IntegrationApi	UpdateCustomerProfileAudiences	Post /v2/customer_audiences	Update a Customer Profile Audiences
IntegrationApi	UpdateCustomerProfileV2	Put /v2/customer_profiles/{integrationId}	Update a Customer Profile
IntegrationApi	UpdateCustomerProfilesV2	Put /v2/customer_profiles	Update multiple Customer Profiles
IntegrationApi	UpdateCustomerSession	Put /v1/customer_sessions/{customerSessionId}	Update a Customer Session V1
IntegrationApi	UpdateCustomerSessionV2	Put /v2/customer_sessions/{customerSessionId}	Update a Customer Session
ManagementApi	AddLoyaltyPoints	Put /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points	Add points in a certain loyalty program for the specified customer
ManagementApi	CopyCampaignToApplications	Post /v1/applications/{applicationId}/campaigns/{campaignId}/copy	Copy the campaign into every specified application
ManagementApi	CreateAdditionalCost	Post /v1/additional_costs	Define a new additional cost
ManagementApi	CreateAttribute	Post /v1/attributes	Define a new custom attribute
ManagementApi	CreateCampaign	Post /v1/applications/{applicationId}/campaigns	Create a Campaign
ManagementApi	CreateCoupons	Post /v1/applications/{applicationId}/campaigns/{campaignId}/coupons	Create Coupons
ManagementApi	CreatePasswordRecoveryEmail	Post /v1/password_recovery_emails	Request a password reset
ManagementApi	CreateRuleset	Post /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets	Create a Ruleset
ManagementApi	CreateSession	Post /v1/sessions	Create a Session
ManagementApi	DeleteCampaign	Delete /v1/applications/{applicationId}/campaigns/{campaignId}	Delete a Campaign
ManagementApi	DeleteCoupon	Delete /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}	Delete one Coupon
ManagementApi	DeleteCoupons	Delete /v1/applications/{applicationId}/campaigns/{campaignId}/coupons	Delete Coupons
ManagementApi	DeleteReferral	Delete /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}	Delete one Referral
ManagementApi	DeleteRuleset	Delete /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}	Delete a Ruleset
ManagementApi	GetAccessLogs	Get /v1/applications/{applicationId}/access_logs	Get access logs for application (with total count)
ManagementApi	GetAccessLogsWithoutTotalCount	Get /v1/applications/{applicationId}/access_logs/no_total	Get access logs for application
ManagementApi	GetAccount	Get /v1/accounts/{accountId}	Get Account Details
ManagementApi	GetAccountAnalytics	Get /v1/accounts/{accountId}/analytics	Get Account Analytics
ManagementApi	GetAdditionalCost	Get /v1/additional_costs/{additionalCostId}	Get an additional cost
ManagementApi	GetAdditionalCosts	Get /v1/additional_costs	List additional costs
ManagementApi	GetAllAccessLogs	Get /v1/access_logs	Get all access logs
ManagementApi	GetAllRoles	Get /v1/roles	Get all roles.
ManagementApi	GetApplication	Get /v1/applications/{applicationId}	Get Application
ManagementApi	GetApplicationApiHealth	Get /v1/applications/{applicationId}/health_report	Get report of health of application API
ManagementApi	GetApplicationCustomer	Get /v1/applications/{applicationId}/customers/{customerId}	Get Application Customer
ManagementApi	GetApplicationCustomers	Get /v1/applications/{applicationId}/customers	List Application Customers
ManagementApi	GetApplicationCustomersByAttributes	Post /v1/application_customer_search	Get a list of the customer profiles that match the given attributes (with total count)
ManagementApi	GetApplicationEventTypes	Get /v1/applications/{applicationId}/event_types	List Applications Event Types
ManagementApi	GetApplicationEvents	Get /v1/applications/{applicationId}/events	List Applications Events (with total count)
ManagementApi	GetApplicationEventsWithoutTotalCount	Get /v1/applications/{applicationId}/events/no_total	List Applications Events
ManagementApi	GetApplicationSession	Get /v1/applications/{applicationId}/sessions/{sessionId}	Get Application Session
ManagementApi	GetApplicationSessions	Get /v1/applications/{applicationId}/sessions	List Application Sessions
ManagementApi	GetApplications	Get /v1/applications	List Applications
ManagementApi	GetAttribute	Get /v1/attributes/{attributeId}	Get a custom attribute
ManagementApi	GetAttributes	Get /v1/attributes	List custom attributes
ManagementApi	GetCampaign	Get /v1/applications/{applicationId}/campaigns/{campaignId}	Get a Campaign
ManagementApi	GetCampaignAnalytics	Get /v1/applications/{applicationId}/campaigns/{campaignId}/analytics	Get analytics of campaigns
ManagementApi	GetCampaignByAttributes	Post /v1/applications/{applicationId}/campaigns_search	Get a list of all campaigns that match the given attributes
ManagementApi	GetCampaigns	Get /v1/applications/{applicationId}/campaigns	List your Campaigns
ManagementApi	GetChanges	Get /v1/changes	Get audit log for an account
ManagementApi	GetCoupons	Get /v1/applications/{applicationId}/campaigns/{campaignId}/coupons	List Coupons (with total count)
ManagementApi	GetCouponsByAttributes	Post /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search	Get a list of the coupons that match the given attributes
ManagementApi	GetCouponsByAttributesApplicationWide	Post /v1/applications/{applicationId}/coupons_search	Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
ManagementApi	GetCouponsWithoutTotalCount	Get /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total	List Coupons
ManagementApi	GetCustomerActivityReport	Get /v1/applications/{applicationId}/customer_activity_reports/{customerId}	Get Activity Report for Single Customer
ManagementApi	GetCustomerActivityReports	Get /v1/applications/{applicationId}/customer_activity_reports	Get Activity Reports for Application Customers (with total count)
ManagementApi	GetCustomerActivityReportsWithoutTotalCount	Get /v1/applications/{applicationId}/customer_activity_reports/no_total	Get Activity Reports for Application Customers
ManagementApi	GetCustomerAnalytics	Get /v1/applications/{applicationId}/customers/{customerId}/analytics	Get Analytics Report for a Customer
ManagementApi	GetCustomerProfile	Get /v1/customers/{customerId}	Get Customer Profile
ManagementApi	GetCustomerProfiles	Get /v1/customers/no_total	List Customer Profiles
ManagementApi	GetCustomersByAttributes	Post /v1/customer_search/no_total	Get a list of the customer profiles that match the given attributes
ManagementApi	GetEventTypes	Get /v1/event_types	List Event Types
ManagementApi	GetExports	Get /v1/exports	Get Exports
ManagementApi	GetImports	Get /v1/imports	Get Imports
ManagementApi	GetLoyaltyPoints	Get /v1/loyalty_programs/{programID}/profile/{integrationID}	get the Loyalty Ledger for this integrationID
ManagementApi	GetLoyaltyProgram	Get /v1/loyalty_programs/{programID}	Get a loyalty program
ManagementApi	GetLoyaltyPrograms	Get /v1/loyalty_programs	List all loyalty Programs
ManagementApi	GetLoyaltyStatistics	Get /v1/loyalty_programs/{programID}/statistics	Get loyalty program statistics by loyalty program ID
ManagementApi	GetReferrals	Get /v1/applications/{applicationId}/campaigns/{campaignId}/referrals	List Referrals (with total count)
ManagementApi	GetReferralsWithoutTotalCount	Get /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total	List Referrals
ManagementApi	GetRole	Get /v1/roles/{roleId}	Get information for the specified role.
ManagementApi	GetRuleset	Get /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}	Get a Ruleset
ManagementApi	GetRulesets	Get /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets	List Campaign Rulesets
ManagementApi	GetUser	Get /v1/users/{userId}	Get a single User
ManagementApi	GetUsers	Get /v1/users	List Users in your account
ManagementApi	GetWebhook	Get /v1/webhooks/{webhookId}	Get Webhook
ManagementApi	GetWebhookActivationLogs	Get /v1/webhook_activation_logs	List Webhook activation Log Entries
ManagementApi	GetWebhookLogs	Get /v1/webhook_logs	List Webhook Log Entries
ManagementApi	GetWebhooks	Get /v1/webhooks	List Webhooks
ManagementApi	RemoveLoyaltyPoints	Put /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points	Deduct points in a certain loyalty program for the specified customer
ManagementApi	ResetPassword	Post /v1/reset_password	Reset password
ManagementApi	SearchCouponsAdvanced	Post /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced	Get a list of the coupons that match the given attributes (with total count)
ManagementApi	SearchCouponsAdvancedApplicationWide	Post /v1/applications/{applicationId}/coupons_search_advanced	Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
ManagementApi	SearchCouponsAdvancedApplicationWideWithoutTotalCount	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
ManagementApi	SearchCouponsAdvancedWithoutTotalCount	Post /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total	Get a list of the coupons that match the given attributes
ManagementApi	UpdateAdditionalCost	Put /v1/additional_costs/{additionalCostId}	Update an additional cost
ManagementApi	UpdateAttribute	Put /v1/attributes/{attributeId}	Update a custom attribute
ManagementApi	UpdateCampaign	Put /v1/applications/{applicationId}/campaigns/{campaignId}	Update a Campaign
ManagementApi	UpdateCoupon	Put /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}	Update a Coupon
ManagementApi	UpdateCouponBatch	Put /v1/applications/{applicationId}/campaigns/{campaignId}/coupons	Update a Batch of Coupons
ManagementApi	UpdateRuleset	Put /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}	Update a Ruleset

Documentation For Models

Documentation For Authorization

api_key_v1

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

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

integration_auth

Type: API key
API key parameter name: Content-Signature
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Content-Signature and passed in as the auth context for each request.

manager_auth

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