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

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

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

Get Profile by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass |

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

Get ExperienceEvents.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass |

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

Retrieve a list of computed attributes.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass |

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

Create a computed attribute.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass |

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

Retrieve a specific computed attribute by its ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.ATTRIBUTE_ID | string | | The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created. |

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

Update a computed attribute by its ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.ATTRIBUTE_ID | string | | The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created. |

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

Delete a computed attribute by its ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.ATTRIBUTE_ID | string | | The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created. |

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

Retrieve a list of merge policies.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Request Id | | [parameters.start] | string | | Page offset - As per created time of resource | | [parameters.limit] | number | | Page Size | | [parameters.orderBy] | string | | Model attribute which will be using for ordering | | [parameters.'schema.name'] | string | | Schema class ID | | [parameters.default] | boolean | | default flag |

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

Create a new merge policy.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request Id |

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

Lookup a merge policy by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.mergePolicyId | string | | Merge policy ID. | | [parameters.'x-request-id'] | string | | Request Id |

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

Update a merge policy by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.mergePolicyId | string | | Merge policy ID. | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request Id |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.mergePolicyId | string | | Merge policy ID. | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request Id |

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

Delete a merge policy by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.mergePolicyId | string | | Merge policy ID. | | [parameters.'x-request-id'] | string | | Request Id |

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

Lookup an entity by ID or namespace.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'schema.name' | string | | XED schema class name. | | [parameters.'relatedSchema.name'] | string | | XDM schema class name that the ExperienceEvent is associated with. Used when looking up ExperienceEvents. | | [parameters.entityId] | string | | ID of the entity. For Native XID lookup, use entityId=<XID> and leave entityIdNS absent; For ID:NS lookup, use both entityId and entityIdNS fields. | | [parameters.entityIdNS] | string | | Identity Namespace code. Used for ID:NS lookup. If this field is used, entityId cannot be empty. | | [parameters.relatedEntityId] | string | | ID of the entity that the ExperienceEvents are associated with. Used when looking up ExperienceEvents. For Native XID lookup, use relatedEntityId=<XID> and leave relatedEntityIdNS absent; For ID:NS lookup, use both relatedEntityId and relatedEntityIdNS fields. | | [parameters.relatedEntityIdNS] | string | | Identity Namespace code of the related entity ID of ExperienceEvent. Used when looking up ExperienceEvents. If this field is used, entityId cannot be empty. | | [parameters.fields] | string | | Fields for the model object. By default, all fields will be fetched. Separated by comma. | | [parameters.mergePolicyId] | string | | ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used. | | [parameters.startTime] | number | | Start time of Time range filter for ExperienceEvents. Should be at millisecond granularity. Included. Default: From beginning. | | [parameters.endTime] | number | | End time of Time range filter for ExperienceEvents. Should be at millisecond granularity. Excluded. Default: To the end. | | [parameters.limit] | number | | Number of records to return from the result. Only for time-series objects. Default: 1000 | | [parameters.orderby] | string | | The sort order of retrieved ExperienceEvents by timestamp. Syntax: (+/-)timestamp. Default: +timestamp |

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

Lookup multiple entities by IDs or namespaces.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. |

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

Delete an entity by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'schema.name' | string | | Name of the associated XDM schema. | | [parameters.entityId] | string | | ID of the entity. For Native XID, use entityId=<XID> and leave entityIdNS absent; For ID:NS, use both entityId and entityIdNS fields. | | [parameters.entityIdNS] | string | | Identity Namespace code. Used for ID:NS. If this field is used, entityId cannot be empty. | | [parameters.mergePolicyId] | string | | ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used. |

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

Retrieve a list of all export jobs.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.limit] | number | | Limit the number of export jobs returned in the list. | | [parameters.offset] | string | | Offset the page of results returned (ordered by created time of resource) | | [parameters.status] | string | | Filter the export jobs returned by job status. Possible values are "NEW", "SUCCEEDED", and "FAILED". |

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

Create a new export job.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | [parameters.'x-profile-instance-id'] | string | | Profile Instance ID |

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

Lookup an export job by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.exportJobId | string | | Export job ID |

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

Cancel or delete an export job by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.exportJobId | string | | Export job ID |

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

Retrieve a list of segment definitions.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'x-request-id' | string | | Unique ID per request | | [parameters.start] | number | | Page offset - As per created time of resource | | [parameters.limit] | number | | Page size | | [parameters.page] | number | | Page number | | [parameters.sort] | string | | Sort parameters |

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

Create a new segment definition.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | parameters.'x-request-id' | string | | Unique ID per request |

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

Lookup a segment definition by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.segmentId | string | | Segment Definition ID. | | parameters.'x-request-id' | string | | Unique ID per request |

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

Delete a segment definition by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.segmentId | string | | Segment Definition ID. | | parameters.'x-request-id' | string | | Unique ID per request |

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

Overwrite a segment definition.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.segmentId | string | | Segment Definition ID. | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | parameters.'x-request-id' | string | | Unique ID per request |

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

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

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | parameters.'x-request-id' | string | | Unique ID per request |

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

Retrieve a list of all segment job requests.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Request ID | | [parameters.start] | number | | Page Offset - As per created Time of resource | | [parameters.limit] | number | | Page Size | | [parameters.status] | string | | The job status |

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

Create a new segment job request.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request ID |

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

Lookup a segment job request by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.segmentJobId | string | | Segment job request ID. | | [parameters.'x-request-id'] | string | | Request ID |

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

Cancel or delete a segment job request by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.segmentJobId | string | | Segment job request ID. | | [parameters.'x-request-id'] | string | | Request ID |

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

Create a new preview job.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. |

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

Lookup the results of a preview job by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.previewId | string | | ID of the preview job. | | [parameters.offset] | string | | Page offset | | [parameters.limit] | number | | How many entries should be present in a page. 1000 if not specified. |

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

Cancel or delete a preview job by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.previewId | string | | ID of the preview job. |

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

Lookup the results of an estimate job by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.previewId | string | | ID of the preview job. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.schemaName] | string | | XDM schema name | | [parameters.name] | string | | projection name | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Create a new edge projection configuration.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.schemaName | string | | XDM schema name | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.projectionid | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.projectionid | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Delete an edge projection configuration by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.projectionid | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Create a new edge projection destination.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.destinationId | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.destinationId | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Delete an edge projection destination by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.destinationId | string | | undefined | | parameters.'x-gw-ims-authorization' | string | | Gateway IMS service token. | | [parameters.'x-user-token'] | string | | User access token. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a client flow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Retrieve a list of event types.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. | | [parameters.start] | number | | Page offset for the response. Default is 0. | | [parameters.limit] | number | | Page size | | [parameters.orderBy] | string | | The model attribute to be used for ordering. |

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

Create a new event type.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'x-profile-instance-id' | string | | Profile instance ID. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Lookup an event type by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.eventTypeId | string | | Event type ID. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Overwrite an event type by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.eventTypeId | string | | Event type ID. | | parameters.'x-profile-instance-id' | string | | Profile instance ID. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.eventTypeId | string | | Event type ID. | | parameters.'x-profile-instance-id' | string | | Profile instance ID. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Delete an event type by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.eventTypeId | string | | Event type ID. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Retrieve a list of all macros for your organization.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Request ID | | [parameters.start] | string | | Page offset (at the created time of resource) | | [parameters.limit] | number | | Maximum number of objects to display on each page. | | [parameters.orderBy] | string | | Model attribute which will be using for ordering. | | [parameters.dataSetId] | string | | Dataset ID. | | [parameters.schemaClassId] | string | | Schema class ID. | | [parameters.value] | string | | Event type value. |

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

Create a new macro.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request ID |

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

Lookup a macro by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.macroId | string | | Macro ID. For example, ca8fe8a8-0f38-478a-9905-fd515d1d2988 | | [parameters.'x-request-id'] | string | | Request Id |

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

Overwrite a macro by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.macroId | string | | Macro ID. For example, ca8fe8a8-0f38-478a-9905-fd515d1d2988 | | parameters.'x-profile-instance-id' | string | | Profile Instance ID | | [parameters.'x-request-id'] | string | | Request ID |

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

Update a macro by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.macroId | string | | Macro ID. For example, ca8fe8a8-0f38-478a-9905-fd515d1d2988 | | parameters.'x-profile-instance-id' | string | | Profile Instance ID. | | [parameters.'x-request-id'] | string | | Request ID. |

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

Delete a macro by ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.macroId | string | | Macro ID. For example, ca8fe8a8-0f38-478a-9905-fd515d1d2988 | | [parameters.'x-request-id'] | string | | Request ID. |

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

Retrieve a list of schedules for your IMS Org

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. | | [parameters.start] | number | | Return results from a specific page offset. For example, start=3 | | [parameters.limit] | number | | Limit response to a specific number of objects. Must be a positive number. For example, limit=10 |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.'Content-Type' | string | | Type of content being sent in the body of the request. Should be 'application/json'. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Lookup a schedule by its ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.SCHEDULE_ID | string | | The ID of the schedule against which the operation is being performed. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.SCHEDULE_ID | string | | The ID of the schedule against which the operation is being performed. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

Delete a schedule by its ID.

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | parameters.SCHEDULE_ID | string | | The ID of the schedule against which the operation is being performed. | | [parameters.'x-request-id'] | string | | Optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |

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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [parameters] | object | {} | parameters to pass | | [parameters.sta