files.com 1.1.669 → 1.1.671

data/docs/ip_address.md

@@ -33,6 +33,20 @@ Files::IpAddress.list
 * `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
 
 
+---
+
+## List all in-use public IP addresses
+
+```
+Files::IpAddress.get_active
+```
+
+### 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: 10000, 1,000 or less is recommended).
+
+
 ---
 
 ## List all possible public SmartFile IP addresses
@@ -73,3 +87,48 @@ Files::IpAddress.get_reserved
 
 * `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: 10000, 1,000 or less is recommended).
+
+
+---
+
+## List all in-use public IP addresses
+
+```
+Files::IpAddress.active_create_export
+```
+
+
+---
+
+## List all possible public SmartFile IP addresses
+
+```
+Files::IpAddress.smartfile_reserved_create_export
+```
+
+
+---
+
+## List all possible public ExaVault IP addresses
+
+```
+Files::IpAddress.exavault_reserved_create_export
+```
+
+
+---
+
+## List all possible public IP addresses
+
+```
+Files::IpAddress.reserved_create_export
+```
+
+
+---
+
+## List IP Addresses associated with the current site
+
+```
+Files::IpAddress.create_export
+```

data/docs/key_lifecycle_rule.md

@@ -77,6 +77,20 @@ Files::KeyLifecycleRule.create(
 * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
 
 
+---
+
+## Create an export CSV of Key Lifecycle Rule resources
+
+```
+Files::KeyLifecycleRule.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type` and `workspace_id`. Valid field combinations are `[ workspace_id, key_type ]`.
+
+
 ---
 
 ## Update Key Lifecycle Rule

data/docs/label.md

@@ -0,0 +1,9 @@
+
+
+---
+
+## Get Label
+
+```
+Files::Label.list
+```

data/docs/lead.md

@@ -0,0 +1,161 @@
+# Lead
+
+## Example Lead Object
+
+```
+{
+  "id": 1,
+  "code": "abc123",
+  "name": "account",
+  "address": "123 Main St",
+  "address_2": "Window 1",
+  "city": "New York",
+  "company_name": "Action Verb",
+  "contact_name": "John Doe",
+  "country": "US",
+  "currency": "USD",
+  "email": "john.doe@files.com",
+  "language": "en",
+  "phone_number": "555-555-5555",
+  "state": "NY",
+  "zip": "00000",
+  "lead_level": "mql",
+  "signup_page_split_test_group": "control"
+}
+```
+
+* `id` (int64): Lead ID
+* `code` (string): Lead Cookie Code
+* `name` (string): Lead name
+* `address` (string): Lead address
+* `address_2` (string): Lead address 2
+* `city` (string): Lead city
+* `company_name` (string): Lead company name
+* `contact_name` (string): Contact name at the company
+* `country` (string): Lead country
+* `currency` (string): Lead preferred currency
+* `email` (string): Lead email address
+* `language` (string): Lead preferred language
+* `phone_number` (string): Lead phone number
+* `state` (string): Lead state
+* `zip` (string): Lead zipcode
+* `lead_level` (string): Quality score of the lead
+* `signup_page_split_test_group` (string): Signup page split test group
+* `recaptcha_token` (string): 
+* `form_name` (string): Signup form name
+* `lead_source` (string): Source of the lead
+* `opportunity_comment` (string): Opportunity comment
+* `opportunity_type` (string): Type of opportunity to create
+* `gclid` (string): Google Adwords Click ID
+* `original_brand` (string): Brand: `files`, `exavault` or `mover`
+* `utm_campaign` (string): Marketing tracking - campaign
+* `utm_content` (string): Marketing tracking - content
+* `utm_domain` (string): Marketing tracking - domain
+* `utm_medium` (string): Marketing tracking - medium
+* `utm_source` (string): Marketing tracking - source
+* `utm_term` (string): Marketing tracking - term
+* `time_zone` (string): Time zone, as returned by Javascript
+* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)
+
+
+---
+
+## Create Lead
+
+```
+Files::Lead.create(
+  name: "account", 
+  address: "123 Main St", 
+  address_2: "Window 1", 
+  city: "New York", 
+  contact_name: "John Doe", 
+  currency: "USD", 
+  email: "john.doe@files.com", 
+  language: "en", 
+  phone_number: "555-555-5555", 
+  state: "NY", 
+  zip: "00000", 
+  time_zone_offset: 1
+)
+```
+
+### Parameters
+
+* `recaptcha_token` (string): 
+* `name` (string): Lead name
+* `address` (string): Lead address
+* `address_2` (string): Lead address 2
+* `city` (string): Lead city
+* `contact_name` (string): Contact name at the company
+* `currency` (string): Lead preferred currency
+* `email` (string): Lead email address
+* `language` (string): Lead preferred language
+* `phone_number` (string): Lead phone number
+* `state` (string): Lead state
+* `zip` (string): Lead zipcode
+* `form_name` (string): Signup form name
+* `lead_source` (string): Source of the lead
+* `opportunity_comment` (string): Opportunity comment
+* `opportunity_type` (string): Type of opportunity to create
+* `gclid` (string): Google Adwords Click ID
+* `original_brand` (string): Brand: `files`, `exavault` or `mover`
+* `utm_campaign` (string): Marketing tracking - campaign
+* `utm_content` (string): Marketing tracking - content
+* `utm_domain` (string): Marketing tracking - domain
+* `utm_medium` (string): Marketing tracking - medium
+* `utm_source` (string): Marketing tracking - source
+* `utm_term` (string): Marketing tracking - term
+* `time_zone` (string): Time zone, as returned by Javascript
+* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)
+
+
+---
+
+## Update Lead
+
+```
+Files::Lead.update(code, 
+  name: "account", 
+  address: "123 Main St", 
+  address_2: "Window 1", 
+  city: "New York", 
+  contact_name: "John Doe", 
+  currency: "USD", 
+  email: "john.doe@files.com", 
+  language: "en", 
+  phone_number: "555-555-5555", 
+  state: "NY", 
+  zip: "00000", 
+  time_zone_offset: 1
+)
+```
+
+### Parameters
+
+* `code` (string): Required - Lead lookup code.
+* `recaptcha_token` (string): 
+* `name` (string): Lead name
+* `address` (string): Lead address
+* `address_2` (string): Lead address 2
+* `city` (string): Lead city
+* `contact_name` (string): Contact name at the company
+* `currency` (string): Lead preferred currency
+* `email` (string): Lead email address
+* `language` (string): Lead preferred language
+* `phone_number` (string): Lead phone number
+* `state` (string): Lead state
+* `zip` (string): Lead zipcode
+* `form_name` (string): Signup form name
+* `lead_source` (string): Source of the lead
+* `opportunity_comment` (string): Opportunity comment
+* `opportunity_type` (string): Type of opportunity to create
+* `gclid` (string): Google Adwords Click ID
+* `original_brand` (string): Brand: `files`, `exavault` or `mover`
+* `utm_campaign` (string): Marketing tracking - campaign
+* `utm_content` (string): Marketing tracking - content
+* `utm_domain` (string): Marketing tracking - domain
+* `utm_medium` (string): Marketing tracking - medium
+* `utm_source` (string): Marketing tracking - source
+* `utm_term` (string): Marketing tracking - term
+* `time_zone` (string): Time zone, as returned by Javascript
+* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)

data/docs/lock.md

@@ -31,6 +31,7 @@
 * `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
 * `user_id` (int64): Lock creator user ID
 * `username` (string): Lock creator username
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -49,6 +50,7 @@ Files::Lock.list_for(path,
 * `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
 * `path` (string): Required - Path to operate on.
 * `include_children` (boolean): Include locks from children objects?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -57,9 +59,14 @@ Files::Lock.list_for(path,
 
 ```
 Files::Lock.create(path, 
+  token: "17c54824e9931a4688ca032d03f6663c", 
+  type: "write", 
   allow_access_by_any_user: false, 
+  scope: "shared", 
   exclusive: false, 
+  depth: "infinity", 
   recursive: true, 
+  owner: "user", 
   timeout: 1
 )
 ```
@@ -67,10 +74,16 @@ Files::Lock.create(path,
 ### Parameters
 
 * `path` (string): Required - Path
+* `token` (string): 
+* `type` (string): 
 * `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
+* `scope` (string): 
 * `exclusive` (boolean): Is lock exclusive?
+* `depth` (string): 
 * `recursive` (boolean): Does lock apply to subfolders?
+* `owner` (string): 
 * `timeout` (int64): Lock timeout in seconds
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -87,6 +100,7 @@ Files::Lock.delete(path,
 
 * `path` (string): Required - Path
 * `token` (string): Required - Lock token
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -105,3 +119,4 @@ lock.delete(
 
 * `path` (string): Required - Path
 * `token` (string): Required - Lock token
+* `bundle_registration_code` (string): 

data/docs/message.md

@@ -83,6 +83,23 @@ Files::Message.create(
 * `body` (string): Required - Message body.
 
 
+---
+
+## Create an export CSV of Message resources
+
+```
+Files::Message.create_export(
+  user_id: 1, 
+  project_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `project_id` (int64): Required - Project for which to return messages.
+
+
 ---
 
 ## Update Message

data/docs/message_comment.md

@@ -71,6 +71,24 @@ Files::MessageComment.create(
 * `body` (string): Required - Comment body.
 
 
+---
+
+## Create an export CSV of Message Comment resources
+
+```
+Files::MessageComment.create_export(
+  user_id: 1, 
+  message_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+* `message_id` (int64): Required - Message comment to return comments for.
+
+
 ---
 
 ## Update Message Comment

data/docs/message_comment_reaction.md

@@ -64,6 +64,24 @@ Files::MessageCommentReaction.create(
 * `emoji` (string): Required - Emoji to react with.
 
 
+---
+
+## Create an export CSV of Message Comment Reaction resources
+
+```
+Files::MessageCommentReaction.create_export(
+  user_id: 1, 
+  message_comment_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+* `message_comment_id` (int64): Required - Message comment to return reactions for.
+
+
 ---
 
 ## Delete Message Comment Reaction

data/docs/message_reaction.md

@@ -63,6 +63,23 @@ Files::MessageReaction.create(
 * `emoji` (string): Required - Emoji to react with.
 
 
+---
+
+## Create an export CSV of Message Reaction resources
+
+```
+Files::MessageReaction.create_export(
+  user_id: 1, 
+  message_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `message_id` (int64): Required - Message to return reactions for.
+
+
 ---
 
 ## Delete Message Reaction

data/docs/metadata_category.md

@@ -88,6 +88,19 @@ Files::MetadataCategory.create(
 * `default_columns` (array(string)): Metadata keys that should appear as columns in the UI by default.
 
 
+---
+
+## Create an export CSV of Metadata Category resources
+
+```
+Files::MetadataCategory.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+
+
 ---
 
 ## Update Metadata Category

data/docs/monitoring_stat.md

@@ -0,0 +1,38 @@
+# MonitoringStat
+
+## Example MonitoringStat Object
+
+```
+{
+  "alerts": [
+    "example"
+  ],
+  "info": "example"
+}
+```
+
+* `alerts` (array(string)): 
+* `info` (object): 
+
+
+---
+
+## List Monitoring Stats
+
+```
+Files::MonitoringStat.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: 10000, 1,000 or less is recommended).
+
+
+---
+
+## Create an export CSV of Monitoring Stat resources
+
+```
+Files::MonitoringStat.create_export
+```

data/docs/monitoring_stats.md

@@ -0,0 +1,15 @@
+# MonitoringStats
+
+## Example MonitoringStats Object
+
+```
+{
+  "alerts": [
+    "example"
+  ],
+  "info": "example"
+}
+```
+
+* `alerts` (array(string)): 
+* `info` (object): 

data/docs/mover_package.md

@@ -0,0 +1,68 @@
+# MoverPackage
+
+## Example MoverPackage Object
+
+```
+{
+  "id": 1,
+  "prepaid_bytes": 1,
+  "prepaid_expire_in_days": 1,
+  "price": "1.0"
+}
+```
+
+* `id` (int64): Mover package ID
+* `prepaid_bytes` (int64): Total prepaid bytes included in this package
+* `prepaid_expire_in_days` (int64): Number of days this package is valid for after purchase
+* `price` (decimal): Price of this mover package in the site's currency
+
+
+---
+
+## List Mover Packages
+
+```
+Files::MoverPackage.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: 10000, 1,000 or less is recommended).
+
+
+---
+
+## Purchase a Mover package for the current site
+
+```
+Files::MoverPackage.purchase(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Mover Package ID.
+
+
+---
+
+## Create an export CSV of Mover Package resources
+
+```
+Files::MoverPackage.create_export
+```
+
+
+---
+
+## Purchase a Mover package for the current site
+
+```
+mover_package = Files::MoverPackage.list.first
+
+mover_package.purchase
+```
+
+### Parameters
+
+* `id` (int64): Required - Mover Package ID.

data/docs/notification.md

@@ -160,6 +160,26 @@ Files::Notification.create(
 * `username` (string): The username of the user to notify.  Provide `user_id`, `username` or `group_id`.
 
 
+---
+
+## Create an export CSV of Notification resources
+
+```
+Files::Notification.create_export(
+  include_ancestors: false
+)
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path`, `user_id` or `group_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id`, `workspace_id` or `group_id`. Valid field combinations are `[ workspace_id, path ]`, `[ workspace_id, user_id ]`, `[ workspace_id, group_id ]` or `[ workspace_id, user_id, path ]`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
+* `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.
+* `group_id` (string): 
+
+
 ---
 
 ## Update Notification

data/docs/nps_response.md

@@ -0,0 +1,75 @@
+# NpsResponse
+
+## Example NpsResponse Object
+
+```
+{
+  "id": 1,
+  "next_step": "example"
+}
+```
+
+* `id` (int64): NPS response id
+* `next_step` (string): 
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `score` (int64): NPS score
+* `skipped` (boolean): NPS skipped
+* `comment` (string): NPS comment
+* `contact_me` (boolean): NPS contact_me
+
+
+---
+
+## Create Nps Response
+
+```
+Files::NpsResponse.create(
+  user_id: 1, 
+  score: 1, 
+  skipped: false
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `score` (int64): NPS score
+* `skipped` (boolean): NPS skipped
+
+
+---
+
+## Update Nps Response
+
+```
+Files::NpsResponse.update(id, 
+  comment: "comment", 
+  contact_me: false
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Nps Response ID.
+* `comment` (string): Required - NPS comment
+* `contact_me` (boolean): NPS contact_me
+
+
+---
+
+## Update Nps Response
+
+```
+nps_response = Files::NpsResponse.new
+
+nps_response.update(
+  comment: "comment",
+  contact_me: false
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Nps Response ID.
+* `comment` (string): Required - NPS comment
+* `contact_me` (boolean): NPS contact_me

data/docs/oauth_redirect.md

@@ -0,0 +1,11 @@
+# OauthRedirect
+
+## Example OauthRedirect Object
+
+```
+{
+  "redirect_uri": "https://provider.com/redirect..."
+}
+```
+
+* `redirect_uri` (string): Redirect URL