DepositsApi class

Constructors

DepositsApi({required String apiKey, required bool isProduction, bool isDebug = false})

Properties

apiKey String
Parameter, apiKey is the apiKey from the console for the host application.
final
baseUrl String?
getter/setter pair
envLoaded bool?
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
isDebug bool
Parameter(Optional) isDebug, tells the library if it should _printToLog debug logs. Useful if you are debuging or in development.
getter/setter pair
isProduction bool
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sdkApiKey String?
Parameter, sdkApiKey is the apiKey from the console for deposits super vendor.
getter/setter pair

Methods

createAsset(dynamic merchantId, dynamic file, dynamic name, dynamic description) Future
createAsset
createCustomer(dynamic merchantId, dynamic email, dynamic firstName, dynamic lastName, dynamic gender, dynamic phoneNumber, dynamic meta) Future
createCustomer
createOrder(dynamic merchantId, dynamic customerId, dynamic shippingFee, dynamic tax, dynamic transactionId, dynamic zip, dynamic streetAddress, dynamic city, dynamic state, dynamic country, dynamic saveAddress, dynamic isDefaultAddress, dynamic productIds, dynamic quantityList, dynamic meta) Future
createOrder
createProduct(dynamic merchantId, dynamic sku, dynamic name, dynamic price, dynamic description, dynamic quantity, dynamic includeFeesTax, dynamic type, dynamic tax, dynamic shippingFee, dynamic assetIds, dynamic meta) Future
createProduct
deleteMerchant(dynamic id) Future
get merchant
findCustomer(dynamic merchantId, dynamic email) Future
findCustomer
findCustomerOrCreate(dynamic merchantId, dynamic email, dynamic firstName, dynamic lastName, dynamic gender, dynamic phoneNumber, dynamic meta) Future
findCustomerOrCreate
get(String endPoint) Future
Make a custom get request to a DepositsApi endpoint, using DepositsApi SDK.
getCategories() Future
get categories
getFeaturedProducts(dynamic merchantId) Future
getFeaturedProducts
getMerchant(dynamic id) Future
get merchant
getMerchantInfo(dynamic id) Future
get merchant info
getProduct(dynamic merchantId, dynamic productId) Future
getProducts
getProducts(dynamic merchantId) Future
getProducts
getSelectedMerchants(dynamic merchantIds) Future
get merchant info
httpRequest(dynamic type, dynamic url, dynamic data) → dynamic
loadEnv() → dynamic
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
post(String endPoint, Map data) Future
Make a custom post request to DepositsApi, using DepositsApi SDK.
setBaseUrl() → dynamic
setSdkApiKey() → dynamic
setupMerchant(dynamic depositUserId, dynamic name, dynamic description, dynamic supportEmail, dynamic category, dynamic zip, dynamic streetAddress, dynamic city, dynamic state, dynamic country) Future
setup merchant
toString() String
A string representation of this object.
inherited
updateMerchant(dynamic id, dynamic name, dynamic description, dynamic supportEmail, dynamic category, dynamic zip, dynamic streetAddress, dynamic city, dynamic state, dynamic country) Future
update merchant
updateMerchantContactInfo(dynamic id, dynamic contactInfo, dynamic contactAddress) Future
update merchant contact info
updateMerchantPolicy(dynamic id, dynamic returnPolicy, dynamic shippingPolicy) Future
update merchant policy
updateMerchantShippingAndTaxInfo(dynamic id, dynamic taxId, dynamic taxPercent, dynamic shippingFee) Future
update merchant shipping and tax info

Operators

operator ==(Object other) bool
The equality operator.
inherited