ODPClient
ODP Node SDKODP Node SDK
ODP Node SDKODP Node SDK / ODPClient
Class: ODPClient
Defined in: src/Api/ODPClient.ts:24
Extended by
- `ReconfigurableODPClient`ReconfigurableODPClient
Constructors
Constructor
Defined in: src/Api/ODPClient.ts:45
Parameters
config
null | Config | InternalConfig
Returns
ODPClient
Properties
identifier
Defined in: src/Api/ODPClient.ts:33
Manage customer identifiers using the v3 APIs
list
Defined in: src/Api/ODPClient.ts:38
Manage list subscriptions using the v3 APIs
schema
Defined in: src/Api/ODPClient.ts:28
Manage schema (ODP domain objects and fields) using the v3 APIs
v3Api
Defined in: src/Api/ODPClient.ts:43
Direct access to query any API by path using the v3 API helper
Methods
customer()
Defined in: src/Api/ODPClient.ts:62
Create or Update a customer profile in ODP using the v3 profiles API
Parameters
payload
`CustomerPayload`CustomerPayload | `CustomerPayload`CustomerPayload[]
opts?
`PayloadOptions`PayloadOptions
Returns
Promise<`HttpResponse`HttpResponse<`CustomerResponse`CustomerResponse>>
event()
Defined in: src/Api/ODPClient.ts:55
Send an event to ODP using the v3 event API
Parameters
payload
`EventPayload`EventPayload | `EventPayload`EventPayload[]
Returns
Promise<`HttpResponse`HttpResponse<`EventResponse`EventResponse>>
graphql()
Defined in: src/Api/ODPClient.ts:79
Query data using the GraphQL API
Type Parameters
T
T extends `V3Response`V3Response
Parameters
query
string
variables?
Returns
Promise<GqlHttpResponse<T>>
object()
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 | `ObjectPayload`ObjectPayload[]
opts?
`PayloadOptions`PayloadOptions
Returns
Promise<`HttpResponse`HttpResponse<`ObjectResponse`ObjectResponse>>