Class: Files::ShareGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/share_group.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ ShareGroup

Returns a new instance of ShareGroup.



7
8
9
10
 
# File 'lib/files.com/models/share_group.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/share_group.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/share_group.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



118
119
120
 
# File 'lib/files.com/models/share_group.rb', line 118

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

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.

Raises:



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/files.com/models/share_group.rb', line 143

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

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



172
173
174
175
176
177
178
179
180
 
# File 'lib/files.com/models/share_group.rb', line 172

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]

  Api.send_request("/share_groups/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



182
183
184
185
 
# File 'lib/files.com/models/share_group.rb', line 182

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Share Group ID.

Raises:



124
125
126
127
128
129
130
131
132
 
# File 'lib/files.com/models/share_group.rb', line 124

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

.get(id, params = {}, options = {}) ⇒ Object 



134
135
136
 
# File 'lib/files.com/models/share_group.rb', line 134

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

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).
action - string
page - int64

Raises:



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/files.com/models/share_group.rb', line 106

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)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)

  List.new(ShareGroup, params) do
    Api.send_request("/share_groups", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

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.

Raises:



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/files.com/models/share_group.rb', line 159

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

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



74
75
76
77
78
79
80
81
82
 
# File 'lib/files.com/models/share_group.rb', line 74

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

#destroy(params = {}) ⇒ Object 



84
85
86
87
 
# File 'lib/files.com/models/share_group.rb', line 84

def destroy(params = {})
  delete(params)
  nil
end

#id ⇒ Object

int64 - Share Group ID



13
14
15
 
# File 'lib/files.com/models/share_group.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/share_group.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#members ⇒ Object

array(object) - A list of share group members



49
50
51
 
# File 'lib/files.com/models/share_group.rb', line 49

def members
  @attributes[:members]
end

#members=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/share_group.rb', line 53

def members=(value)
  @attributes[:members] = value
end

#name ⇒ Object

string - Name of the share group



22
23
24
 
# File 'lib/files.com/models/share_group.rb', line 22

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/share_group.rb', line 26

def name=(value)
  @attributes[:name] = value
end

#notes ⇒ Object

string - Additional notes of the share group



31
32
33
 
# File 'lib/files.com/models/share_group.rb', line 31

def notes
  @attributes[:notes]
end

#notes=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/share_group.rb', line 35

def notes=(value)
  @attributes[:notes] = value
end

#save ⇒ Object 



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/files.com/models/share_group.rb', line 89

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = ShareGroup.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

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.

Raises:



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/files.com/models/share_group.rb', line 61

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

#user_id ⇒ Object

int64 - Owner User ID



40
41
42
 
# File 'lib/files.com/models/share_group.rb', line 40

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/share_group.rb', line 44

def user_id=(value)
  @attributes[:user_id] = value
end