Sha256: 980a05dc97275e5bf6793a8dbb258881662c797d1baae092323f72c42ef75d53

Contents?: true

Size: 1.6 KB

Versions: 10

Compression:

Stored size: 1.6 KB

Contents

# Project

## Example Project Object

```
{
  "id": 1,
  "global_access": "none"
}
```

* `id` (int64): Project ID
* `global_access` (string): Global access settings


---

## List Projects by path

```
Files::Project.list_for(path, 
  page: 1, 
  per_page: 1
)
```

### Parameters

* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
* `path` (string): Required - Path to operate on.


---

## Create Project

```
Files::Project.create(
  global_access: "global_access"
)
```

### Parameters

* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.


---

## Update Project

```
Files::Project.update(id, 
  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`.


---

## Delete Project

```
Files::Project.delete(id)
```

### Parameters

* `id` (int64): Required - Project ID.


---

## Update Project

```
project = Files::Project.find(1)
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`.


---

## Delete Project

```
project = Files::Project.find(1)
project.delete
```

### Parameters

* `id` (int64): Required - Project ID.

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
files.com-1.0.16 docs/project.md
files.com-1.0.15 docs/project.md
files.com-1.0.14 docs/project.md
files.com-1.0.13 docs/project.md
files.com-1.0.12 docs/project.md
files.com-1.0.11 docs/project.md
files.com-1.0.10 docs/project.md
files.com-1.0.9 docs/project.md
files.com-1.0.8 docs/project.md
files.com-1.0.7 docs/project.md