daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
4.2 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminUploadsResource
Hierarchy
-
default↳
AdminUploadsResource
Properties
headers
• Private headers: Object
Type declaration
| Name | Type |
|---|---|
Content-Type |
string |
Defined in
packages/medusa-js/src/resources/admin/uploads.ts:12
Methods
_createPayload
▸ Private _createPayload(file): FormData
Parameters
| Name | Type |
|---|---|
file |
AdminCreateUploadPayload |
Returns
FormData
Defined in
packages/medusa-js/src/resources/admin/uploads.ts:62
create
▸ create(file): ResponsePromise<AdminUploadsRes>
Parameters
| Name | Type | Description |
|---|---|---|
file |
AdminCreateUploadPayload |
File or array of files to upload. |
Returns
ResponsePromise<AdminUploadsRes>
Uploaded file or files.
Description
Uploads at least one file to the specific fileservice that is installed in Medusa.
Defined in
packages/medusa-js/src/resources/admin/uploads.ts:21
createProtected
▸ createProtected(file): ResponsePromise<AdminUploadsRes>
Parameters
| Name | Type | Description |
|---|---|---|
file |
AdminCreateUploadPayload |
File or array of files to upload. |
Returns
ResponsePromise<AdminUploadsRes>
Uploaded file or files.
Description
Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa.
Defined in
packages/medusa-js/src/resources/admin/uploads.ts:34
delete
▸ delete(payload, customHeaders?): ResponsePromise<DeleteResponse>
Parameters
| Name | Type |
|---|---|
payload |
AdminDeleteUploadsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Defined in
packages/medusa-js/src/resources/admin/uploads.ts:44
getPresignedDownloadUrl
▸ getPresignedDownloadUrl(payload, customHeaders?): ResponsePromise<AdminUploadsDownloadUrlRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostUploadsDownloadUrlReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminUploadsDownloadUrlRes>