PaymentsResource class

The payments endpoints with client already applied.

Constructors

PaymentsResource(ExsitedClient client)

Bind the resource to a client; normally reached via client.payments.

const

Properties

client → ExsitedClient

The client every call below is made through.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createPayment(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>

POST /api/{api_version}/payments

createPaymentNote(Object paymentId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteRead>>

POST /api/{api_version}/payments/{payment_id}/notes

deletePayment(Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/payments/{payment_id}

deletePaymentNote(Object paymentId, Object paymentNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}

getInvoicePayment(Object invoiceId, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>

GET /api/{api_version}/invoices/{invoice_id}/payments/{payment_id}

getInvoicePayments(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>

GET /api/{api_version}/invoices/{invoice_id}/payments

getOrderPayments(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>

GET /api/{api_version}/orders/{order_id}/payments

getPayment(Object paymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>

GET /api/{api_version}/payments/{payment_id}

getPaymentNote(Object paymentId, Object paymentNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteRead>>

GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}

getPaymentNoteFile(Object paymentId, Object paymentNoteId, Object paymentFileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteFile>>

GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}/files/{payment_file_id}

getPaymentNoteFiles(Object paymentId, Object paymentNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteFileList>>

GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}/files

getPaymentNotes(Object paymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteList>>

GET /api/{api_version}/payments/{payment_id}/notes

getPayments({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>

GET /api/{api_version}/payments

getPaymentsNotes({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentsNoteList>>

GET /api/{api_version}/payments/notes

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updatePayment(Object paymentId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>

PATCH /api/{api_version}/payments/{payment_id}

Operators

operator ==(Object other) → bool

The equality operator.

inherited