asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: updated js client reference (#2414)

Browse Source 
* docs: updated js client reference

* docs: fixed link
This commit is contained in:
Shahed Nasser
2022-10-11 16:32:41 +03:00
committed by GitHub
parent b3ebc78b95
commit 8ca9354c50
384 changed files with 5705 additions and 4184 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/classes/AdminUploadsResource.md
+11 -11
View File
@@ -20,27 +20,27 @@
#### Defined in
[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L14)
[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L14)
## Methods
### create
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\>
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `file` | [`IAdminPostUploadsFileReq`](internal-26.IAdminPostUploadsFileReq.md) |
| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\>
#### Defined in
[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L18)
[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L18)
___
@@ -52,7 +52,7 @@ ___
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminDeleteUploadsReq`](internal-26.AdminDeleteUploadsReq.md) |
| `payload` | [`AdminDeleteUploadsReq`](internal-28.AdminDeleteUploadsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
@@ -61,25 +61,25 @@ ___
#### Defined in
[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L27)
[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L27)
___
### getPresignedDownloadUrl
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\>
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-26.AdminPostUploadsDownloadUrlReq.md) |
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-28.AdminPostUploadsDownloadUrlReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\>
#### Defined in
[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L36)
[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L36)