files.com 1.0.132 → 1.0.133

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08bc9f16d5d9c80f23b951dfd587fd8e6ac05da09efbc174d4f01d802c45596b'
-  data.tar.gz: c15f2b59612650caf3c4df6d5e3ffa9ba6be5b4836d0e2eb52617874d60aebec
+  metadata.gz: d035ac320deed565de483766b7bd1132c09c9cda2cb9e3fca6ea315e218b22b3
+  data.tar.gz: 411f29ad91d887b4fd5074b42e2b551fdccac61bf764022de32d1bd345f4ddfe
 SHA512:
-  metadata.gz: 69c4a9e1e1daae0bf0cd0f37ee8ccda29b50ac8bdcce773852b767a8c8f551bdf14f881256568efbb87dde514f42d81e30c737b519993f016204bebdd493a87d
-  data.tar.gz: a15358d708e6496abd3ce5ab63efa1ffdd9cdc2357a470780fd71cd2026a1ed1c201a104eb4fb373347b6607a3180bb675e00f61695061649ae1675b90143c5b
+  metadata.gz: ad1e0300e759301679cc8c6125f02aa5e962a686a057b6a158f4a52e430e3b2fe3f1d8e4a33eed6a330298bfd248327d43e50a2e8e29e999765174a69b195026
+  data.tar.gz: 2495ec0411de523c389c0e6fb3872ec6859bd3484666848f9a63c7697791ab9a001f221ac2a48cc274ca710736c1ef7bcd7495987d9436fa4c3f27c347d45909

data/_VERSION

@@ -1 +1 @@
-1.0.132
+1.0.133

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/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/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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.132
+  version: 1.0.133
 platform: ruby
 authors:
 - files.com
@@ -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