Class: Files::Group

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Group.



7
8
9
10
 
# File 'lib/files.com/models/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/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/group.rb', line 5

def options
  @options
end

Class Method Details

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



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

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

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

Parameters:

notes - string - Group notes.
user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
name (required) - string - Group name.

Raises:



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/files.com/models/group.rb', line 212

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]

  response, options = Api.send_request("/groups", :post, params, options)
  Group.new(response.data, options)
end

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

Raises:



249
250
251
252
253
254
255
256
257
 
# File 'lib/files.com/models/group.rb', line 249

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("/groups/#{params[:id]}", :delete, params, options)
  nil
end

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



259
260
261
262
 
# File 'lib/files.com/models/group.rb', line 259

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

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

Parameters:

id (required) - int64 - Group ID.

Raises:



188
189
190
191
192
193
194
195
196
 
# File 'lib/files.com/models/group.rb', line 188

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("/groups/#{params[:id]}", :get, params, options)
  Group.new(response.data, options)
end

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



198
199
200
 
# File 'lib/files.com/models/group.rb', line 198

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

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

Parameters:

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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
ids - string - Comma-separated list of group ids to include in results.

Raises:



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

def self.list(params = {}, options = {})
  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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: ids must be an String") if params[:ids] and !params[:ids].is_a?(String)

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

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

Parameters:

notes - string - Group notes.
user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
name - string - Group name.

Raises:



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/files.com/models/group.rb', line 234

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: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/groups/#{params[:id]}", :patch, params, options)
  Group.new(response.data, options)
end

Instance Method Details

#admin_ids ⇒ Object

string - Comma-delimited list of user IDs who are group administrators (separated by commas)



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

def admin_ids
  @attributes[:admin_ids]
end

#admin_ids=(value) ⇒ Object 



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

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

#allowed_ips ⇒ Object

string - A list of allowed IPs if applicable. Newline delimited



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

def allowed_ips
  @attributes[:allowed_ips]
end

#allowed_ips=(value) ⇒ Object 



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

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

#dav_permission ⇒ Object

boolean - If true, users in this group can use WebDAV to login. This will override a false value of ‘dav_permission` on the user level.



94
95
96
 
# File 'lib/files.com/models/group.rb', line 94

def dav_permission
  @attributes[:dav_permission]
end

#dav_permission=(value) ⇒ Object 



98
99
100
 
# File 'lib/files.com/models/group.rb', line 98

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

#delete(params = {}) ⇒ Object

Raises:



136
137
138
139
140
141
142
143
144
 
# File 'lib/files.com/models/group.rb', line 136

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("/groups/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



146
147
148
149
 
# File 'lib/files.com/models/group.rb', line 146

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

#ftp_permission ⇒ Object

boolean - If true, users in this group can use FTP to login. This will override a false value of ‘ftp_permission` on the user level.



76
77
78
 
# File 'lib/files.com/models/group.rb', line 76

def ftp_permission
  @attributes[:ftp_permission]
end

#ftp_permission=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/group.rb', line 80

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

#id ⇒ Object

int64 - Group ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#name ⇒ Object

string - Group name



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



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

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

#notes ⇒ Object

string - Notes about this group



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

def notes
  @attributes[:notes]
end

#notes=(value) ⇒ Object 



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

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

#restapi_permission ⇒ Object

boolean - If true, users in this group can use the REST API to login. This will override a false value of ‘restapi_permission` on the user level.



103
104
105
 
# File 'lib/files.com/models/group.rb', line 103

def restapi_permission
  @attributes[:restapi_permission]
end

#restapi_permission=(value) ⇒ Object 



107
108
109
 
# File 'lib/files.com/models/group.rb', line 107

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

#save ⇒ Object 



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/files.com/models/group.rb', line 151

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

  @attributes = new_obj.attributes
  true
end

#sftp_permission ⇒ Object

boolean - If true, users in this group can use SFTP to login. This will override a false value of ‘sftp_permission` on the user level.



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

def sftp_permission
  @attributes[:sftp_permission]
end

#sftp_permission=(value) ⇒ Object 



89
90
91
 
# File 'lib/files.com/models/group.rb', line 89

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

#update(params = {}) ⇒ Object

Parameters:

notes - string - Group notes.
user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
name - string - Group name.

Raises:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/files.com/models/group.rb', line 121

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: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/groups/#{@attributes[:id]}", :patch, params, @options)
end

#user_ids ⇒ Object

string - Comma-delimited list of user IDs who belong to this group (separated by commas)



58
59
60
 
# File 'lib/files.com/models/group.rb', line 58

def user_ids
  @attributes[:user_ids]
end

#user_ids=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/group.rb', line 62

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

#usernames ⇒ Object

string - Comma-delimited list of usernames who belong to this group (separated by commas)



67
68
69
 
# File 'lib/files.com/models/group.rb', line 67

def usernames
  @attributes[:usernames]
end

#usernames=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/group.rb', line 71

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