Class ContactsApi

Hierarchy

BaseAPI
- ContactsApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new ContactsApi(configuration?: Configuration): ContactsApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns ContactsApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createContact

createContact(requestParameters: CreateContactOperationRequest): Promise<ContactResponse>

- Defined in apis/ContactsApi.ts:92
Add a contact to the organization. Create a contact

Parameters
- requestParameters: CreateContactOperationRequest
Returns Promise<ContactResponse>

createContactRaw

createContactRaw(requestParameters: CreateContactOperationRequest): Promise<ApiResponse<ContactResponse>>

- Defined in apis/ContactsApi.ts:66
Add a contact to the organization. Create a contact

Parameters
- requestParameters: CreateContactOperationRequest
Returns Promise<ApiResponse<ContactResponse>>

deleteContact

deleteContact(requestParameters: DeleteContactRequest): Promise<string>

- Defined in apis/ContactsApi.ts:124
Delete the given contact. Delete a contact

Parameters
- requestParameters: DeleteContactRequest
Returns Promise<string>

deleteContactRaw

deleteContactRaw(requestParameters: DeleteContactRequest): Promise<ApiResponse<string>>

- Defined in apis/ContactsApi.ts:101
Delete the given contact. Delete a contact

Parameters
- requestParameters: DeleteContactRequest
Returns Promise<ApiResponse<string>>

getContact

getContact(requestParameters: GetContactRequest): Promise<ContactResponse>

- Defined in apis/ContactsApi.ts:156
Get a specific contact's information. Retrieve a contact

Parameters
- requestParameters: GetContactRequest
Returns Promise<ContactResponse>

getContactRaw

getContactRaw(requestParameters: GetContactRequest): Promise<ApiResponse<ContactResponse>>

- Defined in apis/ContactsApi.ts:133
Get a specific contact's information. Retrieve a contact

Parameters
- requestParameters: GetContactRequest
Returns Promise<ApiResponse<ContactResponse>>

listContacts

listContacts(requestParameters: ListContactsRequest): Promise<ListContactsResponse>

- Defined in apis/ContactsApi.ts:192
Returns a list of all contacts in an organization. List all contacts

Parameters
- requestParameters: ListContactsRequest
Returns Promise<ListContactsResponse>

listContactsRaw

listContactsRaw(requestParameters: ListContactsRequest): Promise<ApiResponse<ListContactsResponse>>

- Defined in apis/ContactsApi.ts:165
Returns a list of all contacts in an organization. List all contacts

Parameters
- requestParameters: ListContactsRequest
Returns Promise<ApiResponse<ListContactsResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

updateContact

updateContact(requestParameters: UpdateContactOperationRequest): Promise<ContactResponse>

- Defined in apis/ContactsApi.ts:231
Update a specific contact's information. Update a contact

Parameters
- requestParameters: UpdateContactOperationRequest
Returns Promise<ContactResponse>

updateContactRaw

updateContactRaw(requestParameters: UpdateContactOperationRequest): Promise<ApiResponse<ContactResponse>>

- Defined in apis/ContactsApi.ts:201
Update a specific contact's information. Update a contact

Parameters
- requestParameters: UpdateContactOperationRequest
Returns Promise<ApiResponse<ContactResponse>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc