refunds library

The v4 refunds family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/refunds.dart' as refunds;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

AccountRefunds

The account refunds body.

AccountRefundsData

One entry of a AccountRefunds's data.

AccountRefundsDataAccount

A AccountRefundsData's account.

AccountRefundsDataCreditNote

A AccountRefundsData's credit_note.

Refund

The refund body.

RefundAccount

A Refund's account.

RefundCreditNote

A Refund's credit_note.

RefundList

A page of Refund records.

RefundNote

One note on a refund, under note.

RefundNoteAttachment

One entry of a RefundNote's attachments.

RefundNoteCreatedBy

A RefundNote's created_by.

RefundNoteDetail

A RefundNote's refund.

RefundNoteFile

One attachment's descriptor, under file.

RefundNoteList

One page of RefundNote records, under data.

RefundNoteWatcher

One entry of a RefundNote's watchers.

RefundsResource

The refunds endpoints with client already applied.

RefundsUrls

RefundUpdated

The refund updated body.

RefundUpdatedAccount

A RefundUpdated's account.

RefundUpdatedCreditNote

A RefundUpdated's credit_note.

Functions

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

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

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

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

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

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

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

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

deleteRefundNoteFile(ExsitedClient client, 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(ExsitedClient client, Object refundId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Refund>>

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

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

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

getRefundNoteFile(ExsitedClient client, 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(ExsitedClient client, Object refundId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteFileList>>

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

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

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

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

GET /api/{api_version}/refunds

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

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