docs.md

Classes

ContactsPlus

OAuth

AccountAPI ⇐ API.OAuthBased

ContactsAPI ⇐ API.OAuthBased

V3

TagsAPI ⇐ API.OAuthBased

TeamsAPI ⇐ API.OAuthBased

WebhooksAPI ⇐ API.OAuthBased

ContactsPlus

Kind: global class

• ContactsPlus
  • instance
    • .contacts
    • .oauth
    • .v3
  • static
    • .ContactsPlus
      • new ContactsPlus(config)

contactsPlus.contacts

Gets Contacts APIs

Kind: instance property of ContactsPlus
Read only: true

contactsPlus.oauth

Gets oauth client

Kind: instance property of ContactsPlus
Read only: true

contactsPlus.v3

Gets v3 (alias of contacts)

Kind: instance property of ContactsPlus
Read only: true

ContactsPlus.ContactsPlus

Kind: static class of ContactsPlus

new ContactsPlus(config)

Creates an instance of ContactsPlus. Config: { clientId, clientSecret, redirectUri, scope, baseUrl }

Param	Type
config	Object

OAuth

Kind: global class

• OAuth
  • new OAuth()
  • instance
    • .getAuthorizationUrl(scope, queryString) ⇒ String
    • .exchangeAuthCode(code, [redirectUri]) ⇒ Promise
    • .exchangeRefreshToken(refresh_token) ⇒ Promise
    • .isExpired(auth) ⇒ Boolean
  • static
    • .OAuth
      • new OAuth(config)

new OAuth()

ContactsPlus OAuth

oAuth.getAuthorizationUrl(scope, queryString) ⇒ String

Gets the Authorization URL.

Kind: instance method of OAuth

Param	Type
scope	String
queryString	Object

oAuth.exchangeAuthCode(code, [redirectUri]) ⇒ Promise

Exchanges an auth code for a access_token & refresh_token.

Kind: instance method of OAuth

Param	Type	Default
code	String
[redirectUri]	String	this.redirectUri

oAuth.exchangeRefreshToken(refresh_token) ⇒ Promise

Gets a new access_token using a refresh_token.

Kind: instance method of OAuth

Param	Type
refresh_token	String

oAuth.isExpired(auth) ⇒ Boolean

Kind: instance method of OAuth

Param	Type
auth	Object

OAuth.OAuth

Kind: static class of OAuth

new OAuth(config)

Creates an instance of OAuth.

Param	Type
config	Object

AccountAPI ⇐ API.OAuthBased

Kind: global class
Extends: API.OAuthBased

• AccountAPI ⇐ API.OAuthBased
  • new AccountAPI()
  • instance
    • .get(accessToken) ⇒ Promise
  • static
    • .AccountAPI
      • new AccountAPI()

new AccountAPI()

Account APIs

accountAPI.get(accessToken) ⇒ Promise

Gets account information for the given accessToken. REQUIRED SCOPE: account.read

Kind: instance method of AccountAPI

Param	Type
accessToken	String

AccountAPI.AccountAPI

Kind: static class of AccountAPI

new AccountAPI()

Creates an instance of AccountAPI.

ContactsAPI ⇐ API.OAuthBased

Kind: global class
Extends: API.OAuthBased

• ContactsAPI ⇐ API.OAuthBased
  • new ContactsAPI()
  • instance
    • .get(accessToken, body) ⇒ Promise
    • .scroll(accessToken, body) ⇒ Promise
    • .search(accessToken, body) ⇒ Promise
    • .create(accessToken, body) ⇒ Promise
    • .update(accessToken, body) ⇒ Promise
    • .manageTags(accessToken, body) ⇒ Promise
    • .uploadPhoto(accessToken, contact, buffer) ⇒ Promise
    • .del(accessToken, body) ⇒ Promise
  • static
    • .ContactsAPI
      • new ContactsAPI()

new ContactsAPI()

Contacts APIs

contactsAPI.get(accessToken, body) ⇒ Promise

Gets contacts REQUIRED SCOPE: contacts.read

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.scroll(accessToken, body) ⇒ Promise

Scrolls a list of contacts REQUIRED SCOPE: contacts.read

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.search(accessToken, body) ⇒ Promise

Searches for contacts REQUIRED SCOPE: contacts.read

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.create(accessToken, body) ⇒ Promise

Creates a new contact REQUIRED SCOPE: contacts.write

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.update(accessToken, body) ⇒ Promise

Updates a contact REQUIRED SCOPE: contacts.write

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.manageTags(accessToken, body) ⇒ Promise

Manages tags for a contact (https://api.fullcontact.com/api/v1/docs/methods/contacts.manageTags) REQUIRED SCOPE: contacts.write

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

contactsAPI.uploadPhoto(accessToken, contact, buffer) ⇒ Promise

Uploads a contact photo (https://api.fullcontact.com/api/v1/docs/methods/contacts.uploadPhoto) REQUIRED SCOPE: contacts.write

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
contact	Object
buffer	Buffer

contactsAPI.del(accessToken, body) ⇒ Promise

Deletes a contact (https://api.fullcontact.com/api/v1/docs/methods/contacts.delete) REQUIRED SCOPE: contacts.write

Kind: instance method of ContactsAPI

Param	Type
accessToken	String
body	Object

ContactsAPI.ContactsAPI

Kind: static class of ContactsAPI

new ContactsAPI()

Creates an instance of ContactsAPI.

V3

Kind: global class

• V3
  • new V3()
  • instance
    • .account
    • .contacts
    • .tags
    • .webhooks
    • .teams
  • static
    • .V3
      • new V3()

new V3()

V3 APIs

v3.account

Gets Account APIs

Kind: instance property of V3
Read only: true

v3.contacts

Gets Contacts APIs

Kind: instance property of V3
Read only: true

v3.tags

Gets Tags APIs

Kind: instance property of V3
Read only: true

v3.webhooks

Gets Webhooks APIs

Kind: instance property of V3
Read only: true

v3.teams

Gets Teams APIs

Kind: instance property of V3
Read only: true

V3.V3

Kind: static class of V3

new V3()

Creates an instance of V3.

TagsAPI ⇐ API.OAuthBased

Kind: global class
Extends: API.OAuthBased

• TagsAPI ⇐ API.OAuthBased
  • new TagsAPI()
  • instance
    • .get(accessToken, body) ⇒ Promise
    • .scroll(accessToken, body) ⇒ Promise
    • .create(accessToken, body) ⇒ Promise
    • .update(accessToken, body) ⇒ Promise
    • .del(accessToken, body) ⇒ Promise
  • static
    • .TagsAPI
      • new TagsAPI()

new TagsAPI()

Tags APIs

tagsAPI.get(accessToken, body) ⇒ Promise

Gets tags (https://api.fullcontact.com/api/v1/docs/methods/tags.get) REQUIRED SCOPE: tags.read

Kind: instance method of TagsAPI

Param	Type
accessToken	String
body	Object

tagsAPI.scroll(accessToken, body) ⇒ Promise

Scrolls a list of tags (https://api.fullcontact.com/api/v1/docs/methods/tags.scroll) REQUIRED SCOPE: tags.read

Kind: instance method of TagsAPI

Param	Type
accessToken	String
body	Object

tagsAPI.create(accessToken, body) ⇒ Promise

Creates a tag (https://api.fullcontact.com/api/v1/docs/methods/tags.create) REQUIRED SCOPE: tags.write

Kind: instance method of TagsAPI

Param	Type
accessToken	String
body	Object

tagsAPI.update(accessToken, body) ⇒ Promise

Updates a tag(https://api.fullcontact.com/api/v1/docs/methods/tags.update) REQUIRED SCOPE: tags.write

Kind: instance method of TagsAPI

Param	Type
accessToken	String
body	Object

tagsAPI.del(accessToken, body) ⇒ Promise

Deletes a tag (https://api.fullcontact.com/api/v1/docs/methods/tags.delete) REQUIRED SCOPE: tags.write

Kind: instance method of TagsAPI

Param	Type
accessToken	String
body	Object

TagsAPI.TagsAPI

Kind: static class of TagsAPI

new TagsAPI()

Creates an instance of TagsAPI.

TeamsAPI ⇐ API.OAuthBased

Kind: global class
Extends: API.OAuthBased

• TeamsAPI ⇐ API.OAuthBased
  • new TeamsAPI()
  • instance
    • .get(accessToken, body) ⇒ Promise
  • static
    • .TeamsAPI
      • new TeamsAPI()

new TeamsAPI()

Teams APIs

teamsAPI.get(accessToken, body) ⇒ Promise

Gets a list of teams for user (https://api.fullcontact.com/api/v1/docs/methods/teams.get) REQUIRED SCOPE: teams.read

Kind: instance method of TeamsAPI

Param	Type
accessToken	String
body	Object

TeamsAPI.TeamsAPI

Kind: static class of TeamsAPI

new TeamsAPI()

Creates an instance of TeamsAPI.

WebhooksAPI ⇐ API.OAuthBased

Kind: global class
Extends: API.OAuthBased

• WebhooksAPI ⇐ API.OAuthBased
  • new WebhooksAPI()
  • instance
    • .create(accessToken, body) ⇒ Promise
    • .getTriggers(accessToken, body) ⇒ Promise
    • .get(accessToken, body) ⇒ Promise
    • .search(accessToken, body) ⇒ Promise
    • .getBatches(accessToken, body) ⇒ Promise
    • .del(accessToken, body) ⇒ Promise
  • static
    • .WebhooksAPI
      • new WebhooksAPI()

new WebhooksAPI()

Webhooks APIs

webhooksAPI.create(accessToken, body) ⇒ Promise

Creates a webhook (https://api.fullcontact.com/api/v1/docs/methods/webhooks.create

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

webhooksAPI.getTriggers(accessToken, body) ⇒ Promise

Gets a list of triggers for a webhook (https://api.fullcontact.com/api/v1/docs/methods/webhooks.getTriggers)

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

webhooksAPI.get(accessToken, body) ⇒ Promise

Gets a webhook (https://api.fullcontact.com/api/v1/docs/methods/webhooks.get)

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

webhooksAPI.search(accessToken, body) ⇒ Promise

Searches webhooks(https://api.fullcontact.com/api/v1/docs/methods/webhooks.search)

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

webhooksAPI.getBatches(accessToken, body) ⇒ Promise

Gets batches for a webhook (https://api.fullcontact.com/api/v1/docs/methods/webhooks.getBatches)

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

webhooksAPI.del(accessToken, body) ⇒ Promise

Deletes a webhook (https://api.fullcontact.com/api/v1/docs/methods/webhooks.delete)

Kind: instance method of WebhooksAPI

Param	Type
accessToken	String
body	Object

WebhooksAPI.WebhooksAPI

Kind: static class of WebhooksAPI

new WebhooksAPI()

Creates an instance of WebhooksAPI.