gift_certificates library
The v4 gift certificates family: its endpoints, bound class, path templates and views.
Import it with a prefix, import 'package:exsited/gift_certificates.dart' as gift_certificates;,
because families declare the same top-level names and a Dart export can
neither rename nor prefix them.
Classes
- GiftCertificate
- The gift certificate body.
- GiftCertificateAccountingCode
-
A GiftCertificate's
accounting_code. - GiftCertificateActivityLog
-
One entry of a GiftCertificate's
activity_logs. - GiftCertificateAllocation
-
One entry of a GiftCertificate's
allocations. - GiftCertificateAllocationAccount
-
A GiftCertificateAllocation's
account. - GiftCertificateAllocationRead
-
One allocation, under
gift_certificate_allocation: the fields an allocation carries inallocations. - GiftCertificateAllocations
- The gift certificate allocations body.
- GiftCertificateAllocationsData
-
One entry of a GiftCertificateAllocations's
data. - GiftCertificateAllocationsDataAccount
-
A GiftCertificateAllocationsData's
account. - GiftCertificateCurrency
-
A GiftCertificate's
currency. - GiftCertificateList
- A page of GiftCertificate records.
- GiftCertificatesResource
- The gift certificates endpoints with client already applied.
- GiftCertificatesUrls
- GiftCertificateTransaction
- The gift certificate transaction body.
- GiftCertificateTransactionAccountingCode
-
A GiftCertificateTransaction's
accounting_code. - GiftCertificateTransactionCurrency
-
A GiftCertificateTransaction's
currency. - GiftCertificateTransactionEntry
-
One entry of a GiftCertificate's
transactions. - GiftCertificateTransactionEntryAccountingCode
-
A GiftCertificateTransactionEntry's
accounting_code. - GiftCertificateTransactionEntryCurrency
-
A GiftCertificateTransactionEntry's
currency. - GiftCertificateTransactionList
- A page of GiftCertificateTransaction records.
- GiftCertificateTransactionRead
-
One transaction, under
gift_certificate_transaction: the fields a transaction carries intransactions.
Functions
-
allocateGiftCertificate(
ExsitedClient client, Object gcId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificate> > -
POST /api/{api_version}/gift_certificates/{gc_id}/allocations -
amendGiftCertificate(
ExsitedClient client, Object gcId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificate> > -
POST /api/{api_version}/gift_certificates/{gc_id}/amend -
createGiftCertificate(
ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificate> > -
POST /api/{api_version}/gift_certificates -
deallocateGiftCertificate(
ExsitedClient client, Object gcId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificate> > -
POST /api/{api_version}/gift_certificates/{gc_id}/deallocations -
deleteGiftCertificate(
ExsitedClient client, Object gcId, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< Object?> > -
DELETE /api/{api_version}/gift_certificates/{gc_id} -
getGiftCertificate(
ExsitedClient client, Object gcId, {Map< String, Object?> ? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse< GiftCertificate> > -
GET /api/{api_version}/gift_certificates/{gc_id} -
getGiftCertificateAllocation(
ExsitedClient client, Object gcId, Object allocationId, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificateAllocationRead> > -
GET /api/{api_version}/gift_certificates/{gc_id}/allocations/{allocation_id} -
getGiftCertificateAllocations(
ExsitedClient client, Object gcId, {Map< String, Object?> ? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse< GiftCertificateAllocations> > -
GET /api/{api_version}/gift_certificates/{gc_id}/allocations -
getGiftCertificates(
ExsitedClient client, {Map< String, Object?> ? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse< GiftCertificateList> > -
GET /api/{api_version}/gift_certificates -
getGiftCertificateTransaction(
ExsitedClient client, Object gcId, Object transactionId, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificateTransactionRead> > -
GET /api/{api_version}/gift_certificates/{gc_id}/transactions/{transaction_id} -
getGiftCertificateTransactions(
ExsitedClient client, Object gcId, {Map< String, Object?> ? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse< GiftCertificateTransactionList> > -
GET /api/{api_version}/gift_certificates/{gc_id}/transactions -
updateGiftCertificate(
ExsitedClient client, Object gcId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future< ApiResponse< GiftCertificate> > -
PATCH /api/{api_version}/gift_certificates/{gc_id}