@mozaic-io/mozaic-sdk-node/dist/resources/PaymentCycles/PaymentCycle.d.ts

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

import { Mozaic } from "../..";
import { Amount, FeeDirection, PaymentCycle as RawPaymentCycle, PaymentCycleStatus, PaymentCyclesApi, PaymentCycleEntrySortFields } from "../../api";
import { BaseResource } from "../BaseResource";
import { WalletItem } from "../Wallets/WalletItem";
import { PaymentCycleEntry } from "./PaymentCycleEntry";
import { PaymentCycleEntryList } from "./PaymentCycleEntryList";
/**
 * A payment cycle
 */
export declare class PaymentCycle extends BaseResource {
    private _paymentCycleApi;
    private _mozaic;
    /**
     * The long ID of the payment cycle. This can be used to retrieve a payment cycle.
     */
    readonly paymentCycleId: string;
    /**
     * The current status of the payment cycle.
     */
    readonly status: PaymentCycleStatus | undefined;
    /**
     * The total amount of money that will be paid out by the payment cycle.
     */
    readonly amount: Amount | undefined;
    /**
     * The total amount of fees that will be paid on the payment cycle.
     */
    readonly fees: Amount | undefined;
    /**
     * The short ID of the payment cycle. Use this for a human readable version of the Payment Cycle ID.
     * This can also be used to retrieve a payment cycle.
     */
    readonly shortId: string | null | undefined;
    /**
     * The number of payment cycle entries attached to the payment cycle.
     */
    readonly paymentCycleEntryCount: number | undefined;
    /**
     * A fee direction indicating who will pay the fees on a transaction.
     *
     * default = Use the setting defined in the paying user's account settings
     *
     * payer = The paying user also pays the fees
     *
     * payee = The receiving user pays the fees
     *
     * split = The payer and the receiver will split the fees equally
     *
     */
    feeDirection: FeeDirection | undefined;
    /**
     * The payer can specify a free-text string to help describe the reason for the payment
     */
    memo: string | null | undefined;
    /**
     * The starting date of the accounting period of the payment cycle
     */
    accountingFrom: Date | undefined;
    /**
     * The ending date of the accounting period of the payment cycle
     */
    accountingTo: Date | undefined;
    /**
     * The name of the payment cycle
     */
    name: string;
    /**
     * The ID of the invoice. This will only be present after the payment cycle has been finalized.
     */
    invoiceId: string | null | undefined;
    /**
     * The underlying raw object returned from the API
     */
    rawObject: RawPaymentCycle;
    /**
     * @internal
     * Internal use only. Please use the Mozaic object to utilize this object.
     * @param paymentCycleApi
     * @param paymentCycle
     */
    constructor(mozaic: Mozaic, paymentCycleApi: PaymentCyclesApi, paymentCycle: RawPaymentCycle);
    /**
     * Adds a payment cycle entry to the current payment cycle. The payment cycle entry pays the given user the specified amount.
     * @param name The first and last name of the user to pay.
     * @param email The email address of the user to pay. If the user has not already joined Mozaic, they will be sent an email invite to join.
     * @param amount The amount of money to be paid to the user.
     * @param currency The currency that the amount will be paid in. Foreign exchange rates may apply to cross-boarder payments.
     * @param externalId An optional external ID that can be used to identify the payment recipient in an external system. This ID will be returned in the PaymentCycleEntry object.
     * @param memo An optional free text field that can be used to describe the payment. This field has a maximum length of 140 characters.
     */
    addPaymentCycleEntry(name: string, email: string, amount: number, currency: string, externalId?: string, memo?: string): Promise<PaymentCycleEntry>;
    /**
     * Gets payment cycle entries for the payment cycle. Use limit and page to page through
     * the results for large data sets.
     * @param limit The number of records in a page from 1 - 100
     * @param page The number of the page, starts at 1
     * @param sortBy The field to sort the results by.
     * @returns
     */
    getPaymentCycleEntries(limit: number, page: number, sortBy?: PaymentCycleEntrySortFields, sortByAscending?: boolean): Promise<PaymentCycleEntryList>;
    /**
     * Completes the payment cycle by withdrawing money from your specified wallet item and then
     * distributing it to recipients on the payment cycle.
     * @param walletItem The source of funding for the payment cycle. This must be a Payment wallet item and
     * not a Payout wallet item.
     * @returns A new PaymentCycle object representing the finalized payment cycle.
     */
    finalize(walletItem: WalletItem): Promise<PaymentCycle>;
    /**
     * Completes the payment cycle using "Pay by Invoice". You will need to download the invoice
     * through the Invoices.getInvoice method, and then send a payment to the bank account listed
     * on the invoice.
     * @returns A new PaymentCycle object representing the finalized payment cycle.
     */
    finalizeByInvoice(): Promise<PaymentCycle>;
    /**
     * Retrieves an invoice for this payment cycle. Note that an invoice is not generated for a payment
     * cycle until it has been finalized.
     *
     * @returns an ArrayBuffer containing the bytes of an Invoice PDF. It can be saved using:
     *
     * ```fs.writeFileSync(fileName, Buffer.from(arrayBuffer));```
     */
    getInvoice(): Promise<ArrayBuffer>;
}
//# sourceMappingURL=PaymentCycle.d.ts.map