RefundsResource class

The refunds endpoints with client already applied.

Constructors

RefundsResource(ExsitedClient client)

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

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

createCreditNoteRefund(Object creditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundUpdated>>

POST /api/{api_version}/credit_notes/{credit_note_id}/refunds

createRefundNote(Object refundId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundNote>>

POST /api/{api_version}/refunds/{refund_id}/notes

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

DELETE /api/{api_version}/refunds/{refund_id}

deleteRefundNote(Object refundId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/refunds/{refund_id}/notes/{note_id}

deleteRefundNoteFile(Object refundId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/refunds/{refund_id}/notes/{note_id}/files/{file_id}

getRefund(Object refundId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Refund>>

GET /api/{api_version}/refunds/{refund_id}

getRefundNote(Object refundId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundNote>>

GET /api/{api_version}/refunds/{refund_id}/notes/{note_id}

getRefundNoteFile(Object refundId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundNoteFile>>

GET /api/{api_version}/refunds/{refund_id}/notes/{note_id}/files/{file_id}

getRefundNoteFiles(Object refundId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteFileList>>

GET /api/{api_version}/refunds/{refund_id}/notes/{note_id}/files

getRefundNotes(Object refundId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundNoteList>>

GET /api/{api_version}/refunds/{refund_id}/notes

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

GET /api/{api_version}/refunds

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateRefund(Object refundId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<RefundUpdated>>

PATCH /api/{api_version}/refunds/{refund_id}

Operators

operator ==(Object other) → bool

The equality operator.

inherited