@adobe/aio-lib-customer-profile v3.0.1

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

1) 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]')
}

2) 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

Functions

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

customerProfileAPI.getProfile(parameters) ⇒ Promise.<Response>

Get Profile by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getExperienceEvents(parameters) ⇒ Promise.<Response>

Get ExperienceEvents.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.listComputedAttributes(parameters) ⇒ Promise.<Response>

Retrieve a list of computed attributes.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.createComputedAttribute(parameters) ⇒ Promise.<Response>

Create a computed attribute.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.lookupComputedAttribute(parameters) ⇒ Promise.<Response>

Retrieve a specific computed attribute by its ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.updateComputedAttribute(parameters) ⇒ Promise.<Response>

Update a computed attribute by its ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteComputedAttribute(parameters) ⇒ Promise.<Response>

Delete a computed attribute by its ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigMergePolicies(parameters) ⇒ Promise.<Response>

Retrieve a list of merge policies.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postConfigMergePolicies(parameters) ⇒ Promise.<Response>

Create a new merge policy.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigMergePoliciesMergePolicyId(parameters) ⇒ Promise.<Response>

Lookup a merge policy by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.putConfigMergePoliciesMergePolicyId(parameters) ⇒ Promise.<Response>

Update a merge policy by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.patchConfigMergePoliciesMergePolicyId(parameters) ⇒ Promise.<Response>

Update one or more attributes of a merge policy specified by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteConfigMergePoliciesMergePolicyId(parameters) ⇒ Promise.<Response>

Delete a merge policy by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getAccessEntities(parameters) ⇒ Promise.<Response>

Lookup an entity by ID or namespace.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postAccessEntities(parameters) ⇒ Promise.<Response>

Lookup multiple entities by IDs or namespaces.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteAccessEntities(parameters) ⇒ Promise.<Response>

Delete an entity by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getScanJobsRoute(parameters) ⇒ Promise.<Response>

Retrieve a list of all export jobs.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postScanJobRoute(parameters) ⇒ Promise.<Response>

Create a new export job.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getScanJobRoute(parameters) ⇒ Promise.<Response>

Lookup an export job by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.cancelScanJobRoute(parameters) ⇒ Promise.<Response>

Cancel or delete an export job by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSegmentsRoute(parameters) ⇒ Promise.<Response>

Retrieve a list of segment definitions.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postSegmentRoute(parameters) ⇒ Promise.<Response>

Create a new segment definition.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSegmentRoute(parameters) ⇒ Promise.<Response>

Lookup a segment definition by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteSegmentRoute(parameters) ⇒ Promise.<Response>

Delete a segment definition by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.patchSegmentRoute(parameters) ⇒ Promise.<Response>

Overwrite a segment definition.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postSegmentConversionRoute(parameters) ⇒ Promise.<Response>

Convert PQL formatting between pql/text and pql/json.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSegmentJobs(parameters) ⇒ Promise.<Response>

Retrieve a list of all segment job requests.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postSJRRoute(parameters) ⇒ Promise.<Response>

Create a new segment job request.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSegmentJobsSegmentJobId(parameters) ⇒ Promise.<Response>

Lookup a segment job request by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteSegmentJobsSegmentJobId(parameters) ⇒ Promise.<Response>

Cancel or delete a segment job request by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postSessionlessPreviewRoute(parameters) ⇒ Promise.<Response>

Create a new preview job.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSessionlessPreviewStatusRoute(parameters) ⇒ Promise.<Response>

Lookup the results of a preview job by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteSessionLessPreviewStatusRoute(parameters) ⇒ Promise.<Response>

Cancel or delete a preview job by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getEstimateStatusRoute(parameters) ⇒ Promise.<Response>

Lookup the results of an estimate job by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.listProjectionConfigurations(parameters) ⇒ Promise.<Response>

Retrieve a list of edge projection configurations. The latest definitions are returned.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.createProjectionConfiguration(parameters) ⇒ Promise.<Response>

Create a new edge projection configuration.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getProjectionConfiguration(parameters) ⇒ Promise.<Response>

Lookup an edge projection configuration by ID. The latest definition is returned.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.updateProjectionConfiguration(parameters) ⇒ Promise.<Response>

Create or update an edge projection configuration by ID. Overwrites the entire configuration.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteProjectionConfiguration(parameters) ⇒ Promise.<Response>

Delete an edge projection configuration by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.listProjectionDestinations(parameters) ⇒ Promise.<Response>

Retrieve a list of edge projection destinations. The latest definitions are returned.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.createProjectionDestination(parameters) ⇒ Promise.<Response>

Create a new edge projection destination.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getProjectionDestination(parameters) ⇒ Promise.<Response>

Lookup an edge projection destination by ID. The latest definition is returned.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.putProjectionDestination(parameters) ⇒ Promise.<Response>

Create or update an edge projection destination by ID. Overwrites the entire configuration.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteProjectionDestination(parameters) ⇒ Promise.<Response>

Delete an edge projection destination by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigEventTypes(parameters) ⇒ Promise.<Response>

Retrieve a list of event types.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postConfigEventTypes(parameters) ⇒ Promise.<Response>

Create a new event type.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigEventTypesEventTypeId(parameters) ⇒ Promise.<Response>

Lookup an event type by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.putConfigEventTypesEventTypeId(parameters) ⇒ Promise.<Response>

Overwrite an event type by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.patchConfigEventTypesEventTypeId(parameters) ⇒ Promise.<Response>

Update one or more attributes of an event type by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteConfigEventTypesEventTypeId(parameters) ⇒ Promise.<Response>

Delete an event type by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigMacros(parameters) ⇒ Promise.<Response>

Retrieve a list of all macros for your organization.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.postConfigMacros(parameters) ⇒ Promise.<Response>

Create a new macro.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getConfigMacrosMacroId(parameters) ⇒ Promise.<Response>

Lookup a macro by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.putConfigMacrosMacroId(parameters) ⇒ Promise.<Response>

Overwrite a macro by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.patchConfigMacrosMacroId(parameters) ⇒ Promise.<Response>

Update a macro by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteConfigMacrosMacroId(parameters) ⇒ Promise.<Response>

Delete a macro by ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getSchedules(parameters) ⇒ Promise.<Response>

Retrieve a list of schedules for your IMS Org

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.createSchedule(parameters) ⇒ Promise.<Response>

Create a schedule, including specifying the time when the schedule should be triggered.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.getScheduleById(parameters) ⇒ Promise.<Response>

Lookup a schedule by its ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.updateSchedule(parameters) ⇒ Promise.<Response>

Update a schedule, including changing the trigger time or enabling/disabling the schedule.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.deleteSchedule(parameters) ⇒ Promise.<Response>

Delete a schedule by its ID.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

customerProfileAPI.listDeleteRequests(parameters) ⇒ Promise.<Response>

Retrieve a list of all delete requests (Profile System Jobs) created by your organization.

Kind: instance method of CustomerProfileAPI
Returns: Promise.<Response> - the response

| [parameters.sta