ODPClient

26 min

ODP Node SDK

ODP Node SDK / ODPClient

Class: ODPClient

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

Extended by

ReconfigurableODPClient

Constructors

Constructor

new ODPClient(config): ODPClient

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

Parameters

config

null | Config | InternalConfig

Returns

ODPClient

Properties

identifier

identifier: Identifier

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

Manage customer identifiers using the v3 APIs

list

list: Lists

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

Manage list subscriptions using the v3 APIs

schema

schema: Schema

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

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

v3Api

v3Api: API

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

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

Methods

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

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

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