Class PaymentCycleList

Hierarchy (view full)

BaseList<PaymentCycle>
- PaymentCycleList

Index

Constructors

Properties

count data page totalCount

Constructors

constructor

new PaymentCycleList(source, data): PaymentCycleList
Converts a paged data response from the API into an SDK friendly format.
Parameters
- source: IApiList<PaymentCycle>
  The API response that contains paging information about the list
- data: undefined | PaymentCycle[]
  The actual list items returned from the API.
Returns PaymentCycleList
Inherited from BaseList.constructor
- Defined in src/resources/BaseList.ts:38

Properties

count

count: number

This is the count of records returned

data

data: PaymentCycle[]

page

page: number

The page this list represents

totalCount

totalCount: number

This is the total count of records available, Needed for pagination