ODP Node SDK / ReconfigurableODPClient

Class: ReconfigurableODPClient

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.

Extends

ODPClient

Constructors

Constructor

new ReconfigurableODPClient(config): ReconfigurableODPClient

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

Parameters

config

null | Config | InternalConfig

Returns

ReconfigurableODPClient

Inherited from

ODPClient.constructor

Properties

identifier

identifier: Identifier

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

Manage customer identifiers using the v3 APIs

Inherited from

ODPClient.identifier

list

list: Lists

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

Manage list subscriptions using the v3 APIs

Inherited from

ODPClient.list

schema

schema: Schema

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

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

Inherited from

ODPClient.schema

v3Api

v3Api: API

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

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

Inherited from

ODPClient.v3Api

Methods

configure()

configure(config): void

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

Configure the ODP SDK for use

Parameters

config

null | Config | InternalConfig

Returns

void

customer()

customer(payload, opts?): Promise<HttpResponse<CustomerResponse>>

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

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

Parameters

event()

event(payload): Promise<HttpResponse<EventResponse>>

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

Send an event to ODP using the v3 event API

Parameters

payload

EventPayload | EventPayload[]

Returns

Promise<HttpResponse<EventResponse>>

Inherited from

ODPClient.event

graphql()

graphql<T>(query, variables?): Promise<GqlHttpResponse<T>>

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

Query data using the GraphQL API

Type Parameters

T

T extends V3Response

Parameters

query

string

variables?

Returns

Promise<GqlHttpResponse<T>>

Inherited from

ODPClient.graphql

object()

object(type, payload, opts?): Promise<HttpResponse<ObjectResponse>>

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

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

Parameters

type

string

payload

ObjectPayload | ObjectPayload[]

opts?

PayloadOptions

Returns

Promise<HttpResponse<ObjectResponse>>

Inherited from

ODPClient.object