@evokegroup/iqvia-oce
v2.0.1
Published
Library for IQVIA OCE projects
Downloads
13
Keywords
Readme
@evokegroup/iqvia-oce
Library for IQVIA OCE projects
Class: IQVIA
Class: IQVIA.Api
constructor({args})
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| subdomain | string
| | The subdomain of the Salesforce intance URL |
| authorizer | OAuth2.Authorizer
| | |
| clientId | string
| | |
| clientSecret | string
| | |
| deContacts | string
| | The contact data extension name |
| deAttributes | string
| | The contact attributes data extension name |
| deOpts | string
| | The contact opts data extension name |
| ekCreateContact | string
| | The event definition key for the create contact event |
| timeout | number
| 30000
| |
| logger | Logger
| | The Logger
instance to log to |
getContacts({contactKey, email, fields})
contactKey
or email
is required.
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| contactKey | Array<string>, string
| | |
| email | Array<string>, string
| | |
| fields | Array<string>
| ['Contact Key', 'First Name', 'Last Name', 'Email'] | The fields to return. Contact Key, First Name, Last Name, Email are alwasy returned |
matchContact({email, firstName, lastName})
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| email | string
| | |
| firstName | string
| | |
| lastName | string
| | |
matchContacts(Array<{email, firstName, lastName}>)
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| email | string
| | |
| firstName | string
| | |
| lastName | string
| | |
createContact({contact, eventDefinitionKey})
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| contact | object
| | The contact |
| eventDefinitionKey | string
| | |
updateContacts(contacts)
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| contacts | Array<object>
| | The contacts |
createContactAttributes(attributes)
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| attributes | Array<object>
| | The contact attributes |
createContactOpts(opts)
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| opts | Array<object>
| | The contact opts |
Class: IQVIA.Constants
Class: IQVIA.DataExtensions
static transform(data, fields)
Takes simple data object or array of objects and renames it's properties
Class: IQVIA.Now
Class: IQVIA.Utility
static formatDate(date)
static formatDateTime(date)
static toTrueFalse(val)
static toYesNo(val)
static toInOut(val)
static isContactMatch({matchFirstName, matchLastName, contactFirstName, contactLastName}) => boolean
Compares the first character of a contact's first name and the full last name to the match data. Case insensitive. Either first name missing is considered a first name match. Either last name missing is considered a last name match.
static createGetContactsBatches({contactKey, email, fields}) => Array<Array>
Salesforce has a limit on the number of charactes that can be sent during a query. When searching for many contacts, use this method to create batches of contactKeys or emails to ensure that request character limit is not hit.
| Parameter | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| contactKey | Array<string>, string
| | |
| email | Array<string>, string
| | |
| fields | Array<string>
| ['Contact Key', 'First Name', 'Last Name', 'Email'] | The fields to return. Contact Key, First Name, Last Name, Email are alwasy returned |
const emails = [...]; // Many email addresses