Adobe I/O Adobe Experience Platform Realtime Customer Profile SDK

Node JavaScript SDK wrapping the Adobe Experience Platform Realtime Customer Profile API

Installing

$ npm install @adobe/aio-lib-customer-profile

Usage

Initialize the SDK

const sdk = require('@adobe/aio-lib-customer-profile')

async function sdkTest() {
  //initialize sdk
  const client = await sdk.init('<tenant>', '<iMSOrgId>', 'x-api-key', '<valid auth token>', '[sandbox]')
}

Call methods using the initialized SDK

const sdk = require('@adobe/aio-lib-customer-profile')

async function sdkTest() {
  // initialize sdk
  const client = await sdk.init('<tenant>', '<iMSOrgId>', 'x-api-key', '<valid auth token>', '[sandbox]')

  // call methods
  try {
    // get profiles by custom filters
    const result = await client.getSegmentRoute({
        segmentId: 'abc123'
    })
    console.log(result)

  } catch (e) {
    console.error(e)
  }
}

Classes

CustomerProfileAPI: This class provides methods to call your CustomerProfileAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid values for tenantId, apiKey and accessToken
OpenApi: Create dynamic methods from openApi spec file

Functions

init(tenantId, iMSOrgId, apiKey, accessToken, [sandbox]) ⇒ Promise.<CustomerProfileAPI>: Returns a Promise that resolves with a new CustomerProfileAPI object.

CustomerProfileAPI

This class provides methods to call your CustomerProfileAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid values for tenantId, apiKey and accessToken

Kind: global class

CustomerProfileAPI
- .tenantId : string
- .iMSOrgId : string
- .apiKey : string
- .accessToken : string
- .sandbox : string
- .init(tenantId, iMSOrgId, apiKey, accessToken, [sandbox]) ⇒ Promise.<CustomerProfileAPI>
- .getProfile([parameters]) ⇒ Promise.<Response>
- .getExperienceEvents([parameters]) ⇒ Promise.<Response>
- .listComputedAttributes([parameters]) ⇒ Promise.<Response>
- .createComputedAttribute([parameters]) ⇒ Promise.<Response>
- .lookupComputedAttribute([parameters]) ⇒ Promise.<Response>
- .updateComputedAttribute([parameters]) ⇒ Promise.<Response>
- .deleteComputedAttribute([parameters]) ⇒ Promise.<Response>
- .getConfigMergePolicies([parameters]) ⇒ Promise.<Response>
- .postConfigMergePolicies([parameters]) ⇒ Promise.<Response>
- .getConfigMergePoliciesMergePolicyId([parameters]) ⇒ Promise.<Response>
- .putConfigMergePoliciesMergePolicyId([parameters]) ⇒ Promise.<Response>
- .patchConfigMergePoliciesMergePolicyId([parameters]) ⇒ Promise.<Response>
- .deleteConfigMergePoliciesMergePolicyId([parameters]) ⇒ Promise.<Response>
- .getAccessEntities([parameters]) ⇒ Promise.<Response>
- .postAccessEntities([parameters]) ⇒ Promise.<Response>
- .deleteAccessEntities([parameters]) ⇒ Promise.<Response>
- .getScanJobsRoute([parameters]) ⇒ Promise.<Response>
- .postScanJobRoute([parameters]) ⇒ Promise.<Response>
- .getScanJobRoute([parameters]) ⇒ Promise.<Response>
- .cancelScanJobRoute([parameters]) ⇒ Promise.<Response>
- .getSegmentsRoute([parameters]) ⇒ Promise.<Response>
- .postSegmentRoute([parameters]) ⇒ Promise.<Response>
- .getSegmentRoute([parameters]) ⇒ Promise.<Response>
- .deleteSegmentRoute([parameters]) ⇒ Promise.<Response>
- .patchSegmentRoute([parameters]) ⇒ Promise.<Response>
- .postSegmentConversionRoute([parameters]) ⇒ Promise.<Response>
- .getSegmentJobs([parameters]) ⇒ Promise.<Response>
- .postSJRRoute([parameters]) ⇒ Promise.<Response>
- .getSegmentJobsSegmentJobId([parameters]) ⇒ Promise.<Response>
- .deleteSegmentJobsSegmentJobId([parameters]) ⇒ Promise.<Response>
- .postSessionlessPreviewRoute([parameters]) ⇒ Promise.<Response>
- .getSessionlessPreviewStatusRoute([parameters]) ⇒ Promise.<Response>
- .deleteSessionLessPreviewStatusRoute([parameters]) ⇒ Promise.<Response>
- .getEstimateStatusRoute([parameters]) ⇒ Promise.<Response>
- .listProjectionConfigurations([parameters]) ⇒ Promise.<Response>
- .createProjectionConfiguration([parameters]) ⇒ Promise.<Response>
- .getProjectionConfiguration([parameters]) ⇒ Promise.<Response>
- .updateProjectionConfiguration([parameters]) ⇒ Promise.<Response>
- .deleteProjectionConfiguration([parameters]) ⇒ Promise.<Response>
- .listProjectionDestinations([parameters]) ⇒ Promise.<Response>
- .createProjectionDestination([parameters]) ⇒ Promise.<Response>
- .getProjectionDestination([parameters]) ⇒ Promise.<Response>
- .putProjectionDestination([parameters]) ⇒ Promise.<Response>
- .deleteProjectionDestination([parameters]) ⇒ Promise.<Response>
- .getConfigEventTypes([parameters]) ⇒ Promise.<Response>
- .postConfigEventTypes([parameters]) ⇒ Promise.<Response>
- .getConfigEventTypesEventTypeId([parameters]) ⇒ Promise.<Response>
- .putConfigEventTypesEventTypeId([parameters]) ⇒ Promise.<Response>
- .patchConfigEventTypesEventTypeId([parameters]) ⇒ Promise.<Response>
- .deleteConfigEventTypesEventTypeId([parameters]) ⇒ Promise.<Response>
- .getConfigMacros([parameters]) ⇒ Promise.<Response>
- .postConfigMacros([parameters]) ⇒ Promise.<Response>
- .getConfigMacrosMacroId([parameters]) ⇒ Promise.<Response>
- .putConfigMacrosMacroId([parameters]) ⇒ Promise.<Response>
- .patchConfigMacrosMacroId([parameters]) ⇒ Promise.<Response>
- .deleteConfigMacrosMacroId([parameters]) ⇒ Promise.<Response>
- .getSchedules([parameters]) ⇒ Promise.<Response>
- .createSchedule([parameters]) ⇒ Promise.<Response>
- .getScheduleById([parameters]) ⇒ Promise.<Response>
- .updateSchedule([parameters]) ⇒ Promise.<Response>
- .deleteSchedule([parameters]) ⇒ Promise.<Response>
- .listDeleteRequests([parameters]) ⇒ Promise.<Response>
- .createDeleteRequest([parameters]) ⇒ Promise.<Response>
- .viewDeleteRequest([parameters]) ⇒ Promise.<Response>
- .deleteDeleteRequest([parameters]) ⇒ Promise.<Response>

customerProfileAPI.tenantId : `string`

The tenant id

Kind: instance property of CustomerProfileAPI

customerProfileAPI.iMSOrgId : `string`

The iMSOrgId

Kind: instance property of CustomerProfileAPI

customerProfileAPI.apiKey : `string`

The api key from your integration

Kind: instance property of CustomerProfileAPI

customerProfileAPI.accessToken : `string`

The access token from your integration

Kind: instance property of CustomerProfileAPI

customerProfileAPI.sandbox : `string`

The sandbox name

Kind: instance property of CustomerProfileAPI

customerProfileAPI.init(tenantId, iMSOrgId, apiKey, accessToken, [sandbox]) ⇒ `Promise.<CustomerProfileAPI>`

Initializes a CustomerProfileAPI object and returns it.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<CustomerProfileAPI> - a CustomerProfileAPI object

Param	Type	Description
tenantId	`string`	the tenant id
iMSOrgId	`string`	the iMSOrgId for your integration
apiKey	`string`	the API key for your integration
accessToken	`string`	the access token for your integration
[sandbox]	`string`	sandbox name