Sha256: 9b9b7ac4f6349ec44b538c327e30b4b95f931ee2f754c6b3026f6c258d934a3f

Contents?: true

Size: 1.77 KB

Versions: 1

Compression:

Stored size: 1.77 KB

Contents

# UserRequest

## Example UserRequest Object

```
{
  "id": 1,
  "name": "John Doe",
  "email": "example",
  "details": "Changed Departments",
  "company": "Acme Inc."
}
```

* `id` (int64): ID
* `name` (string): User's full name
* `email` (email): User email address
* `details` (string): Details of the user's request
* `company` (string): User's company name


---

## List User Requests

```
Files::UserRequest.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 User Request

```
Files::UserRequest.find(id)
```

### Parameters

* `id` (int64): Required - User Request ID.


---

## Create User Request

```
Files::UserRequest.create(
  name: "name", 
  email: "email", 
  details: "details", 
  company: "Acme Inc."
)
```

### Parameters

* `name` (string): Required - Name of user requested
* `email` (string): Required - Email of user requested
* `details` (string): Required - Details of the user request
* `company` (string): Company of the user requested


---

## Create Export User Request

```
Files::UserRequest.create_export
```


---

## Delete User Request

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

### Parameters

* `id` (int64): Required - User Request ID.


---

## Delete User Request

```
user_request = Files::UserRequest.find(id)

user_request.delete
```

### Parameters

* `id` (int64): Required - User Request ID.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
files.com-1.1.179 docs/user_request.md