Class Invoices

Hierarchy (view full)

BaseResource
- Invoices

Index

Constructors

Accessors

Methods

execute getInvoice throwIfLimitOrPageAreInvalid throwIfNullOrUndefined

Constructors

constructor

new Invoices(mozaic, configuration): Invoices
Internal
You should not call this constructor directly. Instead, use the Mozaic main entry point to get access to the SDK classes.
Parameters
- mozaic: Mozaic
- configuration: Configuration
Returns Invoices
Overrides BaseResource.constructor
- Defined in src/resources/Invoices/Invoices.ts:18

Accessors

InvoicesApi

get InvoicesApi(): InvoicesApi
Get the underlying API for direct calls to the Mozaic API.

Returns InvoicesApi
- Defined in src/resources/Invoices/Invoices.ts:27

Methods

`Protected`execute

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.
Inherited from BaseResource.execute
- Defined in src/resources/BaseResource.ts:45

getInvoice

getInvoice(invoiceId): Promise<ArrayBuffer>
Parameters
- invoiceId: string
  Downloads an invoice by it's invoiceId. The invoiceId can be found on a payment cycle that has been completed as well as other areas of the Mozaic SDK.
Returns Promise<ArrayBuffer>
an ArrayBuffer containing the bytes of an Invoice PDF. It can be saved using:

fs.writeFileSync(fileName, Buffer.from(arrayBuffer));
- Defined in src/resources/Invoices/Invoices.ts:40

`Protected`throwIfLimitOrPageAreInvalid

throwIfLimitOrPageAreInvalid(limit, page): void
A helper function to validate limit and paging parameters.
Parameters
- limit: number
  Must be between 1 and 100 inclusive.
- page: number
  Must be greater than 0
Returns void
Inherited from BaseResource.throwIfLimitOrPageAreInvalid
- Defined in src/resources/BaseResource.ts:29

`Protected`throwIfNullOrUndefined

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.
Inherited from BaseResource.throwIfNullOrUndefined
- Defined in src/resources/BaseResource.ts:17