files.com 1.0.198 → 1.0.199

package/_VERSION

@@ -1 +1 @@
-1.0.198
+1.0.199

package/docs/models/AccountLineItem.md

@@ -10,25 +10,29 @@
   "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": "Premier",
+      "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",
@@ -43,9 +47,9 @@
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
+* `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (PaymentLineItem): Associated payment line items
+* `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

package/docs/models/App.md

@@ -31,7 +31,7 @@
 * `documentation_links` (object): Collection of named links to documentation
 * `icon_url` (string): App icon
 * `logo_url` (string): Full size logo for the App
-* `screenshot_list_urls` (string): Screenshots of the App
+* `screenshot_list_urls` (array): Screenshots of the App
 * `logo_thumbnail_url` (string): Logo thumbnail for the App
 * `sso_strategy_type` (string): Associated SSO Strategy type, if any
 * `remote_server_type` (string): Associated Remote Server type, if any

package/docs/models/Automation.md

@@ -42,7 +42,9 @@
     2
   ],
   "webhook_url": "https://app.files.com/api/webhooks/abc123",
-  "trigger_actions": "[ \"create\" ]",
+  "trigger_actions": [
+    "[ \"create\" ]"
+  ],
   "value": "{\"limit\": \"1\"}"
 }
 ```
@@ -57,7 +59,7 @@
 * `name` (string): Name for this automation.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
 * `source` (string): Source Path
-* `destinations` (string): Destination Path
+* `destinations` (array): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
 * `description` (string): Description for the this Automation.
@@ -66,7 +68,7 @@
 * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
 * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
 * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
-* `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
+* `trigger_actions` (array): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `value` (object): A Hash of attributes specific to the automation type.
 * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
 
@@ -124,7 +126,7 @@ await Automation.create({
   'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
   'disabled': true,
   'trigger': "realtime",
-  'trigger_actions': "[ \"create\" ]",
+  'trigger_actions': ["[ \"create\" ]"],
   'value': "{\"limit\": \"1\"}",
   'automation': "create_folder",
 })
@@ -167,7 +169,7 @@ await automation.update({
   'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
   'disabled': true,
   'trigger': "realtime",
-  'trigger_actions': "[ \"create\" ]",
+  'trigger_actions': ["[ \"create\" ]"],
   'value': "{\"limit\": \"1\"}",
   'automation': "create_folder",
 })
@@ -236,7 +238,9 @@ await automation.update({
     2
   ],
   "webhook_url": "https://app.files.com/api/webhooks/abc123",
-  "trigger_actions": "[ \"create\" ]",
+  "trigger_actions": [
+    "[ \"create\" ]"
+  ],
   "value": "{\"limit\": \"1\"}"
 }
 ```

package/docs/models/Bundle.md

@@ -8,6 +8,7 @@
   "url": "https://subdomain.files.com/f/12345678",
   "description": "The public description of the bundle.",
   "password_protected": true,
+  "permissions": "read",
   "preview_only": true,
   "require_registration": true,
   "require_share_recipient": true,
@@ -21,20 +22,22 @@
       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
@@ -67,6 +70,7 @@
 * `url` (string): Public URL of Share Link
 * `description` (string): Public description
 * `password_protected` (boolean): Is this bundle password protected?
+* `permissions` (string): Permissions that apply to Folders in this Share Link.
 * `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?
@@ -146,6 +150,7 @@ await Bundle.create({
   'description': "The public description of the bundle.",
   'note': "The internal note on the bundle.",
   'code': "abc123",
+  'permissions': "read",
   'preview_only': true,
   'require_registration': true,
   'clickwrap_id': 1,
@@ -169,6 +174,7 @@ await 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.
+* `permissions` (string): Permissions that apply to Folders in this Share Link.
 * `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.
@@ -219,6 +225,7 @@ await bundle.update({
   'inbox_id': 1,
   'max_uses': 1,
   'note': "The internal note on the bundle.",
+  'permissions': "read",
   'preview_only': true,
   'require_registration': true,
   'require_share_recipient': true,
@@ -242,6 +249,7 @@ await 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
+* `permissions` (string): Permissions that apply to Folders in this Share Link.
 * `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?
@@ -259,6 +267,7 @@ await bundle.update({
   "url": "https://subdomain.files.com/f/12345678",
   "description": "The public description of the bundle.",
   "password_protected": true,
+  "permissions": "read",
   "preview_only": true,
   "require_registration": true,
   "require_share_recipient": true,
@@ -272,20 +281,22 @@ await bundle.update({
       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

package/docs/models/FileComment.md

@@ -6,16 +6,18 @@
 {
   "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` (FileCommentReaction): Reactions to this comment.
+* `reactions` (array): Reactions to this comment.
 * `path` (string): File path.
 
 ---
@@ -75,10 +77,12 @@ await file_comment.update({
 {
   "id": 1,
   "body": "What a great file!",
-  "reactions": {
-    "id": 1,
-    "emoji": "👍"
-  }
+  "reactions": [
+    {
+      "id": 1,
+      "emoji": "👍"
+    }
+  ]
 }
 ```
 

package/docs/models/FormField.md

@@ -24,6 +24,6 @@
 * `required` (boolean): Is this a required field?
 * `help_text` (string): Help text to be displayed
 * `field_type` (string): Type of Field
-* `options_for_select` (string): Options to display for radio and dropdown
+* `options_for_select` (array): Options to display for radio and dropdown
 * `default_option` (string): Default option for radio and dropdown
 * `form_field_set_id` (int64): Form field set id

package/docs/models/FormFieldSet.md

@@ -12,20 +12,22 @@
     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
@@ -34,8 +36,8 @@
 
 * `id` (int64): Form field set id
 * `title` (string): Title to be displayed
-* `form_layout` (int64): Layout of the form
-* `form_fields` (FormField): Associated form fields
+* `form_layout` (array): Layout of the form
+* `form_fields` (array): 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
@@ -83,7 +85,7 @@ await 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}],
 })
 ```
 
@@ -109,7 +111,7 @@ await 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}],
 })
 ```
 
@@ -134,20 +136,22 @@ await form_field_set.update({
     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

package/docs/models/Group.md

@@ -6,25 +6,19 @@
 {
   "id": 1,
   "name": "owners",
-  "admin_ids": [
-    1
-  ],
+  "admin_ids": "1",
   "notes": "",
-  "user_ids": [
-    1
-  ],
-  "usernames": [
-    "user"
-  ]
+  "user_ids": "1",
+  "usernames": "user"
 }
 ```
 
 * `id` (int64): Group ID
 * `name` (string): Group name
-* `admin_ids` (string): List of user IDs who are group administrators (separated by commas)
+* `admin_ids` (string): Comma-delimited 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)
+* `user_ids` (string): Comma-delimited list of user IDs who belong to this group (separated by commas)
+* `usernames` (string): Comma-delimited list of usernames who belong to this group (separated by commas)
 
 ---
 
@@ -70,8 +64,8 @@ await Group.find(id)
 ```
 await Group.create({
   'name': "owners",
-  'user_ids': [1],
-  'admin_ids': [1],
+  'user_ids': "1",
+  'admin_ids': "1",
 })
 ```
 
@@ -92,8 +86,8 @@ const [group] = await Group.list()
 
 await group.update({
   'name': "owners",
-  'user_ids': [1],
-  'admin_ids': [1],
+  'user_ids': "1",
+  'admin_ids': "1",
 })
 ```
 
@@ -111,16 +105,10 @@ await group.update({
 {
   "id": 1,
   "name": "owners",
-  "admin_ids": [
-    1
-  ],
+  "admin_ids": "1",
   "notes": "",
-  "user_ids": [
-    1
-  ],
-  "usernames": [
-    "user"
-  ]
+  "user_ids": "1",
+  "usernames": "user"
 }
 ```
 

package/docs/models/Invoice.md

@@ -10,25 +10,29 @@
   "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": "Premier",
+      "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",
@@ -43,9 +47,9 @@
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
+* `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (PaymentLineItem): Associated payment line items
+* `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

package/docs/models/InvoiceLineItem.md

@@ -11,7 +11,7 @@
   "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",
+  "plan": "Premier",
   "site": "My site"
 }
 ```

package/docs/models/Message.md

@@ -7,21 +7,25 @@
   "id": 1,
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
-  "comments": {
-    "id": 1,
-    "body": "What a great idea, thank you!",
-    "reactions": {
+  "comments": [
+    {
       "id": 1,
-      "emoji": "👍"
+      "body": "What a great idea, thank you!",
+      "reactions": [
+        {
+          "id": 1,
+          "emoji": "👍"
+        }
+      ]
     }
-  }
+  ]
 }
 ```
 
 * `id` (int64): Message ID
 * `subject` (string): Message subject.
 * `body` (string): Message body.
-* `comments` (MessageComment): Comments.
+* `comments` (array): 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.
 
@@ -107,14 +111,18 @@ await message.update({
   "id": 1,
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
-  "comments": {
-    "id": 1,
-    "body": "What a great idea, thank you!",
-    "reactions": {
+  "comments": [
+    {
       "id": 1,
-      "emoji": "👍"
+      "body": "What a great idea, thank you!",
+      "reactions": [
+        {
+          "id": 1,
+          "emoji": "👍"
+        }
+      ]
     }
-  }
+  ]
 }
 ```
 

package/docs/models/MessageComment.md

@@ -6,16 +6,18 @@
 {
   "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` (MessageCommentReaction): Reactions to this comment.
+* `reactions` (array): Reactions to this comment.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 ---
@@ -91,10 +93,12 @@ await message_comment.update({
 {
   "id": 1,
   "body": "What a great idea, thank you!",
-  "reactions": {
-    "id": 1,
-    "emoji": "👍"
-  }
+  "reactions": [
+    {
+      "id": 1,
+      "emoji": "👍"
+    }
+  ]
 }
 ```