chore(docs): Generated JS Client Reference (#5421)
* chore(docs): Generated JS Client Reference (automated) * fix js client reference * fix links --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
83f46b9b32
commit
9dcd62c731
@@ -0,0 +1,318 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Admin
|
||||
|
||||
[admin](../../modules/admin.mdx).Admin
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "auth",
|
||||
"type": "[`AdminAuthResource`](../../admin_auth/classes/admin_auth.AdminAuthResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "batchJobs",
|
||||
"type": "[`AdminBatchJobsResource`](../../admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collections",
|
||||
"type": "[`AdminCollectionsResource`](../../admin_collections/classes/admin_collections.AdminCollectionsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currencies",
|
||||
"type": "[`AdminCurrenciesResource`](../../admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "custom",
|
||||
"type": "[`AdminCustomResource`](../../admin_custom/classes/admin_custom.AdminCustomResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customerGroups",
|
||||
"type": "[`AdminCustomerGroupsResource`](../../admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customers",
|
||||
"type": "[`AdminCustomersResource`](../../admin_customers/classes/admin_customers.AdminCustomersResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[`AdminDiscountsResource`](../../admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "draftOrders",
|
||||
"type": "[`AdminDraftOrdersResource`](../../admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "giftCards",
|
||||
"type": "[`AdminGiftCardsResource`](../../admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventoryItems",
|
||||
"type": "[`AdminInventoryItemsResource`](../../admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "invites",
|
||||
"type": "[`AdminInvitesResource`](../../admin_invites/classes/admin_invites.AdminInvitesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "notes",
|
||||
"type": "[`AdminNotesResource`](../../admin_notes/classes/admin_notes.AdminNotesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "notifications",
|
||||
"type": "[`AdminNotificationsResource`](../../admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "orderEdits",
|
||||
"type": "[`AdminOrderEditsResource`](../../admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "orders",
|
||||
"type": "[`AdminOrdersResource`](../../admin_orders/classes/admin_orders.AdminOrdersResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "paymentCollections",
|
||||
"type": "[`AdminPaymentCollectionsResource`](../../admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "payments",
|
||||
"type": "[`AdminPaymentsResource`](../../admin_payments/classes/admin_payments.AdminPaymentsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priceLists",
|
||||
"type": "[`AdminPriceListResource`](../../admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "productCategories",
|
||||
"type": "[`AdminProductCategoriesResource`](../../admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "productTags",
|
||||
"type": "[`AdminProductTagsResource`](../../admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "productTypes",
|
||||
"type": "[`AdminProductTypesResource`](../../admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[`AdminProductsResource`](../../admin_products/classes/admin_products.AdminProductsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "publishableApiKeys",
|
||||
"type": "[`AdminPublishableApiKeyResource`](../../admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "regions",
|
||||
"type": "[`AdminRegionsResource`](../../admin_regions/classes/admin_regions.AdminRegionsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "reservations",
|
||||
"type": "[`AdminReservationsResource`](../../admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "returnReasons",
|
||||
"type": "[`AdminReturnReasonsResource`](../../admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "returns",
|
||||
"type": "[`AdminReturnsResource`](../../admin_returns/classes/admin_returns.AdminReturnsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "salesChannels",
|
||||
"type": "[`AdminSalesChannelsResource`](../../admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "shippingOptions",
|
||||
"type": "[`AdminShippingOptionsResource`](../../admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "shippingProfiles",
|
||||
"type": "[`AdminShippingProfilesResource`](../../admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "stockLocations",
|
||||
"type": "[`AdminStockLocationsResource`](../../admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "store",
|
||||
"type": "[`AdminStoresResource`](../../admin_store/classes/admin_store.AdminStoresResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "swaps",
|
||||
"type": "[`AdminSwapsResource`](../../admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "taxRates",
|
||||
"type": "[`AdminTaxRatesResource`](../../admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "uploads",
|
||||
"type": "[`AdminUploadsResource`](../../admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "users",
|
||||
"type": "[`AdminUsersResource`](../../admin_users/classes/admin_users.AdminUsersResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variants",
|
||||
"type": "[`AdminVariantsResource`](../../admin_variants/classes/admin_variants.AdminVariantsResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Reference in New Issue
Block a user