Share Groups

A ShareGroup is a way for you to store and name groups of email contacts to be used for sending share and inbox invitations.

List Share Groups

SDK Method

Files::ShareGroup.list

Return Object

List<ShareGroup>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

begin
  share_groups = Files::ShareGroup.list(
    user_id: 1
  )
  share_groups.auto_paging_each do |share_group|
    # Operate on share_group
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Share Group

SDK Method

Files::ShareGroup.find

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Share Group ID.

Example Request

begin
  share_group = Files::ShareGroup.find(id)
  # Operate on share_group
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Share Group

SDK Method

Files::ShareGroup.create

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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.

Example Request

begin
  share_group = Files::ShareGroup.create(
    name: "Test group 1",
    members: [{"name":"John Doe","company":"Acme Ltd","email":"johndoe@gmail.com"}]
  )
  # Operate on share_group
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Share Group

SDK Method

share_group.update

Return Object

ShareGroup

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
notes
string		Additional notes of the share group
name
string		Name of the share group
members
array(object)		A list of share group members.

Example Request

begin
  # Find the share_group object by its id.
  share_group = Files::ShareGroup.find(id)
  share_group.update(
    notes: "This group is defined for testing purposes"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Share Group

SDK Method

share_group.delete

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  # Find the share_group object by its id.
  share_group = Files::ShareGroup.find(id)
  share_group.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ShareGroup Object

Some of the methods above return a ShareGroup object. The attributes of this object are listed below.

AttributeDescription
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
members
array(object)		A list of share group members