Function ContactsApiAxiosParamCreator

Returns {
    acceptContactRequest: ((id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsBulkPOST: ((contactBulkCreateDeets?: ContactBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsDELETE: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsDeleteAvatar: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsGetAvatarById: ((id: string, avatarType?: AvatarType, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsGETById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsGETList: ((includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsGETRequests: ((contactStatus?: ContactStatusPersonaFilter, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsInvitePOST: ((contactInviteCreateDeets?: ContactInviteCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsInvitePut: ((personaId: string, contactInviteUpdateDeets?: ContactInviteUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsPOST: ((contactCreateDeets?: ContactCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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) => Promise<RequestArgs>);
    contactsUpdateAvatar: ((id: string, file?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsUpdateAvatarByDeets: ((id: string, userId?: string, avatarBytes?: AvatarBytes, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    contactsUpdateAvatarByPrompt: ((id: string, avatarPromptCreateDeets?: AvatarPromptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getAcceptPaymentStatusByAccountId: ((accountId?: string, status?: AcceptPaymentStatusEnum, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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) => Promise<RequestArgs>);
    rejectContactRequest: ((id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    requestsGETList: ((includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• acceptContactRequest: ((id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Accept the contact invitation

  Throws

  • • (id, contactStatusUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalcontactStatusUpdateDeets: ContactStatusUpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsBulkPOST: ((contactBulkCreateDeets?: ContactBulkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Bulk add contacts

  Throws

  • • (contactBulkCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalcontactBulkCreateDeets: ContactBulkCreateDeets

        All the contact details
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsDELETE: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Delete an contact

  Throws

  • • (id?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalid: string

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

        Override http request option.

      Returns Promise<RequestArgs>

• contactsDeleteAvatar: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Reset avatar to the default

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsGetAvatarById: ((id: string, avatarType?: AvatarType, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve an avatar by id

  Throws

  • • (id, avatarType?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• contactsGETById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Get a single contact

  Throws

  • • (id, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• contactsGETList: ((includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary List contacts

  Throws

  • • (includeSelf?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• contactsGETRequests: ((contactStatus?: ContactStatusPersonaFilter, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary List of invited contacts

  Throws

  • • (contactStatus?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• contactsInvitePOST: ((contactInviteCreateDeets?: ContactInviteCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Create a contact record - contact invite.

  Throws

  • • (contactInviteCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalcontactInviteCreateDeets: ContactInviteCreateDeets

        The contact details
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsInvitePut: ((personaId: string, contactInviteUpdateDeets?: ContactInviteUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Update a contact record - contact invite.

  Throws

  • • (personaId, contactInviteUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • personaId: string
      • OptionalcontactInviteUpdateDeets: ContactInviteUpdateDeets

        The contact details
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsPOST: ((contactCreateDeets?: ContactCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Create a contact record

  Throws

  • • (contactCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalcontactCreateDeets: ContactCreateDeets

        The contact details
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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) => Promise<RequestArgs>)

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

  summary Search contacts

  Throws

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

    • 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<RequestArgs>

• contactsUpdateAvatar: ((id: string, file?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, file?, options?): Promise<RequestArgs>

    • Parameters

      • id: string

        contact id
      • Optionalfile: File

        The avatar image for this contact
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• contactsUpdateAvatarByDeets: ((id: string, userId?: string, avatarBytes?: AvatarBytes, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, userId?, avatarBytes?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• contactsUpdateAvatarByPrompt: ((id: string, avatarPromptCreateDeets?: AvatarPromptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, avatarPromptCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalavatarPromptCreateDeets: AvatarPromptCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getAcceptPaymentStatusByAccountId: ((accountId?: string, status?: AcceptPaymentStatusEnum, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve the payment acceptance status for an account

  Throws

  • • (accountId?, status?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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) => Promise<RequestArgs>)

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

  Throws

  • • (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<RequestArgs>

    • 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<RequestArgs>

• rejectContactRequest: ((id: string, contactStatusUpdateDeets?: ContactStatusUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Reject the contact invitation

  Throws

  • • (id, contactStatusUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalcontactStatusUpdateDeets: ContactStatusUpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• requestsGETList: ((includeSelf?: boolean, sortByFieldName?: ListOfSortFieldsForContact, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary List requests

  Throws

  • • (includeSelf?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>