* 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
8.3 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Namespace: internal
Enumerations
- AllocationType
- CartType
- ClaimFulfillmentStatus
- ClaimPaymentStatus
- ClaimReason
- ClaimType
- DiscountConditionOperator
- DiscountConditionType
- DiscountRuleType
- DraftOrderStatus
- FulfillmentStatus
- OrderEditItemChangeType
- OrderEditStatus
- OrderStatus
- PaymentCollectionStatus
- PaymentStatus
- PriceListStatus
- PriceListType
- ProductStatus
- RequirementType
- ReturnStatus
- ShippingOptionPriceType
- ShippingProfileType
- SwapFulfillmentStatus
- SwapPaymentStatus
Classes
- Address
- AddressCreatePayload
- AddressPayload
- Axios
- BaseEntity
- Cart
- ClaimImage
- ClaimItem
- ClaimOrder
- ClaimTag
- Client
- Country
- Currency
- Customer
- CustomerGroup
- Discount
- DiscountCondition
- DiscountRule
- DraftOrder
- Fulfillment
- FulfillmentItem
- FulfillmentProvider
- GiftCard
- GiftCardTransaction
- Image
- LineItem
- LineItemAdjustment
- LineItemTaxLine
- MoneyAmount
- Order
- OrderEdit
- OrderItemChange
- Payment
- PaymentCollection
- PaymentProvider
- PaymentSession
- PriceList
- Product
- ProductCollection
- ProductOption
- ProductOptionValue
- ProductTag
- ProductType
- ProductVariant
- Refund
- Region
- Return
- ReturnItem
- ReturnReason
- SalesChannel
- ShippingMethod
- ShippingMethodTaxLine
- ShippingOption
- ShippingOptionRequirement
- ShippingProfile
- SoftDeletableEntity
- StorePostCustomersCustomerAddressesAddressReq
- StorePostCustomersCustomerAddressesReq
- Swap
- TaxLine
- TaxProvider
- TaxRate
- TrackingLink
Interfaces
- AxiosAdapter
- AxiosBasicCredentials
- AxiosDefaults
- AxiosError
- AxiosInstance
- AxiosInterceptorManager
- AxiosPromise
- AxiosProxyConfig
- AxiosRequestConfig
- AxiosRequestTransformer
- AxiosResponse
- AxiosResponseTransformer
- Cancel
- CancelToken
- Config
- HTTPResponse
- HeadersDefaults
- RequestOptions
- RetryConfig
- TransitionalOptions
Enumeration Members
ORDER_EDIT
• ORDER_EDIT: "order_edit"
Defined in
medusa/dist/models/payment-collection.d.ts:11
Type Aliases
AxiosRequestHeaders
Ƭ AxiosRequestHeaders: Record<string, string>
Defined in
medusa-js/node_modules/axios/index.d.ts:3
AxiosResponseHeaders
Ƭ AxiosResponseHeaders: Record<string, string> & { set-cookie?: string[] }
Defined in
medusa-js/node_modules/axios/index.d.ts:5
Method
Ƭ Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"
Defined in
medusa-js/node_modules/axios/index.d.ts:36
RequestMethod
Ƭ RequestMethod: "DELETE" | "POST" | "GET"
Defined in
Response
Ƭ Response<T>: T & { response: HTTPResponse }
Type parameters
| Name |
|---|
T |
Defined in
ResponsePromise
Ƭ ResponsePromise<T>: Promise<Response<T>>
Type parameters
| Name | Type |
|---|---|
T |
any |
Defined in
ResponseType
Ƭ ResponseType: "arraybuffer" | "blob" | "document" | "json" | "text" | "stream"
Defined in
medusa-js/node_modules/axios/index.d.ts:48
StoreCustomersRes
Ƭ StoreCustomersRes: Object
Type declaration
| Name | Type |
|---|---|
customer |
Omit<Customer, "password_hash"> |
Defined in
medusa/dist/api/routes/store/customers/index.d.ts:9