1.0.0 • Published 4 years ago

zapper.sdk.triggercode v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

TriggerCode Consumer

Create Consumer

var consumer = new TriggerCodeConsumer('localhost:5001')

Get TriggerCodeValue

For a given TriggerCode (GUID), the TriggerCodeValue can be obtained as follows:

var triggerCodeValue = consumer.GetValue({TriggerCode: "GUID-ABC-DEF-..."})

Receive TriggerCodeValue events

consumer.OnTriggerCodeValue((tcv: TriggerCodeValue) => {
	console.log(`received triggerCodeValue: ${tcv.Value}`)
})

TriggerCode Provider

CreateTriggerCode Provider

var provider = new TriggerCodeProvider('localhost:5001')

Creating TriggerCode Config/Mapping

A TriggerCode can be configured/mapped to a specified origin and originReference as follows:

provider.SetConfig({
	Origin: "invoice.api",
	ExpiryOffsetMinutes: 5,
	OriginReference: `${merchantId}-${siteId}`,
	TriggerCode: "XYZ-ABC-DEF-GUID"
})

Setting the TriggerCode value

The Invoice Service is an example of a TriggerCode provider. The Invoice Service will set the TriggerCodeValue's value to the zappercode string as follows:

var zapperCode = 'http://6.zap.pe/...'
var originReference = `${merchantId}-${siteId}`

provider.SetValueByOriginReference({ Origin: "invoice.api", OriginReference: `${originReference}`, Value: zapperCode })