contactsapi.md

fiken › ContactsApi

Class: ContactsApi

Hierarchy

• BaseAPI

  ↳ ContactsApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addContactPersonToContact
• addContactPersonToContactRaw
• createContact
• createContactRaw
• deleteContactContactPerson
• deleteContactContactPersonRaw
• getContact
• getContactContactPerson
• getContactContactPersonRaw
• getContactPerson
• getContactPersonRaw
• getContactRaw
• getContacts
• getContactsRaw
• request
• updateContact
• updateContactContactPerson
• updateContactContactPersonRaw
• updateContactRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new ContactsApi(configuration: Configuration‹›): ContactsApi

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: ContactsApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addContactPersonToContact

▸ addContactPersonToContact(requestParameters: AddContactPersonToContactRequest): Promise‹void›

Adds a new contact person to a contact

Parameters:

Name	Type
requestParameters	AddContactPersonToContactRequest

Returns: Promise‹void›

---

addContactPersonToContactRaw

▸ addContactPersonToContactRaw(requestParameters: AddContactPersonToContactRequest): Promise‹ApiResponse‹void››

Adds a new contact person to a contact

Parameters:

Name	Type
requestParameters	AddContactPersonToContactRequest

Returns: Promise‹ApiResponse‹void››

---

createContact

▸ createContact(requestParameters: CreateContactRequest): Promise‹void›

Creates a new contact. The Location response header returns the URL of the newly created contact.

Parameters:

Name	Type
requestParameters	CreateContactRequest

Returns: Promise‹void›

---

createContactRaw

▸ createContactRaw(requestParameters: CreateContactRequest): Promise‹ApiResponse‹void››

Creates a new contact. The Location response header returns the URL of the newly created contact.

Parameters:

Name	Type
requestParameters	CreateContactRequest

Returns: Promise‹ApiResponse‹void››

---

deleteContactContactPerson

▸ deleteContactContactPerson(requestParameters: DeleteContactContactPersonRequest): Promise‹void›

Delete a contact's contact person.

Parameters:

Name	Type
requestParameters	DeleteContactContactPersonRequest

Returns: Promise‹void›

---

deleteContactContactPersonRaw

▸ deleteContactContactPersonRaw(requestParameters: DeleteContactContactPersonRequest): Promise‹ApiResponse‹void››

Delete a contact's contact person.

Parameters:

Name	Type
requestParameters	DeleteContactContactPersonRequest

Returns: Promise‹ApiResponse‹void››

---

getContact

▸ getContact(requestParameters: GetContactRequest): Promise‹Contact›

Retrieves specified contact. ContactId is returned with a GET contacts call as the first returned field. ContactId is returned in the Location response header for POST contact.

Parameters:

Name	Type
requestParameters	GetContactRequest

Returns: Promise‹Contact›

---

getContactContactPerson

▸ getContactContactPerson(requestParameters: GetContactContactPersonRequest): Promise‹Array‹ContactPerson››

Retrieves contact person(s) for a specified contact.

Parameters:

Name	Type
requestParameters	GetContactContactPersonRequest

Returns: Promise‹Array‹ContactPerson››

---

getContactContactPersonRaw

▸ getContactContactPersonRaw(requestParameters: GetContactContactPersonRequest): Promise‹ApiResponse‹Array‹ContactPerson›››

Retrieves contact person(s) for a specified contact.

Parameters:

Name	Type
requestParameters	GetContactContactPersonRequest

Returns: Promise‹ApiResponse‹Array‹ContactPerson›››

---

getContactPerson

▸ getContactPerson(requestParameters: GetContactPersonRequest): Promise‹ContactPerson›

Retrieves specified contact person

Parameters:

Name	Type
requestParameters	GetContactPersonRequest

Returns: Promise‹ContactPerson›

---

getContactPersonRaw

▸ getContactPersonRaw(requestParameters: GetContactPersonRequest): Promise‹ApiResponse‹ContactPerson››

Retrieves specified contact person

Parameters:

Name	Type
requestParameters	GetContactPersonRequest

Returns: Promise‹ApiResponse‹ContactPerson››

---

getContactRaw

▸ getContactRaw(requestParameters: GetContactRequest): Promise‹ApiResponse‹Contact››

Retrieves specified contact. ContactId is returned with a GET contacts call as the first returned field. ContactId is returned in the Location response header for POST contact.

Parameters:

Name	Type
requestParameters	GetContactRequest

Returns: Promise‹ApiResponse‹Contact››

---

getContacts

▸ getContacts(requestParameters: GetContactsRequest): Promise‹Array‹Contact››

Retrieves all contacts for the specified company.

Parameters:

Name	Type
requestParameters	GetContactsRequest

Returns: Promise‹Array‹Contact››

---

getContactsRaw

▸ getContactsRaw(requestParameters: GetContactsRequest): Promise‹ApiResponse‹Array‹Contact›››

Retrieves all contacts for the specified company.

Parameters:

Name	Type
requestParameters	GetContactsRequest

Returns: Promise‹ApiResponse‹Array‹Contact›››

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

updateContact

▸ updateContact(requestParameters: UpdateContactRequest): Promise‹void›

Updates an existing contact.

Parameters:

Name	Type
requestParameters	UpdateContactRequest

Returns: Promise‹void›

---

updateContactContactPerson

▸ updateContactContactPerson(requestParameters: UpdateContactContactPersonRequest): Promise‹void›

Updates an existing contact person.

Parameters:

Name	Type
requestParameters	UpdateContactContactPersonRequest

Returns: Promise‹void›

---

updateContactContactPersonRaw

▸ updateContactContactPersonRaw(requestParameters: UpdateContactContactPersonRequest): Promise‹ApiResponse‹void››

Updates an existing contact person.

Parameters:

Name	Type
requestParameters	UpdateContactContactPersonRequest

Returns: Promise‹ApiResponse‹void››

---

updateContactRaw

▸ updateContactRaw(requestParameters: UpdateContactRequest): Promise‹ApiResponse‹void››

Updates an existing contact.

Parameters:

Name	Type
requestParameters	UpdateContactRequest

Returns: Promise‹ApiResponse‹void››

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Inherited from BaseAPI.withPostMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Inherited from BaseAPI.withPreMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T