Class: DocuSign_eSign::GroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = GroupsApi.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.


54
55
56
# File 'lib/docusign_esign/api/groups_api.rb', line 54

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


52
53
54
# File 'lib/docusign_esign/api/groups_api.rb', line 52

def api_client
  @api_client
end

Instance Method Details

#create_groups(account_id, group_information) ⇒ GroupInformation

Creates one or more groups for the account. Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:


63
64
65
66
# File 'lib/docusign_esign/api/groups_api.rb', line 63

def create_groups(, group_information)
  data, _status_code, _headers = create_groups_with_http_info(,  group_information)
  return data
end

#create_groups_with_http_info(account_id, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>

Creates one or more groups for the account. Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the &#x60;userSettings&#x60; property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:

  • (Array<(GroupInformation, Fixnum, Hash)>)

    GroupInformation data, response status code and response headers


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/docusign_esign/api/groups_api.rb', line 73

def create_groups_with_http_info(, group_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.create_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.create_groups" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(group_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#create_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_brands(account_id, group_id, brands_request) ⇒ BrandsResponse

Deletes brand information from the requested group. Deletes brand information from the requested group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • brands_request (optional parameter)

Returns:


115
116
117
118
# File 'lib/docusign_esign/api/groups_api.rb', line 115

def delete_brands(, group_id, brands_request)
  data, _status_code, _headers = delete_brands_with_http_info(, group_id,  brands_request)
  return data
end

#delete_brands_with_http_info(account_id, group_id, brands_request) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Deletes brand information from the requested group. Deletes brand information from the requested group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • brands_request (optional parameter)

Returns:

  • (Array<(BrandsResponse, Fixnum, Hash)>)

    BrandsResponse data, response status code and response headers


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/docusign_esign/api/groups_api.rb', line 126

def delete_brands_with_http_info(, group_id, brands_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.delete_brands ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_brands" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_brands" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(brands_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_group_users(account_id, group_id, user_info_list) ⇒ UsersResponse

Deletes one or more users from a gro Deletes one or more users from a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • user_info_list (optional parameter)

Returns:


170
171
172
173
# File 'lib/docusign_esign/api/groups_api.rb', line 170

def delete_group_users(, group_id, )
  data, _status_code, _headers = delete_group_users_with_http_info(, group_id,  )
  return data
end

#delete_group_users_with_http_info(account_id, group_id, user_info_list) ⇒ Array<(UsersResponse, Fixnum, Hash)>

Deletes one or more users from a gro Deletes one or more users from a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • user_info_list (optional parameter)

Returns:

  • (Array<(UsersResponse, Fixnum, Hash)>)

    UsersResponse data, response status code and response headers


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
# File 'lib/docusign_esign/api/groups_api.rb', line 181

def delete_group_users_with_http_info(, group_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.delete_group_users ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_group_users" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_group_users" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#delete_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_groups(account_id, group_information) ⇒ GroupInformation

Deletes an existing user group. Deletes an existing user group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:


224
225
226
227
# File 'lib/docusign_esign/api/groups_api.rb', line 224

def delete_groups(, group_information)
  data, _status_code, _headers = delete_groups_with_http_info(,  group_information)
  return data
end

#delete_groups_with_http_info(account_id, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>

Deletes an existing user group. Deletes an existing user group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:

  • (Array<(GroupInformation, Fixnum, Hash)>)

    GroupInformation data, response status code and response headers


234
235
236
237
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
# File 'lib/docusign_esign/api/groups_api.rb', line 234

def delete_groups_with_http_info(, group_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.delete_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_groups" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(group_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#delete_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brands(account_id, group_id) ⇒ BrandsResponse

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

Returns:


275
276
277
278
# File 'lib/docusign_esign/api/groups_api.rb', line 275

def get_brands(, group_id)
  data, _status_code, _headers = get_brands_with_http_info(, group_id)
  return data
end

#get_brands_with_http_info(account_id, group_id) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

Returns:

  • (Array<(BrandsResponse, Fixnum, Hash)>)

    BrandsResponse data, response status code and response headers


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/docusign_esign/api/groups_api.rb', line 285

def get_brands_with_http_info(, group_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.get_brands ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.get_brands" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_brands" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#get_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_group_users(account_id, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default) ⇒ UsersResponse

Gets a list of users in a group. Retrieves a list of users in a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • DocuSign_eSign::ListGroupUsersOptions

    Options for modifying the behavior of the function.

Returns:


329
330
331
332
# File 'lib/docusign_esign/api/groups_api.rb', line 329

def list_group_users(, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default)
  data, _status_code, _headers = list_group_users_with_http_info(, group_id, options)
  return data
end

#list_group_users_with_http_info(account_id, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default) ⇒ Array<(UsersResponse, Fixnum, Hash)>

Gets a list of users in a group. Retrieves a list of users in a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • DocuSign_eSign::ListGroupUsersOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(UsersResponse, Fixnum, Hash)>)

    UsersResponse data, response status code and response headers


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
374
375
376
377
378
# File 'lib/docusign_esign/api/groups_api.rb', line 340

def list_group_users_with_http_info(, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.list_group_users ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.list_group_users" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.list_group_users" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#list_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_groups(account_id, options = DocuSign_eSign::ListGroupsOptions.default) ⇒ GroupInformation

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListGroupsOptions

    Options for modifying the behavior of the function.

Returns:


385
386
387
388
# File 'lib/docusign_esign/api/groups_api.rb', line 385

def list_groups(, options = DocuSign_eSign::ListGroupsOptions.default)
  data, _status_code, _headers = list_groups_with_http_info(, options)
  return data
end

#list_groups_with_http_info(account_id, options = DocuSign_eSign::ListGroupsOptions.default) ⇒ Array<(GroupInformation, Fixnum, Hash)>

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListGroupsOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(GroupInformation, Fixnum, Hash)>)

    GroupInformation data, response status code and response headers


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
# File 'lib/docusign_esign/api/groups_api.rb', line 395

def list_groups_with_http_info(, options = DocuSign_eSign::ListGroupsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.list_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.list_groups" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'group_type'] = options.group_type if !options.group_type.nil?
  query_params[:'include_usercount'] = options.include_usercount if !options.include_usercount.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#list_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brands(account_id, group_id, brands_request) ⇒ BrandsResponse

Adds group brand ID information to a group. Adds group brand ID information to a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • brands_request (optional parameter)

Returns:


442
443
444
445
# File 'lib/docusign_esign/api/groups_api.rb', line 442

def update_brands(, group_id, brands_request)
  data, _status_code, _headers = update_brands_with_http_info(, group_id,  brands_request)
  return data
end

#update_brands_with_http_info(account_id, group_id, brands_request) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Adds group brand ID information to a group. Adds group brand ID information to a group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • brands_request (optional parameter)

Returns:

  • (Array<(BrandsResponse, Fixnum, Hash)>)

    BrandsResponse data, response status code and response headers


453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/docusign_esign/api/groups_api.rb', line 453

def update_brands_with_http_info(, group_id, brands_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.update_brands ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_brands" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.update_brands" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(brands_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#update_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_group_users(account_id, group_id, user_info_list) ⇒ UsersResponse

Adds one or more users to an existing group. Adds one or more users to an existing group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • user_info_list (optional parameter)

Returns:


497
498
499
500
# File 'lib/docusign_esign/api/groups_api.rb', line 497

def update_group_users(, group_id, )
  data, _status_code, _headers = update_group_users_with_http_info(, group_id,  )
  return data
end

#update_group_users_with_http_info(account_id, group_id, user_info_list) ⇒ Array<(UsersResponse, Fixnum, Hash)>

Adds one or more users to an existing group. Adds one or more users to an existing group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_id

    The ID of the group being accessed.

  • user_info_list (optional parameter)

Returns:

  • (Array<(UsersResponse, Fixnum, Hash)>)

    UsersResponse data, response status code and response headers


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
# File 'lib/docusign_esign/api/groups_api.rb', line 508

def update_group_users_with_http_info(, group_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.update_group_users ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_group_users" if .nil?
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.update_group_users" if group_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#update_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_groups(account_id, group_information) ⇒ GroupInformation

Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:


551
552
553
554
# File 'lib/docusign_esign/api/groups_api.rb', line 551

def update_groups(, group_information)
  data, _status_code, _headers = update_groups_with_http_info(,  group_information)
  return data
end

#update_groups_with_http_info(account_id, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>

Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • group_information (optional parameter)

Returns:

  • (Array<(GroupInformation, Fixnum, Hash)>)

    GroupInformation data, response status code and response headers


561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/docusign_esign/api/groups_api.rb', line 561

def update_groups_with_http_info(, group_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.update_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_groups" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(group_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#update_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end