ReconfigurableODPClient
ODP Node SDKODP Node SDK
ODP Node SDKODP Node SDK / ReconfigurableODPClient
Class: 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.
Extends
- `ODPClient`ODPClient
Constructors
Constructor
Defined in: src/Api/ODPClient.ts:45
Parameters
config
null | Config | InternalConfig
Returns
ReconfigurableODPClient
Inherited from
`ODPClient`ODPClient.`constructor`constructor
Properties
identifier
Defined in: src/Api/ODPClient.ts:33
Manage customer identifiers using the v3 APIs
Inherited from
`ODPClient`ODPClient.`identifier`identifier
list
Defined in: src/Api/ODPClient.ts:38
Manage list subscriptions using the v3 APIs
Inherited from
`ODPClient`ODPClient.`list`list
schema
Defined in: src/Api/ODPClient.ts:28
Manage schema (ODP domain objects and fields) using the v3 APIs
Inherited from
`ODPClient`ODPClient.`schema`schema
v3Api
Defined in: src/Api/ODPClient.ts:43
Direct access to query any API by path using the v3 API helper
Inherited from
`ODPClient`ODPClient.`v3Api`v3Api
Methods
configure()
Defined in: src/Api/index.ts:16
Configure the ODP SDK for use
Parameters
config
null | Config | InternalConfig
Returns
void
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>>
Inherited from
`ODPClient`ODPClient.`customer`customer
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>>
Inherited from
`ODPClient`ODPClient.`event`event
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>>
Inherited from
`ODPClient`ODPClient.`graphql`graphql
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>>
Inherited from
`ODPClient`ODPClient.`object`object