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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
www/apps/docs/content/references/js-client/classes/AdminUploadsResource.mdx
View File

@@ -18,9 +18,9 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
## Methods
### \_createPayload
#### \_createPayload
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -34,7 +34,7 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -50,11 +50,11 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
___
### create
#### create
Upload a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -65,7 +65,7 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -79,7 +79,7 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -134,11 +134,11 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
___
### createProtected
#### createProtected
Upload a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -149,7 +149,7 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -163,7 +163,7 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -218,11 +218,11 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
___
### delete
#### delete
Delete an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -237,7 +237,7 @@ medusa.admin.uploads
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -270,7 +270,7 @@ medusa.admin.uploads
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -314,11 +314,11 @@ medusa.admin.uploads
___
### getPresignedDownloadUrl
#### getPresignedDownloadUrl
Create and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -333,7 +333,7 @@ medusa.admin.uploads
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -366,7 +366,7 @@ medusa.admin.uploads
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{