Class PaymentCycleEntry

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

Hierarchy (view full)

Constructors

constructor

Properties

amount email name rawObject status

Methods

execute throwIfLimitOrPageAreInvalid throwIfNullOrUndefined

Constructors

constructor

Properties

amount

amount: Amount

An object representing the amount received by the user from the payment cycle.

email

email: string

The email of the contact receiving the payment from the payment cycle.

name

name: string

The name of the contact receiving the payment from the payment cycle.

rawObject

rawObject: PaymentCycleEntry

The raw PaymentCycleEntry object that was returned from the API

status

status: string

The status of payment to the user for the payment cycle.

Methods

Protectedexecute

  • execute<T>(call): Promise<T>

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

ProtectedthrowIfLimitOrPageAreInvalid

ProtectedthrowIfNullOrUndefined

  • throwIfNullOrUndefined<T>(name, value): T

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods