files.com 1.0.128 → 1.0.133

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3e1278f84e7c16dba288784cf89e9a52b4dbb2d864c8dccce564ea413aad735
-  data.tar.gz: 06d50e38f5728b443c19f104f63545b5ee414fe85805dbe09f77628c82b0881b
+  metadata.gz: d035ac320deed565de483766b7bd1132c09c9cda2cb9e3fca6ea315e218b22b3
+  data.tar.gz: 411f29ad91d887b4fd5074b42e2b551fdccac61bf764022de32d1bd345f4ddfe
 SHA512:
-  metadata.gz: 96ceaa8549312e55ff63dba0d16d0498ab99833505279684d3e7ec36cadb3d9866dcc5d34e23af4029c87336bef658fd2468e2116f0bf975eb61654eeb90eb7c
-  data.tar.gz: d24ed0fb7d3cddd8d71ed270649294e4b2b543f8b6f4f8a3fb062538ed27463e2c361534d47d958b97b314721ba202d7f8d41cf3989ae04cb07a3f2c314337a9
+  metadata.gz: ad1e0300e759301679cc8c6125f02aa5e962a686a057b6a158f4a52e430e3b2fe3f1d8e4a33eed6a330298bfd248327d43e50a2e8e29e999765174a69b195026
+  data.tar.gz: 2495ec0411de523c389c0e6fb3872ec6859bd3484666848f9a63c7697791ab9a001f221ac2a48cc274ca710736c1ef7bcd7495987d9436fa4c3f27c347d45909

data/_VERSION

@@ -1 +1 @@
-1.0.128
+1.0.133

data/docs/automation.md

@@ -35,13 +35,15 @@
     1,
     2
   ],
-  "webhook_url": "https://app.files.com/api/webhooks/abc123"
+  "webhook_url": "https://app.files.com/api/webhooks/abc123",
+  "trigger_actions": "[ \"create\" ]",
+  "trigger_action_path": "path/to/file/or/folder"
 }
 ```
 
 * `id` (int64): Automation ID
 * `automation` (string): Automation type
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
 * `interval` (string): If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
 * `next_process_on` (string): If trigger is `daily`, date this automation will next run.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
@@ -54,6 +56,8 @@
 * `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_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 
 
 ---
@@ -107,7 +111,9 @@ Files::Automation.create(
   user_ids: [1,2], 
   group_ids: [1,2], 
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}", 
-  trigger: "realtime"
+  trigger: "realtime", 
+  trigger_actions: "[ \"create\" ]", 
+  trigger_action_path: "path/to/file/or/folder"
 )
 ```
 
@@ -123,7 +129,9 @@ Files::Automation.create(
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `schedule` (object): Custom schedule for running this automation.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger_actions` (array(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_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 
 
 ---
@@ -139,7 +147,9 @@ Files::Automation.update(id,
   user_ids: [1,2], 
   group_ids: [1,2], 
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}", 
-  trigger: "realtime"
+  trigger: "realtime", 
+  trigger_actions: "[ \"create\" ]", 
+  trigger_action_path: "path/to/file/or/folder"
 )
 ```
 
@@ -156,7 +166,9 @@ Files::Automation.update(id,
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `schedule` (object): Custom schedule for running this automation.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger_actions` (array(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_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 
 
 ---
@@ -187,7 +199,9 @@ automation.update(
   user_ids: [1,2],
   group_ids: [1,2],
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
-  trigger: "realtime"
+  trigger: "realtime",
+  trigger_actions: "[ \"create\" ]",
+  trigger_action_path: "path/to/file/or/folder"
 )
 ```
 
@@ -204,7 +218,9 @@ automation.update(
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `schedule` (object): Custom schedule for running this automation.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger_actions` (array(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_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 
 
 ---

data/docs/bundle_recipient.md

@@ -17,6 +17,9 @@
 * `note` (string): A note sent to the recipient with the bundle.
 * `recipient` (string): The recipient's email address.
 * `sent_at` (date-time): When the Bundle was shared with this recipient.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `bundle_id` (int64): Bundle to share.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
 
 
 ---
@@ -44,3 +47,30 @@ Files::BundleRecipient.list(
 * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
 * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
 * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
+
+
+---
+
+## Create Bundle Recipient
+
+```
+Files::BundleRecipient.create(
+  user_id: 1, 
+  bundle_id: 1, 
+  recipient: "johndoe@gmail.com", 
+  name: "John Smith", 
+  company: "Acme Ltd", 
+  note: "Just a note.", 
+  share_after_create: true
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `bundle_id` (int64): Required - Bundle to share.
+* `recipient` (string): Required - Email addresses to share this bundle with.
+* `name` (string): Name of recipient.
+* `company` (string): Company of recipient.
+* `note` (string): Note to include in email.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.

data/docs/folder.md

@@ -70,7 +70,7 @@ Files::Folder.list_for(path,
 * `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 header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `path` (string): Required - Path to operate on.
-* `filter` (string): If specified, will to filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+* `filter` (string): If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
 * `search_all` (boolean): Search entire site?

data/docs/form_field_set.md

@@ -77,7 +77,7 @@ Files::FormFieldSet.find(id)
 Files::FormFieldSet.create(
   user_id: 1, 
   title: "Sample Form Title", 
-  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: [{"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/inbox_recipient.md

@@ -0,0 +1,76 @@
+# InboxRecipient
+
+## Example InboxRecipient Object
+
+```
+{
+  "company": "Acme Inc.",
+  "name": "John Doe",
+  "note": "Some note.",
+  "recipient": "john.doe@example.com",
+  "sent_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `company` (string): The recipient's company.
+* `name` (string): The recipient's name.
+* `note` (string): A note sent to the recipient with the inbox.
+* `recipient` (string): The recipient's email address.
+* `sent_at` (date-time): When the Inbox was shared with this recipient.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `inbox_id` (int64): Inbox to share.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
+
+
+---
+
+## List Inbox Recipients
+
+```
+Files::InboxRecipient.list(
+  user_id: 1, 
+  per_page: 1, 
+  inbox_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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).
+* `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 `has_registrations`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
+
+
+---
+
+## Create Inbox Recipient
+
+```
+Files::InboxRecipient.create(
+  user_id: 1, 
+  inbox_id: 1, 
+  recipient: "johndoe@gmail.com", 
+  name: "John Smith", 
+  company: "Acme Ltd", 
+  note: "Just a note.", 
+  share_after_create: true
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `inbox_id` (int64): Required - Inbox to share.
+* `recipient` (string): Required - Email addresses to share this inbox with.
+* `name` (string): Name of recipient.
+* `company` (string): Company of recipient.
+* `note` (string): Note to include in email.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.

data/docs/status.md

@@ -17,12 +17,16 @@
 
       ]
     }
-  ]
+  ],
+  "clickwrap_id": 1,
+  "clickwrap_body": ""
 }
 ```
 
-* `code` (int64): Status http code
+* `code` (int64): Status HTTP code
 * `message` (string): Error message
 * `status` (string): Status message
 * `data`: Additional data
 * `errors` (array): A list of api errors
+* `clickwrap_id` (int64): Required Clickwrap id
+* `clickwrap_body` (string): Required Clickwrap body

data/lib/files.com.rb

@@ -58,6 +58,7 @@ require "files.com/models/history"
 require "files.com/models/history_export"
 require "files.com/models/history_export_result"
 require "files.com/models/image"
+require "files.com/models/inbox_recipient"
 require "files.com/models/inbox_registration"
 require "files.com/models/inbox_upload"
 require "files.com/models/invoice"

data/lib/files.com/api_client.rb

@@ -154,7 +154,7 @@ module Files
           http.request request do |response|
             io.fulfill_content_length(response.content_length) if io.respond_to?(:fulfill_content_length)
             response.read_body do |chunk|
-              io << chunk.encode!
+              io << chunk
             end
           end
         end

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

@@ -27,7 +27,7 @@ module Files
       @attributes[:automation] = value
     end
 
-    # string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+    # string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
     def trigger
       @attributes[:trigger]
     end
@@ -144,6 +144,24 @@ module Files
       @attributes[:webhook_url] = value
     end
 
+    # 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
+    def trigger_actions
+      @attributes[:trigger_actions]
+    end
+
+    def trigger_actions=(value)
+      @attributes[:trigger_actions] = value
+    end
+
+    # string - If trigger is `action`, this is the path to watch for the specified trigger actions.
+    def trigger_action_path
+      @attributes[:trigger_action_path]
+    end
+
+    def trigger_action_path=(value)
+      @attributes[:trigger_action_path] = value
+    end
+
     # Parameters:
     #   automation (required) - string - Automation type
     #   source - string - Source Path
@@ -155,7 +173,9 @@ module Files
     #   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   schedule - object - Custom schedule for running this automation.
-    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+    #   trigger_actions - array(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_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -171,6 +191,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
@@ -259,7 +281,9 @@ module Files
     #   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   schedule - object - Custom schedule for running this automation.
-    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+    #   trigger_actions - array(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_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
@@ -272,6 +296,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
       response, options = Api.send_request("/automations", :post, params, options)
@@ -289,7 +315,9 @@ module Files
     #   user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
     #   schedule - object - Custom schedule for running this automation.
-    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
+    #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+    #   trigger_actions - array(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_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -305,6 +333,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 

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

@@ -14,26 +14,82 @@ module Files
       @attributes[:company]
     end
 
+    def company=(value)
+      @attributes[:company] = value
+    end
+
     # string - The recipient's name.
     def name
       @attributes[:name]
     end
 
+    def name=(value)
+      @attributes[:name] = value
+    end
+
     # string - A note sent to the recipient with the bundle.
     def note
       @attributes[:note]
     end
 
+    def note=(value)
+      @attributes[:note] = value
+    end
+
     # string - The recipient's email address.
     def recipient
       @attributes[:recipient]
     end
 
+    def recipient=(value)
+      @attributes[:recipient] = value
+    end
+
     # date-time - When the Bundle was shared with this recipient.
     def sent_at
       @attributes[:sent_at]
     end
 
+    def sent_at=(value)
+      @attributes[:sent_at] = value
+    end
+
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # int64 - Bundle to share.
+    def bundle_id
+      @attributes[:bundle_id]
+    end
+
+    def bundle_id=(value)
+      @attributes[:bundle_id] = value
+    end
+
+    # boolean - Set to true to share the link with the recipient upon creation.
+    def share_after_create
+      @attributes[:share_after_create]
+    end
+
+    def share_after_create=(value)
+      @attributes[:share_after_create] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The BundleRecipient object doesn't support updates.")
+      else
+        new_obj = BundleRecipient.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   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.
@@ -68,5 +124,27 @@ module Files
     def self.all(params = {}, options = {})
       list(params, options)
     end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   bundle_id (required) - int64 - Bundle to share.
+    #   recipient (required) - string - Email addresses to share this bundle with.
+    #   name - string - Name of recipient.
+    #   company - string - Company of recipient.
+    #   note - string - Note to include in email.
+    #   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: recipient must be an String") if params.dig(:recipient) and !params.dig(:recipient).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: company must be an String") if params.dig(:company) and !params.dig(:company).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
+      raise MissingParameterError.new("Parameter missing: recipient") unless params.dig(:recipient)
+
+      response, options = Api.send_request("/bundle_recipients", :post, params, options)
+      BundleRecipient.new(response.data, options)
+    end
   end
 end

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

@@ -303,7 +303,7 @@ module Files
     #   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 header.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   path (required) - string - Path to operate on.
-    #   filter - string - If specified, will to filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+    #   filter - string - If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   search - string - If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
     #   search_all - boolean - Search entire site?

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

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Files
+  class InboxRecipient
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - The recipient's company.
+    def company
+      @attributes[:company]
+    end
+
+    def company=(value)
+      @attributes[:company] = value
+    end
+
+    # string - The recipient's name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - A note sent to the recipient with the inbox.
+    def note
+      @attributes[:note]
+    end
+
+    def note=(value)
+      @attributes[:note] = value
+    end
+
+    # string - The recipient's email address.
+    def recipient
+      @attributes[:recipient]
+    end
+
+    def recipient=(value)
+      @attributes[:recipient] = value
+    end
+
+    # date-time - When the Inbox was shared with this recipient.
+    def sent_at
+      @attributes[:sent_at]
+    end
+
+    def sent_at=(value)
+      @attributes[:sent_at] = value
+    end
+
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # int64 - Inbox to share.
+    def inbox_id
+      @attributes[:inbox_id]
+    end
+
+    def inbox_id=(value)
+      @attributes[:inbox_id] = value
+    end
+
+    # boolean - Set to true to share the link with the recipient upon creation.
+    def share_after_create
+      @attributes[:share_after_create]
+    end
+
+    def share_after_create=(value)
+      @attributes[:share_after_create] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The InboxRecipient object doesn't support updates.")
+      else
+        new_obj = InboxRecipient.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   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).
+    #   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 `has_registrations`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+    #   inbox_id (required) - int64 - List recipients for the inbox with this ID.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      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)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: inbox_id") unless params.dig(:inbox_id)
+
+      List.new(InboxRecipient, params) do
+        Api.send_request("/inbox_recipients", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   inbox_id (required) - int64 - Inbox to share.
+    #   recipient (required) - string - Email addresses to share this inbox with.
+    #   name - string - Name of recipient.
+    #   company - string - Company of recipient.
+    #   note - string - Note to include in email.
+    #   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: recipient must be an String") if params.dig(:recipient) and !params.dig(:recipient).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: company must be an String") if params.dig(:company) and !params.dig(:company).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: inbox_id") unless params.dig(:inbox_id)
+      raise MissingParameterError.new("Parameter missing: recipient") unless params.dig(:recipient)
+
+      response, options = Api.send_request("/inbox_recipients", :post, params, options)
+      InboxRecipient.new(response.data, options)
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Files
       @options = options || {}
     end
 
-    # int64 - Status http code
+    # int64 - Status HTTP code
     def code
       @attributes[:code]
     end
@@ -33,5 +33,15 @@ module Files
     def errors
       @attributes[:errors]
     end
+
+    # int64 - Required Clickwrap id
+    def clickwrap_id
+      @attributes[:clickwrap_id]
+    end
+
+    # string - Required Clickwrap body
+    def clickwrap_body
+      @attributes[:clickwrap_body]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.128
+  version: 1.0.133
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -117,6 +117,7 @@ files:
 - docs/history_export.md
 - docs/history_export_result.md
 - docs/image.md
+- docs/inbox_recipient.md
 - docs/inbox_registration.md
 - docs/inbox_upload.md
 - docs/invoice.md
@@ -187,6 +188,7 @@ files:
 - lib/files.com/models/history_export.rb
 - lib/files.com/models/history_export_result.rb
 - lib/files.com/models/image.rb
+- lib/files.com/models/inbox_recipient.rb
 - lib/files.com/models/inbox_registration.rb
 - lib/files.com/models/inbox_upload.rb
 - lib/files.com/models/invoice.rb