All classes in the resource folder should implement this interface so that they can be instantiated in the main barrel.

Hierarchy (view full)

Constructors

Properties

amount: Amount

The amount of the payment

email: string

The recipient's email address. This is the email address at the time the payment was sent. If the email address has changed, this will be the old email address.

id: string

The ID of the payment. This can be used to retrieve a payment.

memo: undefined | null | string

An optional free text field containing user supplied information about the payment. This field has a maximum length of 140 characters.

paymentCycleEntryId: undefined | null | string

If the payment was sent from a payment cycle, then this is the ID of the payment cycle entry. Otherwise, it will be null.

paymentCycleId: undefined | null | string

If the payment was sent from a payment cycle, then this is the ID of the payment cycle. Otherwise, it will be null.

rawObject: Payment

The raw ContactInfo object that was returned from the API

status: string

The status of the payment. Refer to the API documentation for a list of possible statuses.

Methods

  • A helper function to ensure that API calls are successful and return a valid status code.

    Type Parameters

    • T

    Parameters

    • call: (() => Promise<AxiosResponse<T, any>>)

      The API call to guard for exceptions and bad return codes.

        • (): Promise<AxiosResponse<T, any>>
        • Returns Promise<AxiosResponse<T, any>>

    Returns Promise<T>

    A promise of the type returned by Axios in the data field.

  • A helper function that will either return the variable's value or throw an exception if the value is null or undefined. Unit testing is simplified by avoiding ??

    Type Parameters

    • T

    Parameters

    • name: string

      The name of the variable being checked

    • value: undefined | null | T

      The value of the variable being checked

    Returns T

    The value of the variable if it is available, otherwise an exception is thrown.