2.0.1 • Published 2 years ago

@evokegroup/iqvia-oce v2.0.1

Weekly downloads
182
License
ISC
Repository
bitbucket
Last release
2 years ago

@evokegroup/iqvia-oce

Library for IQVIA OCE projects

Class: IQVIA

Class: IQVIA.Api

constructor({args})

ParameterTypeDefaultDescription
subdomainstringThe subdomain of the Salesforce intance URL
authorizerOAuth2.Authorizer
clientIdstring
clientSecretstring
deContactsstringThe contact data extension name
deAttributesstringThe contact attributes data extension name
deOptsstringThe contact opts data extension name
ekCreateContactstringThe event definition key for the create contact event
timeoutnumber30000
loggerLoggerThe Logger instance to log to

getContacts({contactKey, email, fields})

contactKey or email is required.

ParameterTypeDefaultDescription
contactKeyArray<string>, string
emailArray<string>, string
fieldsArray<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})

ParameterTypeDefaultDescription
emailstring
firstNamestring
lastNamestring

matchContacts(Array<{email, firstName, lastName}>)

ParameterTypeDefaultDescription
emailstring
firstNamestring
lastNamestring

createContact({contact, eventDefinitionKey})

ParameterTypeDefaultDescription
contactobjectThe contact
eventDefinitionKeystring

updateContacts(contacts)

ParameterTypeDefaultDescription
contactsArray<object>The contacts

createContactAttributes(attributes)

ParameterTypeDefaultDescription
attributesArray<object>The contact attributes

createContactOpts(opts)

ParameterTypeDefaultDescription
optsArray<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.

ParameterTypeDefaultDescription
contactKeyArray<string>, string
emailArray<string>, string
fieldsArray<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
2.0.1

2 years ago

2.0.0

2 years ago

1.1.3

3 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.2

4 years ago

1.0.3

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago