files.com
Version:
Files.com SDK for JavaScript
97 lines (60 loc) • 1.6 kB
Markdown
# Project
## Example Project Object
```
{
"id": 1,
"global_access": "none"
}
```
* `id` (int64): Project ID
* `global_access` (string): Global access settings
## List Projects
```
await Project.list
```
### Parameters
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
## Show Project
```
await Project.find(id)
```
### Parameters
* `id` (int64): Required - Project ID.
## Create Project
```
await Project.create({
'global_access': "global_access",
})
```
### Parameters
* `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
## Update Project
```
const project = await Project.find(id)
await project.update({
'global_access': "global_access",
})
```
### Parameters
* `id` (int64): Required - Project ID.
* `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
### Example Response
```json
{
"id": 1,
"global_access": "none"
}
```
## Delete Project
```
const project = await Project.find(id)
await project.delete()
```
### Parameters
* `id` (int64): Required - Project ID.