files.com 1.0.361 → 1.0.362

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54a6c1c9d8200f8492641b76255d63dc027326e56957ad0f6d9e28b2ba362fde
-  data.tar.gz: 47426ea8543a0fe55f41e50bee291e758397e06798eeabfccfcb0e08327fac61
+  metadata.gz: 18af8443937174bf0ae7a46ef866b8f1a4a56db9ea14d449a036e47ebde0b88f
+  data.tar.gz: 79de26b29faf547c955b519ee4fe457f04f7a1826276ab2b31b9d95925a27520
 SHA512:
-  metadata.gz: 70c67ca1a465b0839fa3f2fc5905d56ea6fccb0258652fb57b5881e38d460da4db536b4185f641c88ab8693bee052a99f8b28ec1c707c5e24ff857afdaeeebcd
-  data.tar.gz: c3e2efa5ab442e10f7e2cab683e56fe45f7d9c146e4e6bb3c392f23f70b4071d05aabef5069f522a793b14188fd11d634bdf7fa335ce102b5775ea4fd955d6b2
+  metadata.gz: ab240292eba5d2bccb31b038e37123f3c6772445637299cb61d4f804276eb4ccfec8d3b3ef28659bc63b68fdd2b78b5842929276d5d699d09688158175598e23
+  data.tar.gz: df112f9a21749c530de41bb66978db1b183bf8a2874205bdb47e73c3143ec6b865c6a3d0f1680706c68389905c252b7f3e2c5a119e0021aa8813700de89da320

data/_VERSION

@@ -1 +1 @@
-1.0.361
+1.0.362

data/docs/share_group.md

@@ -0,0 +1,148 @@
+# ShareGroup
+
+## Example ShareGroup Object
+
+```
+{
+  "id": 1,
+  "name": "Test group 1",
+  "notes": "This group is defined for testing purposes",
+  "user_id": 1,
+  "share_group_members": [
+    {
+      "name": "John Doe",
+      "company": "Acme Ltd",
+      "email": "johndoe@gmail.com"
+    }
+  ]
+}
+```
+
+* `id` (int64): Share Group ID
+* `name` (string): Name of the share group
+* `notes` (string): Additional notes of the share group
+* `user_id` (int64): Owner User ID
+* `share_group_members` (array): A list of share group members
+* `members` (array(object)): A list of share group members.
+
+
+---
+
+## List Share Groups
+
+```
+Files::ShareGroup.list(
+  user_id: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+
+---
+
+## Show Share Group
+
+```
+Files::ShareGroup.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Share Group ID.
+
+
+---
+
+## Create Share Group
+
+```
+Files::ShareGroup.create(
+  user_id: 1, 
+  notes: "This group is defined for testing purposes", 
+  name: "Test group 1", 
+  members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `notes` (string): Additional notes of the share group
+* `name` (string): Required - Name of the share group
+* `members` (array(object)): Required - A list of share group members.
+
+
+---
+
+## Update Share Group
+
+```
+Files::ShareGroup.update(id, 
+  notes: "This group is defined for testing purposes", 
+  name: "Test group 1", 
+  members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Share Group ID.
+* `notes` (string): Additional notes of the share group
+* `name` (string): Name of the share group
+* `members` (array(object)): A list of share group members.
+
+
+---
+
+## Delete Share Group
+
+```
+Files::ShareGroup.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Share Group ID.
+
+
+---
+
+## Update Share Group
+
+```
+share_group = Files::ShareGroup.list.first
+
+share_group.update(
+  notes: "This group is defined for testing purposes",
+  name: "Test group 1",
+  members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Share Group ID.
+* `notes` (string): Additional notes of the share group
+* `name` (string): Name of the share group
+* `members` (array(object)): A list of share group members.
+
+
+---
+
+## Delete Share Group
+
+```
+share_group = Files::ShareGroup.list.first
+
+share_group.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Share Group ID.

data/docs/share_group_member.md

@@ -0,0 +1,15 @@
+# ShareGroupMember
+
+## Example ShareGroupMember Object
+
+```
+{
+  "name": "John Doe",
+  "company": "Acme Ltd",
+  "email": "johndoe@gmail.com"
+}
+```
+
+* `name` (string): Name of the share group member
+* `company` (string): Company of the share group member
+* `email` (string): Email of the share group member

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

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Files
+  class ShareGroup
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Share Group ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Name of the share group
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Additional notes of the share group
+    def notes
+      @attributes[:notes]
+    end
+
+    def notes=(value)
+      @attributes[:notes] = value
+    end
+
+    # int64 - Owner User ID
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # array - A list of share group members
+    def share_group_members
+      @attributes[:share_group_members]
+    end
+
+    def share_group_members=(value)
+      @attributes[:share_group_members] = value
+    end
+
+    # array(object) - A list of share group members.
+    def members
+      @attributes[:members]
+    end
+
+    def members=(value)
+      @attributes[:members] = value
+    end
+
+    # Parameters:
+    #   notes - string - Additional notes of the share group
+    #   name - string - Name of the share group
+    #   members - array(object) - A list of share group members.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/share_groups/#{@attributes[:id]}", :patch, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/share_groups/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = ShareGroup.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.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+
+      List.new(ShareGroup, params) do
+        Api.send_request("/share_groups", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Share Group ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/share_groups/#{params[:id]}", :get, params, options)
+      ShareGroup.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   notes - string - Additional notes of the share group
+    #   name (required) - string - Name of the share group
+    #   members (required) - array(object) - A list of share group members.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+      raise MissingParameterError.new("Parameter missing: members") unless params[:members]
+
+      response, options = Api.send_request("/share_groups", :post, params, options)
+      ShareGroup.new(response.data, options)
+    end
+
+    # Parameters:
+    #   notes - string - Additional notes of the share group
+    #   name - string - Name of the share group
+    #   members - array(object) - A list of share group members.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: members must be an Array") if params[:members] and !params[:members].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/share_groups/#{params[:id]}", :patch, params, options)
+      ShareGroup.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, _options = Api.send_request("/share_groups/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Files
+  class ShareGroupMember
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Name of the share group member
+    def name
+      @attributes[:name]
+    end
+
+    # string - Company of the share group member
+    def company
+      @attributes[:company]
+    end
+
+    # string - Email of the share group member
+    def email
+      @attributes[:email]
+    end
+  end
+end

data/lib/files.com.rb

@@ -99,6 +99,8 @@ require "files.com/models/request"
 require "files.com/models/session"
 require "files.com/models/settings_change"
 require "files.com/models/sftp_host_key"
+require "files.com/models/share_group"
+require "files.com/models/share_group_member"
 require "files.com/models/site"
 require "files.com/models/snapshot"
 require "files.com/models/sso_strategy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.361
+  version: 1.0.362
 platform: ruby
 authors:
 - files.com
@@ -182,6 +182,8 @@ files:
 - docs/session.md
 - docs/settings_change.md
 - docs/sftp_host_key.md
+- docs/share_group.md
+- docs/share_group_member.md
 - docs/site.md
 - docs/snapshot.md
 - docs/sso_strategy.md
@@ -268,6 +270,8 @@ files:
 - lib/files.com/models/session.rb
 - lib/files.com/models/settings_change.rb
 - lib/files.com/models/sftp_host_key.rb
+- lib/files.com/models/share_group.rb
+- lib/files.com/models/share_group_member.rb
 - lib/files.com/models/site.rb
 - lib/files.com/models/snapshot.rb
 - lib/files.com/models/sso_strategy.rb