Class: Fastly::IamUserGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/iam_user_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IamUserGroupsApi

Returns a new instance of IamUserGroupsApi.



17
18
19
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_a_user_group(opts = {}) ⇒ nil

Delete a user group Delete a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (nil) 


24
25
26
27
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 24

def delete_a_user_group(opts = {})
  delete_a_user_group_with_http_info(opts)
  nil
end

#delete_a_user_group_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a user group Delete a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 33

def delete_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.delete_a_user_group ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.delete_a_user_group"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.delete_a_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#delete_a_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_user_group(opts = {}) ⇒ Object

Get a user group Get a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (Object) 


85
86
87
88
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 85

def get_a_user_group(opts = {})
  data, _status_code, _headers = get_a_user_group_with_http_info(opts)
  data
end

#get_a_user_group_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get a user group Get a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 94

def get_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.get_a_user_group ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.get_a_user_group"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.get_a_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#get_a_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_group_members(opts = {}) ⇒ Object

List members of a user group List members of a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


150
151
152
153
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 150

def list_user_group_members(opts = {})
  data, _status_code, _headers = list_user_group_members_with_http_info(opts)
  data
end

#list_user_group_members_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List members of a user group List members of a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 161

def list_user_group_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_members ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_members"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_members, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_members, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user-groups/{user_group_id}/members'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.list_user_group_members",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#list_user_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_group_roles(opts = {}) ⇒ Object

List roles in a user group List roles in a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


227
228
229
230
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 227

def list_user_group_roles(opts = {})
  data, _status_code, _headers = list_user_group_roles_with_http_info(opts)
  data
end

#list_user_group_roles_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List roles in a user group List roles in a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 238

def list_user_group_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_roles ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_roles"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_roles, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_roles, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user-groups/{user_group_id}/roles'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.list_user_group_roles",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#list_user_group_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_group_service_groups(opts = {}) ⇒ Object

List service groups in a user group List service groups in a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


304
305
306
307
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 304

def list_user_group_service_groups(opts = {})
  data, _status_code, _headers = list_user_group_service_groups_with_http_info(opts)
  data
end

#list_user_group_service_groups_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List service groups in a user group List service groups in a user group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 315

def list_user_group_service_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_service_groups ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_service_groups"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_service_groups, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_service_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user-groups/{user_group_id}/service-groups'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.list_user_group_service_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#list_user_group_service_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_groups(opts = {}) ⇒ Object

List user groups List all user groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


380
381
382
383
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 380

def list_user_groups(opts = {})
  data, _status_code, _headers = list_user_groups_with_http_info(opts)
  data
end

#list_user_groups_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List user groups List all user groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 390

def list_user_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_groups ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_groups, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user-groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"IamUserGroupsApi.list_user_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IamUserGroupsApi#list_user_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end