@mozaic-io/mozaic-sdk-node/dist/resources/Contacts/Contact.d.ts

The Mozaic Node SDK enables you to pay your creators easily via the Mozaic API.

import { Mozaic } from "../..";
import { ContactsApi, ContactInfo as RawContactInfo } from "../../api";
import { BaseResource } from "../BaseResource";
import { PaymentList } from "../Payments/PaymentList";
export declare class Contact extends BaseResource {
    private _mozaic;
    private _contactsApi;
    /**
     * The ID of the contact. This can be used to retrieve a contact.
     */
    id: string;
    /**
     * The known name of the contact. This is the name that you have given the contact when you created it.
     */
    name: string;
    /**
     * The contact's email address
     */
    email: string;
    /**
     * The contact's status.
     */
    status: string;
    /**
     * The optional external ID of the payment recipient from the payment cycle.
     * This ID represents the user in an external system.
     */
    externalId: string | null | undefined;
    /**
     * The raw ContactInfo object that was returned from the API
     */
    rawObject: RawContactInfo;
    /**
     * @internal
     * Internal use only. Please use the Mozaic object to utilize this object.
     * @param contactInfo
     */
    constructor(mozaic: Mozaic, contactsApi: ContactsApi, contactInfo: RawContactInfo);
    /**
     * Returns a list of payments that have been sent to this contact. From these payments, you can see the payment cycle that the payment was sent from.
     * Note that only payments that have been sent to this contact will be returned. Payments that have been sent from a payment cycle that is
     * still in Draft status will not be returned because they have not been created yet.
     * @param limit An integer number between 1 and 100.
     * @param page An integer number of the page starting at 1.
     */
    getPayments(limit: number, page: number): Promise<PaymentList>;
}
//# sourceMappingURL=Contact.d.ts.map