Class: DocuSign_Rooms::FormGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/form_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = FormGroupsApi.default) ⇒ FormGroupsApi

Returns a new instance of FormGroupsApi.



32
33
34
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 32

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



30
31
32
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 30

def api_client
  @api_client
end

Instance Method Details

#assign_form_group_form(form_group_id, account_id, body) ⇒ FormGroupFormToAssign

Assigns a form to a form group. Assigns the form specified in the ‘formId` property of the request to the form group `formGroupId`.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Assigns the form specified in the ‘formId` property of the request to the form group `formGroupId`. (optional parameter)

Returns:



42
43
44
45
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 42

def assign_form_group_form(form_group_id, , body)
  data, _status_code, _headers = assign_form_group_form_with_http_info(form_group_id, ,  body)
  return data
end

#assign_form_group_form_with_http_info(form_group_id, account_id, body) ⇒ Array<(FormGroupFormToAssign, Fixnum, Hash)>

Assigns a form to a form group. Assigns the form specified in the &#x60;formId&#x60; property of the request to the form group &#x60;formGroupId&#x60;.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Assigns the form specified in the ‘formId` property of the request to the form group `formGroupId`. (optional parameter)

Returns:

  • (Array<(FormGroupFormToAssign, Fixnum, Hash)>) —

    FormGroupFormToAssign data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 53

def assign_form_group_form_with_http_info(form_group_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.assign_form_group_form ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.assign_form_group_form" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.assign_form_group_form" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/assign_form".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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 => 'FormGroupFormToAssign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#assign_form_group_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_form_group(account_id, body) ⇒ FormGroup

Creates a form group. Creates a new form group with the name given in the ‘name` property of the request body.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Required input of name for the form group (optional parameter)

Returns:



98
99
100
101
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 98

def create_form_group(, body)
  data, _status_code, _headers = create_form_group_with_http_info(,  body)
  return data
end

#create_form_group_with_http_info(account_id, body) ⇒ Array<(FormGroup, Fixnum, Hash)>

Creates a form group. Creates a new form group with the name given in the &#x60;name&#x60; property of the request body.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Required input of name for the form group (optional parameter)

Returns:

  • (Array<(FormGroup, Fixnum, Hash)>) —

    FormGroup data, response status code and response headers



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
143
144
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 108

def create_form_group_with_http_info(, body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.create_form_group ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.create_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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 => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#create_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_form_group(form_group_id, account_id) ⇒ nil

Deletes a form group. Deletes the specified form group.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


151
152
153
154
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 151

def delete_form_group(form_group_id, )
  delete_form_group_with_http_info(form_group_id, )
  return nil
end

#delete_form_group_with_http_info(form_group_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a form group. Deletes the specified form group.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, 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
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 161

def delete_form_group_with_http_info(form_group_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.delete_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.delete_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.delete_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#delete_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_form_group(form_group_id, account_id) ⇒ FormGroup

Gets a form group. Get the specified form group.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



205
206
207
208
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 205

def get_form_group(form_group_id, )
  data, _status_code, _headers = get_form_group_with_http_info(form_group_id, )
  return data
end

#get_form_group_with_http_info(form_group_id, account_id) ⇒ Array<(FormGroup, Fixnum, Hash)>

Gets a form group. Get the specified form group.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (Array<(FormGroup, Fixnum, Hash)>) —

    FormGroup data, response status code and response headers



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 215

def get_form_group_with_http_info(form_group_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.get_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.get_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.get_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', '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 => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#get_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_form_groups(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default) ⇒ FormGroupSummaryList

Get account Form Groups. Returns the company form groups to which the current user has access.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormGroupsOptions —

    Options for modifying the behavior of the function.

Returns:



260
261
262
263
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 260

def get_form_groups(, options = DocuSign_Rooms::GetFormGroupsOptions.default)
  data, _status_code, _headers = get_form_groups_with_http_info(, options)
  return data
end

#get_form_groups_with_http_info(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default) ⇒ Array<(FormGroupSummaryList, Fixnum, Hash)>

Get account Form Groups. Returns the company form groups to which the current user has access.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormGroupsOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(FormGroupSummaryList, Fixnum, Hash)>) —

    FormGroupSummaryList data, response status code and response headers



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
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 270

def get_form_groups_with_http_info(, options = DocuSign_Rooms::GetFormGroupsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.get_form_groups ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.get_form_groups" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = 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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', '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 => 'FormGroupSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#get_form_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#grant_office_access_to_form_group(form_group_id, office_id, account_id) ⇒ nil

Assign office to a form group so the specified office has access to the form group. "Grants the office ‘officeId` access to the form group `formGroupId`.

Parameters:

  • form_group_id —

    The ID of the form group.

  • office_id —

    The id of the office. This is the id that the system generated when you created the office.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


316
317
318
319
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 316

def grant_office_access_to_form_group(form_group_id, office_id, )
  grant_office_access_to_form_group_with_http_info(form_group_id, office_id, )
  return nil
end

#grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Assign office to a form group so the specified office has access to the form group. &quot;Grants the office &#x60;officeId&#x60; access to the form group &#x60;formGroupId&#x60;.

Parameters:

  • form_group_id —

    The ID of the form group.

  • office_id —

    The id of the office. This is the id that the system generated when you created the office.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 327

def grant_office_access_to_form_group_with_http_info(form_group_id, office_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.grant_office_access_to_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.grant_office_access_to_form_group" if form_group_id.nil?
  # verify the required parameter 'office_id' is set
  fail ArgumentError, "Missing the required parameter 'office_id' when calling FormGroupsApi.grant_office_access_to_form_group" if office_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.grant_office_access_to_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/grant_office_access/{officeId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'officeId' + '}', office_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#grant_office_access_to_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_form_group_form(form_group_id, form_id, account_id) ⇒ nil

Removes a form from a form group. Removes the form ‘formId` from the form group `formGroupId`.

Parameters:

  • form_group_id —

    The ID of the form group.

  • form_id —

    The id of the form.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


374
375
376
377
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 374

def remove_form_group_form(form_group_id, form_id, )
  remove_form_group_form_with_http_info(form_group_id, form_id, )
  return nil
end

#remove_form_group_form_with_http_info(form_group_id, form_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Removes a form from a form group. Removes the form &#x60;formId&#x60; from the form group &#x60;formGroupId&#x60;.

Parameters:

  • form_group_id —

    The ID of the form group.

  • form_id —

    The id of the form.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, response status code and response headers



385
386
387
388
389
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
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 385

def remove_form_group_form_with_http_info(form_group_id, form_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.remove_form_group_form ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.remove_form_group_form" if form_group_id.nil?
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling FormGroupsApi.remove_form_group_form" if form_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.remove_form_group_form" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/unassign_form/{formId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'formId' + '}', form_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#remove_form_group_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rename_form_group(form_group_id, account_id, body) ⇒ FormGroup

Renames a form group. Renames the specified form group with the name given in the ‘name` property of the request.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Required input of name for the form group (optional parameter)

Returns:



432
433
434
435
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 432

def rename_form_group(form_group_id, , body)
  data, _status_code, _headers = rename_form_group_with_http_info(form_group_id, ,  body)
  return data
end

#rename_form_group_with_http_info(form_group_id, account_id, body) ⇒ Array<(FormGroup, Fixnum, Hash)>

Renames a form group. Renames the specified form group with the name given in the &#x60;name&#x60; property of the request.

Parameters:

  • form_group_id —

    The ID of the form group.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Required input of name for the form group (optional parameter)

Returns:

  • (Array<(FormGroup, Fixnum, Hash)>) —

    FormGroup data, response status code and response headers



443
444
445
446
447
448
449
450
451
452
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
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 443

def rename_form_group_with_http_info(form_group_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.rename_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.rename_form_group" if form_group_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.rename_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'FormGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#rename_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_office_access_from_form_group(form_group_id, office_id, account_id) ⇒ nil

Remove office to a form group so the specified office doesn’t have access to the form group. Revoke access to the form group ‘formGroupId` from the office `officeId`.

Parameters:

  • form_group_id —

    The ID of the form group.

  • office_id —

    The id of the office. This is the id that the system generated when you created the office.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


489
490
491
492
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 489

def revoke_office_access_from_form_group(form_group_id, office_id, )
  revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, )
  return nil
end

#revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Remove office to a form group so the specified office doesn&#39;t have access to the form group. Revoke access to the form group &#x60;formGroupId&#x60; from the office &#x60;officeId&#x60;.

Parameters:

  • form_group_id —

    The ID of the form group.

  • office_id —

    The id of the office. This is the id that the system generated when you created the office.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, response status code and response headers



500
501
502
503
504
505
506
507
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
 
# File 'lib/docusign_rooms/api/form_groups_api.rb', line 500

def revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormGroupsApi.revoke_office_access_from_form_group ..."
  end
  # verify the required parameter 'form_group_id' is set
  fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if form_group_id.nil?
  # verify the required parameter 'office_id' is set
  fail ArgumentError, "Missing the required parameter 'office_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if office_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupsApi.revoke_office_access_from_form_group" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/revoke_office_access/{officeId}".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'officeId' + '}', office_id.to_s).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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormGroupsApi#revoke_office_access_from_form_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end