Class ContactsApi

ContactsApi - object-oriented interface export ContactsApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

acceptContactRequest contactsBulkPOST contactsDELETE contactsDeleteAvatar contactsGetAvatarById contactsGETById contactsGETList contactsGETRequests contactsInvitePOST contactsInvitePut contactsPOST contactsSearch contactsUpdateAvatar contactsUpdateAvatarByDeets contactsUpdateAvatarByPrompt getAcceptPaymentStatusByAccountId getPayments rejectContactRequest requestsGETList

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

acceptContactRequest

  • acceptContactRequest(id, contactStatusUpdateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Accept the contact invitation

    Parameters

    • id: string
    • OptionalcontactStatusUpdateDeets: ContactStatusUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsBulkPOST

  • contactsBulkPOST(contactBulkCreateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Bulk add contacts

    Parameters

    • OptionalcontactBulkCreateDeets: ContactBulkCreateDeets

      All the contact details

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsDELETE

  • contactsDELETE(id?, options?): Promise<AxiosResponse<void, any>>

  • summary Delete an contact

    Parameters

    • Optionalid: string

      The id for the contact to delete.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

contactsDeleteAvatar

  • contactsDeleteAvatar(id, options?): Promise<AxiosResponse<void, any>>

  • summary Reset avatar to the default

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

contactsGetAvatarById

  • contactsGetAvatarById(id, avatarType?, userId?, options?): Promise<AxiosResponse<void, any>>

  • summary Retrieve an avatar by id

    Parameters

    • id: string

      The id of the record you wish to retrieve

    • OptionalavatarType: AvatarType

      default contact simpleContarct paymentCycle

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

contactsGETById

  • contactsGETById(id, userId?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Get a single contact

    Parameters

    • id: string

      The id of the record you wish to retrieve

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsGETList

  • contactsGETList(includeSelf?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<AxiosResponse<ContactInfoListResponse, any>>

  • summary List contacts

    Parameters

    • OptionalincludeSelf: boolean
    • OptionalsortByFieldName: ListOfSortFieldsForContact

      The field to sort by knownName firstName lastName email status externalId

    • OptionalsortByAscending: boolean

      Whether the list will be sorted in ascending order. Default value is true

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfoListResponse, any>>

    Throws

    memberof ContactsApi

contactsGETRequests

  • contactsGETRequests(contactStatus?, limit?, page?, userId?, options?): Promise<AxiosResponse<ContactInfoListResponse, any>>

  • summary List of invited contacts

    Parameters

    • OptionalcontactStatus: ContactStatusPersonaFilter

      all invited accepted rejected

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfoListResponse, any>>

    Throws

    memberof ContactsApi

contactsInvitePOST

  • contactsInvitePOST(contactInviteCreateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Create a contact record - contact invite.

    Parameters

    • OptionalcontactInviteCreateDeets: ContactInviteCreateDeets

      The contact details

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsInvitePut

  • contactsInvitePut(personaId, contactInviteUpdateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Update a contact record - contact invite.

    Parameters

    • personaId: string
    • OptionalcontactInviteUpdateDeets: ContactInviteUpdateDeets

      The contact details

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsPOST

  • contactsPOST(contactCreateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Create a contact record

    Parameters

    • OptionalcontactCreateDeets: ContactCreateDeets

      The contact details

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

contactsSearch

  • contactsSearch(term?, externalId?, sinceUTC?, accessPerspective?, includeAlias?, includeContacts?, includeRequest?, contactStatus?, roles?, includeCounts?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<AxiosResponse<ContactInfoListResponse, any>>

  • Search contacts in the network based on Name, KnownName, Business name or Handle Returns a list of EndUser_Deets.

    summary Search contacts

    Parameters

    • Optionalterm: string

      The search term or keyword

    • OptionalexternalId: string
    • OptionalsinceUTC: string
    • OptionalaccessPerspective: AccessPerspective

      none self collaborators all invite admin webHook function

    • OptionalincludeAlias: boolean
    • OptionalincludeContacts: boolean
    • OptionalincludeRequest: boolean
    • OptionalcontactStatus: ContactStatusPersona[]
    • Optionalroles: string[]
    • OptionalincludeCounts: boolean
    • OptionalsortByFieldName: ListOfSortFieldsForContact

      The field to sort by knownName firstName lastName email status externalId

    • OptionalsortByAscending: boolean

      Whether the list will be sorted in ascending order. Default value is true

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfoListResponse, any>>

    Throws

    memberof ContactsApi

contactsUpdateAvatar

  • contactsUpdateAvatar(id, file?, options?): Promise<AxiosResponse<void, any>>

  • avatar_id could be tenant.id, contact.id, work.id, project.id, team.id, etc summary Upload avatar image via file

    Parameters

    • id: string

      contact id

    • Optionalfile: File

      The avatar image for this contact

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

contactsUpdateAvatarByDeets

  • contactsUpdateAvatarByDeets(id, userId?, avatarBytes?, options?): Promise<AxiosResponse<void, any>>

  • avatar_id could be tenant.id, contact.id, work.id, project.id, team.id, etc summary Upload avatar via JSON body

    Parameters

    • id: string

      The id of the record you wish to retrieve

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • OptionalavatarBytes: AvatarBytes
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

contactsUpdateAvatarByPrompt

  • contactsUpdateAvatarByPrompt(id, avatarPromptCreateDeets?, options?): Promise<AxiosResponse<void, any>>

  • avatar_id could be tenant.id, contact.id, work.id, project.id, team.id, etc summary Generate a new avatar image via AI prompt.

    Parameters

    • id: string
    • OptionalavatarPromptCreateDeets: AvatarPromptCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof ContactsApi

getAcceptPaymentStatusByAccountId

  • getAcceptPaymentStatusByAccountId(accountId?, status?, options?): Promise<AxiosResponse<PaymentAcceptResponse, any>>

  • summary Retrieve the payment acceptance status for an account

    Parameters

    • OptionalaccountId: string

      Account Id to accept payments from

    • Optionalstatus: AcceptPaymentStatusEnum

      Accept payment status enum pending accepted suspended

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PaymentAcceptResponse, any>>

    Throws

    memberof ContactsApi

getPayments

  • getPayments(id, minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id2?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toIsAcceptedContact?, toCountryCode?, toExternalId?, toAvatar?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentListResponse, any>>

  • summary Retrieve a list of payments for a contact. The payments can also be linked back to payment cycles (mass payments).

    Parameters

    • id: string

      The contact id (PersonaId) of the contact

    • OptionalminAmount: number

      The minimum amount for filtering

    • OptionalmaxAmount: number

      The maximum amount for filtering

    • OptionalfromDate: string

      The starting date for filtering

    • OptionaltoDate: string

      The end date for filtering

    • Optionalstatuses: string[]

      A list of statuses for filtering

    • OptionalpaymentTypes: string[]

      A list of payment types for filtering

    • Optionalid2: string
    • OptionalshortId: string
    • OptionaltoHandle: string

      The Mozaic handle for a contact

    • OptionaltoEmail: string

      The email address of the contact

    • OptionaltoPhone: string

      The fully qualified phone number of the contact

    • OptionaltoName: string

      Loosely, the name of the contact. May be changed during registration

    • OptionaltoPersonaId: string

      Specifies the persona associated with this contact record

    • OptionaltoUserId: string

      Specifies the user associated with this contact record

    • OptionaltoUserAccountId: string

      Specifies the user account id associated with this contact record

    • OptionaltoIsAcceptedContact: boolean

      Specifies whether this contact is in network or out of network

    • OptionaltoCountryCode: string
    • OptionaltoExternalId: string
    • OptionaltoAvatar: AvatarSize[]

      contact avatar

    • OptionaltoId: string
    • OptionaltoCreated: string
    • OptionaltoShortId: string
    • OptionaltoObjectName: string

      The name of this object

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PaymentListResponse, any>>

    Throws

    memberof ContactsApi

rejectContactRequest

  • rejectContactRequest(id, contactStatusUpdateDeets?, options?): Promise<AxiosResponse<ContactInfo, any>>

  • summary Reject the contact invitation

    Parameters

    • id: string
    • OptionalcontactStatusUpdateDeets: ContactStatusUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfo, any>>

    Throws

    memberof ContactsApi

requestsGETList

  • requestsGETList(includeSelf?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<AxiosResponse<ContactInfoListResponse, any>>

  • summary List requests

    Parameters

    • OptionalincludeSelf: boolean
    • OptionalsortByFieldName: ListOfSortFieldsForContact

      The field to sort by knownName firstName lastName email status externalId

    • OptionalsortByAscending: boolean

      Whether the list will be sorted in ascending order. Default value is true

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContactInfoListResponse, any>>

    Throws

    memberof ContactsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods