Files
medusa-store/www/docs/content/references/js-client/index.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770)
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

113 lines
5.0 KiB
Markdown

# JS Client Reference
## Namespaces
- [internal](modules/internal.md)
- [internal](modules/internal-1.md)
- [internal](modules/internal-2.md)
- [internal](modules/internal-3.md)
- [internal](modules/internal-4.md)
- [internal](modules/internal-5.md)
- [internal](modules/internal-6.md)
- [internal](modules/internal-7.md)
- [internal](modules/internal-8.md)
- [internal](modules/internal-9.md)
- [internal](modules/internal-10.md)
- [internal](modules/internal-11.md)
- [internal](modules/internal-12.md)
- [internal](modules/internal-13.md)
- [internal](modules/internal-14.md)
- [internal](modules/internal-15.md)
- [internal](modules/internal-16.md)
- [internal](modules/internal-17.md)
- [internal](modules/internal-18.md)
- [internal](modules/internal-19.md)
- [internal](modules/internal-20.md)
- [internal](modules/internal-21.md)
- [internal](modules/internal-22.md)
- [internal](modules/internal-23.md)
- [internal](modules/internal-24.md)
- [internal](modules/internal-25.md)
- [internal](modules/internal-26.md)
- [internal](modules/internal-27.md)
- [internal](modules/internal-28.md)
- [internal](modules/internal-29.md)
- [internal](modules/internal-30.md)
- [internal](modules/internal-31.md)
- [internal](modules/internal-32.md)
- [internal](modules/internal-33.md)
- [internal](modules/internal-34.md)
- [internal](modules/internal-35.md)
- [internal](modules/internal-36.md)
- [internal](modules/internal-37.md)
- [internal](modules/internal-38.md)
- [internal](modules/internal-39.md)
- [internal](modules/internal-40.md)
- [internal](modules/internal-41.md)
- [internal](modules/internal-42.md)
- [internal](modules/internal-43.md)
- [internal](modules/internal-44.md)
- [internal](modules/internal-45.md)
- [internal](modules/internal-46.md)
- [internal](modules/internal-47.md)
- [internal](modules/internal-48.md)
- [internal](modules/internal-49.md)
- [internal](modules/internal-50.md)
- [internal](modules/internal-51.md)
## Classes
- [AddressesResource](classes/AddressesResource.md)
- [Admin](classes/Admin.md)
- [AdminAuthResource](classes/AdminAuthResource.md)
- [AdminBatchJobsResource](classes/AdminBatchJobsResource.md)
- [AdminCollectionsResource](classes/AdminCollectionsResource.md)
- [AdminCurrenciesResource](classes/AdminCurrenciesResource.md)
- [AdminCustomerGroupsResource](classes/AdminCustomerGroupsResource.md)
- [AdminCustomersResource](classes/AdminCustomersResource.md)
- [AdminDiscountsResource](classes/AdminDiscountsResource.md)
- [AdminDraftOrdersResource](classes/AdminDraftOrdersResource.md)
- [AdminGiftCardsResource](classes/AdminGiftCardsResource.md)
- [AdminInvitesResource](classes/AdminInvitesResource.md)
- [AdminNotesResource](classes/AdminNotesResource.md)
- [AdminNotificationsResource](classes/AdminNotificationsResource.md)
- [AdminOrderEditsResource](classes/AdminOrderEditsResource.md)
- [AdminOrdersResource](classes/AdminOrdersResource.md)
- [AdminPaymentCollectionsResource](classes/AdminPaymentCollectionsResource.md)
- [AdminPaymentsResource](classes/AdminPaymentsResource.md)
- [AdminPriceListResource](classes/AdminPriceListResource.md)
- [AdminProductTagsResource](classes/AdminProductTagsResource.md)
- [AdminProductTypesResource](classes/AdminProductTypesResource.md)
- [AdminProductsResource](classes/AdminProductsResource.md)
- [AdminPublishableApiKeyResource](classes/AdminPublishableApiKeyResource.md)
- [AdminRegionsResource](classes/AdminRegionsResource.md)
- [AdminReturnReasonsResource](classes/AdminReturnReasonsResource.md)
- [AdminReturnsResource](classes/AdminReturnsResource.md)
- [AdminSalesChannelsResource](classes/AdminSalesChannelsResource.md)
- [AdminShippingOptionsResource](classes/AdminShippingOptionsResource.md)
- [AdminShippingProfilesResource](classes/AdminShippingProfilesResource.md)
- [AdminStoresResource](classes/AdminStoresResource.md)
- [AdminSwapsResource](classes/AdminSwapsResource.md)
- [AdminTaxRatesResource](classes/AdminTaxRatesResource.md)
- [AdminUploadsResource](classes/AdminUploadsResource.md)
- [AdminUsersResource](classes/AdminUsersResource.md)
- [AdminVariantsResource](classes/AdminVariantsResource.md)
- [AuthResource](classes/AuthResource.md)
- [CartsResource](classes/CartsResource.md)
- [CollectionsResource](classes/CollectionsResource.md)
- [CustomerResource](classes/CustomerResource.md)
- [GiftCardsResource](classes/GiftCardsResource.md)
- [LineItemsResource](classes/LineItemsResource.md)
- [OrderEditsResource](classes/OrderEditsResource.md)
- [OrdersResource](classes/OrdersResource.md)
- [PaymentCollectionsResource](classes/PaymentCollectionsResource.md)
- [PaymentMethodsResource](classes/PaymentMethodsResource.md)
- [ProductTypesResource](classes/ProductTypesResource.md)
- [ProductVariantsResource](classes/ProductVariantsResource.md)
- [ProductsResource](classes/ProductsResource.md)
- [RegionsResource](classes/RegionsResource.md)
- [ReturnReasonsResource](classes/ReturnReasonsResource.md)
- [ReturnsResource](classes/ReturnsResource.md)
- [ShippingOptionsResource](classes/ShippingOptionsResource.md)
- [SwapsResource](classes/SwapsResource.md)