Sha256: 15c72ffa363cfb2a306af808447527fc305a6b877861ad8f7cdcf5a8903ae4e0
Contents?: true
Size: 1.06 KB
Versions: 9
Compression:
Stored size: 1.06 KB
Contents
# BundleRecipient
## Example BundleRecipient Object
```
{
"company": "Acme Inc.",
"name": "John Doe",
"note": "Some note.",
"recipient": "john.doe@example.com",
"sent_at": "2000-01-01T01:00:00Z"
}
```
* `company` (string): The recipient's company.
* `name` (string): The recipient's name.
* `note` (string): A note sent to the recipient with the bundle.
* `recipient` (string): The recipient's email address.
* `sent_at` (date-time): When the Bundle was shared with this recipient.
---
## List Bundle Recipients
```
Files::BundleRecipient.list(
user_id: 1,
page: 1,
per_page: 1,
bundle_id: 1
)
```
### Parameters
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
* `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.
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
Version data entries
9 entries across 9 versions & 1 rubygems