chore(docs): Generated JS Client Reference (#5421)

* chore(docs): Generated JS Client Reference (automated)

* fix js client reference

* fix links

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-10-20 14:01:27 +03:00
committed by GitHub
co-authored by olivermrbl Shahed nasser
parent 83f46b9b32
commit 9dcd62c731
1604 changed files with 211689 additions and 151746 deletions
@@ -0,0 +1,119 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SwapsResource
[swaps](../../modules/swaps.mdx).SwapsResource
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`StorePostSwapsReq`](../../internal/classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "StoreSwapsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Creates a swap from a cart
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart_id",
"type": "`string`",
"description": "id of cart",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "StoreSwapsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Retrieves a swap by cart id
@@ -0,0 +1,101 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# internal
## Classes
- [Axios](../../internal/classes/swaps.internal.Axios.mdx)
- [Client](../../internal/classes/swaps.internal.Client.mdx)
## Interfaces
- [AxiosAdapter](../../internal/interfaces/swaps.internal.AxiosAdapter.mdx)
- [AxiosBasicCredentials](../../internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx)
- [AxiosDefaults](../../internal/interfaces/swaps.internal.AxiosDefaults.mdx)
- [AxiosError](../../internal/interfaces/swaps.internal.AxiosError.mdx)
- [AxiosInstance](../../internal/interfaces/swaps.internal.AxiosInstance.mdx)
- [AxiosInterceptorManager](../../internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx)
- [AxiosPromise](../../internal/interfaces/swaps.internal.AxiosPromise.mdx)
- [AxiosProxyConfig](../../internal/interfaces/swaps.internal.AxiosProxyConfig.mdx)
- [AxiosRequestTransformer](../../internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx)
- [AxiosResponse](../../internal/interfaces/swaps.internal.AxiosResponse.mdx)
- [AxiosResponseTransformer](../../internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx)
- [Cancel](../../internal/interfaces/swaps.internal.Cancel.mdx)
- [CancelToken](../../internal/interfaces/swaps.internal.CancelToken.mdx)
- [Config](../../internal/interfaces/swaps.internal.Config.mdx)
- [HTTPResponse](../../internal/interfaces/swaps.internal.HTTPResponse.mdx)
- [HeadersDefaults](../../internal/interfaces/swaps.internal.HeadersDefaults.mdx)
- [RetryConfig](../../internal/interfaces/swaps.internal.RetryConfig.mdx)
- [TransitionalOptions](../../internal/interfaces/swaps.internal.TransitionalOptions.mdx)
## Type Aliases
### AxiosRequestHeaders
Ƭ **AxiosRequestHeaders**: Record<`string`, `string`\>
___
### AxiosResponseHeaders
Ƭ **AxiosResponseHeaders**: Record<`string`, `string`\> & { `set-cookie?`: `string`[] }
___
### Method
Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``
___
### RequestMethod
Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"``
___
### Response
Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../../internal/interfaces/swaps.internal.HTTPResponse.mdx) }
#### Type parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
___
### ResponsePromise
Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](swaps.internal.mdx#response)<`T`\>\>
#### Type parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
___
### ResponseType
Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"``