ODP Node SDK / ReconfigurableODPClient

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.

Hierarchy

ODPClient.ReconfigurableODPClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor()

Signature

new ReconfigurableODPClient(config: null | Config | InternalConfig = null): ReconfigurableODPClient;

Parameters

Name	Type	Default value
`config`	`null` \| `Config` \| `InternalConfig`	`null`

Returns

ReconfigurableODPClient

Inherited from: ODPClient.constructor

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

Properties

identifier

Identifier

Manage customer identifiers using the v3 APIs

Inherited from: ODPClient.identifier

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

list

Lists

Manage list subscriptions using the v3 APIs

Inherited from: ODPClient.list

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

schema

Schema

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

Inherited from: ODPClient.schema

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

v3Api

API

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

Inherited from: ODPClient.v3Api

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

Methods

configure()

Configure the ODP SDK for use

Signature

configure(config: null | Config | InternalConfig): void;

Parameters

Name	Type
`config`	`null` \| `Config` \| `InternalConfig`

Returns

void

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

customer()

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

Signature

customer(payload: CustomerPayload | CustomerPayload[], opts?: PayloadOptions): Promise<HttpResponse<CustomerResponse>>;

Parameters

Name	Type
`payload`	`CustomerPayload` \| `CustomerPayload`[]
`opts?`	`PayloadOptions`

Returns

Promise<HttpResponse<CustomerResponse>>

Inherited from: ODPClient.customer

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

event()

Send an event to ODP using the v3 event API

Signature

event(payload: EventPayload | EventPayload[]): Promise<HttpResponse<EventResponse>>;

Parameters

Name	Type
`payload`	`EventPayload` \| `EventPayload`[]

Returns

Promise<HttpResponse<EventResponse>>

Inherited from: ODPClient.event

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

graphql()

Query data using the GraphQL API

Signature

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

Type parameters

T extends V3Response

Parameters

Name	Type
`query`	`string`
`variables?`	{}

Returns

Promise<GqlHttpResponse<T>>

Inherited from: ODPClient.graphql

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

object()

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

Signature

object(type: string, payload: ObjectPayload | ObjectPayload[], opts?: PayloadOptions): Promise<HttpResponse<ObjectResponse>>;

Parameters

Name	Type
`type`	`string`
`payload`	`ObjectPayload` \| `ObjectPayload`[]
`opts?`	`PayloadOptions`

Returns

Promise<HttpResponse<ObjectResponse>>

Inherited from: ODPClient.object

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