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
This commit is contained in:
Shahed Nasser
2023-08-15 18:07:54 +03:00
committed by GitHub
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosAdapter
[internal](../modules/internal.md).AxiosAdapter
## Callable
### AxiosAdapter
**AxiosAdapter**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:18
@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosBasicCredentials
[internal](../modules/internal.md).AxiosBasicCredentials
## Properties
### password
**password**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:23
___
### username
**username**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:22
@@ -0,0 +1,519 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosDefaults<D\>
[internal](../modules/internal.md).AxiosDefaults
## Type parameters
| Name | Type |
| :------ | :------ |
| `D` | `any` |
## Hierarchy
- `Omit`<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\>
**`AxiosDefaults`**
## Properties
### adapter
`Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
#### Inherited from
Omit.adapter
#### Defined in
medusa-js/node_modules/axios/index.d.ts:75
___
### auth
`Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
#### Inherited from
Omit.auth
#### Defined in
medusa-js/node_modules/axios/index.d.ts:76
___
### baseURL
`Optional` **baseURL**: `string`
#### Inherited from
Omit.baseURL
#### Defined in
medusa-js/node_modules/axios/index.d.ts:65
___
### cancelToken
`Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
#### Inherited from
Omit.cancelToken
#### Defined in
medusa-js/node_modules/axios/index.d.ts:90
___
### data
`Optional` **data**: `D`
#### Inherited from
Omit.data
#### Defined in
medusa-js/node_modules/axios/index.d.ts:71
___
### decompress
`Optional` **decompress**: `boolean`
#### Inherited from
Omit.decompress
#### Defined in
medusa-js/node_modules/axios/index.d.ts:91
___
### headers
**headers**: [`HeadersDefaults`](internal.HeadersDefaults.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:112
___
### httpAgent
`Optional` **httpAgent**: `any`
#### Inherited from
Omit.httpAgent
#### Defined in
medusa-js/node_modules/axios/index.d.ts:87
___
### httpsAgent
`Optional` **httpsAgent**: `any`
#### Inherited from
Omit.httpsAgent
#### Defined in
medusa-js/node_modules/axios/index.d.ts:88
___
### insecureHTTPParser
`Optional` **insecureHTTPParser**: `boolean`
#### Inherited from
Omit.insecureHTTPParser
#### Defined in
medusa-js/node_modules/axios/index.d.ts:94
___
### maxBodyLength
`Optional` **maxBodyLength**: `number`
#### Inherited from
Omit.maxBodyLength
#### Defined in
medusa-js/node_modules/axios/index.d.ts:84
___
### maxContentLength
`Optional` **maxContentLength**: `number`
#### Inherited from
Omit.maxContentLength
#### Defined in
medusa-js/node_modules/axios/index.d.ts:82
___
### maxRedirects
`Optional` **maxRedirects**: `number`
#### Inherited from
Omit.maxRedirects
#### Defined in
medusa-js/node_modules/axios/index.d.ts:85
___
### method
`Optional` **method**: [`Method`](../modules/internal.md#method)
#### Inherited from
Omit.method
#### Defined in
medusa-js/node_modules/axios/index.d.ts:64
___
### onDownloadProgress
`Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void`
#### Type declaration
▸ (`progressEvent`): `void`
##### Parameters
| Name | Type |
| :------ | :------ |
| `progressEvent` | `any` |
##### Returns
`void`
#### Inherited from
Omit.onDownloadProgress
#### Defined in
medusa-js/node_modules/axios/index.d.ts:81
___
### onUploadProgress
`Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void`
#### Type declaration
▸ (`progressEvent`): `void`
##### Parameters
| Name | Type |
| :------ | :------ |
| `progressEvent` | `any` |
##### Returns
`void`
#### Inherited from
Omit.onUploadProgress
#### Defined in
medusa-js/node_modules/axios/index.d.ts:80
___
### params
`Optional` **params**: `any`
#### Inherited from
Omit.params
#### Defined in
medusa-js/node_modules/axios/index.d.ts:69
___
### paramsSerializer
`Optional` **paramsSerializer**: (`params`: `any`) => `string`
#### Type declaration
▸ (`params`): `string`
##### Parameters
| Name | Type |
| :------ | :------ |
| `params` | `any` |
##### Returns
`string`
#### Inherited from
Omit.paramsSerializer
#### Defined in
medusa-js/node_modules/axios/index.d.ts:70
___
### proxy
`Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
#### Inherited from
Omit.proxy
#### Defined in
medusa-js/node_modules/axios/index.d.ts:89
___
### raxConfig
• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
#### Inherited from
Omit.raxConfig
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
___
### responseType
• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
#### Inherited from
Omit.responseType
#### Defined in
medusa-js/node_modules/axios/index.d.ts:77
___
### signal
• `Optional` **signal**: `AbortSignal`
#### Inherited from
Omit.signal
#### Defined in
medusa-js/node_modules/axios/index.d.ts:93
___
### socketPath
• `Optional` **socketPath**: ``null`` \| `string`
#### Inherited from
Omit.socketPath
#### Defined in
medusa-js/node_modules/axios/index.d.ts:86
___
### timeout
• `Optional` **timeout**: `number`
#### Inherited from
Omit.timeout
#### Defined in
medusa-js/node_modules/axios/index.d.ts:72
___
### timeoutErrorMessage
• `Optional` **timeoutErrorMessage**: `string`
#### Inherited from
Omit.timeoutErrorMessage
#### Defined in
medusa-js/node_modules/axios/index.d.ts:73
___
### transformRequest
• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
#### Inherited from
Omit.transformRequest
#### Defined in
medusa-js/node_modules/axios/index.d.ts:66
___
### transformResponse
• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
#### Inherited from
Omit.transformResponse
#### Defined in
medusa-js/node_modules/axios/index.d.ts:67
___
### transitional
• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
#### Inherited from
Omit.transitional
#### Defined in
medusa-js/node_modules/axios/index.d.ts:92
___
### url
• `Optional` **url**: `string`
#### Inherited from
Omit.url
#### Defined in
medusa-js/node_modules/axios/index.d.ts:63
___
### validateStatus
• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
#### Inherited from
Omit.validateStatus
#### Defined in
medusa-js/node_modules/axios/index.d.ts:83
___
### withCredentials
• `Optional` **withCredentials**: `boolean`
#### Inherited from
Omit.withCredentials
#### Defined in
medusa-js/node_modules/axios/index.d.ts:74
___
### xsrfCookieName
• `Optional` **xsrfCookieName**: `string`
#### Inherited from
Omit.xsrfCookieName
#### Defined in
medusa-js/node_modules/axios/index.d.ts:78
___
### xsrfHeaderName
• `Optional` **xsrfHeaderName**: `string`
#### Inherited from
Omit.xsrfHeaderName
#### Defined in
medusa-js/node_modules/axios/index.d.ts:79
@@ -0,0 +1,88 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosError<T, D\>
[internal](../modules/internal.md).AxiosError
## Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `D` | `any` |
## Hierarchy
- `Error`
**`AxiosError`**
## Properties
### code
`Optional` **code**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:126
___
### config
**config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:125
___
### isAxiosError
**isAxiosError**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:129
___
### request
`Optional` **request**: `any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:127
___
### response
`Optional` **response**: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `D`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:128
___
### toJSON
**toJSON**: () => `object`
#### Type declaration
▸ (): `object`
##### Returns
`object`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:130
@@ -0,0 +1,377 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosInstance
[internal](../modules/internal.md).AxiosInstance
## Hierarchy
- [`Axios`](../classes/internal.Axios.md)
**`AxiosInstance`**
## Callable
### AxiosInstance
**AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:188
### AxiosInstance
**AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:189
## Properties
### defaults
**defaults**: [`AxiosDefaults`](internal.AxiosDefaults.md)<`any`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[defaults](../classes/internal.Axios.md#defaults)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:171
___
### interceptors
**interceptors**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `request` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\>\> |
| `response` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosResponse`](internal.AxiosResponse.md)<`any`, `any`\>\> |
#### Inherited from
[Axios](../classes/internal.Axios.md).[interceptors](../classes/internal.Axios.md#interceptors)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:172
## Methods
### delete
**delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[delete](../classes/internal.Axios.md#delete)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:179
___
### get
**get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[get](../classes/internal.Axios.md#get)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:178
___
### getUri
**getUri**(`config?`): `string`
#### Parameters
| Name | Type |
| :------ | :------ |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
#### Returns
`string`
#### Inherited from
[Axios](../classes/internal.Axios.md).[getUri](../classes/internal.Axios.md#geturi)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:176
___
### head
**head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[head](../classes/internal.Axios.md#head)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:180
___
### options
**options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[options](../classes/internal.Axios.md#options)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:181
___
### patch
**patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[patch](../classes/internal.Axios.md#patch)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:184
___
### post
**post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[post](../classes/internal.Axios.md#post)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:182
___
### put
**put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[put](../classes/internal.Axios.md#put)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:183
___
### request
**request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
#### Returns
`Promise`<`R`\>
#### Inherited from
[Axios](../classes/internal.Axios.md).[request](../classes/internal.Axios.md#request)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:177
@@ -0,0 +1,60 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosInterceptorManager<V\>
[internal](../modules/internal.md).AxiosInterceptorManager
## Type parameters
| Name |
| :------ |
| `V` |
## Methods
### eject
**eject**(`id`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `number` |
#### Returns
`void`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:166
___
### use
**use**<`T`\>(`onFulfilled?`, `onRejected?`): `number`
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `V` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `onFulfilled?` | (`value`: `V`) => `T` \| `Promise`<`T`\> |
| `onRejected?` | (`error`: `any`) => `any` |
#### Returns
`number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:165
@@ -0,0 +1,19 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosPromise<T\>
[internal](../modules/internal.md).AxiosPromise
## Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
## Hierarchy
- `Promise`<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\>
**`AxiosPromise`**
@@ -0,0 +1,54 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosProxyConfig
[internal](../modules/internal.md).AxiosProxyConfig
## Properties
### auth
`Optional` **auth**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `password` | `string` |
| `username` | `string` |
#### Defined in
medusa-js/node_modules/axios/index.d.ts:29
___
### host
**host**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:27
___
### port
**port**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:28
___
### protocol
`Optional` **protocol**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:33
@@ -0,0 +1,385 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosRequestConfig<D\>
[internal](../modules/internal.md).AxiosRequestConfig
## Type parameters
| Name | Type |
| :------ | :------ |
| `D` | `any` |
## Properties
### adapter
`Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:75
___
### auth
`Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:76
___
### baseURL
`Optional` **baseURL**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:65
___
### cancelToken
`Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:90
___
### data
`Optional` **data**: `D`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:71
___
### decompress
`Optional` **decompress**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:91
___
### headers
`Optional` **headers**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:68
___
### httpAgent
`Optional` **httpAgent**: `any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:87
___
### httpsAgent
`Optional` **httpsAgent**: `any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:88
___
### insecureHTTPParser
`Optional` **insecureHTTPParser**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:94
___
### maxBodyLength
`Optional` **maxBodyLength**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:84
___
### maxContentLength
`Optional` **maxContentLength**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:82
___
### maxRedirects
`Optional` **maxRedirects**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:85
___
### method
`Optional` **method**: [`Method`](../modules/internal.md#method)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:64
___
### onDownloadProgress
`Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void`
#### Type declaration
▸ (`progressEvent`): `void`
##### Parameters
| Name | Type |
| :------ | :------ |
| `progressEvent` | `any` |
##### Returns
`void`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:81
___
### onUploadProgress
`Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void`
#### Type declaration
▸ (`progressEvent`): `void`
##### Parameters
| Name | Type |
| :------ | :------ |
| `progressEvent` | `any` |
##### Returns
`void`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:80
___
### params
`Optional` **params**: `any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:69
___
### paramsSerializer
`Optional` **paramsSerializer**: (`params`: `any`) => `string`
#### Type declaration
▸ (`params`): `string`
##### Parameters
| Name | Type |
| :------ | :------ |
| `params` | `any` |
##### Returns
`string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:70
___
### proxy
`Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:89
___
### raxConfig
• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
___
### responseType
• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:77
___
### signal
• `Optional` **signal**: `AbortSignal`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:93
___
### socketPath
• `Optional` **socketPath**: ``null`` \| `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:86
___
### timeout
• `Optional` **timeout**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:72
___
### timeoutErrorMessage
• `Optional` **timeoutErrorMessage**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:73
___
### transformRequest
• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
#### Defined in
medusa-js/node_modules/axios/index.d.ts:66
___
### transformResponse
• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
#### Defined in
medusa-js/node_modules/axios/index.d.ts:67
___
### transitional
• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:92
___
### url
• `Optional` **url**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:63
___
### validateStatus
• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:83
___
### withCredentials
• `Optional` **withCredentials**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:74
___
### xsrfCookieName
• `Optional` **xsrfCookieName**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:78
___
### xsrfHeaderName
• `Optional` **xsrfHeaderName**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:79
@@ -0,0 +1,28 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosRequestTransformer
[internal](../modules/internal.md).AxiosRequestTransformer
## Callable
### AxiosRequestTransformer
**AxiosRequestTransformer**(`data`, `headers?`): `any`
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `any` |
| `headers?` | [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) |
#### Returns
`any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:10
@@ -0,0 +1,74 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosResponse<T, D\>
[internal](../modules/internal.md).AxiosResponse
## Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `D` | `any` |
## Properties
### config
**config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:120
___
### data
**data**: `T`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:116
___
### headers
**headers**: [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:119
___
### request
`Optional` **request**: `any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:121
___
### status
**status**: `number`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:117
___
### statusText
**statusText**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:118
@@ -0,0 +1,28 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: AxiosResponseTransformer
[internal](../modules/internal.md).AxiosResponseTransformer
## Callable
### AxiosResponseTransformer
**AxiosResponseTransformer**(`data`, `headers?`): `any`
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `any` |
| `headers?` | [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders) |
#### Returns
`any`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:14
@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: Cancel
[internal](../modules/internal.md).Cancel
## Properties
### message
**message**: `string`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:141
@@ -0,0 +1,41 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: CancelToken
[internal](../modules/internal.md).CancelToken
## Properties
### promise
**promise**: `Promise`<[`Cancel`](internal.Cancel.md)\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:154
___
### reason
`Optional` **reason**: [`Cancel`](internal.Cancel.md)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:155
## Methods
### throwIfRequested
**throwIfRequested**(): `void`
#### Returns
`void`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:156
@@ -0,0 +1,47 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: Config
[internal](../modules/internal.md).Config
## Properties
### apiKey
`Optional` **apiKey**: `string`
#### Defined in
[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L17)
___
### baseUrl
**baseUrl**: `string`
#### Defined in
[medusa-js/src/request.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L15)
___
### maxRetries
**maxRetries**: `number`
#### Defined in
[medusa-js/src/request.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L16)
___
### publishableApiKey
`Optional` **publishableApiKey**: `string`
#### Defined in
[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L18)
@@ -0,0 +1,57 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: HTTPResponse
[internal](../modules/internal.md).HTTPResponse
## Properties
### config
**config**: `any`
#### Defined in
[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L13)
___
### headers
**headers**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] }
#### Defined in
[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L10)
___
### request
`Optional` **request**: `any`
#### Defined in
[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L14)
___
### status
**status**: `number`
#### Defined in
[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L8)
___
### statusText
**statusText**: `string`
#### Defined in
[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L9)
@@ -0,0 +1,117 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: HeadersDefaults
[internal](../modules/internal.md).HeadersDefaults
## Properties
### common
**common**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:98
___
### delete
**delete**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:99
___
### get
**get**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:100
___
### head
**head**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:101
___
### link
`Optional` **link**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:107
___
### options
`Optional` **options**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:105
___
### patch
**patch**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:104
___
### post
**post**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:102
___
### purge
`Optional` **purge**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:106
___
### put
**put**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:103
___
### unlink
`Optional` **unlink**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
medusa-js/node_modules/axios/index.d.ts:108
@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: RequestOptions
[internal](../modules/internal.md).RequestOptions
## Properties
### numberOfRetries
`Optional` **numberOfRetries**: `number`
#### Defined in
[medusa-js/src/request.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L23)
___
### timeout
`Optional` **timeout**: `number`
#### Defined in
[medusa-js/src/request.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L22)
@@ -0,0 +1,195 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: RetryConfig
[internal](../modules/internal.md).RetryConfig
Configuration for the Axios `request` method.
## Properties
### backoffType
`Optional` **backoffType**: ``"linear"`` \| ``"static"`` \| ``"exponential"``
Backoff Type; 'linear', 'static' or 'exponential'.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47
___
### checkRetryAfter
• `Optional` **checkRetryAfter**: `boolean`
Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51
___
### currentRetryAttempt
• `Optional` **currentRetryAttempt**: `number`
The number of retries already attempted.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13
___
### httpMethodsToRetry
• `Optional` **httpMethodsToRetry**: `string`[]
The HTTP Methods that will be automatically retried.
Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26
___
### instance
• `Optional` **instance**: [`AxiosInstance`](internal.AxiosInstance.md)
The instance of the axios object to which the interceptor is attached.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21
___
### maxRetryAfter
• `Optional` **maxRetryAfter**: `number`
Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55
___
### maxRetryDelay
• `Optional` **maxRetryDelay**: `number`
Ceiling for calculated delay (in ms) - delay will not exceed this value.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59
___
### noResponseRetries
• `Optional` **noResponseRetries**: `number`
When there is no response, the number of retries to attempt. Defaults to 2.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43
___
### onRetryAttempt
• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `void`
#### Type declaration
▸ (`err`): `void`
Function to invoke when a retry attempt is made.
##### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
##### Returns
`void`
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35
___
### retry
• `Optional` **retry**: `number`
The number of times to retry the request. Defaults to 3.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9
___
### retryDelay
• `Optional` **retryDelay**: `number`
The amount of time to initially delay the retry. Defaults to 100.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17
___
### shouldRetry
• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `boolean`
#### Type declaration
▸ (`err`): `boolean`
Function to invoke which determines if you should retry
##### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
##### Returns
`boolean`
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39
___
### statusCodesToRetry
• `Optional` **statusCodesToRetry**: `number`[][]
The HTTP response status codes that will automatically be retried.
Defaults to: [[100, 199], [429, 429], [500, 599]]
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31
@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: TransitionalOptions
[internal](../modules/internal.md).TransitionalOptions
## Properties
### clarifyTimeoutError
`Optional` **clarifyTimeoutError**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:59
___
### forcedJSONParsing
`Optional` **forcedJSONParsing**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:58
___
### silentJSONParsing
`Optional` **silentJSONParsing**: `boolean`
#### Defined in
medusa-js/node_modules/axios/index.d.ts:57