vendure library
vendure — the Zuraffa reimplementation of the Vendure Flutter SDK.
The GraphQL commerce seam for the Zuraffa ecosystem: authenticate, manage orders, browse the catalog, and run custom operations against a Vendure shop-api — over the registered VendureDataSource port, with the schema's 179 entities as zorphy types.
final vendure = await Vendure.initialize(
endpoint: 'https://shop.example.com/shop-api',
languageCode: 'en',
);
final order = await vendure.order.getActiveOrder();
Classes
- $Address
-
Vendure
Addressentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Adjustment
-
Vendure
Adjustmententity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $AlreadyLoggedInError
-
Vendure
AlreadyLoggedInErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Asset
-
Vendure
Assetentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $AssetList
-
Vendure
AssetListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $AuthenticationInput
-
Vendure
AuthenticationInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $AuthenticationMethod
-
Vendure
AuthenticationMethodentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $BooleanCustomFieldConfig
-
Vendure
BooleanCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $BooleanListOperators
-
Vendure
BooleanListOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $BooleanOperators
-
Vendure
BooleanOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Channel
-
Vendure
Channelentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Collection
-
Vendure
Collectionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionBreadcrumb
-
Vendure
CollectionBreadcrumbentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionFilterParameter
-
Vendure
CollectionFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionList
-
Vendure
CollectionListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionListOptions
-
Vendure
CollectionListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionResult
-
Vendure
CollectionResultentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionSortParameter
-
Vendure
CollectionSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CollectionTranslation
-
Vendure
CollectionTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigArg
-
Vendure
ConfigArgentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigArgDefinition
-
Vendure
ConfigArgDefinitionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigArgInput
-
Vendure
ConfigArgInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigurableOperation
-
Vendure
ConfigurableOperationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigurableOperationDefinition
-
Vendure
ConfigurableOperationDefinitionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ConfigurableOperationInput
-
Vendure
ConfigurableOperationInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Coordinate
-
Vendure
Coordinateentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Country
-
Vendure
Countryentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CountryList
-
Vendure
CountryListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CouponCodeExpiredError
-
Vendure
CouponCodeExpiredErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CouponCodeInvalidError
-
Vendure
CouponCodeInvalidErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CouponCodeLimitError
-
Vendure
CouponCodeLimitErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CreateAddressInput
-
Vendure
CreateAddressInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CreateCustomerInput
-
Vendure
CreateCustomerInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CurrentUser
-
Vendure
CurrentUserentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CurrentUserChannel
-
Vendure
CurrentUserChannelentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Customer
-
Vendure
Customerentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CustomerFilterParameter
-
Vendure
CustomerFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CustomerGroup
-
Vendure
CustomerGroupentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CustomerList
-
Vendure
CustomerListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CustomerListOptions
-
Vendure
CustomerListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $CustomerSortParameter
-
Vendure
CustomerSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $DateListOperators
-
Vendure
DateListOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $DateOperators
-
Vendure
DateOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $DateRange
-
Vendure
DateRangeentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $DateTimeCustomFieldConfig
-
Vendure
DateTimeCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $DeletionResponse
-
Vendure
DeletionResponseentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Discount
-
Vendure
Discountentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $EmailAddressConflictError
-
Vendure
EmailAddressConflictErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Facet
-
Vendure
Facetentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetFilterParameter
-
Vendure
FacetFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetList
-
Vendure
FacetListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetListOptions
-
Vendure
FacetListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetSortParameter
-
Vendure
FacetSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetTranslation
-
Vendure
FacetTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValue
-
Vendure
FacetValueentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueFilterInput
-
Vendure
FacetValueFilterInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueFilterParameter
-
Vendure
FacetValueFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueList
-
Vendure
FacetValueListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueListOptions
-
Vendure
FacetValueListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueResult
-
Vendure
FacetValueResultentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueSortParameter
-
Vendure
FacetValueSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FacetValueTranslation
-
Vendure
FacetValueTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FloatCustomFieldConfig
-
Vendure
FloatCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Fulfillment
-
Vendure
Fulfillmententity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $FulfillmentLine
-
Vendure
FulfillmentLineentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $GuestCheckoutError
-
Vendure
GuestCheckoutErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $HistoryEntry
-
Vendure
HistoryEntryentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $HistoryEntryFilterParameter
-
Vendure
HistoryEntryFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $HistoryEntryList
-
Vendure
HistoryEntryListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $HistoryEntryListOptions
-
Vendure
HistoryEntryListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $HistoryEntrySortParameter
-
Vendure
HistoryEntrySortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IdentifierChangeTokenExpiredError
-
Vendure
IdentifierChangeTokenExpiredErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IdentifierChangeTokenInvalidError
-
Vendure
IdentifierChangeTokenInvalidErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IdListOperators
-
Vendure
IdListOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IdOperators
-
Vendure
IdOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IneligiblePaymentMethodError
-
Vendure
IneligiblePaymentMethodErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IneligibleShippingMethodError
-
Vendure
IneligibleShippingMethodErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $InsufficientStockError
-
Vendure
InsufficientStockErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $IntCustomFieldConfig
-
Vendure
IntCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $InvalidCredentialsError
-
Vendure
InvalidCredentialsErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $LocaleStringCustomFieldConfig
-
Vendure
LocaleStringCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $LocaleTextCustomFieldConfig
-
Vendure
LocaleTextCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $LocalizedString
-
Vendure
LocalizedStringentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $MissingPasswordError
-
Vendure
MissingPasswordErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NativeAuthInput
-
Vendure
NativeAuthInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NativeAuthStrategyError
-
Vendure
NativeAuthStrategyErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NegativeQuantityError
-
Vendure
NegativeQuantityErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NoActiveOrderError
-
Vendure
NoActiveOrderErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NotVerifiedError
-
Vendure
NotVerifiedErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NumberListOperators
-
Vendure
NumberListOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NumberOperators
-
Vendure
NumberOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $NumberRange
-
Vendure
NumberRangeentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Order
-
Vendure
Orderentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderAddress
-
Vendure
OrderAddressentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderFilterParameter
-
Vendure
OrderFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderLimitError
-
Vendure
OrderLimitErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderLine
-
Vendure
OrderLineentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderList
-
Vendure
OrderListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderListOptions
-
Vendure
OrderListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderModificationError
-
Vendure
OrderModificationErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderPaymentStateError
-
Vendure
OrderPaymentStateErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderSortParameter
-
Vendure
OrderSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderStateTransitionError
-
Vendure
OrderStateTransitionErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $OrderTaxSummary
-
Vendure
OrderTaxSummaryentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PasswordAlreadySetError
-
Vendure
PasswordAlreadySetErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PasswordResetTokenExpiredError
-
Vendure
PasswordResetTokenExpiredErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PasswordResetTokenInvalidError
-
Vendure
PasswordResetTokenInvalidErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PasswordValidationError
-
Vendure
PasswordValidationErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Payment
-
Vendure
Paymententity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentDeclinedError
-
Vendure
PaymentDeclinedErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentFailedError
-
Vendure
PaymentFailedErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentInput
-
Vendure
PaymentInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentMethod
-
Vendure
PaymentMethodentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentMethodQuote
-
Vendure
PaymentMethodQuoteentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PaymentMethodTranslation
-
Vendure
PaymentMethodTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PriceRange
-
Vendure
PriceRangeentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Product
-
Vendure
Productentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductFilterParameter
-
Vendure
ProductFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductList
-
Vendure
ProductListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductListOptions
-
Vendure
ProductListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductOption
-
Vendure
ProductOptionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductOptionGroup
-
Vendure
ProductOptionGroupentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductOptionGroupTranslation
-
Vendure
ProductOptionGroupTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductOptionTranslation
-
Vendure
ProductOptionTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductSortParameter
-
Vendure
ProductSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductTranslation
-
Vendure
ProductTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariant
-
Vendure
ProductVariantentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariantFilterParameter
-
Vendure
ProductVariantFilterParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariantList
-
Vendure
ProductVariantListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariantListOptions
-
Vendure
ProductVariantListOptionsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariantSortParameter
-
Vendure
ProductVariantSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProductVariantTranslation
-
Vendure
ProductVariantTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Promotion
-
Vendure
Promotionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PromotionList
-
Vendure
PromotionListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $PromotionTranslation
-
Vendure
PromotionTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Province
-
Vendure
Provinceentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ProvinceList
-
Vendure
ProvinceListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Refund
-
Vendure
Refundentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $RefundLine
-
Vendure
RefundLineentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Region
-
Vendure
Regionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $RegionTranslation
-
Vendure
RegionTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $RegisterCustomerInput
-
Vendure
RegisterCustomerInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $RelationCustomFieldConfig
-
Vendure
RelationCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Role
-
Vendure
Roleentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $RoleList
-
Vendure
RoleListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchInput
-
Vendure
SearchInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchReindexResponse
-
Vendure
SearchReindexResponseentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchResponse
-
Vendure
SearchResponseentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchResult
-
Vendure
SearchResultentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchResultAsset
-
Vendure
SearchResultAssetentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SearchResultSortParameter
-
Vendure
SearchResultSortParameterentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Seller
-
Vendure
Sellerentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ShippingLine
-
Vendure
ShippingLineentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ShippingMethod
-
Vendure
ShippingMethodentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ShippingMethodList
-
Vendure
ShippingMethodListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ShippingMethodQuote
-
Vendure
ShippingMethodQuoteentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $ShippingMethodTranslation
-
Vendure
ShippingMethodTranslationentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $SinglePrice
-
Vendure
SinglePriceentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $StringCustomFieldConfig
-
Vendure
StringCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $StringFieldOption
-
Vendure
StringFieldOptionentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $StringListOperators
-
Vendure
StringListOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $StringOperators
-
Vendure
StringOperatorsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Success
-
Vendure
Successentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Surcharge
-
Vendure
Surchargeentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Tag
-
Vendure
Tagentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TagList
-
Vendure
TagListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TaxCategory
-
Vendure
TaxCategoryentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TaxLine
-
Vendure
TaxLineentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TaxRate
-
Vendure
TaxRateentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TaxRateList
-
Vendure
TaxRateListentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $TextCustomFieldConfig
-
Vendure
TextCustomFieldConfigentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $UpdateAddressInput
-
Vendure
UpdateAddressInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $UpdateCustomerInput
-
Vendure
UpdateCustomerInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $UpdateOrderInput
-
Vendure
UpdateOrderInputentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $User
-
Vendure
Userentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $UserCustomFields
-
Vendure
UserCustomFieldsentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $VerificationTokenExpiredError
-
Vendure
VerificationTokenExpiredErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $VerificationTokenInvalidError
-
Vendure
VerificationTokenInvalidErrorentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - $Zone
-
Vendure
Zoneentity — zorphy-generated from the schema manifest (spec 001, entity-manifest.json). - ActiveOrderResult
- AddPaymentToOrderResult
- Address
- AddressFields
- Field descriptors for Address query construction
- AddressPatch
- Adjustment
- AdjustmentFields
- Field descriptors for Adjustment query construction
- AdjustmentPatch
- AlreadyLoggedInError
- AlreadyLoggedInErrorFields
- Field descriptors for AlreadyLoggedInError query construction
- AlreadyLoggedInErrorPatch
- AppCheckConfig
- Configuration for Firebase App Check integration
- ApplyCouponCodeResult
- Asset
- AssetFields
- Field descriptors for Asset query construction
- AssetList
- AssetListFields
- Field descriptors for AssetList query construction
- AssetListPatch
- AssetPatch
- AuthenticationInput
- AuthenticationInputFields
- Field descriptors for AuthenticationInput query construction
- AuthenticationInputPatch
- AuthenticationMethod
- AuthenticationMethodFields
- Field descriptors for AuthenticationMethod query construction
- AuthenticationMethodPatch
- AuthenticationResult
- AuthLink
-
Simple header-based authentication link that adds headerKey:
getToken()to every request. - AuthOperations
-
Authentication operations backed by the clean-architecture stack —
AuthRepository + the auth use cases (spec 001: the source SDK's
AuthOperationsre-shape; the old group built the stack itself from a bare GraphQLClient, the facade now wires it once). - AuthRepository
- Abstract repository contract for authentication operations. Implementations delegate to remote data sources (Vendure GraphQL) and local data sources (token management).
- BooleanCustomFieldConfig
- BooleanCustomFieldConfigFields
- Field descriptors for BooleanCustomFieldConfig query construction
- BooleanCustomFieldConfigPatch
- BooleanListOperators
- BooleanListOperatorsFields
- Field descriptors for BooleanListOperators query construction
- BooleanListOperatorsPatch
- BooleanOperators
- BooleanOperatorsFields
- Field descriptors for BooleanOperators query construction
- BooleanOperatorsPatch
- CancellableHttpLink
- An HTTP link that supports request cancellation.
-
CancellableOperation<
T> - Result wrapper that includes both the result future and a cancellation token.
- CancellationContextEntry
- Context entry that holds a CancellationToken.
- CancellationToken
- A token that can be used to cancel an in-flight GraphQL operation.
- CatalogOperations
- CatalogRepository
- Domain repository interface for Catalog operations. Each method mirrors a public method on CatalogOperations (the facade).
- Channel
- ChannelFields
- Field descriptors for Channel query construction
- ChannelPatch
- Collection
- CollectionBreadcrumb
- CollectionBreadcrumbFields
- Field descriptors for CollectionBreadcrumb query construction
- CollectionBreadcrumbPatch
- CollectionFields
- Field descriptors for Collection query construction
- CollectionFilterParameter
- CollectionFilterParameterFields
- Field descriptors for CollectionFilterParameter query construction
- CollectionFilterParameterPatch
- CollectionList
- CollectionListFields
- Field descriptors for CollectionList query construction
- CollectionListOptions
- CollectionListOptionsFields
- Field descriptors for CollectionListOptions query construction
- CollectionListOptionsPatch
- CollectionListPatch
- CollectionPatch
- CollectionResult
- CollectionResultFields
- Field descriptors for CollectionResult query construction
- CollectionResultPatch
- CollectionSortParameter
- CollectionSortParameterFields
- Field descriptors for CollectionSortParameter query construction
- CollectionSortParameterPatch
- CollectionTranslation
- CollectionTranslationFields
- Field descriptors for CollectionTranslation query construction
- CollectionTranslationPatch
- ConfigArg
- ConfigArgDefinition
- ConfigArgDefinitionFields
- Field descriptors for ConfigArgDefinition query construction
- ConfigArgDefinitionPatch
- ConfigArgFields
- Field descriptors for ConfigArg query construction
- ConfigArgInput
- ConfigArgInputFields
- Field descriptors for ConfigArgInput query construction
- ConfigArgInputPatch
- ConfigArgPatch
- ConfigurableOperation
- ConfigurableOperationDefinition
- ConfigurableOperationDefinitionFields
- Field descriptors for ConfigurableOperationDefinition query construction
- ConfigurableOperationDefinitionPatch
- ConfigurableOperationFields
- Field descriptors for ConfigurableOperation query construction
- ConfigurableOperationInput
- ConfigurableOperationInputFields
- Field descriptors for ConfigurableOperationInput query construction
- ConfigurableOperationInputPatch
- ConfigurableOperationPatch
- ConnectionAck
- The server will send this acknowledgment message after receiving the init command from the client if the init was successful.
- ConnectionError
- The server will send this error message after receiving the init command from the client if the init was not successful.
- ConnectionKeepAlive
- The server will send this message to keep the connection alive
- Context
- A Context to be passed along with a Request.
- ContextEntry
- Entry in the Context.
- Coordinate
- CoordinateFields
- Field descriptors for Coordinate query construction
- CoordinatePatch
- Country
- CountryFields
- Field descriptors for Country query construction
- CountryList
- CountryListFields
- Field descriptors for CountryList query construction
- CountryListPatch
- CountryPatch
- CouponCodeExpiredError
- CouponCodeExpiredErrorFields
- Field descriptors for CouponCodeExpiredError query construction
- CouponCodeExpiredErrorPatch
- CouponCodeInvalidError
- CouponCodeInvalidErrorFields
- Field descriptors for CouponCodeInvalidError query construction
- CouponCodeInvalidErrorPatch
- CouponCodeLimitError
- CouponCodeLimitErrorFields
- Field descriptors for CouponCodeLimitError query construction
- CouponCodeLimitErrorPatch
- CreateAddressInput
- CreateAddressInputFields
- Field descriptors for CreateAddressInput query construction
- CreateAddressInputPatch
- CreateCustomerInput
- CreateCustomerInputFields
- Field descriptors for CreateCustomerInput query construction
- CreateCustomerInputPatch
- CurrentUser
- CurrentUserChannel
- CurrentUserChannelFields
- Field descriptors for CurrentUserChannel query construction
- CurrentUserChannelPatch
- CurrentUserFields
- Field descriptors for CurrentUser query construction
- CurrentUserPatch
- Customer
- CustomerFields
- Field descriptors for Customer query construction
- CustomerFilterParameter
- CustomerFilterParameterFields
- Field descriptors for CustomerFilterParameter query construction
- CustomerFilterParameterPatch
- CustomerGroup
- CustomerGroupFields
- Field descriptors for CustomerGroup query construction
- CustomerGroupPatch
- CustomerList
- CustomerListFields
- Field descriptors for CustomerList query construction
- CustomerListOptions
- CustomerListOptionsFields
- Field descriptors for CustomerListOptions query construction
- CustomerListOptionsPatch
- CustomerListPatch
- CustomerOperations
- CustomerPatch
- CustomerRepository
- Domain repository interface for Customer operations. Each method mirrors a public method on CustomerOperations (the facade).
- CustomerSortParameter
- CustomerSortParameterFields
- Field descriptors for CustomerSortParameter query construction
- CustomerSortParameterPatch
- CustomOperations
- Direct access to the underlying GraphQL seam — the escape hatch the facade contract pins for operations the convenience groups don't cover.
- DateListOperators
- DateListOperatorsFields
- Field descriptors for DateListOperators query construction
- DateListOperatorsPatch
- DateOperators
- DateOperatorsFields
- Field descriptors for DateOperators query construction
- DateOperatorsPatch
- DateRange
- DateRangeFields
- Field descriptors for DateRange query construction
- DateRangePatch
- DateTimeCustomFieldConfig
- DateTimeCustomFieldConfigFields
- Field descriptors for DateTimeCustomFieldConfig query construction
- DateTimeCustomFieldConfigPatch
- DedupeLink
- A Link to deduplicate Requests
- DefaultPolicies
- The default Policies to set for each client action.
- DeletionResponse
- DeletionResponseFields
- Field descriptors for DeletionResponse query construction
- DeletionResponsePatch
- Discount
- DiscountFields
- Field descriptors for Discount query construction
- DiscountPatch
- EmailAddressConflictError
- EmailAddressConflictErrorFields
- Field descriptors for EmailAddressConflictError query construction
- EmailAddressConflictErrorPatch
- ErrorLink
- ErrorLink allows interception of GraphQL errors (using onGraphQLError) and LinkExceptions (using onException).
- ErrorLocation
- Location of a GraphQL error in the request document
- Facet
- FacetFields
- Field descriptors for Facet query construction
- FacetFilterParameter
- FacetFilterParameterFields
- Field descriptors for FacetFilterParameter query construction
- FacetFilterParameterPatch
- FacetList
- FacetListFields
- Field descriptors for FacetList query construction
- FacetListOptions
- FacetListOptionsFields
- Field descriptors for FacetListOptions query construction
- FacetListOptionsPatch
- FacetListPatch
- FacetPatch
- FacetSortParameter
- FacetSortParameterFields
- Field descriptors for FacetSortParameter query construction
- FacetSortParameterPatch
- FacetTranslation
- FacetTranslationFields
- Field descriptors for FacetTranslation query construction
- FacetTranslationPatch
- FacetValue
- FacetValueFields
- Field descriptors for FacetValue query construction
- FacetValueFilterInput
- FacetValueFilterInputFields
- Field descriptors for FacetValueFilterInput query construction
- FacetValueFilterInputPatch
- FacetValueFilterParameter
- FacetValueFilterParameterFields
- Field descriptors for FacetValueFilterParameter query construction
- FacetValueFilterParameterPatch
- FacetValueList
- FacetValueListFields
- Field descriptors for FacetValueList query construction
- FacetValueListOptions
- FacetValueListOptionsFields
- Field descriptors for FacetValueListOptions query construction
- FacetValueListOptionsPatch
- FacetValueListPatch
- FacetValuePatch
- FacetValueResult
- FacetValueResultFields
- Field descriptors for FacetValueResult query construction
- FacetValueResultPatch
- FacetValueSortParameter
- FacetValueSortParameterFields
- Field descriptors for FacetValueSortParameter query construction
- FacetValueSortParameterPatch
- FacetValueTranslation
- FacetValueTranslationFields
- Field descriptors for FacetValueTranslation query construction
- FacetValueTranslationPatch
- FetchMoreOptions
- options for fetchMore operations
- FloatCustomFieldConfig
- FloatCustomFieldConfigFields
- Field descriptors for FloatCustomFieldConfig query construction
- FloatCustomFieldConfigPatch
- Fragment
- A fragment in a document, optionally defined by fragmentName
- FragmentRequest
- Cache access request of fragment with variables.
- Fulfillment
- FulfillmentFields
- Field descriptors for Fulfillment query construction
- FulfillmentLine
- FulfillmentLineFields
- Field descriptors for FulfillmentLine query construction
- FulfillmentLinePatch
- FulfillmentPatch
- GraphQLCache
-
Optimistic GraphQL Entity cache with
normalizeTypePolicysupport and configurable store. - GraphQLClient
-
Universal GraphQL Client with configurable caching and link system.
modelled after the
apollo-client. - GraphQLDataProxy
- A proxy to the normalized data living in our store.
- GraphQLError
- GraphQL Error returned if execution fails
- GraphQLProtocol
- ALL protocol supported by the library
- GraphQLSocketMessage
- Base type for representing a server-client subscription message.
- GraphQLVendureDataSource
- The platform driver for VendureDataSource — the GraphQL adapter that talks to a Vendure shop-api endpoint over HTTP.
- GraphQLWebSocketChannel
- GuestCheckoutError
- GuestCheckoutErrorFields
- Field descriptors for GuestCheckoutError query construction
- GuestCheckoutErrorPatch
- HistoryEntry
- HistoryEntryFields
- Field descriptors for HistoryEntry query construction
- HistoryEntryFilterParameter
- HistoryEntryFilterParameterFields
- Field descriptors for HistoryEntryFilterParameter query construction
- HistoryEntryFilterParameterPatch
- HistoryEntryList
- HistoryEntryListFields
- Field descriptors for HistoryEntryList query construction
- HistoryEntryListOptions
- HistoryEntryListOptionsFields
- Field descriptors for HistoryEntryListOptions query construction
- HistoryEntryListOptionsPatch
- HistoryEntryListPatch
- HistoryEntryPatch
- HistoryEntrySortParameter
- HistoryEntrySortParameterFields
- Field descriptors for HistoryEntrySortParameter query construction
- HistoryEntrySortParameterPatch
- HiveStore
- HttpLink
- A simple HttpLink implementation.
- HttpLinkHeaders
- HTTP link headers
- HttpLinkResponseContext
- HTTP link Response Context
- IdentifierChangeTokenExpiredError
- IdentifierChangeTokenExpiredErrorFields
- Field descriptors for IdentifierChangeTokenExpiredError query construction
- IdentifierChangeTokenExpiredErrorPatch
- IdentifierChangeTokenInvalidError
- IdentifierChangeTokenInvalidErrorFields
- Field descriptors for IdentifierChangeTokenInvalidError query construction
- IdentifierChangeTokenInvalidErrorPatch
- IdListOperators
- IdListOperatorsFields
- Field descriptors for IdListOperators query construction
- IdListOperatorsPatch
- IdOperators
- IdOperatorsFields
- Field descriptors for IdOperators query construction
- IdOperatorsPatch
- IneligiblePaymentMethodError
- IneligiblePaymentMethodErrorFields
- Field descriptors for IneligiblePaymentMethodError query construction
- IneligiblePaymentMethodErrorPatch
- IneligibleShippingMethodError
- IneligibleShippingMethodErrorFields
- Field descriptors for IneligibleShippingMethodError query construction
- IneligibleShippingMethodErrorPatch
- InitOperation
- After establishing a connection with the server, the client will send this message to tell the server that it is ready to begin sending new subscription queries.
- InMemoryStore
- Simplest possible Map-backed store
- InMemoryVendureDataSource
- The pure-Dart VendureDataSource — the test/dev stand-in for the GraphQL adapter.
- InsufficientStockError
- InsufficientStockErrorFields
- Field descriptors for InsufficientStockError query construction
- InsufficientStockErrorPatch
- IntCustomFieldConfig
- IntCustomFieldConfigFields
- Field descriptors for IntCustomFieldConfig query construction
- IntCustomFieldConfigPatch
- InvalidCredentialsError
- InvalidCredentialsErrorFields
- Field descriptors for InvalidCredentialsError query construction
- InvalidCredentialsErrorPatch
- JsonSerializable
- Link
-
DocumentNode-based GraphQL execution interface - ListOptions
-
The list-options vocabulary every Vendure list query shares: filter,
sort, and pagination (skip/take). Serialized onto the wire as the
optionsvariable. - LocaleStringCustomFieldConfig
- LocaleStringCustomFieldConfigFields
- Field descriptors for LocaleStringCustomFieldConfig query construction
- LocaleStringCustomFieldConfigPatch
- LocaleTextCustomFieldConfig
- LocaleTextCustomFieldConfigFields
- Field descriptors for LocaleTextCustomFieldConfig query construction
- LocaleTextCustomFieldConfigPatch
- LocalizedString
- LocalizedStringFields
- Field descriptors for LocalizedString query construction
- LocalizedStringPatch
- MessageTypes
-
These messages represent the structures used for Client-server communication
in a GraphQL web-socket subscription. Each message is represented in a JSON
format where the data type is denoted by the
typefield. A list of constants used for identifying message types - MissingPasswordError
- MissingPasswordErrorFields
- Field descriptors for MissingPasswordError query construction
- MissingPasswordErrorPatch
-
MultiSourceResult<
TParsed> -
MutationCallbackHandler<
TParsed> -
Handles execution of mutation
update,onCompleted, andonErrorcallbacks -
MutationOptions<
TParsed extends Object?> - NativeAuthenticationResult
- NativeAuthInput
- NativeAuthInputFields
- Field descriptors for NativeAuthInput query construction
- NativeAuthInputPatch
- NativeAuthStrategyError
- NativeAuthStrategyErrorFields
- Field descriptors for NativeAuthStrategyError query construction
- NativeAuthStrategyErrorPatch
- NegativeQuantityError
- NegativeQuantityErrorFields
- Field descriptors for NegativeQuantityError query construction
- NegativeQuantityErrorPatch
- NoActiveOrderError
- NoActiveOrderErrorFields
- Field descriptors for NoActiveOrderError query construction
- NoActiveOrderErrorPatch
- NotVerifiedError
- NotVerifiedErrorFields
- Field descriptors for NotVerifiedError query construction
- NotVerifiedErrorPatch
- NumberListOperators
- NumberListOperatorsFields
- Field descriptors for NumberListOperators query construction
- NumberListOperatorsPatch
- NumberOperators
- NumberOperatorsFields
- Field descriptors for NumberOperators query construction
- NumberOperatorsPatch
- NumberRange
- NumberRangeFields
- Field descriptors for NumberRange query construction
- NumberRangePatch
-
ObservableQuery<
TParsed> - An Observable/Stream-based API for both queries and mutations.
- Operation
- An operation in a document, optionally defined by operationName
- Order
- OrderAddress
- OrderAddressFields
- Field descriptors for OrderAddress query construction
- OrderAddressPatch
- OrderFields
- Field descriptors for Order query construction
- OrderFilterParameter
- OrderFilterParameterFields
- Field descriptors for OrderFilterParameter query construction
- OrderFilterParameterPatch
- OrderLimitError
- OrderLimitErrorFields
- Field descriptors for OrderLimitError query construction
- OrderLimitErrorPatch
- OrderLine
- OrderLineFields
- Field descriptors for OrderLine query construction
- OrderLinePatch
- OrderList
- OrderListFields
- Field descriptors for OrderList query construction
- OrderListOptions
- OrderListOptionsFields
- Field descriptors for OrderListOptions query construction
- OrderListOptionsPatch
- OrderListPatch
- OrderModificationError
- OrderModificationErrorFields
- Field descriptors for OrderModificationError query construction
- OrderModificationErrorPatch
- OrderOperations
- OrderPatch
- OrderPaymentStateError
- OrderPaymentStateErrorFields
- Field descriptors for OrderPaymentStateError query construction
- OrderPaymentStateErrorPatch
- OrderRepository
- Domain repository interface for Order operations. Each method mirrors a public method on OrderOperations (the facade).
- OrderSortParameter
- OrderSortParameterFields
- Field descriptors for OrderSortParameter query construction
- OrderSortParameterPatch
- OrderStateTransitionError
- OrderStateTransitionErrorFields
- Field descriptors for OrderStateTransitionError query construction
- OrderStateTransitionErrorPatch
- OrderTaxSummary
- OrderTaxSummaryFields
- Field descriptors for OrderTaxSummary query construction
- OrderTaxSummaryPatch
-
PaginatedList<
T> -
A page of results from a Vendure list query — the
items/totalItemspair every list operation returns (ported from the source SDK'sPaginatedList). -
PaginatedListImpl<
T> - PassthroughLink
- PasswordAlreadySetError
- PasswordAlreadySetErrorFields
- Field descriptors for PasswordAlreadySetError query construction
- PasswordAlreadySetErrorPatch
- PasswordResetTokenExpiredError
- PasswordResetTokenExpiredErrorFields
- Field descriptors for PasswordResetTokenExpiredError query construction
- PasswordResetTokenExpiredErrorPatch
- PasswordResetTokenInvalidError
- PasswordResetTokenInvalidErrorFields
- Field descriptors for PasswordResetTokenInvalidError query construction
- PasswordResetTokenInvalidErrorPatch
- PasswordValidationError
- PasswordValidationErrorFields
- Field descriptors for PasswordValidationError query construction
- PasswordValidationErrorPatch
- Payment
- PaymentDeclinedError
- PaymentDeclinedErrorFields
- Field descriptors for PaymentDeclinedError query construction
- PaymentDeclinedErrorPatch
- PaymentFailedError
- PaymentFailedErrorFields
- Field descriptors for PaymentFailedError query construction
- PaymentFailedErrorPatch
- PaymentFields
- Field descriptors for Payment query construction
- PaymentInput
- PaymentInputFields
- Field descriptors for PaymentInput query construction
- PaymentInputPatch
- PaymentMethod
- PaymentMethodFields
- Field descriptors for PaymentMethod query construction
- PaymentMethodPatch
- PaymentMethodQuote
- PaymentMethodQuoteFields
- Field descriptors for PaymentMethodQuote query construction
- PaymentMethodQuotePatch
- PaymentMethodTranslation
- PaymentMethodTranslationFields
- Field descriptors for PaymentMethodTranslation query construction
- PaymentMethodTranslationPatch
- PaymentPatch
- PingMessage
- Policies
- Container for supplying fetch, error, and cacheReread policies.
- PongMessage
- PriceRange
- PriceRangeFields
- Field descriptors for PriceRange query construction
- PriceRangePatch
- Product
- ProductFields
- Field descriptors for Product query construction
- ProductFilterParameter
- ProductFilterParameterFields
- Field descriptors for ProductFilterParameter query construction
- ProductFilterParameterPatch
- ProductList
- ProductListFields
- Field descriptors for ProductList query construction
- ProductListOptions
- ProductListOptionsFields
- Field descriptors for ProductListOptions query construction
- ProductListOptionsPatch
- ProductListPatch
- ProductOption
- ProductOptionFields
- Field descriptors for ProductOption query construction
- ProductOptionGroup
- ProductOptionGroupFields
- Field descriptors for ProductOptionGroup query construction
- ProductOptionGroupPatch
- ProductOptionGroupTranslation
- ProductOptionGroupTranslationFields
- Field descriptors for ProductOptionGroupTranslation query construction
- ProductOptionGroupTranslationPatch
- ProductOptionPatch
- ProductOptionTranslation
- ProductOptionTranslationFields
- Field descriptors for ProductOptionTranslation query construction
- ProductOptionTranslationPatch
- ProductPatch
- ProductSortParameter
- ProductSortParameterFields
- Field descriptors for ProductSortParameter query construction
- ProductSortParameterPatch
- ProductTranslation
- ProductTranslationFields
- Field descriptors for ProductTranslation query construction
- ProductTranslationPatch
- ProductVariant
- ProductVariantFields
- Field descriptors for ProductVariant query construction
- ProductVariantFilterParameter
- ProductVariantFilterParameterFields
- Field descriptors for ProductVariantFilterParameter query construction
- ProductVariantFilterParameterPatch
- ProductVariantList
- ProductVariantListFields
- Field descriptors for ProductVariantList query construction
- ProductVariantListOptions
- ProductVariantListOptionsFields
- Field descriptors for ProductVariantListOptions query construction
- ProductVariantListOptionsPatch
- ProductVariantListPatch
- ProductVariantPatch
- ProductVariantSortParameter
- ProductVariantSortParameterFields
- Field descriptors for ProductVariantSortParameter query construction
- ProductVariantSortParameterPatch
- ProductVariantTranslation
- ProductVariantTranslationFields
- Field descriptors for ProductVariantTranslation query construction
- ProductVariantTranslationPatch
- Promotion
- PromotionFields
- Field descriptors for Promotion query construction
- PromotionList
- PromotionListFields
- Field descriptors for PromotionList query construction
- PromotionListPatch
- PromotionPatch
- PromotionTranslation
- PromotionTranslationFields
- Field descriptors for PromotionTranslation query construction
- PromotionTranslationPatch
- Province
- ProvinceFields
- Field descriptors for Province query construction
- ProvinceList
- ProvinceListFields
- Field descriptors for ProvinceList query construction
- ProvinceListPatch
- ProvincePatch
-
QueryCallbackHandler<
TParsed> - Handles execution of query callbacks
- QueryManager
-
QueryOptions<
TParsed extends Object?> - Query options.
- QueryPayload
- Represent the payload used during a Start query operation. The operationName should match one of the top level query definitions defined in the query provided. Additional variables can be provided and sent to the server for processing.
-
QueryResult<
TParsed extends Object?> - A single operation result
- RefreshCustomerVerificationResult
- Refund
- RefundFields
- Field descriptors for Refund query construction
- RefundLine
- RefundLineFields
- Field descriptors for RefundLine query construction
- RefundLinePatch
- RefundPatch
- Region
- RegionFields
- Field descriptors for Region query construction
- RegionPatch
- RegionTranslation
- RegionTranslationFields
- Field descriptors for RegionTranslation query construction
- RegionTranslationPatch
- RegisterCustomerAccountResult
- RegisterCustomerInput
- RegisterCustomerInputFields
- Field descriptors for RegisterCustomerInput query construction
- RegisterCustomerInputPatch
- RelationCustomFieldConfig
- RelationCustomFieldConfigFields
- Field descriptors for RelationCustomFieldConfig query construction
- RelationCustomFieldConfigPatch
- RemoveOrderItemsResult
- Request
- Execution request of an operation with variables.
- RequestExtensionsThunk
- Exposes Request extensions
- RequestPasswordResetResult
- RequestSerializer
- JSON Request serializer.
- RequestUpdateCustomerEmailAddressResult
- ResetPasswordResult
- Response
- Execution response
- ResponseExtensions
- Extensions returned with the response
- ResponseParser
- JSON Response parser
- Role
- RoleFields
- Field descriptors for Role query construction
- RoleList
- RoleListFields
- Field descriptors for RoleList query construction
- RoleListPatch
- RolePatch
- SearchInput
- SearchInputFields
- Field descriptors for SearchInput query construction
- SearchInputPatch
- SearchReindexResponse
- SearchReindexResponseFields
- Field descriptors for SearchReindexResponse query construction
- SearchReindexResponsePatch
- SearchResponse
- SearchResponseFields
- Field descriptors for SearchResponse query construction
- SearchResponsePatch
- SearchResult
- SearchResultAsset
- SearchResultAssetFields
- Field descriptors for SearchResultAsset query construction
- SearchResultAssetPatch
- SearchResultFields
- Field descriptors for SearchResult query construction
- SearchResultPatch
- SearchResultPrice
-
Vendure's
SearchResultPriceGraphQL union: either a price range (when the channel's currency rounds a product's price into a band) or a single price. The sealed hierarchy is ported verbatim from the source SDK — it is a wire union, not a zorphy entity. - SearchResultSortParameter
- SearchResultSortParameterFields
- Field descriptors for SearchResultSortParameter query construction
- SearchResultSortParameterPatch
- Seller
- SellerFields
- Field descriptors for Seller query construction
- SellerPatch
- SetCustomerForOrderResult
- SetOrderShippingMethodResult
- ShippingLine
- ShippingLineFields
- Field descriptors for ShippingLine query construction
- ShippingLinePatch
- ShippingMethod
- ShippingMethodFields
- Field descriptors for ShippingMethod query construction
- ShippingMethodList
- ShippingMethodListFields
- Field descriptors for ShippingMethodList query construction
- ShippingMethodListPatch
- ShippingMethodPatch
- ShippingMethodQuote
- ShippingMethodQuoteFields
- Field descriptors for ShippingMethodQuote query construction
- ShippingMethodQuotePatch
- ShippingMethodTranslation
- ShippingMethodTranslationFields
- Field descriptors for ShippingMethodTranslation query construction
- ShippingMethodTranslationPatch
- SinglePrice
- SinglePriceFields
- Field descriptors for SinglePrice query construction
- SinglePricePatch
- SocketClient
- Wraps a standard web socket instance to marshal and un-marshal the server / client payloads into dart object representation.
- SocketClientConfig
- SocketSubProtocol
- All the protocol supported by the library
- StartOperation
- A message to tell the server to create a subscription. The contents of the query will be defined by the payload request. The id provided will be used to tag messages such that they can be identified for this subscription instance. id values should be unique and not be re-used during the lifetime of the server.
- StopOperation
- Tell the server to stop sending subscription data for a particular subscription instance. See StartOperation.
- Store
-
Raw key-value datastore API leveraged by the
Cache - StringCustomFieldConfig
- StringCustomFieldConfigFields
- Field descriptors for StringCustomFieldConfig query construction
- StringCustomFieldConfigPatch
- StringFieldOption
- StringFieldOptionFields
- Field descriptors for StringFieldOption query construction
- StringFieldOptionPatch
- StringListOperators
- StringListOperatorsFields
- Field descriptors for StringListOperators query construction
- StringListOperatorsPatch
- StringOperators
- StringOperatorsFields
- Field descriptors for StringOperators query construction
- StringOperatorsPatch
- SubscribeOperation
- SubscriptionComplete
- Server message to the client to indicate that no more data will be sent for a particular subscription instance.
- SubscriptionData
- Data sent from the server to the client with subscription data or error payload. The user should check the errors result before processing the data value. These error are from the query resolvers.
- SubscriptionError
- Errors sent from the server to the client if the subscription operation was not successful, usually due to GraphQL validation errors.
- SubscriptionListener
- SubscriptionNext
-
SubscriptionOptions<
TParsed extends Object?> - Success
- SuccessFields
- Field descriptors for Success query construction
- SuccessPatch
- Surcharge
- SurchargeFields
- Field descriptors for Surcharge query construction
- SurchargePatch
- SystemOperations
- SystemRepository
- Domain repository interface for System operations. Each method mirrors a public method on SystemOperations (the facade).
- Tag
- TagFields
- Field descriptors for Tag query construction
- TagList
- TagListFields
- Field descriptors for TagList query construction
- TagListPatch
- TagPatch
- TaxCategory
- TaxCategoryFields
- Field descriptors for TaxCategory query construction
- TaxCategoryPatch
- TaxLine
- TaxLineFields
- Field descriptors for TaxLine query construction
- TaxLinePatch
- TaxRate
- TaxRateFields
- Field descriptors for TaxRate query construction
- TaxRateList
- TaxRateListFields
- Field descriptors for TaxRateList query construction
- TaxRateListPatch
- TaxRatePatch
- TerminateOperation
- The client sends this message to terminate the connection.
- TextCustomFieldConfig
- TextCustomFieldConfigFields
- Field descriptors for TextCustomFieldConfig query construction
- TextCustomFieldConfigPatch
- TokenManager
-
Token lifecycle: the session token, its expiry, and the optional
fetch-refresh closure the facade wires for re-initialization
(ported from the source SDK's
TokenManager). - TransitionOrderToStateResult
- UnknownData
- Not expected to be created. Indicates there are problems parsing the server response, or that new unsupported types have been added to the subscription implementation.
- UpdateAddressInput
- UpdateAddressInputFields
- Field descriptors for UpdateAddressInput query construction
- UpdateAddressInputPatch
- UpdateCustomerEmailAddressResult
- UpdateCustomerInput
- UpdateCustomerInputFields
- Field descriptors for UpdateCustomerInput query construction
- UpdateCustomerInputPatch
- UpdateCustomerPasswordResult
- UpdateOrderInput
- UpdateOrderInputFields
- Field descriptors for UpdateOrderInput query construction
- UpdateOrderInputPatch
- UpdateOrderItemsResult
- User
- UserCustomFields
- UserCustomFieldsFields
- Field descriptors for UserCustomFields query construction
- UserCustomFieldsPatch
- UserFields
- Field descriptors for User query construction
- UserPatch
- Vendure
- The Vendure facade — the package's entire public surface (spec 001, contracts/facade.md). Five initializers bind the SDK to a Vendure channel; six operation groups expose the commerce vocabulary; the runtime setters re-route the context mid-session.
- VendureContext
-
The runtime context every outbound request rides: the endpoint plus the
Vendure multi-tenant/multi-language routing vocabulary — the same link
chain the source SDK assembled per call in
_getClient: - VendureDataSource
-
The outbound Vendure seam: one interface between the repositories and
whatever executes a GraphQL document against a Vendure shop-api
endpoint (the
GraphQL VendureDataSource adapteron a device, the pure-Dart InMemoryVendureDataSource in tests and dev). - VendureRawDataSource
- The raw escape hatch the custom operations ride: execute a document and get the UNTYPED extracted payload (the caller supplies no decoder). Same envelope and error path as VendureDataSource.query.
- VendureRequestRecord
- One recorded Vendure request — the document, variables, headers, and the kind of operation, exactly as the repository passed them.
-
VendureResponse<
T> -
A mutation result that carries the HTTP response headers alongside the
decoded data — the Vendure session token rides a response header
(
vendure-auth-token), not the body, so the auth repository needs the headers to capture it (ported from the source SDK'sAuthBaseOperations.extractResponseHeaders). - VendureUtils
- VerificationTokenExpiredError
- VerificationTokenExpiredErrorFields
- Field descriptors for VerificationTokenExpiredError query construction
- VerificationTokenExpiredErrorPatch
- VerificationTokenInvalidError
- VerificationTokenInvalidErrorFields
- Field descriptors for VerificationTokenInvalidError query construction
- VerificationTokenInvalidErrorPatch
- VerifyCustomerAccountResult
-
WatchQueryOptions<
TParsed extends Object?> - WebSocketLink
- A Universal Websocket Link implementation to support the websocket transport. It supports subscriptions, query and mutation operations as well.
- Zone
- ZoneFields
- Field descriptors for Zone query construction
- ZonePatch
Enums
- Address$
- Adjustment$
- AdjustmentType
- AlreadyLoggedInError$
- Asset$
- AssetList$
- AssetType
- AuthenticationInput$
- AuthenticationMethod$
- BooleanCustomFieldConfig$
- BooleanListOperators$
- BooleanOperators$
- CacheRereadPolicy
-
CacheRereadPolicy determines whether and how cache data will be merged into
the final QueryResult
databefore it is returned. - Channel$
- Collection$
- CollectionBreadcrumb$
- CollectionFilterParameter$
- CollectionList$
- CollectionListOptions$
- CollectionResult$
- CollectionSortParameter$
- CollectionTranslation$
- ConfigArg$
- ConfigArgDefinition$
- ConfigArgInput$
- ConfigurableOperation$
- ConfigurableOperationDefinition$
- ConfigurableOperationInput$
- Coordinate$
- Country$
- CountryList$
- CouponCodeExpiredError$
- CouponCodeInvalidError$
- CouponCodeLimitError$
- CreateAddressInput$
- CreateCustomerInput$
- CurrencyCode
- CurrentUser$
- CurrentUserChannel$
- Customer$
- CustomerFilterParameter$
- CustomerGroup$
- CustomerList$
- CustomerListOptions$
- CustomerSortParameter$
- DateListOperators$
- DateOperators$
- DateRange$
- DateTimeCustomFieldConfig$
- DeletionResponse$
- DeletionResult
- Discount$
- EmailAddressConflictError$
- ErrorCode
- ErrorPolicy
- ErrorPolicy determines the level of events for GraphQL Errors in the execution result. The options are:
- Facet$
- FacetFilterParameter$
- FacetList$
- FacetListOptions$
- FacetSortParameter$
- FacetTranslation$
- FacetValue$
- FacetValueFilterInput$
- FacetValueFilterParameter$
- FacetValueList$
- FacetValueListOptions$
- FacetValueResult$
- FacetValueSortParameter$
- FacetValueTranslation$
- FetchPolicy
- FetchPolicy determines where the client may return a result from.
- FloatCustomFieldConfig$
- Fulfillment$
- FulfillmentLine$
- GuestCheckoutError$
- HistoryEntry$
- HistoryEntryFilterParameter$
- HistoryEntryList$
- HistoryEntryListOptions$
- HistoryEntrySortParameter$
- HistoryEntryType
- IdentifierChangeTokenExpiredError$
- IdentifierChangeTokenInvalidError$
- IdListOperators$
- IdOperators$
- IneligiblePaymentMethodError$
- IneligibleShippingMethodError$
- InsufficientStockError$
- IntCustomFieldConfig$
- InvalidCredentialsError$
- LanguageCode
- LocaleStringCustomFieldConfig$
- LocaleTextCustomFieldConfig$
- LocalizedString$
- LogicalOperator
- MissingPasswordError$
- NativeAuthInput$
- NativeAuthStrategyError$
- NegativeQuantityError$
- NoActiveOrderError$
- NotVerifiedError$
- NumberListOperators$
- NumberOperators$
- NumberRange$
- OperationType
- Order$
- OrderAddress$
- OrderFilterParameter$
- OrderLimitError$
- OrderLine$
- OrderList$
- OrderListOptions$
- OrderModificationError$
- OrderPaymentStateError$
- OrderSortParameter$
- OrderStateTransitionError$
- OrderTaxSummary$
- OrderType
- PartialDataCachePolicy
- Determines how partial data should be handled when written to the cache
- PasswordAlreadySetError$
- PasswordResetTokenExpiredError$
- PasswordResetTokenInvalidError$
- PasswordValidationError$
- Payment$
- PaymentDeclinedError$
- PaymentFailedError$
- PaymentInput$
- PaymentMethod$
- PaymentMethodQuote$
- PaymentMethodTranslation$
- Permission
- PriceRange$
- Product$
- ProductFilterParameter$
- ProductList$
- ProductListOptions$
- ProductOption$
- ProductOptionGroup$
- ProductOptionGroupTranslation$
- ProductOptionTranslation$
- ProductSortParameter$
- ProductTranslation$
- ProductVariant$
- ProductVariantFilterParameter$
- ProductVariantList$
- ProductVariantListOptions$
- ProductVariantSortParameter$
- ProductVariantTranslation$
- Promotion$
- PromotionList$
- PromotionTranslation$
- Province$
- ProvinceList$
- QueryLifecycle
- Lifecycle states for ObservableQuery.lifecycle
- QueryResultSource
- The source of the result data contained
- Refund$
- RefundLine$
- Region$
- RegionTranslation$
- RegisterCustomerInput$
- RelationCustomFieldConfig$
- Role$
- RoleList$
- SearchInput$
- SearchReindexResponse$
- SearchResponse$
- SearchResult$
- SearchResultAsset$
- SearchResultSortParameter$
- Seller$
- ShippingLine$
- ShippingMethod$
- ShippingMethodList$
- ShippingMethodQuote$
- ShippingMethodTranslation$
- SinglePrice$
- SocketConnectionState
- SortOrder
- StringCustomFieldConfig$
- StringFieldOption$
- StringListOperators$
- StringOperators$
- Success$
- Surcharge$
- Tag$
- TagList$
- TaxCategory$
- TaxLine$
- TaxRate$
- TaxRateList$
- TextCustomFieldConfig$
- ToggleConnectionState
- UpdateAddressInput$
- UpdateCustomerInput$
- UpdateOrderInput$
- User$
- UserCustomFields$
- VerificationTokenExpiredError$
- VerificationTokenInvalidError$
- Zone$
Extensions
- AddressCompareE on Address
- AddressPropertyHelpers on Address
- AddressSerialization on Address
- AdjustmentCompareE on Adjustment
- AdjustmentPropertyHelpers on Adjustment
- AdjustmentSerialization on Adjustment
- AlreadyLoggedInErrorCompareE on AlreadyLoggedInError
- AlreadyLoggedInErrorPropertyHelpers on AlreadyLoggedInError
- AlreadyLoggedInErrorSerialization on AlreadyLoggedInError
- AssetCompareE on Asset
- AssetListCompareE on AssetList
- AssetListPropertyHelpers on AssetList
- AssetListSerialization on AssetList
- AssetPropertyHelpers on Asset
- AssetSerialization on Asset
- AuthenticationInputCompareE on AuthenticationInput
- AuthenticationInputPropertyHelpers on AuthenticationInput
- AuthenticationInputSerialization on AuthenticationInput
- AuthenticationMethodCompareE on AuthenticationMethod
- AuthenticationMethodPropertyHelpers on AuthenticationMethod
- AuthenticationMethodSerialization on AuthenticationMethod
- BooleanCustomFieldConfigCompareE on BooleanCustomFieldConfig
- BooleanCustomFieldConfigPropertyHelpers on BooleanCustomFieldConfig
- BooleanCustomFieldConfigSerialization on BooleanCustomFieldConfig
- BooleanListOperatorsCompareE on BooleanListOperators
- BooleanListOperatorsPropertyHelpers on BooleanListOperators
- BooleanListOperatorsSerialization on BooleanListOperators
- BooleanOperatorsCompareE on BooleanOperators
- BooleanOperatorsPropertyHelpers on BooleanOperators
- BooleanOperatorsSerialization on BooleanOperators
- ChannelCompareE on Channel
- ChannelPropertyHelpers on Channel
- ChannelSerialization on Channel
- CollectionBreadcrumbCompareE on CollectionBreadcrumb
- CollectionBreadcrumbPropertyHelpers on CollectionBreadcrumb
- CollectionBreadcrumbSerialization on CollectionBreadcrumb
- CollectionCompareE on Collection
- CollectionFilterParameterCompareE on CollectionFilterParameter
- CollectionFilterParameterPropertyHelpers on CollectionFilterParameter
- CollectionFilterParameterSerialization on CollectionFilterParameter
- CollectionListCompareE on CollectionList
- CollectionListOptionsCompareE on CollectionListOptions
- CollectionListOptionsPropertyHelpers on CollectionListOptions
- CollectionListOptionsSerialization on CollectionListOptions
- CollectionListPropertyHelpers on CollectionList
- CollectionListSerialization on CollectionList
- CollectionPropertyHelpers on Collection
- CollectionResultCompareE on CollectionResult
- CollectionResultPropertyHelpers on CollectionResult
- CollectionResultSerialization on CollectionResult
- CollectionSerialization on Collection
- CollectionSortParameterCompareE on CollectionSortParameter
- CollectionSortParameterPropertyHelpers on CollectionSortParameter
- CollectionSortParameterSerialization on CollectionSortParameter
- CollectionTranslationCompareE on CollectionTranslation
- CollectionTranslationPropertyHelpers on CollectionTranslation
- CollectionTranslationSerialization on CollectionTranslation
- ConfigArgCompareE on ConfigArg
- ConfigArgDefinitionCompareE on ConfigArgDefinition
- ConfigArgDefinitionPropertyHelpers on ConfigArgDefinition
- ConfigArgDefinitionSerialization on ConfigArgDefinition
- ConfigArgInputCompareE on ConfigArgInput
- ConfigArgInputPropertyHelpers on ConfigArgInput
- ConfigArgInputSerialization on ConfigArgInput
- ConfigArgPropertyHelpers on ConfigArg
- ConfigArgSerialization on ConfigArg
- ConfigurableOperationCompareE on ConfigurableOperation
- ConfigurableOperationDefinitionCompareE on ConfigurableOperationDefinition
- ConfigurableOperationDefinitionPropertyHelpers on ConfigurableOperationDefinition
- ConfigurableOperationDefinitionSerialization on ConfigurableOperationDefinition
- ConfigurableOperationInputCompareE on ConfigurableOperationInput
- ConfigurableOperationInputPropertyHelpers on ConfigurableOperationInput
- ConfigurableOperationInputSerialization on ConfigurableOperationInput
- ConfigurableOperationPropertyHelpers on ConfigurableOperation
- ConfigurableOperationSerialization on ConfigurableOperation
- CoordinateCompareE on Coordinate
- CoordinatePropertyHelpers on Coordinate
- CoordinateSerialization on Coordinate
- CountryCompareE on Country
- CountryListCompareE on CountryList
- CountryListPropertyHelpers on CountryList
- CountryListSerialization on CountryList
- CountryPropertyHelpers on Country
- CountrySerialization on Country
- CouponCodeExpiredErrorCompareE on CouponCodeExpiredError
- CouponCodeExpiredErrorPropertyHelpers on CouponCodeExpiredError
- CouponCodeExpiredErrorSerialization on CouponCodeExpiredError
- CouponCodeInvalidErrorCompareE on CouponCodeInvalidError
- CouponCodeInvalidErrorPropertyHelpers on CouponCodeInvalidError
- CouponCodeInvalidErrorSerialization on CouponCodeInvalidError
- CouponCodeLimitErrorCompareE on CouponCodeLimitError
- CouponCodeLimitErrorPropertyHelpers on CouponCodeLimitError
- CouponCodeLimitErrorSerialization on CouponCodeLimitError
- CreateAddressInputCompareE on CreateAddressInput
- CreateAddressInputPropertyHelpers on CreateAddressInput
- CreateAddressInputSerialization on CreateAddressInput
- CreateCustomerInputCompareE on CreateCustomerInput
- CreateCustomerInputPropertyHelpers on CreateCustomerInput
- CreateCustomerInputSerialization on CreateCustomerInput
- CurrentUserChannelCompareE on CurrentUserChannel
- CurrentUserChannelPropertyHelpers on CurrentUserChannel
- CurrentUserChannelSerialization on CurrentUserChannel
- CurrentUserCompareE on CurrentUser
- CurrentUserPropertyHelpers on CurrentUser
- CurrentUserSerialization on CurrentUser
- CustomerCompareE on Customer
- CustomerFilterParameterCompareE on CustomerFilterParameter
- CustomerFilterParameterPropertyHelpers on CustomerFilterParameter
- CustomerFilterParameterSerialization on CustomerFilterParameter
- CustomerGroupCompareE on CustomerGroup
- CustomerGroupPropertyHelpers on CustomerGroup
- CustomerGroupSerialization on CustomerGroup
- CustomerListCompareE on CustomerList
- CustomerListOptionsCompareE on CustomerListOptions
- CustomerListOptionsPropertyHelpers on CustomerListOptions
- CustomerListOptionsSerialization on CustomerListOptions
- CustomerListPropertyHelpers on CustomerList
- CustomerListSerialization on CustomerList
- CustomerPropertyHelpers on Customer
- CustomerSerialization on Customer
- CustomerSortParameterCompareE on CustomerSortParameter
- CustomerSortParameterPropertyHelpers on CustomerSortParameter
- CustomerSortParameterSerialization on CustomerSortParameter
- DateListOperatorsCompareE on DateListOperators
- DateListOperatorsPropertyHelpers on DateListOperators
- DateListOperatorsSerialization on DateListOperators
- DateOperatorsCompareE on DateOperators
- DateOperatorsPropertyHelpers on DateOperators
- DateOperatorsSerialization on DateOperators
- DateRangeCompareE on DateRange
- DateRangePropertyHelpers on DateRange
- DateRangeSerialization on DateRange
- DateTimeCustomFieldConfigCompareE on DateTimeCustomFieldConfig
- DateTimeCustomFieldConfigPropertyHelpers on DateTimeCustomFieldConfig
- DateTimeCustomFieldConfigSerialization on DateTimeCustomFieldConfig
- DeletionResponseCompareE on DeletionResponse
- DeletionResponsePropertyHelpers on DeletionResponse
- DeletionResponseSerialization on DeletionResponse
- DiscountCompareE on Discount
- DiscountPropertyHelpers on Discount
- DiscountSerialization on Discount
- EmailAddressConflictErrorCompareE on EmailAddressConflictError
- EmailAddressConflictErrorPropertyHelpers on EmailAddressConflictError
- EmailAddressConflictErrorSerialization on EmailAddressConflictError
- FacetCompareE on Facet
- FacetFilterParameterCompareE on FacetFilterParameter
- FacetFilterParameterPropertyHelpers on FacetFilterParameter
- FacetFilterParameterSerialization on FacetFilterParameter
- FacetListCompareE on FacetList
- FacetListOptionsCompareE on FacetListOptions
- FacetListOptionsPropertyHelpers on FacetListOptions
- FacetListOptionsSerialization on FacetListOptions
- FacetListPropertyHelpers on FacetList
- FacetListSerialization on FacetList
- FacetPropertyHelpers on Facet
- FacetSerialization on Facet
- FacetSortParameterCompareE on FacetSortParameter
- FacetSortParameterPropertyHelpers on FacetSortParameter
- FacetSortParameterSerialization on FacetSortParameter
- FacetTranslationCompareE on FacetTranslation
- FacetTranslationPropertyHelpers on FacetTranslation
- FacetTranslationSerialization on FacetTranslation
- FacetValueCompareE on FacetValue
- FacetValueFilterInputCompareE on FacetValueFilterInput
- FacetValueFilterInputPropertyHelpers on FacetValueFilterInput
- FacetValueFilterInputSerialization on FacetValueFilterInput
- FacetValueFilterParameterCompareE on FacetValueFilterParameter
- FacetValueFilterParameterPropertyHelpers on FacetValueFilterParameter
- FacetValueFilterParameterSerialization on FacetValueFilterParameter
- FacetValueListCompareE on FacetValueList
- FacetValueListOptionsCompareE on FacetValueListOptions
- FacetValueListOptionsPropertyHelpers on FacetValueListOptions
- FacetValueListOptionsSerialization on FacetValueListOptions
- FacetValueListPropertyHelpers on FacetValueList
- FacetValueListSerialization on FacetValueList
- FacetValuePropertyHelpers on FacetValue
- FacetValueResultCompareE on FacetValueResult
- FacetValueResultPropertyHelpers on FacetValueResult
- FacetValueResultSerialization on FacetValueResult
- FacetValueSerialization on FacetValue
- FacetValueSortParameterCompareE on FacetValueSortParameter
- FacetValueSortParameterPropertyHelpers on FacetValueSortParameter
- FacetValueSortParameterSerialization on FacetValueSortParameter
- FacetValueTranslationCompareE on FacetValueTranslation
- FacetValueTranslationPropertyHelpers on FacetValueTranslation
- FacetValueTranslationSerialization on FacetValueTranslation
- FloatCustomFieldConfigCompareE on FloatCustomFieldConfig
- FloatCustomFieldConfigPropertyHelpers on FloatCustomFieldConfig
- FloatCustomFieldConfigSerialization on FloatCustomFieldConfig
- FragmentDataValid on FragmentRequest
- FulfillmentCompareE on Fulfillment
- FulfillmentLineCompareE on FulfillmentLine
- FulfillmentLinePropertyHelpers on FulfillmentLine
- FulfillmentLineSerialization on FulfillmentLine
- FulfillmentPropertyHelpers on Fulfillment
- FulfillmentSerialization on Fulfillment
- Getters on QueryResultSource
- GraphQLGetter on WebSocketChannel
- GuestCheckoutErrorCompareE on GuestCheckoutError
- GuestCheckoutErrorPropertyHelpers on GuestCheckoutError
- GuestCheckoutErrorSerialization on GuestCheckoutError
- HistoryEntryCompareE on HistoryEntry
- HistoryEntryFilterParameterCompareE on HistoryEntryFilterParameter
- HistoryEntryFilterParameterPropertyHelpers on HistoryEntryFilterParameter
- HistoryEntryFilterParameterSerialization on HistoryEntryFilterParameter
- HistoryEntryListCompareE on HistoryEntryList
- HistoryEntryListOptionsCompareE on HistoryEntryListOptions
- HistoryEntryListOptionsPropertyHelpers on HistoryEntryListOptions
- HistoryEntryListOptionsSerialization on HistoryEntryListOptions
- HistoryEntryListPropertyHelpers on HistoryEntryList
- HistoryEntryListSerialization on HistoryEntryList
- HistoryEntryPropertyHelpers on HistoryEntry
- HistoryEntrySerialization on HistoryEntry
- HistoryEntrySortParameterCompareE on HistoryEntrySortParameter
- HistoryEntrySortParameterPropertyHelpers on HistoryEntrySortParameter
- HistoryEntrySortParameterSerialization on HistoryEntrySortParameter
- IdentifierChangeTokenExpiredErrorCompareE on IdentifierChangeTokenExpiredError
- IdentifierChangeTokenExpiredErrorPropertyHelpers on IdentifierChangeTokenExpiredError
- IdentifierChangeTokenExpiredErrorSerialization on IdentifierChangeTokenExpiredError
- IdentifierChangeTokenInvalidErrorCompareE on IdentifierChangeTokenInvalidError
- IdentifierChangeTokenInvalidErrorPropertyHelpers on IdentifierChangeTokenInvalidError
- IdentifierChangeTokenInvalidErrorSerialization on IdentifierChangeTokenInvalidError
- IdListOperatorsCompareE on IdListOperators
- IdListOperatorsPropertyHelpers on IdListOperators
- IdListOperatorsSerialization on IdListOperators
- IdOperatorsCompareE on IdOperators
- IdOperatorsPropertyHelpers on IdOperators
- IdOperatorsSerialization on IdOperators
- IneligiblePaymentMethodErrorCompareE on IneligiblePaymentMethodError
- IneligiblePaymentMethodErrorPropertyHelpers on IneligiblePaymentMethodError
- IneligiblePaymentMethodErrorSerialization on IneligiblePaymentMethodError
- IneligibleShippingMethodErrorCompareE on IneligibleShippingMethodError
- IneligibleShippingMethodErrorPropertyHelpers on IneligibleShippingMethodError
- IneligibleShippingMethodErrorSerialization on IneligibleShippingMethodError
- InsufficientStockErrorCompareE on InsufficientStockError
- InsufficientStockErrorPropertyHelpers on InsufficientStockError
- InsufficientStockErrorSerialization on InsufficientStockError
- IntCustomFieldConfigCompareE on IntCustomFieldConfig
- IntCustomFieldConfigPropertyHelpers on IntCustomFieldConfig
- IntCustomFieldConfigSerialization on IntCustomFieldConfig
- InvalidCredentialsErrorCompareE on InvalidCredentialsError
- InvalidCredentialsErrorPropertyHelpers on InvalidCredentialsError
- InvalidCredentialsErrorSerialization on InvalidCredentialsError
- LocaleStringCustomFieldConfigCompareE on LocaleStringCustomFieldConfig
- LocaleStringCustomFieldConfigPropertyHelpers on LocaleStringCustomFieldConfig
- LocaleStringCustomFieldConfigSerialization on LocaleStringCustomFieldConfig
- LocaleTextCustomFieldConfigCompareE on LocaleTextCustomFieldConfig
- LocaleTextCustomFieldConfigPropertyHelpers on LocaleTextCustomFieldConfig
- LocaleTextCustomFieldConfigSerialization on LocaleTextCustomFieldConfig
- LocalizedStringCompareE on LocalizedString
- LocalizedStringPropertyHelpers on LocalizedString
- LocalizedStringSerialization on LocalizedString
- MissingPasswordErrorCompareE on MissingPasswordError
- MissingPasswordErrorPropertyHelpers on MissingPasswordError
- MissingPasswordErrorSerialization on MissingPasswordError
- NativeAuthInputCompareE on NativeAuthInput
- NativeAuthInputPropertyHelpers on NativeAuthInput
- NativeAuthInputSerialization on NativeAuthInput
- NativeAuthStrategyErrorCompareE on NativeAuthStrategyError
- NativeAuthStrategyErrorPropertyHelpers on NativeAuthStrategyError
- NativeAuthStrategyErrorSerialization on NativeAuthStrategyError
- NegativeQuantityErrorCompareE on NegativeQuantityError
- NegativeQuantityErrorPropertyHelpers on NegativeQuantityError
- NegativeQuantityErrorSerialization on NegativeQuantityError
- NoActiveOrderErrorCompareE on NoActiveOrderError
- NoActiveOrderErrorPropertyHelpers on NoActiveOrderError
- NoActiveOrderErrorSerialization on NoActiveOrderError
- NotVerifiedErrorCompareE on NotVerifiedError
- NotVerifiedErrorPropertyHelpers on NotVerifiedError
- NotVerifiedErrorSerialization on NotVerifiedError
- NumberListOperatorsCompareE on NumberListOperators
- NumberListOperatorsPropertyHelpers on NumberListOperators
- NumberListOperatorsSerialization on NumberListOperators
- NumberOperatorsCompareE on NumberOperators
- NumberOperatorsPropertyHelpers on NumberOperators
- NumberOperatorsSerialization on NumberOperators
- NumberRangeCompareE on NumberRange
- NumberRangePropertyHelpers on NumberRange
- NumberRangeSerialization on NumberRange
- OperationDataValid on Request
- OperationRequestHelper on Operation
- OperationTypeExtension on Operation
- OrderAddressCompareE on OrderAddress
- OrderAddressPropertyHelpers on OrderAddress
- OrderAddressSerialization on OrderAddress
- OrderCompareE on Order
- OrderFilterParameterCompareE on OrderFilterParameter
- OrderFilterParameterPropertyHelpers on OrderFilterParameter
- OrderFilterParameterSerialization on OrderFilterParameter
- OrderLimitErrorCompareE on OrderLimitError
- OrderLimitErrorPropertyHelpers on OrderLimitError
- OrderLimitErrorSerialization on OrderLimitError
- OrderLineCompareE on OrderLine
- OrderLinePropertyHelpers on OrderLine
- OrderLineSerialization on OrderLine
- OrderListCompareE on OrderList
- OrderListOptionsCompareE on OrderListOptions
- OrderListOptionsPropertyHelpers on OrderListOptions
- OrderListOptionsSerialization on OrderListOptions
- OrderListPropertyHelpers on OrderList
- OrderListSerialization on OrderList
- OrderModificationErrorCompareE on OrderModificationError
- OrderModificationErrorPropertyHelpers on OrderModificationError
- OrderModificationErrorSerialization on OrderModificationError
- OrderPaymentStateErrorCompareE on OrderPaymentStateError
- OrderPaymentStateErrorPropertyHelpers on OrderPaymentStateError
- OrderPaymentStateErrorSerialization on OrderPaymentStateError
- OrderPropertyHelpers on Order
- OrderSerialization on Order
- OrderSortParameterCompareE on OrderSortParameter
- OrderSortParameterPropertyHelpers on OrderSortParameter
- OrderSortParameterSerialization on OrderSortParameter
- OrderStateTransitionErrorCompareE on OrderStateTransitionError
- OrderStateTransitionErrorPropertyHelpers on OrderStateTransitionError
- OrderStateTransitionErrorSerialization on OrderStateTransitionError
- OrderTaxSummaryCompareE on OrderTaxSummary
- OrderTaxSummaryPropertyHelpers on OrderTaxSummary
- OrderTaxSummarySerialization on OrderTaxSummary
- PasswordAlreadySetErrorCompareE on PasswordAlreadySetError
- PasswordAlreadySetErrorPropertyHelpers on PasswordAlreadySetError
- PasswordAlreadySetErrorSerialization on PasswordAlreadySetError
- PasswordResetTokenExpiredErrorCompareE on PasswordResetTokenExpiredError
- PasswordResetTokenExpiredErrorPropertyHelpers on PasswordResetTokenExpiredError
- PasswordResetTokenExpiredErrorSerialization on PasswordResetTokenExpiredError
- PasswordResetTokenInvalidErrorCompareE on PasswordResetTokenInvalidError
- PasswordResetTokenInvalidErrorPropertyHelpers on PasswordResetTokenInvalidError
- PasswordResetTokenInvalidErrorSerialization on PasswordResetTokenInvalidError
- PasswordValidationErrorCompareE on PasswordValidationError
- PasswordValidationErrorPropertyHelpers on PasswordValidationError
- PasswordValidationErrorSerialization on PasswordValidationError
- PaymentCompareE on Payment
- PaymentDeclinedErrorCompareE on PaymentDeclinedError
- PaymentDeclinedErrorPropertyHelpers on PaymentDeclinedError
- PaymentDeclinedErrorSerialization on PaymentDeclinedError
- PaymentFailedErrorCompareE on PaymentFailedError
- PaymentFailedErrorPropertyHelpers on PaymentFailedError
- PaymentFailedErrorSerialization on PaymentFailedError
- PaymentInputCompareE on PaymentInput
- PaymentInputPropertyHelpers on PaymentInput
- PaymentInputSerialization on PaymentInput
- PaymentMethodCompareE on PaymentMethod
- PaymentMethodPropertyHelpers on PaymentMethod
- PaymentMethodQuoteCompareE on PaymentMethodQuote
- PaymentMethodQuotePropertyHelpers on PaymentMethodQuote
- PaymentMethodQuoteSerialization on PaymentMethodQuote
- PaymentMethodSerialization on PaymentMethod
- PaymentMethodTranslationCompareE on PaymentMethodTranslation
- PaymentMethodTranslationPropertyHelpers on PaymentMethodTranslation
- PaymentMethodTranslationSerialization on PaymentMethodTranslation
- PaymentPropertyHelpers on Payment
- PaymentSerialization on Payment
- PriceRangeCompareE on PriceRange
- PriceRangePropertyHelpers on PriceRange
- PriceRangeSerialization on PriceRange
- ProductCompareE on Product
- ProductFilterParameterCompareE on ProductFilterParameter
- ProductFilterParameterPropertyHelpers on ProductFilterParameter
- ProductFilterParameterSerialization on ProductFilterParameter
- ProductListCompareE on ProductList
- ProductListOptionsCompareE on ProductListOptions
- ProductListOptionsPropertyHelpers on ProductListOptions
- ProductListOptionsSerialization on ProductListOptions
- ProductListPropertyHelpers on ProductList
- ProductListSerialization on ProductList
- ProductOptionCompareE on ProductOption
- ProductOptionGroupCompareE on ProductOptionGroup
- ProductOptionGroupPropertyHelpers on ProductOptionGroup
- ProductOptionGroupSerialization on ProductOptionGroup
- ProductOptionGroupTranslationCompareE on ProductOptionGroupTranslation
- ProductOptionGroupTranslationPropertyHelpers on ProductOptionGroupTranslation
- ProductOptionGroupTranslationSerialization on ProductOptionGroupTranslation
- ProductOptionPropertyHelpers on ProductOption
- ProductOptionSerialization on ProductOption
- ProductOptionTranslationCompareE on ProductOptionTranslation
- ProductOptionTranslationPropertyHelpers on ProductOptionTranslation
- ProductOptionTranslationSerialization on ProductOptionTranslation
- ProductPropertyHelpers on Product
- ProductSerialization on Product
- ProductSortParameterCompareE on ProductSortParameter
- ProductSortParameterPropertyHelpers on ProductSortParameter
- ProductSortParameterSerialization on ProductSortParameter
- ProductTranslationCompareE on ProductTranslation
- ProductTranslationPropertyHelpers on ProductTranslation
- ProductTranslationSerialization on ProductTranslation
- ProductVariantCompareE on ProductVariant
- ProductVariantFilterParameterCompareE on ProductVariantFilterParameter
- ProductVariantFilterParameterPropertyHelpers on ProductVariantFilterParameter
- ProductVariantFilterParameterSerialization on ProductVariantFilterParameter
- ProductVariantListCompareE on ProductVariantList
- ProductVariantListOptionsCompareE on ProductVariantListOptions
- ProductVariantListOptionsPropertyHelpers on ProductVariantListOptions
- ProductVariantListOptionsSerialization on ProductVariantListOptions
- ProductVariantListPropertyHelpers on ProductVariantList
- ProductVariantListSerialization on ProductVariantList
- ProductVariantPropertyHelpers on ProductVariant
- ProductVariantSerialization on ProductVariant
- ProductVariantSortParameterCompareE on ProductVariantSortParameter
- ProductVariantSortParameterPropertyHelpers on ProductVariantSortParameter
- ProductVariantSortParameterSerialization on ProductVariantSortParameter
- ProductVariantTranslationCompareE on ProductVariantTranslation
- ProductVariantTranslationPropertyHelpers on ProductVariantTranslation
- ProductVariantTranslationSerialization on ProductVariantTranslation
- PromotionCompareE on Promotion
- PromotionListCompareE on PromotionList
- PromotionListPropertyHelpers on PromotionList
- PromotionListSerialization on PromotionList
- PromotionPropertyHelpers on Promotion
- PromotionSerialization on Promotion
- PromotionTranslationCompareE on PromotionTranslation
- PromotionTranslationPropertyHelpers on PromotionTranslation
- PromotionTranslationSerialization on PromotionTranslation
- ProvinceCompareE on Province
- ProvinceListCompareE on ProvinceList
- ProvinceListPropertyHelpers on ProvinceList
- ProvinceListSerialization on ProvinceList
- ProvincePropertyHelpers on Province
- ProvinceSerialization on Province
- RefundCompareE on Refund
- RefundLineCompareE on RefundLine
- RefundLinePropertyHelpers on RefundLine
- RefundLineSerialization on RefundLine
- RefundPropertyHelpers on Refund
- RefundSerialization on Refund
- RegionCompareE on Region
- RegionPropertyHelpers on Region
- RegionSerialization on Region
- RegionTranslationCompareE on RegionTranslation
- RegionTranslationPropertyHelpers on RegionTranslation
- RegionTranslationSerialization on RegionTranslation
- RegisterCustomerInputCompareE on RegisterCustomerInput
- RegisterCustomerInputPropertyHelpers on RegisterCustomerInput
- RegisterCustomerInputSerialization on RegisterCustomerInput
- RelationCustomFieldConfigCompareE on RelationCustomFieldConfig
- RelationCustomFieldConfigPropertyHelpers on RelationCustomFieldConfig
- RelationCustomFieldConfigSerialization on RelationCustomFieldConfig
- RoleCompareE on Role
- RoleListCompareE on RoleList
- RoleListPropertyHelpers on RoleList
- RoleListSerialization on RoleList
- RolePropertyHelpers on Role
- RoleSerialization on Role
- SearchInputCompareE on SearchInput
- SearchInputPropertyHelpers on SearchInput
- SearchInputSerialization on SearchInput
- SearchReindexResponseCompareE on SearchReindexResponse
- SearchReindexResponsePropertyHelpers on SearchReindexResponse
- SearchReindexResponseSerialization on SearchReindexResponse
- SearchResponseCompareE on SearchResponse
- SearchResponsePropertyHelpers on SearchResponse
- SearchResponseSerialization on SearchResponse
- SearchResultAssetCompareE on SearchResultAsset
- SearchResultAssetPropertyHelpers on SearchResultAsset
- SearchResultAssetSerialization on SearchResultAsset
- SearchResultCompareE on SearchResult
- SearchResultPropertyHelpers on SearchResult
- SearchResultSerialization on SearchResult
- SearchResultSortParameterCompareE on SearchResultSortParameter
- SearchResultSortParameterPropertyHelpers on SearchResultSortParameter
- SearchResultSortParameterSerialization on SearchResultSortParameter
- SellerCompareE on Seller
- SellerPropertyHelpers on Seller
- SellerSerialization on Seller
- ShippingLineCompareE on ShippingLine
- ShippingLinePropertyHelpers on ShippingLine
- ShippingLineSerialization on ShippingLine
- ShippingMethodCompareE on ShippingMethod
- ShippingMethodListCompareE on ShippingMethodList
- ShippingMethodListPropertyHelpers on ShippingMethodList
- ShippingMethodListSerialization on ShippingMethodList
- ShippingMethodPropertyHelpers on ShippingMethod
- ShippingMethodQuoteCompareE on ShippingMethodQuote
- ShippingMethodQuotePropertyHelpers on ShippingMethodQuote
- ShippingMethodQuoteSerialization on ShippingMethodQuote
- ShippingMethodSerialization on ShippingMethod
- ShippingMethodTranslationCompareE on ShippingMethodTranslation
- ShippingMethodTranslationPropertyHelpers on ShippingMethodTranslation
- ShippingMethodTranslationSerialization on ShippingMethodTranslation
- SinglePriceCompareE on SinglePrice
- SinglePricePropertyHelpers on SinglePrice
- SinglePriceSerialization on SinglePrice
- StringCustomFieldConfigCompareE on StringCustomFieldConfig
- StringCustomFieldConfigPropertyHelpers on StringCustomFieldConfig
- StringCustomFieldConfigSerialization on StringCustomFieldConfig
- StringExtension on String
- StringFieldOptionCompareE on StringFieldOption
- StringFieldOptionPropertyHelpers on StringFieldOption
- StringFieldOptionSerialization on StringFieldOption
- StringListOperatorsCompareE on StringListOperators
- StringListOperatorsPropertyHelpers on StringListOperators
- StringListOperatorsSerialization on StringListOperators
- StringOperatorsCompareE on StringOperators
- StringOperatorsPropertyHelpers on StringOperators
- StringOperatorsSerialization on StringOperators
- SuccessCompareE on Success
- SuccessPropertyHelpers on Success
- SuccessSerialization on Success
- SurchargeCompareE on Surcharge
- SurchargePropertyHelpers on Surcharge
- SurchargeSerialization on Surcharge
- TagCompareE on Tag
- TagListCompareE on TagList
- TagListPropertyHelpers on TagList
- TagListSerialization on TagList
- TagPropertyHelpers on Tag
- TagSerialization on Tag
- TaxCategoryCompareE on TaxCategory
- TaxCategoryPropertyHelpers on TaxCategory
- TaxCategorySerialization on TaxCategory
- TaxLineCompareE on TaxLine
- TaxLinePropertyHelpers on TaxLine
- TaxLineSerialization on TaxLine
- TaxRateCompareE on TaxRate
- TaxRateListCompareE on TaxRateList
- TaxRateListPropertyHelpers on TaxRateList
- TaxRateListSerialization on TaxRateList
- TaxRatePropertyHelpers on TaxRate
- TaxRateSerialization on TaxRate
- TextCustomFieldConfigCompareE on TextCustomFieldConfig
- TextCustomFieldConfigPropertyHelpers on TextCustomFieldConfig
- TextCustomFieldConfigSerialization on TextCustomFieldConfig
- UpdateAddressInputCompareE on UpdateAddressInput
- UpdateAddressInputPropertyHelpers on UpdateAddressInput
- UpdateAddressInputSerialization on UpdateAddressInput
- UpdateCustomerInputCompareE on UpdateCustomerInput
- UpdateCustomerInputPropertyHelpers on UpdateCustomerInput
- UpdateCustomerInputSerialization on UpdateCustomerInput
- UpdateOrderInputCompareE on UpdateOrderInput
- UpdateOrderInputPropertyHelpers on UpdateOrderInput
- UpdateOrderInputSerialization on UpdateOrderInput
- UserCompareE on User
- UserCustomFieldsCompareE on UserCustomFields
- UserCustomFieldsPropertyHelpers on UserCustomFields
- UserCustomFieldsSerialization on UserCustomFields
- UserPropertyHelpers on User
- UserSerialization on User
- VerificationTokenExpiredErrorCompareE on VerificationTokenExpiredError
- VerificationTokenExpiredErrorPropertyHelpers on VerificationTokenExpiredError
- VerificationTokenExpiredErrorSerialization on VerificationTokenExpiredError
- VerificationTokenInvalidErrorCompareE on VerificationTokenInvalidError
- VerificationTokenInvalidErrorPropertyHelpers on VerificationTokenInvalidError
- VerificationTokenInvalidErrorSerialization on VerificationTokenInvalidError
- WithType on Request
- ZoneCompareE on Zone
- ZonePropertyHelpers on Zone
- ZoneSerialization on Zone
Constants
Properties
- gqlAsyncDeepEquals ↔ AsyncDeepEqualsFn
-
The async equality function used for comparing cached and new data
during asynchronous operations like rebroadcast checks.
getter/setter pair
- gqlDeepEquals ↔ DeepEqualsFn
-
The equality function used for comparing cached and new data
in synchronous contexts like operator overrides or custom logic.
getter/setter pair
Functions
-
coalesceErrors(
{List< GraphQLError> ? graphqlErrors, LinkException? linkException, List? raw, OperationException? exception}) → OperationException? -
(graphqlErrors?, exception?) => exception? -
gql(
String document) → DocumentNode -
Parse a GraphQL
documentinto aDocumentNode, automatically adding__typenames -
optimizedDeepEquals(
Object? a, Object? b) → bool -
Compare two json-like objects for equality
aandbmust be one of -
registerVendureDependencies(
GetIt getIt, {required String endpoint, String? languageCode, String? channelToken, String? apiKey, String? apiKeyHeaderKey, String? token}) → void -
Registers the Vendure stack onto
getIt: the GraphQL datasource and the five repositories as lazy singletons (the fleet's composition-root pattern). The in-memory adapters are bound by registerVendureTestDependencies. -
registerVendureTestDependencies(
GetIt getIt) → void - The test/dev composition root: binds the in-memory datasource and the repositories over it — the pure-Dart stack the suite asserts against.
-
shouldRespondEagerlyFromCache(
FetchPolicy? fetchPolicy) → bool -
shouldStopAtCache(
FetchPolicy? fetchPolicy) → bool -
translateFailure(
Object failure, StackTrace trace) → LinkException -
willAlwaysExecuteOnNetwork(
FetchPolicy? policy) → bool
Typedefs
-
ActiveCustomerStreamProvider
= Stream<
Customer> Function({bool convertEnums, bool includeInitialValue, String? websocketEndpoint}) -
AppCheckTokenProvider
= Future<
String?> Function() - Callback function type for fetching Firebase App Check tokens Returns the App Check token string, or null if unavailable
-
AsyncDeepEqualsFn
= Future<
bool> Function(dynamic a, dynamic b) -
ContextUpdater<
T> = T Function(T entry) - DeepEqualsFn = bool Function(dynamic a, dynamic b)
-
ErrorHandler
= Stream<
Response> ? Function(Request request, NextLink forward, Response response) - A handler of GraphQL errors.
-
ExceptionHandler
= Stream<
Response> ? Function(Request request, NextLink forward, LinkException exception) - A handler of Link Exceptions.
- GetInitPayload = FutureOr Function()
- GetRequestExtensions = dynamic Function(Request request)
-
HttpResponseDecoder
= FutureOr<
Map< Function(Response httpResponse)String, dynamic> ?> -
LinkFunction
= Stream<
Response> Function(Request request, [NextLink? forward]) - Link as a function
- LinkRouter = Link Function(Request request)
- A function which returns a Link based on contents Request
-
NextLink
= Stream<
Response> Function(Request request) -
Type of the
forwardfunction -
OnData<
TParsed> = FutureOr< void> Function(QueryResult<TParsed> ? result) - Side effect to register for execution when data is received
-
OnError
= FutureOr<
void> Function(OperationException? error) -
OnMutationCompleted
= FutureOr<
void> Function(Map<String, dynamic> ? data) -
OnMutationUpdate<
TParsed> = FutureOr< void> Function(GraphQLDataProxy cache, QueryResult<TParsed> ? result) -
OnQueryComplete
= FutureOr<
void> Function(Map<String, dynamic> ? data) -
OnQueryError
= FutureOr<
void> Function(OperationException? error) -
TokenFetcher
= Future<
String?> Function(Map<String, dynamic> params) -
UpdateQuery
= Map<
String, dynamic> ? Function(Map<String, dynamic> ? previousResultData, Map<String, dynamic> ? fetchMoreResultData) - merge fetchMore result data with earlier result data
- VariableEncoder = Object Function(Object t)
-
WebSocketConnect
= FutureOr<
WebSocketChannel> Function(Uri uri, Iterable<String> ? protocols) -
A definition for functions that returns a connected
WebSocketChannel
Exceptions / Errors
- CacheMisconfigurationException
-
Failure occurring when the structure of data
does not match that of the request
operationdocument. - CacheMissException
- A failure to find a response from the cache.
- CancelledException
- Exception thrown when an operation is cancelled via a CancellationToken.
- ContextReadException
- Exception occurring when reading from the context
- ContextWriteException
- Exception occurring when writing to the context
- HttpLinkParserException
- Exception occurring when parsing fails.
- HttpLinkServerException
-
Exception occurring when network fails
or parsed response is missing both
dataanderrors. - LinkException
- A base class for exceptions thrown by links
- MismatchedDataStructureException
-
A failure due to a data structure mismatch between the data and the expected
structure based on the request
operationdocument. - NetworkException
- Exception occurring when there is a network-level error. This constructor is deprecated, use NetworkException.fromException instead.
- OperationException
- Container for both graphqlErrors returned from the server and any linkException that caused a failure.
- PartialDataException
- Exception occurring when structurally valid data cannot be resolved for an expected field.
- RequestFormatException
- Exception occurring when a terminating link tries to serialize the request
- ResponseFormatException
- Exception occurring when a terminating link tries to parse the response
- ServerException
-
Exception occurring when network fails
or parsed response is missing both
dataanderrors - UnexpectedResponseStructureException
-
Failure occurring when the structure of the parsedResponse
datadoes not match that of the requestoperationdocument. - UnknownException
- Exception occurring when an unhandled, non-link exception is thrown during execution
- VendureDataSourceException
- The port's single error type: everything the transport can produce — connection failures, timeouts, GraphQL error payloads, malformed responses — resolves to one VendureDataSourceException (or a subtype) so callers own one error path.