files.com 1.0.158 → 1.0.163

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a100f45b1174b6eae8c341db6d5c9b098c704a3b5cdcfa0c22ecd3e61d33b5
-  data.tar.gz: af94c8541f7f85148844f955b9c19fe6729a9955f2902ffcb7ec9bb65c22f421
+  metadata.gz: bed444ff1310255cc27495e94e3f0da4c74b8eae7fd252f270bf1e55c0485756
+  data.tar.gz: 69a0f5c6be3210a2eb95c3623ad73b497dabc332ae221690f54d25129ded050b
 SHA512:
-  metadata.gz: 2b9f2a09ded08bb006c60baca0898c0ff4afebbcdca9d637803bcd2037c0b11f5a3c0e7fe558c2e6269ebefb91a741f968db117a9e343b40e4cf4eeab306abf8
-  data.tar.gz: af1d77a612e7938f275c12fe616b70dcfdbf34d78bff0f6464d12a44ef7d3f49b363b1750eca1b059582e0f95825d44ef0584a925e5d3892fc6c966adbb60f53
+  metadata.gz: 9eb2034cdd3e13de856cd41f8cc3ea769b0361d7096c9c27d51c1e975f6ec0912a6c2ff720daaa59e60f454ffebb672b0c8c7e5651cac9fa3dc98c360eb55d2f
+  data.tar.gz: c6ffcc6aec230f813b9521775c558fe3a1c1a9188a43f6ab3fc4d33f9e448f3fdbfd298852886ea06ce600b8101641d55cedbe33f23b80c0bf5fa84525a5c501

data/_VERSION

@@ -1 +1 @@
-1.0.158
+1.0.163

data/docs/account_line_item.md

@@ -10,29 +10,25 @@
   "created_at": "2000-01-01T01:00:00Z",
   "currency": "USD",
   "download_uri": "https://url...",
-  "invoice_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "description": "Service from 2019-01-01 through 2019-12-31",
-      "type": "invoice",
-      "service_end_at": "2000-01-01T01:00:00Z",
-      "service_start_at": "2000-01-01T01:00:00Z",
-      "updated_at": "2000-01-01T01:00:00Z",
-      "plan": "Enterprise",
-      "site": "My site"
-    }
-  ],
+  "invoice_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "description": "Service from 2019-01-01 through 2019-12-31",
+    "type": "invoice",
+    "service_end_at": "2000-01-01T01:00:00Z",
+    "service_start_at": "2000-01-01T01:00:00Z",
+    "updated_at": "2000-01-01T01:00:00Z",
+    "plan": "Enterprise",
+    "site": "My site"
+  },
   "method": "paypal",
-  "payment_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "invoice_id": 1,
-      "payment_id": 1,
-      "updated_at": "2000-01-01T01:00:00Z"
-    }
-  ],
+  "payment_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "invoice_id": 1,
+    "payment_id": 1,
+    "updated_at": "2000-01-01T01:00:00Z"
+  },
   "payment_reversed_at": "2000-01-01T01:00:00Z",
   "payment_type": "",
   "site_name": "My Site",
@@ -47,9 +43,9 @@
 * `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
+* `invoice_line_items`: Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items`: 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

data/docs/bundle.md

@@ -8,6 +8,7 @@
   "url": "https://subdomain.files.com/f/12345678",
   "description": "The public description of the bundle.",
   "password_protected": true,
+  "preview_only": true,
   "require_registration": true,
   "require_share_recipient": true,
   "clickwrap_body": "[Legal text]",
@@ -20,22 +21,20 @@
       3,
       4
     ],
-    "form_fields": [
-      {
-        "id": 1,
-        "label": "Sample Label",
-        "required": true,
-        "help_text": "Help Text",
-        "field_type": "text",
-        "options_for_select": [
-          "red",
-          "green",
-          "blue"
-        ],
-        "default_option": "red",
-        "form_field_set_id": 1
-      }
-    ],
+    "form_fields": {
+      "id": 1,
+      "label": "Sample Label",
+      "required": true,
+      "help_text": "Help Text",
+      "field_type": "text",
+      "options_for_select": [
+        "red",
+        "green",
+        "blue"
+      ],
+      "default_option": "red",
+      "form_field_set_id": 1
+    },
     "skip_name": true,
     "skip_email": true,
     "skip_company": true
@@ -60,6 +59,7 @@
 * `url` (string): Public URL of Share Link
 * `description` (string): Public description
 * `password_protected` (boolean): Is this bundle password protected?
+* `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
 * `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
@@ -132,6 +132,7 @@ Files::Bundle.create(
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
+  preview_only: true, 
   require_registration: true, 
   clickwrap_id: 1, 
   inbox_id: 1, 
@@ -150,6 +151,7 @@ Files::Bundle.create(
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `inbox_id` (int64): ID of the associated inbox, if available.
@@ -192,6 +194,7 @@ Files::Bundle.update(id,
   inbox_id: 1, 
   max_uses: 1, 
   note: "The internal note on the bundle.", 
+  preview_only: true, 
   require_registration: true, 
   require_share_recipient: true
 )
@@ -210,6 +213,7 @@ Files::Bundle.update(id,
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
+* `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
 
@@ -267,6 +271,7 @@ bundle.update(
   inbox_id: 1,
   max_uses: 1,
   note: "The internal note on the bundle.",
+  preview_only: true,
   require_registration: true,
   require_share_recipient: true
 )
@@ -285,6 +290,7 @@ bundle.update(
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
+* `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
 

data/docs/bundle_registration.md

@@ -9,6 +9,7 @@
   "company": "Action Verb",
   "email": "john.doe@files.com",
   "inbox_code": "abc123",
+  "clickwrap_body": "",
   "form_field_set_id": 1,
   "form_field_data": ""
 }
@@ -19,6 +20,7 @@
 * `company` (string): Registrant company name
 * `email` (string): Registrant email address
 * `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
+* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
 * `form_field_set_id` (int64): Id of associated form field set
 * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
 

data/docs/external_event.md

@@ -11,8 +11,8 @@
 }
 ```
 
-* `event_type` (string): Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
-* `status` (string): Status of event. Valid values: `error`
+* `event_type` (string): Type of event being recorded.
+* `status` (string): Status of event.
 * `body` (string): Event body
 * `created_at` (date-time): External event create date/time
 

data/docs/file_comment.md

@@ -6,18 +6,16 @@
 {
   "id": 1,
   "body": "What a great file!",
-  "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
-  ]
+  "reactions": {
+    "id": 1,
+    "emoji": "👍"
+  }
 }
 ```
 
 * `id` (int64): File Comment ID
 * `body` (string): Comment body.
-* `reactions` (array): Reactions to this comment.
+* `reactions`: Reactions to this comment.
 * `path` (string): File path.
 
 

data/docs/form_field_set.md

@@ -12,22 +12,20 @@
     3,
     4
   ],
-  "form_fields": [
-    {
-      "id": 1,
-      "label": "Sample Label",
-      "required": true,
-      "help_text": "Help Text",
-      "field_type": "text",
-      "options_for_select": [
-        "red",
-        "green",
-        "blue"
-      ],
-      "default_option": "red",
-      "form_field_set_id": 1
-    }
-  ],
+  "form_fields": {
+    "id": 1,
+    "label": "Sample Label",
+    "required": true,
+    "help_text": "Help Text",
+    "field_type": "text",
+    "options_for_select": [
+      "red",
+      "green",
+      "blue"
+    ],
+    "default_option": "red",
+    "form_field_set_id": 1
+  },
   "skip_name": true,
   "skip_email": true,
   "skip_company": true
@@ -37,7 +35,7 @@
 * `id` (int64): Form field set id
 * `title` (string): Title to be displayed
 * `form_layout` (int64): Layout of the form
-* `form_fields` (array): Associated form fields
+* `form_fields`: Associated form fields
 * `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
 * `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
 * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
@@ -86,7 +84,7 @@ Files::FormFieldSet.create(
   skip_email: true, 
   skip_name: true, 
   skip_company: true, 
-  form_fields: [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
+  form_fields: {"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
 )
 ```
 
@@ -110,7 +108,7 @@ Files::FormFieldSet.update(id,
   skip_email: true, 
   skip_name: true, 
   skip_company: true, 
-  form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
+  form_fields: {"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
 )
 ```
 
@@ -149,7 +147,7 @@ form_field_set.update(
   skip_email: true,
   skip_name: true,
   skip_company: true,
-  form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
+  form_fields: {"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}
 )
 ```
 

data/docs/group.md

@@ -21,7 +21,7 @@
 
 * `id` (int64): Group ID
 * `name` (string): Group name
-* `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
+* `admin_ids` (string): List of user IDs who are group administrators (separated by commas)
 * `notes` (string): Notes about this group
 * `user_ids` (array): List of user IDs who belong to this group (separated by commas)
 * `usernames` (array): List of usernames who belong to this group (separated by commas)

data/docs/inbox_registration.md

@@ -8,6 +8,7 @@
   "name": "account",
   "company": "Action Verb",
   "email": "john.doe@files.com",
+  "clickwrap_body": "",
   "form_field_set_id": 1,
   "form_field_data": ""
 }
@@ -17,6 +18,7 @@
 * `name` (string): Registrant name
 * `company` (string): Registrant company name
 * `email` (string): Registrant email address
+* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
 * `form_field_set_id` (int64): Id of associated form field set
 * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
 

data/docs/invoice.md

@@ -10,29 +10,25 @@
   "created_at": "2000-01-01T01:00:00Z",
   "currency": "USD",
   "download_uri": "https://url...",
-  "invoice_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "description": "Service from 2019-01-01 through 2019-12-31",
-      "type": "invoice",
-      "service_end_at": "2000-01-01T01:00:00Z",
-      "service_start_at": "2000-01-01T01:00:00Z",
-      "updated_at": "2000-01-01T01:00:00Z",
-      "plan": "Enterprise",
-      "site": "My site"
-    }
-  ],
+  "invoice_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "description": "Service from 2019-01-01 through 2019-12-31",
+    "type": "invoice",
+    "service_end_at": "2000-01-01T01:00:00Z",
+    "service_start_at": "2000-01-01T01:00:00Z",
+    "updated_at": "2000-01-01T01:00:00Z",
+    "plan": "Enterprise",
+    "site": "My site"
+  },
   "method": "paypal",
-  "payment_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "invoice_id": 1,
-      "payment_id": 1,
-      "updated_at": "2000-01-01T01:00:00Z"
-    }
-  ],
+  "payment_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "invoice_id": 1,
+    "payment_id": 1,
+    "updated_at": "2000-01-01T01:00:00Z"
+  },
   "payment_reversed_at": "2000-01-01T01:00:00Z",
   "payment_type": "",
   "site_name": "My Site",
@@ -47,9 +43,9 @@
 * `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
+* `invoice_line_items`: Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items`: 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

data/docs/message.md

@@ -7,25 +7,21 @@
   "id": 1,
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
-  "comments": [
-    {
+  "comments": {
+    "id": 1,
+    "body": "What a great idea, thank you!",
+    "reactions": {
       "id": 1,
-      "body": "What a great idea, thank you!",
-      "reactions": [
-        {
-          "id": 1,
-          "emoji": "👍"
-        }
-      ]
+      "emoji": "👍"
     }
-  ]
+  }
 }
 ```
 
 * `id` (int64): Message ID
 * `subject` (string): Message subject.
 * `body` (string): Message body.
-* `comments` (array): Comments.
+* `comments`: Comments.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `project_id` (int64): Project to which the message should be attached.
 

data/docs/message_comment.md

@@ -6,18 +6,16 @@
 {
   "id": 1,
   "body": "What a great idea, thank you!",
-  "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
-  ]
+  "reactions": {
+    "id": 1,
+    "emoji": "👍"
+  }
 }
 ```
 
 * `id` (int64): Message Comment ID
 * `body` (string): Comment body.
-* `reactions` (array): Reactions to this comment.
+* `reactions`: Reactions to this comment.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 

data/docs/payment.md

@@ -10,29 +10,25 @@
   "created_at": "2000-01-01T01:00:00Z",
   "currency": "USD",
   "download_uri": "https://url...",
-  "invoice_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "description": "Service from 2019-01-01 through 2019-12-31",
-      "type": "invoice",
-      "service_end_at": "2000-01-01T01:00:00Z",
-      "service_start_at": "2000-01-01T01:00:00Z",
-      "updated_at": "2000-01-01T01:00:00Z",
-      "plan": "Enterprise",
-      "site": "My site"
-    }
-  ],
+  "invoice_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "description": "Service from 2019-01-01 through 2019-12-31",
+    "type": "invoice",
+    "service_end_at": "2000-01-01T01:00:00Z",
+    "service_start_at": "2000-01-01T01:00:00Z",
+    "updated_at": "2000-01-01T01:00:00Z",
+    "plan": "Enterprise",
+    "site": "My site"
+  },
   "method": "paypal",
-  "payment_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "invoice_id": 1,
-      "payment_id": 1,
-      "updated_at": "2000-01-01T01:00:00Z"
-    }
-  ],
+  "payment_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "invoice_id": 1,
+    "payment_id": 1,
+    "updated_at": "2000-01-01T01:00:00Z"
+  },
   "payment_reversed_at": "2000-01-01T01:00:00Z",
   "payment_type": "",
   "site_name": "My Site",
@@ -47,9 +43,9 @@
 * `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
+* `invoice_line_items`: Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items`: 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

data/docs/remote_server.md

@@ -31,6 +31,7 @@
   "auth_status": "in_setup",
   "auth_account_name": "me@example.com",
   "one_drive_account_type": "personal",
+  "sharepoint_hostname": "filescom.sharepoint.com",
   "azure_blob_storage_account": "storage-account-name",
   "azure_blob_storage_container": "container-name"
 }
@@ -63,6 +64,7 @@
 * `auth_status` (string): Either `in_setup` or `complete`
 * `auth_account_name` (string): Describes the authorized account
 * `one_drive_account_type` (string): Either personal or business_other account types
+* `sharepoint_hostname` (string): Cloud hosted sharepoint hostname
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 * `aws_access_key` (string): AWS Access Key.
@@ -137,6 +139,7 @@ Files::RemoteServer.create(
   rackspace_region: "dfw", 
   rackspace_container: "my-container", 
   one_drive_account_type: "personal", 
+  sharepoint_hostname: "filescom.sharepoint.com", 
   azure_blob_storage_account: "storage-account-name", 
   azure_blob_storage_container: "container-name"
 )
@@ -178,6 +181,7 @@ Files::RemoteServer.create(
 * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
 * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
 * `one_drive_account_type` (string): Either personal or business_other account types
+* `sharepoint_hostname` (string): Cloud hosted sharepoint hostname
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 
@@ -210,6 +214,7 @@ Files::RemoteServer.update(id,
   rackspace_region: "dfw", 
   rackspace_container: "my-container", 
   one_drive_account_type: "personal", 
+  sharepoint_hostname: "filescom.sharepoint.com", 
   azure_blob_storage_account: "storage-account-name", 
   azure_blob_storage_container: "container-name"
 )
@@ -252,6 +257,7 @@ Files::RemoteServer.update(id,
 * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
 * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
 * `one_drive_account_type` (string): Either personal or business_other account types
+* `sharepoint_hostname` (string): Cloud hosted sharepoint hostname
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 
@@ -299,6 +305,7 @@ remote_server.update(
   rackspace_region: "dfw",
   rackspace_container: "my-container",
   one_drive_account_type: "personal",
+  sharepoint_hostname: "filescom.sharepoint.com",
   azure_blob_storage_account: "storage-account-name",
   azure_blob_storage_container: "container-name"
 )
@@ -341,6 +348,7 @@ remote_server.update(
 * `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
 * `rackspace_container` (string): The name of the container (top level directory) where files will sync.
 * `one_drive_account_type` (string): Either personal or business_other account types
+* `sharepoint_hostname` (string): Cloud hosted sharepoint hostname
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 

data/docs/sso_strategy.md

@@ -4,9 +4,7 @@
 
 ```
 {
-  "protocol": [
-    "okta"
-  ],
+  "protocol": "oauth2",
   "provider": "okta",
   "label": "My Corporate SSO Provider",
   "logo_url": "https://mysite.files.com/.../logo.png",
@@ -51,7 +49,7 @@
 }
 ```
 
-* `protocol` (array): SSO Protocol
+* `protocol` (string): SSO Protocol
 * `provider` (string): Provider name
 * `label` (string): Custom label for the SSO provider on the login page.
 * `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.

data/docs/status.md

@@ -8,16 +8,14 @@
   "message": "",
   "status": "",
   "data": "",
-  "errors": [
-    {
-      "fields": [
+  "errors": {
+    "fields": [
 
-      ],
-      "messages": [
+    ],
+    "messages": [
 
-      ]
-    }
-  ],
+    ]
+  },
   "clickwrap_id": 1,
   "clickwrap_body": ""
 }
@@ -27,6 +25,6 @@
 * `message` (string): Error message
 * `status` (string): Status message
 * `data`: Additional data
-* `errors` (array): A list of api errors
+* `errors`: A list of api errors
 * `clickwrap_id` (int64): Required Clickwrap id
 * `clickwrap_body` (string): Required Clickwrap body

data/docs/sync_job.md

@@ -0,0 +1,37 @@
+# SyncJob
+
+## Example SyncJob Object
+
+```
+{
+  "queued_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z",
+  "status": "",
+  "regional_worker_status": "",
+  "uuid": "",
+  "folder_behavior_id": 1
+}
+```
+
+* `queued_at` (date-time): Job enqueued at
+* `updated_at` (date-time): Job updated at
+* `status` (string): Status of the job
+* `regional_worker_status` (string): Most recent reported status of sync worker
+* `uuid` (string): 
+* `folder_behavior_id` (int64): 
+
+
+---
+
+## List Sync Jobs
+
+```
+Files::SyncJob.list(
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value 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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

data/lib/files.com.rb

@@ -85,6 +85,7 @@ require "files.com/models/site"
 require "files.com/models/sso_strategy"
 require "files.com/models/status"
 require "files.com/models/style"
+require "files.com/models/sync_job"
 require "files.com/models/usage_daily_snapshot"
 require "files.com/models/usage_snapshot"
 require "files.com/models/user"

data/lib/files.com/models/account_line_item.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/bundle.rb

@@ -45,6 +45,15 @@ module Files
       @attributes[:password_protected] = value
     end
 
+    # boolean - Restrict users to previewing files only?
+    def preview_only
+      @attributes[:preview_only]
+    end
+
+    def preview_only=(value)
+      @attributes[:preview_only] = value
+    end
+
     # boolean - Show a registration page that captures the downloader's name and email address?
     def require_registration
       @attributes[:require_registration]
@@ -224,6 +233,7 @@ module Files
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   note - string - Bundle internal note
+    #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
     def update(params = {})
@@ -327,6 +337,7 @@ module Files
     #   description - string - Public description
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     #   inbox_id - int64 - ID of the associated inbox, if available.
@@ -379,6 +390,7 @@ module Files
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   note - string - Bundle internal note
+    #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
     def self.update(id, params = {}, options = {})

data/lib/files.com/models/bundle_registration.rb

@@ -34,6 +34,11 @@ module Files
       @attributes[:inbox_code]
     end
 
+    # string - Clickwrap text that was shown to the registrant
+    def clickwrap_body
+      @attributes[:clickwrap_body]
+    end
+
     # int64 - Id of associated form field set
     def form_field_set_id
       @attributes[:form_field_set_id]

data/lib/files.com/models/external_event.rb

@@ -9,12 +9,12 @@ module Files
       @options = options || {}
     end
 
-    # string - Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
+    # string - Type of event being recorded.
     def event_type
       @attributes[:event_type]
     end
 
-    # string - Status of event. Valid values: `error`
+    # string - Status of event.
     def status
       @attributes[:status]
     end

data/lib/files.com/models/file_comment.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Reactions to this comment.
+    # Reactions to this comment.
     def reactions
       @attributes[:reactions]
     end

data/lib/files.com/models/form_field_set.rb

@@ -36,7 +36,7 @@ module Files
       @attributes[:form_layout] = value
     end
 
-    # array - Associated form fields
+    # Associated form fields
     def form_fields
       @attributes[:form_fields]
     end

data/lib/files.com/models/group.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:name] = value
     end
 
-    # array - List of user IDs who are group administrators (separated by commas)
+    # string - List of user IDs who are group administrators (separated by commas)
     def admin_ids
       @attributes[:admin_ids]
     end

data/lib/files.com/models/inbox_registration.rb

@@ -29,6 +29,11 @@ module Files
       @attributes[:email]
     end
 
+    # string - Clickwrap text that was shown to the registrant
+    def clickwrap_body
+      @attributes[:clickwrap_body]
+    end
+
     # int64 - Id of associated form field set
     def form_field_set_id
       @attributes[:form_field_set_id]

data/lib/files.com/models/invoice.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/message.rb

@@ -36,7 +36,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Comments.
+    # Comments.
     def comments
       @attributes[:comments]
     end

data/lib/files.com/models/message_comment.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Reactions to this comment.
+    # Reactions to this comment.
     def reactions
       @attributes[:reactions]
     end

data/lib/files.com/models/payment.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/remote_server.rb

@@ -252,6 +252,15 @@ module Files
       @attributes[:one_drive_account_type] = value
     end
 
+    # string - Cloud hosted sharepoint hostname
+    def sharepoint_hostname
+      @attributes[:sharepoint_hostname]
+    end
+
+    def sharepoint_hostname=(value)
+      @attributes[:sharepoint_hostname] = value
+    end
+
     # string - Azure Blob Storage Account name
     def azure_blob_storage_account
       @attributes[:azure_blob_storage_account]
@@ -422,6 +431,7 @@ module Files
     #   rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
     #   rackspace_container - string - The name of the container (top level directory) where files will sync.
     #   one_drive_account_type - string - Either personal or business_other account types
+    #   sharepoint_hostname - string - Cloud hosted sharepoint hostname
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     def update(params = {})
@@ -462,6 +472,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sharepoint_hostname must be an String") if params.dig(:sharepoint_hostname) and !params.dig(:sharepoint_hostname).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
@@ -559,6 +570,7 @@ module Files
     #   rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
     #   rackspace_container - string - The name of the container (top level directory) where files will sync.
     #   one_drive_account_type - string - Either personal or business_other account types
+    #   sharepoint_hostname - string - Cloud hosted sharepoint hostname
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     def self.create(params = {}, options = {})
@@ -595,6 +607,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sharepoint_hostname must be an String") if params.dig(:sharepoint_hostname) and !params.dig(:sharepoint_hostname).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
 
@@ -637,6 +650,7 @@ module Files
     #   rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
     #   rackspace_container - string - The name of the container (top level directory) where files will sync.
     #   one_drive_account_type - string - Either personal or business_other account types
+    #   sharepoint_hostname - string - Cloud hosted sharepoint hostname
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     def self.update(id, params = {}, options = {})
@@ -676,6 +690,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sharepoint_hostname must be an String") if params.dig(:sharepoint_hostname) and !params.dig(:sharepoint_hostname).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

data/lib/files.com/models/sso_strategy.rb

@@ -9,7 +9,7 @@ module Files
       @options = options || {}
     end
 
-    # array - SSO Protocol
+    # string - SSO Protocol
     def protocol
       @attributes[:protocol]
     end

data/lib/files.com/models/status.rb

@@ -29,7 +29,7 @@ module Files
       @attributes[:data]
     end
 
-    # array - A list of api errors
+    # A list of api errors
     def errors
       @attributes[:errors]
     end

data/lib/files.com/models/sync_job.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Files
+  class SyncJob
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # date-time - Job enqueued at
+    def queued_at
+      @attributes[:queued_at]
+    end
+
+    # date-time - Job updated at
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # string - Status of the job
+    def status
+      @attributes[:status]
+    end
+
+    # string - Most recent reported status of sync worker
+    def regional_worker_status
+      @attributes[:regional_worker_status]
+    end
+
+    # string -
+    def uuid
+      @attributes[:uuid]
+    end
+
+    # int64 -
+    def folder_behavior_id
+      @attributes[:folder_behavior_id]
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  Send a cursor value 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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+
+      List.new(SyncJob, params) do
+        Api.send_request("/sync_jobs", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.158
+  version: 1.0.163
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -145,6 +145,7 @@ files:
 - docs/sso_strategy.md
 - docs/status.md
 - docs/style.md
+- docs/sync_job.md
 - docs/usage_daily_snapshot.md
 - docs/usage_snapshot.md
 - docs/user.md
@@ -217,6 +218,7 @@ files:
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb
 - lib/files.com/models/style.rb
+- lib/files.com/models/sync_job.rb
 - lib/files.com/models/usage_daily_snapshot.rb
 - lib/files.com/models/usage_snapshot.rb
 - lib/files.com/models/user.rb