Function ContactsApiFactory

Returns {
    acceptContactRequest(id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsBulkPOST(contactBulkCreateDeets?: ContactBulkCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsDELETE(id?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    contactsDeleteAvatar(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    contactsGetAvatarById(id: string, avatarType?: AvatarType, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    contactsGETById(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsGETList(includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfoListResponse>;
    contactsGETRequests(contactStatus?: ContactStatusPersonaFilter, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfoListResponse>;
    contactsInvitePOST(contactInviteCreateDeets?: ContactInviteCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsInvitePut(personaId: string, contactInviteUpdateDeets?: ContactInviteUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsPOST(contactCreateDeets?: ContactCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    contactsSearch(term?: string, externalId?: string, sinceUTC?: string, accessPerspective?: AccessPerspective, includeAlias?: boolean, includeContacts?: boolean, includeRequest?: boolean, contactStatus?: ContactStatusPersona[], roles?: string[], includeCounts?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfoListResponse>;
    contactsUpdateAvatar(id: string, file?: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    contactsUpdateAvatarByDeets(id: string, userId?: string, avatarBytes?: AvatarBytes, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    contactsUpdateAvatarByPrompt(id: string, avatarPromptCreateDeets?: AvatarPromptCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getAcceptPaymentStatusByAccountId(accountId?: string, status?: AcceptPaymentStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<PaymentAcceptResponse>;
    getPayments(id: string, minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id2?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentListResponse>;
    rejectContactRequest(id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfo>;
    requestsGETList(includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ContactInfoListResponse>;
}

• acceptContactRequest:function

  • acceptContactRequest(id, contactStatusUpdateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Accept the contact invitation

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• contactsBulkPOST:function

  • contactsBulkPOST(contactBulkCreateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Bulk add contacts

    Parameters

    • OptionalcontactBulkCreateDeets: ContactBulkCreateDeets

      All the contact details
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• contactsDELETE:function

  • contactsDELETE(id?, options?): AxiosPromise<void>

  • summary Delete an contact

    Parameters

    • Optionalid: string

      The id for the contact to delete.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• contactsDeleteAvatar:function

  • contactsDeleteAvatar(id, options?): AxiosPromise<void>

  • summary Reset avatar to the default

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• contactsGetAvatarById:function

  • contactsGetAvatarById(id, avatarType?, userId?, options?): AxiosPromise<void>

  • 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 AxiosPromise<void>

    Throws

• contactsGETById:function

  • contactsGETById(id, userId?, options?): AxiosPromise<ContactInfo>

  • 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 AxiosPromise<ContactInfo>

    Throws

• contactsGETList:function

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

  • 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 AxiosPromise<ContactInfoListResponse>

    Throws

• contactsGETRequests:function

  • contactsGETRequests(contactStatus?, limit?, page?, userId?, options?): AxiosPromise<ContactInfoListResponse>

  • 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 AxiosPromise<ContactInfoListResponse>

    Throws

• contactsInvitePOST:function

  • contactsInvitePOST(contactInviteCreateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Create a contact record - contact invite.

    Parameters

    • OptionalcontactInviteCreateDeets: ContactInviteCreateDeets

      The contact details
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• contactsInvitePut:function

  • contactsInvitePut(personaId, contactInviteUpdateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Update a contact record - contact invite.

    Parameters

    • personaId: string
    • OptionalcontactInviteUpdateDeets: ContactInviteUpdateDeets

      The contact details
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• contactsPOST:function

  • contactsPOST(contactCreateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Create a contact record

    Parameters

    • OptionalcontactCreateDeets: ContactCreateDeets

      The contact details
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• contactsSearch:function

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

  • 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 AxiosPromise<ContactInfoListResponse>

    Throws

• contactsUpdateAvatar:function

  • contactsUpdateAvatar(id, file?, options?): AxiosPromise<void>

  • 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 AxiosPromise<void>

    Throws

• contactsUpdateAvatarByDeets:function

  • contactsUpdateAvatarByDeets(id, userId?, avatarBytes?, options?): AxiosPromise<void>

  • 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 AxiosPromise<void>

    Throws

• contactsUpdateAvatarByPrompt:function

  • contactsUpdateAvatarByPrompt(id, avatarPromptCreateDeets?, options?): AxiosPromise<void>

  • 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 AxiosPromise<void>

    Throws

• getAcceptPaymentStatusByAccountId:function

  • getAcceptPaymentStatusByAccountId(accountId?, status?, options?): AxiosPromise<PaymentAcceptResponse>

  • 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 AxiosPromise<PaymentAcceptResponse>

    Throws

• getPayments:function

  • 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?): AxiosPromise<PaymentListResponse>

  • 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 AxiosPromise<PaymentListResponse>

    Throws

• rejectContactRequest:function

  • rejectContactRequest(id, contactStatusUpdateDeets?, options?): AxiosPromise<ContactInfo>

  • summary Reject the contact invitation

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ContactInfo>

    Throws

• requestsGETList:function

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

  • 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 AxiosPromise<ContactInfoListResponse>

    Throws