@bareena/eagle-eye v0.32.0

Eagle Eye SDK

Installation

Eagle Eye SDK can be installed by running:

npm install @bareena/eagle-eye

Set up environments

You can setup your environment by provisioning following environment variables:

export EES_AUTH_CLIENT_ID="your_client_id"
export EES_AUTH_CLIENT_SECRET="your_client_secret"

export EES_API_PREFIX="/2.0"
export EES_POS_API_HOST="pos.uk.eagleeye.com"
export EES_WALLET_API_HOST="wallet.uk.eagleeye.com"
export EES_RESOURCES_API_HOST="resources.uk.eagleeye.com"

Using CLI tool to make calls

ee pos open-wallet @test/open-wallet/1.json

Making calls to Eagle Eye with SDK

The following example shows how you can make calls with Eagle Eye SDK.

$ node
> const { EagleEyePos, EagleEyeWallet } = require('@bareena/eagle-eye');

> const wallet = new EagleEyeWallet('wallet.uk.eagleeye.com', '/2.0', 'my_client_id', 'my_secret');

> const pos = new EagleEyePos('pos.uk.eagleeye.com', '/2.0', 'my_client_id', 'my_secret');

> pos.openWallet({ identity: { identityValue: '393274732' } })
... .then(data => console.log(data));

{
  wallet: {
    walletId: '42313415',
    friendlyName: 'Test Wallet',
    status: 'ACTIVE',
    type: 'MEMBER',
    state: 'EARNBURN',
    meta: { sample: 'metadata', key: 'value' },
    dateCreated: '2021-03-18T22:26:38+00:00',
    lastUpdated: '2021-03-18T22:26:38+00:00',
    relationships: null
  },
  identity: {
    ...
  },
  accounts: [],
  additionalEntities: null,
  walletTransactions: [],
  accountTransactions: [],
  analyseBasketResults: {
    basket: {
      type: 'ENRICHED',
      summary: [Object],
      contents: [Array],
      analysedDateTime: '2021-04-01T23:22:37+01:00'
    }
  },
  basketAdjudicationResult: null,
  spendAdjudicationResults: {
    pointsValue: 0,
    pointsRemainder: 0,
    monetaryValue: 0,
    operations: []
  },
  transactionCapabilities: { loyalty: { spend: true, earn: true } }
}

> wallet.getWalletAccountsByIdentityValue({
...    query: { 'identity-value': '42313415' }
... }).then(data => console.log(data));

Models

Models in the source code are defined based on swagger/openapi input. The general guidelines are:

• Models from definitions[*] are defined as named models
• Models from components.requestBodies[*] are defined as named models
• Models from components.responses[*] are defined as named models
• Inline models defined embedded inside other named models can be optionally defined as named models
• Inline composition models are defined as named models
• When choosing name for inline models, the attribute name to which it belongs should be used as the model name

Named models in POS openapi specification

Named models in Wallet swagger specification