Files

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

9.3 KiB

Raw Blame History

Class: CartsResource

Hierarchy

default

↳ CartsResource

Properties

lineItems

• lineItems: LineItemsResource

Defined in

medusa-js/src/resources/carts.ts:15

Methods

addShippingMethod

▸ addShippingMethod(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Adds a shipping method to cart

Parameters

Name	Type	Description
`cart_id`	`string`	Id of cart
`payload`	`StorePostCartsCartShippingMethodReq`	Containg id of shipping option and optional data
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:24

complete

▸ complete(cart_id, customHeaders?): ResponsePromise<StoreCompleteCartRes>

Completes a cart. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. If payment is authorized and order is not yet created, we make sure to do so. The completion of a cart can be performed idempotently with a provided header Idempotency-Key. If not provuided, we will generate one for the request.

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCompleteCartRes>

Defined in

medusa-js/src/resources/carts.ts:43

create

▸ create(payload?, customHeaders?): ResponsePromise<StoreCartsRes>

Creates a cart

Parameters

Name	Type	Description
`payload?`	`StorePostCartReq`	is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:58

createPaymentSessions

▸ createPaymentSessions(cart_id, customHeaders?): ResponsePromise<StoreCartsRes>

Creates payment sessions. Initializes the payment sessions that can be used to pay for the items of the cart. This is usually called when a customer proceeds to checkout.

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:74

deleteDiscount

▸ deleteDiscount(cart_id, code, customHeaders?): ResponsePromise<StoreCartsRes>

Removes a discount from cart.

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`code`	`string`	discount code to remove
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:89

deletePaymentSession

▸ deletePaymentSession(cart_id, provider_id, customHeaders?): ResponsePromise<StoreCartsRes>

Removes a payment session from a cart. Can be useful in case a payment has failed

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`provider_id`	`string`	the provider id of the session e.g. "stripe"
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:106

refreshPaymentSession

▸ refreshPaymentSession(cart_id, provider_id, customHeaders?): ResponsePromise<StoreCartsRes>

Refreshes a payment session.

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`provider_id`	`string`	the provider id of the session e.g. "stripe"
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:122

retrieve

▸ retrieve(cart_id, customHeaders?): ResponsePromise<StoreCartsRes>

Retrieves a cart

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:137

setPaymentSession

▸ setPaymentSession(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Refreshes a payment session.

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`payload`	`StorePostCartsCartPaymentSessionReq`	the provider id of the session e.g. "stripe"
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:152

update

▸ update(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Updates a cart

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`payload`	`StorePostCartsCartReq`	is required and can contain region_id, email, billing and shipping address
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:168

updatePaymentSession

▸ updatePaymentSession(cart_id, provider_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Updates the payment method

Parameters

Name	Type	Description
`cart_id`	`string`	is required
`provider_id`	`string`	is required
`payload`	`StorePostCartsCartPaymentSessionUpdateReq`	is required
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:185

9.3 KiB Raw Blame History

Class: CartsResource

Hierarchy

Properties

lineItems

Defined in

Methods

addShippingMethod

Parameters

Returns

Defined in

complete

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

createPaymentSessions

Parameters

Returns

Defined in

deleteDiscount

Parameters

Returns

Defined in

deletePaymentSession

Parameters

Returns

Defined in

refreshPaymentSession

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

setPaymentSession

Parameters

Returns

Defined in

update

Parameters

Returns

Defined in

updatePaymentSession

Parameters

Returns

Defined in

9.3 KiB

Raw Blame History