docs: added reference for JS Client (#1629)

* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
This commit is contained in:
Shahed Nasser
2022-07-08 18:21:46 +03:00
committed by GitHub
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions

View File

@@ -477,5 +477,263 @@ module.exports = {
type: 'autogenerated',
dirName: 'references/services/classes', // generate sidebar from the docs folder (or versioned_docs/<version>)
},
],
jsClientSidebar: [
{
type: "doc",
id: "js-client/overview",
label: "Overview",
},
{
type: "category",
collapsed: false,
label: "Resources",
items: [
{
type: "category",
label: "admin",
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/Admin",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AdminAuthResource",
label: "auth",
},
{
type: "doc",
id: "references/js-client/classes/AdminCollectionsResource",
label: "collections",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomerGroupsResource",
label: "customerGroups",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomersResource",
label: "customers",
},
{
type: "doc",
id: "references/js-client/classes/AdminDiscountsResource",
label: "discounts",
},
{
type: "doc",
id: "references/js-client/classes/AdminDraftOrdersResource",
label: "draftOrders",
},
{
type: "doc",
id: "references/js-client/classes/AdminGiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/AdminInvitesResource",
label: "invites",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotesResource",
label: "notes",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotificationsResource",
label: "notifications",
},
{
type: "doc",
id: "references/js-client/classes/AdminOrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/AdminPriceListResource",
label: "priceLists",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductsResource",
label: "products",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTagsResource",
label: "productTags",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTypesResource",
label: "productTypes",
},
{
type: "doc",
id: "references/js-client/classes/AdminRegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnReasonsResource",
label: "returnReasons",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingProfilesResource",
label: "shippingProfiles",
},
{
type: "doc",
id: "references/js-client/classes/AdminStoresResource",
label: "store",
},
{
type: "doc",
id: "references/js-client/classes/AdminSwapsResource",
label: "swaps",
},
{
type: "doc",
id: "references/js-client/classes/AdminTaxRatesResource",
label: "taxRates",
},
{
type: "doc",
id: "references/js-client/classes/AdminUploadsResource",
label: "uploads",
},
{
type: "doc",
id: "references/js-client/classes/AdminUsersResource",
label: "users",
},
{
type: "doc",
id: "references/js-client/classes/AdminVariantsResource",
label: "variants",
},
]
},
{
type: "doc",
id: "references/js-client/classes/AuthResource",
label: "auth",
},
{
type: "category",
label: "carts",
link: {
type: "doc",
id: "references/js-client/classes/CartsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/LineItemsResource",
label: "lineItems",
}
]
},
{
type: "doc",
id: "references/js-client/classes/CollectionsResource",
label: "collections",
},
{
type: "category",
label: "customers",
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/CustomerResource",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AddressesResource",
label: "addresses"
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
label: "paymentMethods"
}
]
},
{
type: "doc",
id: "references/js-client/classes/GiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/OrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
label: "paymentMethods",
},
{
type: "category",
label: "products",
link: {
type: "doc",
id: "references/js-client/classes/ProductsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/ProductVariantsResource",
label: "variants",
}
]
},
{
type: "doc",
id: "references/js-client/classes/RegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/ReturnReasonsResource",
label: "returnReason",
},
{
type: "doc",
id: "references/js-client/classes/ReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/ShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/SwapsResource",
label: "swaps",
},
]
}
]
}