ODP Node SDK

ODP Node SDK / ReconfigurableODPClient

Defined in: src/Api/index.ts:10

An extension of ODPClient that allows changing the configuration after the client has been created. The purpose of this class is to allow managing module scoped instance of OCPClient.

Defined in: src/Api/ODPClient.ts:45

null | Config | InternalConfig

ReconfigurableODPClient

ODPClient.constructor

Defined in: src/Api/ODPClient.ts:33

Manage customer identifiers using the v3 APIs

ODPClient.identifier

Defined in: src/Api/ODPClient.ts:38

Manage list subscriptions using the v3 APIs

ODPClient.list

Defined in: src/Api/ODPClient.ts:28

Manage schema (ODP domain objects and fields) using the v3 APIs

ODPClient.schema

Defined in: src/Api/ODPClient.ts:43

Direct access to query any API by path using the v3 API helper

ODPClient.v3Api

Defined in: src/Api/index.ts:16

Configure the ODP SDK for use

null | Config | InternalConfig

void

Defined in: src/Api/ODPClient.ts:62

Create or Update a customer profile in ODP using the v3 profiles API

CustomerPayload | CustomerPayload[]

PayloadOptions

Promise<HttpResponse<CustomerResponse>>

ODPClient.customer

Defined in: src/Api/ODPClient.ts:55

Send an event to ODP using the v3 event API

EventPayload | EventPayload[]

Promise<HttpResponse<EventResponse>>

ODPClient.event

Defined in: src/Api/ODPClient.ts:79

Query data using the GraphQL API

T extends V3Response

string

Promise<GqlHttpResponse<T>>

ODPClient.graphql

Defined in: src/Api/ODPClient.ts:70

Create or Update an object in ODP using the v3 objects API

string

ObjectPayload | ObjectPayload[]

PayloadOptions

Promise<HttpResponse<ObjectResponse>>

ODPClient.object