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.7 KiB

Raw Blame History

Class: AdminRegionsResource

Hierarchy

default

↳ AdminRegionsResource

Methods

addCountry

▸ addCountry(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

adds a country to the list of countries in a region

Parameters

Name	Type	Description
`id`	`string`	region id
`payload`	`AdminPostRegionsRegionCountriesReq`	country data
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:103

addFulfillmentProvider

▸ addFulfillmentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

adds a fulfillment provider to a region

Parameters

Name	Type	Description
`id`	`string`	region id
`payload`	`AdminPostRegionsRegionFulfillmentProvidersReq`	fulfillment provider data
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:135

addPaymentProvider

▸ addPaymentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

adds a payment provider to a region

Parameters

Name	Type	Description
`id`	`string`	region id
`payload`	`AdminPostRegionsRegionPaymentProvidersReq`	payment provider data
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:181

create

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

Description

creates a region.

Parameters

Name	Type
`payload`	`AdminPostRegionsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

created region.

Defined in

medusa-js/src/resources/admin/regions.ts:24

delete

▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Description

deletes a region

Parameters

Name	Type	Description
`id`	`string`	id of region to delete.
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<DeleteResponse>

Deleted response

Defined in

medusa-js/src/resources/admin/regions.ts:54

deleteCountry

▸ deleteCountry(id, country_code, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

remove a country from a region's list of coutnries

Parameters

Name	Type	Description
`id`	`string`	region id
`country_code`	`string`	the 2 character ISO code for the Country.
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:119

deleteFulfillmentProvider

▸ deleteFulfillmentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

remove a fulfillment provider from a region

Parameters

Name	Type	Description
`id`	`string`	region id
`provider_id`	`string`	the if of the fulfillment provider
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:151

deletePaymentProvider

▸ deletePaymentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

removes a payment provider from a region

Parameters

Name	Type	Description
`id`	`string`	region id
`provider_id`	`string`	the id of the payment provider
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:197

list

▸ list(query?, customHeaders?): ResponsePromise<AdminRegionsListRes>

Description

lists regions matching a query

Parameters

Name	Type	Description
`query?`	`AdminGetRegionsParams`	query for searching regions
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsListRes>

a list of regions matching the query.

Defined in

medusa-js/src/resources/admin/regions.ts:82

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

get a region

Parameters

Name	Type	Description
`id`	`string`	id of the region to retrieve.
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

the region with the given id

Defined in

medusa-js/src/resources/admin/regions.ts:68

retrieveFulfillmentOptions

▸ retrieveFulfillmentOptions(id, customHeaders?): ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>

Description

retrieves the list of fulfillment options available in a region

Parameters

Name	Type	Description
`id`	`string`	region id
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>

list of fulfillment options

Defined in

medusa-js/src/resources/admin/regions.ts:166

update

▸ update(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Description

updates a region

Parameters

Name	Type	Description
`id`	`string`	id of the region to update.
`payload`	`AdminPostRegionsRegionReq`	update to apply to region.
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminRegionsRes>

the updated region.

Defined in

medusa-js/src/resources/admin/regions.ts:39

9.7 KiB Raw Blame History

Class: AdminRegionsResource

Hierarchy

Methods

addCountry

Parameters

Returns

Defined in

addFulfillmentProvider

Parameters

Returns

Defined in

addPaymentProvider

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

deleteCountry

Parameters

Returns

Defined in

deleteFulfillmentProvider

Parameters

Returns

Defined in

deletePaymentProvider

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

retrieveFulfillmentOptions

Parameters

Returns

Defined in

update

Parameters

Returns

Defined in

9.7 KiB

Raw Blame History