bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
67 lines
5.0 KiB
Plaintext
67 lines
5.0 KiB
Plaintext
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# js-client
|
|
|
|
## Classes
|
|
|
|
- [AddressesResource](../js_client/classes/js_client.AddressesResource.mdx)
|
|
- [AdminAuthResource](../js_client/classes/js_client.AdminAuthResource.mdx)
|
|
- [AdminBatchJobsResource](../js_client/classes/js_client.AdminBatchJobsResource.mdx)
|
|
- [AdminCollectionsResource](../js_client/classes/js_client.AdminCollectionsResource.mdx)
|
|
- [AdminCurrenciesResource](../js_client/classes/js_client.AdminCurrenciesResource.mdx)
|
|
- [AdminCustomResource](../js_client/classes/js_client.AdminCustomResource.mdx)
|
|
- [AdminCustomerGroupsResource](../js_client/classes/js_client.AdminCustomerGroupsResource.mdx)
|
|
- [AdminCustomersResource](../js_client/classes/js_client.AdminCustomersResource.mdx)
|
|
- [AdminDiscountsResource](../js_client/classes/js_client.AdminDiscountsResource.mdx)
|
|
- [AdminDraftOrdersResource](../js_client/classes/js_client.AdminDraftOrdersResource.mdx)
|
|
- [AdminGiftCardsResource](../js_client/classes/js_client.AdminGiftCardsResource.mdx)
|
|
- [Admin](../js_client/classes/js_client.Admin.mdx)
|
|
- [AdminInventoryItemsResource](../js_client/classes/js_client.AdminInventoryItemsResource.mdx)
|
|
- [AdminInvitesResource](../js_client/classes/js_client.AdminInvitesResource.mdx)
|
|
- [AdminNotesResource](../js_client/classes/js_client.AdminNotesResource.mdx)
|
|
- [AdminNotificationsResource](../js_client/classes/js_client.AdminNotificationsResource.mdx)
|
|
- [AdminOrderEditsResource](../js_client/classes/js_client.AdminOrderEditsResource.mdx)
|
|
- [AdminOrdersResource](../js_client/classes/js_client.AdminOrdersResource.mdx)
|
|
- [AdminPaymentCollectionsResource](../js_client/classes/js_client.AdminPaymentCollectionsResource.mdx)
|
|
- [AdminPaymentsResource](../js_client/classes/js_client.AdminPaymentsResource.mdx)
|
|
- [AdminPriceListResource](../js_client/classes/js_client.AdminPriceListResource.mdx)
|
|
- [AdminProductCategoriesResource](../js_client/classes/js_client.AdminProductCategoriesResource.mdx)
|
|
- [AdminProductTagsResource](../js_client/classes/js_client.AdminProductTagsResource.mdx)
|
|
- [AdminProductTypesResource](../js_client/classes/js_client.AdminProductTypesResource.mdx)
|
|
- [AdminProductsResource](../js_client/classes/js_client.AdminProductsResource.mdx)
|
|
- [AdminPublishableApiKeyResource](../js_client/classes/js_client.AdminPublishableApiKeyResource.mdx)
|
|
- [AdminRegionsResource](../js_client/classes/js_client.AdminRegionsResource.mdx)
|
|
- [AdminReservationsResource](../js_client/classes/js_client.AdminReservationsResource.mdx)
|
|
- [AdminReturnReasonsResource](../js_client/classes/js_client.AdminReturnReasonsResource.mdx)
|
|
- [AdminReturnsResource](../js_client/classes/js_client.AdminReturnsResource.mdx)
|
|
- [AdminSalesChannelsResource](../js_client/classes/js_client.AdminSalesChannelsResource.mdx)
|
|
- [AdminShippingOptionsResource](../js_client/classes/js_client.AdminShippingOptionsResource.mdx)
|
|
- [AdminShippingProfilesResource](../js_client/classes/js_client.AdminShippingProfilesResource.mdx)
|
|
- [AdminStockLocationsResource](../js_client/classes/js_client.AdminStockLocationsResource.mdx)
|
|
- [AdminStoresResource](../js_client/classes/js_client.AdminStoresResource.mdx)
|
|
- [AdminSwapsResource](../js_client/classes/js_client.AdminSwapsResource.mdx)
|
|
- [AdminTaxRatesResource](../js_client/classes/js_client.AdminTaxRatesResource.mdx)
|
|
- [AdminUploadsResource](../js_client/classes/js_client.AdminUploadsResource.mdx)
|
|
- [AdminUsersResource](../js_client/classes/js_client.AdminUsersResource.mdx)
|
|
- [AdminVariantsResource](../js_client/classes/js_client.AdminVariantsResource.mdx)
|
|
- [AuthResource](../js_client/classes/js_client.AuthResource.mdx)
|
|
- [CartsResource](../js_client/classes/js_client.CartsResource.mdx)
|
|
- [CollectionsResource](../js_client/classes/js_client.CollectionsResource.mdx)
|
|
- [CustomersResource](../js_client/classes/js_client.CustomersResource.mdx)
|
|
- [GiftCardsResource](../js_client/classes/js_client.GiftCardsResource.mdx)
|
|
- [LineItemsResource](../js_client/classes/js_client.LineItemsResource.mdx)
|
|
- [OrderEditsResource](../js_client/classes/js_client.OrderEditsResource.mdx)
|
|
- [OrdersResource](../js_client/classes/js_client.OrdersResource.mdx)
|
|
- [PaymentCollectionsResource](../js_client/classes/js_client.PaymentCollectionsResource.mdx)
|
|
- [PaymentMethodsResource](../js_client/classes/js_client.PaymentMethodsResource.mdx)
|
|
- [ProductCategoriesResource](../js_client/classes/js_client.ProductCategoriesResource.mdx)
|
|
- [ProductTagsResource](../js_client/classes/js_client.ProductTagsResource.mdx)
|
|
- [ProductTypesResource](../js_client/classes/js_client.ProductTypesResource.mdx)
|
|
- [ProductVariantsResource](../js_client/classes/js_client.ProductVariantsResource.mdx)
|
|
- [ProductsResource](../js_client/classes/js_client.ProductsResource.mdx)
|
|
- [RegionsResource](../js_client/classes/js_client.RegionsResource.mdx)
|
|
- [ReturnReasonsResource](../js_client/classes/js_client.ReturnReasonsResource.mdx)
|
|
- [ReturnsResource](../js_client/classes/js_client.ReturnsResource.mdx)
|
|
- [ShippingOptionsResource](../js_client/classes/js_client.ShippingOptionsResource.mdx)
|
|
- [SwapsResource](../js_client/classes/js_client.SwapsResource.mdx)
|