files.com 1.0.91

data/docs/message_reaction.md

@@ -0,0 +1,94 @@
+# MessageReaction
+
+## Example MessageReaction Object
+
+```
+{
+  "id": 1,
+  "emoji": "👍"
+}
+```
+
+* `id` (int64): Reaction ID
+* `emoji` (string): Emoji used in the reaction.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
+---
+
+## List Message Reactions
+
+```
+Files::MessageReaction.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  message_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.
+* `message_id` (int64): Required - Message to return reactions for.
+
+
+---
+
+## Show Message Reaction
+
+```
+Files::MessageReaction.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Reaction ID.
+
+
+---
+
+## Create Message Reaction
+
+```
+Files::MessageReaction.create(
+  user_id: 1, 
+  emoji: "emoji"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `emoji` (string): Required - Emoji to react with.
+
+
+---
+
+## Delete Message Reaction
+
+```
+Files::MessageReaction.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Reaction ID.
+
+
+---
+
+## Delete Message Reaction
+
+```
+message_reaction = Files::MessageReaction.list_for(path).first
+
+message_reaction.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Reaction ID.

data/docs/notification.md

@@ -0,0 +1,177 @@
+# Notification
+
+## Example Notification Object
+
+```
+{
+  "id": 1,
+  "path": "path",
+  "group_id": 1,
+  "group_name": "",
+  "notify_user_actions": true,
+  "notify_on_copy": true,
+  "send_interval": "fifteen_minutes",
+  "unsubscribed": true,
+  "unsubscribed_reason": "",
+  "user_id": 1,
+  "username": "User",
+  "suppressed_email": "suppressed_email"
+}
+```
+
+* `id` (int64): Notification ID
+* `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `group_id` (int64): Notification group id
+* `group_name` (string): Group name if applicable
+* `notify_user_actions` (boolean): Trigger notification on notification user actions?
+* `notify_on_copy` (boolean): Triggers notification when moving or copying files to this path
+* `send_interval` (string): The time interval that notifications are aggregated to
+* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
+* `unsubscribed_reason` (string): The reason that the user unsubscribed
+* `user_id` (int64): Notification user ID
+* `username` (string): Notification username
+* `suppressed_email` (boolean): If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
+
+
+---
+
+## List Notifications
+
+```
+Files::Notification.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  group_id: 1, 
+  path: "path", 
+  include_ancestors: true
+)
+```
+
+### Parameters
+
+* `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
+* `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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `path`, `user_id` or `group_id`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
+* `group_id` (int64): DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
+* `path` (string): Show notifications for this Path.
+* `include_ancestors` (boolean): If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
+
+
+---
+
+## Show Notification
+
+```
+Files::Notification.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Notification ID.
+
+
+---
+
+## Create Notification
+
+```
+Files::Notification.create(
+  user_id: 1, 
+  notify_on_copy: true, 
+  notify_user_actions: true, 
+  send_interval: "daily", 
+  group_id: 1, 
+  path: "path", 
+  username: "User"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): The id of the user to notify. Provide `user_id`, `username` or `group_id`.
+* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
+* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
+* `send_interval` (string): The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
+* `group_id` (int64): The ID of the group to notify.  Provide `user_id`, `username` or `group_id`.
+* `path` (string): Path
+* `username` (string): The username of the user to notify.  Provide `user_id`, `username` or `group_id`.
+
+
+---
+
+## Update Notification
+
+```
+Files::Notification.update(id, 
+  notify_on_copy: true, 
+  notify_user_actions: true, 
+  send_interval: "daily"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Notification ID.
+* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
+* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
+* `send_interval` (string): The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
+
+
+---
+
+## Delete Notification
+
+```
+Files::Notification.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Notification ID.
+
+
+---
+
+## Update Notification
+
+```
+notification = Files::Notification.list_for(path).first
+
+notification.update(
+  notify_on_copy: true,
+  notify_user_actions: true,
+  send_interval: "daily"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Notification ID.
+* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
+* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
+* `send_interval` (string): The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
+
+
+---
+
+## Delete Notification
+
+```
+notification = Files::Notification.list_for(path).first
+
+notification.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Notification ID.

data/docs/payment.md

@@ -0,0 +1,72 @@
+# Payment
+
+## Example Payment Object
+
+```
+{
+  "id": 1,
+  "amount": "",
+  "balance": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "currency": "USD",
+  "download_uri": "https://url...",
+  "invoice_line_items": [
+
+  ],
+  "method": "paypal",
+  "payment_line_items": [
+
+  ],
+  "payment_reversed_at": "2000-01-01T01:00:00Z",
+  "payment_type": "",
+  "site_name": "My Site",
+  "type": "invoice",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Line item Id
+* `amount` (double): Line item amount
+* `balance` (double): Line item balance
+* `created_at` (date-time): Line item created at
+* `currency` (string): Line item currency
+* `download_uri` (string): Line item download uri
+* `invoice_line_items` (array): Associated invoice line items
+* `method` (string): Line item payment method
+* `payment_line_items` (array): Associated payment line items
+* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
+* `payment_type` (string): Type of payment if applicable
+* `site_name` (string): Site name this line item is for
+* `type` (string): Type of line item, either payment or invoice
+* `updated_at` (date-time): Line item updated at
+
+
+---
+
+## List Payments
+
+```
+Files::Payment.list(
+  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.
+
+
+---
+
+## Show Payment
+
+```
+Files::Payment.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Payment ID.

data/docs/payment_line_item.md

@@ -0,0 +1,19 @@
+# PaymentLineItem
+
+## Example PaymentLineItem Object
+
+```
+{
+  "amount": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "invoice_id": 1,
+  "payment_id": 1,
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `amount` (double): Payment line item amount
+* `created_at` (date-time): Payment line item created at date/time
+* `invoice_id` (int64): Invoice ID
+* `payment_id` (int64): Payment ID
+* `updated_at` (date-time): Payment line item updated at date/time

data/docs/permission.md

@@ -0,0 +1,95 @@
+# Permission
+
+## Example Permission Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "user_id": 1,
+  "username": "Sser",
+  "group_id": 1,
+  "group_name": "",
+  "permission": "full",
+  "recursive": true
+}
+```
+
+* `id` (int64): Permission ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `user_id` (int64): User ID
+* `username` (string): User's username
+* `group_id` (int64): Group ID
+* `group_name` (string): Group name if applicable
+* `permission` (string): Permission type
+* `recursive` (boolean): Does this permission apply to subfolders?
+
+
+---
+
+## List Permissions
+
+```
+Files::Permission.list(path, 
+  page: 1, 
+  per_page: 1, 
+  group_id: 1, 
+  user_id: 1, 
+  include_groups: true
+)
+```
+
+### 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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `deleted_at`, `group_id`, `path`, `user_id` or `permission`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
+* `path` (string): DEPRECATED: Permission path.  If provided, will scope permissions to this path. Use `filter[path]` instead.
+* `group_id` (string): DEPRECATED: Group ID.  If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
+* `user_id` (string): DEPRECATED: User ID.  If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
+* `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
+
+
+---
+
+## Create Permission
+
+```
+Files::Permission.create(path, 
+  group_id: 1, 
+  permission: "full", 
+  recursive: true, 
+  user_id: 1, 
+  username: "Sser"
+)
+```
+
+### Parameters
+
+* `group_id` (int64): Group ID
+* `path` (string): Folder path
+* `permission` (string):  Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
+* `recursive` (boolean): Apply to subfolders recursively?
+* `user_id` (int64): User ID.  Provide `username` or `user_id`
+* `username` (string): User username.  Provide `username` or `user_id`
+
+
+---
+
+## Delete Permission
+
+```
+Files::Permission.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Permission ID.