Constructors
constructor
- new VendureClient(adminApiUrl): VendureClient
-
Methods
addOptionGroupToProduct
- addOptionGroupToProduct(productId, optiontGroupId): Promise<void>
-
Parameters
-
productId: string
-
optiontGroupId: string
Returns Promise<void>
createAssets
- createAssets(assets): Promise<any>
-
Returns Promise<any>
createCategory
- createCategory(category): Promise<string>
-
Returns Promise<string>
createCategoryFacet
- createCategoryFacet(facet): Promise<string>
-
Returns Promise<string>
createCollection
- createCollection(collection): Promise<string>
-
Returns Promise<string>
createFacetValues
- createFacetValues(facetId, values): Promise<string>
-
Returns Promise<string>
createProduct
- createProduct(item): Promise<string>
-
Returns Promise<string>
createProductOption
- createProductOption(option): Promise<void>
-
Returns Promise<void>
createProductOptionGroup
- createProductOptionGroup(optgrp): Promise<any>
-
Returns Promise<any>
createProductVariants
- createProductVariants(productId, variants, groupSpec?): Promise<string[]>
-
Parameters
-
productId: any
-
-
groupSpec: any = {}
Returns Promise<string[]>
deleteAssets
- deleteAssets(assetIds, force?): Promise<VendureDeleteResult>
-
Parameters
-
assetIds: string[]
-
force: boolean = false
deleteCategory
- deleteCategory(identifier): Promise<VendureDeleteResult>
-
deleteCategoryFacet
- deleteCategoryFacet(categoryCode): Promise<void>
-
Returns Promise<void>
deleteCollections
- deleteCollections(ids): Promise<VendureDeleteResult[]>
-
deleteFacetValues
- deleteFacetValues(ids, force?): Promise<VendureDeleteResult[]>
-
Parameters
-
ids: string[]
-
force: boolean = false
deleteProduct
- deleteProduct(productId): Promise<VendureDeleteResult>
-
deleteProductOption
- deleteProductOption(optionId): Promise<VendureDeleteResult>
-
deleteProductVariants
- deleteProductVariants(ids): Promise<VendureDeleteResult[]>
-
findOrCreateAsset
- findOrCreateAsset(asset, force?): Promise<string>
-
Returns Promise<string>
getAssets
- getAssets(options): Promise<any>
-
Returns Promise<any>
getCategories
- getCategories(opts?): Promise<VendureCategory[]>
-
getCategoryFacetId
- getCategoryFacetId(): Promise<string>
-
Returns Promise<string>
getCollections
- getCollections(options): Promise<any>
-
Returns Promise<any>
getFacetValues
- getFacetValues(options): Promise<any>
-
Returns Promise<any>
getFacets
- getFacets(options): Promise<any>
-
Returns Promise<any>
getProductOptionGroup
- getProductOptionGroup(groupId): Promise<any>
-
Returns Promise<any>
getProductOptionGroups
- getProductOptionGroups(filterTerm): Promise<any>
-
Returns Promise<any>
getProducts
- getProducts(params): Promise<any>
-
Returns Promise<any>
gqlRequest
- gqlRequest(doc, vars, authToken?): Promise<any>
-
Parameters
-
doc: string
-
vars: any
-
authToken: string = ''
Returns Promise<any>
hasCategoryFacet
- hasCategoryFacet(categoryCode): Promise<boolean>
-
Returns Promise<boolean>
hasCollection
- hasCollection(slug): Promise<boolean>
-
Returns Promise<boolean>
removeOptionGroupFromProduct
- removeOptionGroupFromProduct(productId, optiontGroupId, force?): Promise<any>
-
Parameters
-
productId: string
-
optiontGroupId: string
-
force: boolean = false
Returns Promise<any>
setAuthToken
- setAuthToken(authToken): void
-
Returns void
updateCategory
- updateCategory(category): Promise<string>
-
Returns Promise<string>
updateCollection
- updateCollection(collection): Promise<string>
-
Returns Promise<string>
updateFacetValues
- updateFacetValues(updates): Promise<string>
-
Returns Promise<string>
updateProduct
- updateProduct(item): Promise<any>
-
Returns Promise<any>
updateProductVariants
- updateProductVariants(variants): Promise<string[]>
-
Returns Promise<string[]>