Class: DocuSign_Admin::ProvisionAssetGroupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/provision_asset_group_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ProvisionAssetGroupApi.default) ⇒ ProvisionAssetGroupApi



71
72
73
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 71

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



69
70
71
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 69

def api_client
  @api_client
end

Instance Method Details

#clone_asset_group_account(organization_id, request) ⇒ AssetGroupAccountClone

Clones an existing Docusign account to a new Docusign account. Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write



80
81
82
83
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 80

def (organization_id, request)
  data, _status_code, _headers = (organization_id,  request)
  return data
end

#clone_asset_group_account_with_http_info(organization_id, request) ⇒ Array<(AssetGroupAccountClone, Fixnum, Hash)>

Clones an existing Docusign account to a new Docusign account. Currently this only clones eSign settings and asset group information. Required scopes: asset_group_account_clone_write



90
91
92
93
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
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 90

def (organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.clone_asset_group_account ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.clone_asset_group_account" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling ProvisionAssetGroupApi.clone_asset_group_account" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountClone".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#create_asset_group_account(organization_id, request) ⇒ SubscriptionProvisionModelAssetGroupWorkResult

Creates a new Docusign account using the plan and modules specified in request body. Currently this only supports eSign plans and modules. Required scopes: organization_sub_account_write



135
136
137
138
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 135

def (organization_id, request)
  data, _status_code, _headers = (organization_id,  request)
  return data
end

#create_asset_group_account_with_http_info(organization_id, request) ⇒ Array<(SubscriptionProvisionModelAssetGroupWorkResult, Fixnum, Hash)>

Creates a new Docusign account using the plan and modules specified in request body. Currently this only supports eSign plans and modules. Required scopes: organization_sub_account_write



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 145

def (organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.create_asset_group_account ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.create_asset_group_account" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling ProvisionAssetGroupApi.create_asset_group_account" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountCreate".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_asset_group_account_clone(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default) ⇒ AssetGroupAccountClone

Gets an asset group account clone by the asset group work id. Required scopes: asset_group_account_clone_read



192
193
194
195
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 192

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default)
  data, _status_code, _headers = (organization_id, asset_group_id, asset_group_work_id, options)
  return data
end

#get_asset_group_account_clone_with_http_info(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default) ⇒ Array<(AssetGroupAccountClone, Fixnum, Hash)>

Gets an asset group account clone by the asset group work id. Required scopes: asset_group_account_clone_read



204
205
206
207
208
209
210
211
212
213
214
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
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 204

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetAssetGroupAccountCloneOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_account_clone ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if organization_id.nil?
  # verify the required parameter 'asset_group_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if asset_group_id.nil?
  # verify the required parameter 'asset_group_work_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_work_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clone" if asset_group_work_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroups/{assetGroupId}/accountClones/{assetGroupWorkId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'assetGroupId' + '}', asset_group_id.to_s).sub('{' + 'assetGroupWorkId' + '}', asset_group_work_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'AssetGroupAccountClone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_account_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_group_account_clones_by_org_id(organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default) ⇒ AssetGroupAccountClones

Gets all asset group account clone(s) for an organization id. Required scopes: asset_group_account_clone_read



252
253
254
255
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 252

def (organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default)
  data, _status_code, _headers = (organization_id, options)
  return data
end

#get_asset_group_account_clones_by_org_id_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default) ⇒ Array<(AssetGroupAccountClones, Fixnum, Hash)>

Gets all asset group account clone(s) for an organization id. Required scopes: asset_group_account_clone_read



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
297
298
299
300
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 262

def (organization_id, options = DocuSign_Admin::GetAssetGroupAccountClonesByOrgIdOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_account_clones_by_org_id ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_account_clones_by_org_id" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroups/accountClones".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'AssetGroupAccountClones')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_account_clones_by_org_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_group_accounts(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default) ⇒ AssetGroupAccountsResponse

Get all accounts in asset groups for the organization. Required scopes: asset_group_account_read



307
308
309
310
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 307

def get_asset_group_accounts(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default)
  data, _status_code, _headers = get_asset_group_accounts_with_http_info(organization_id, options)
  return data
end

#get_asset_group_accounts_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default) ⇒ Array<(AssetGroupAccountsResponse, Fixnum, Hash)>

Get all accounts in asset groups for the organization. Required scopes: asset_group_account_read



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
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 317

def get_asset_group_accounts_with_http_info(organization_id, options = DocuSign_Admin::GetAssetGroupAccountsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_asset_group_accounts ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_asset_group_accounts" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroups/accounts".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'AssetGroupAccountsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_asset_group_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_plan_items(organization_id) ⇒ Array<OrganizationSubscriptionResponse>

Gets the subscription details for an organization id. Currently charges and non e-sign assets are excluded in the response. Required scopes: organization_sub_account_read



360
361
362
363
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 360

def get_organization_plan_items(organization_id)
  data, _status_code, _headers = get_organization_plan_items_with_http_info(organization_id)
  return data
end

#get_organization_plan_items_with_http_info(organization_id) ⇒ Array<(Array<OrganizationSubscriptionResponse>, Fixnum, Hash)>

Gets the subscription details for an organization id. Currently charges and non e-sign assets are excluded in the response. Required scopes: organization_sub_account_read



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 369

def get_organization_plan_items_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_organization_plan_items ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_organization_plan_items" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/planItems".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'Array<OrganizationSubscriptionResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_organization_plan_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sub_account_create_process_by_asset_group_work_id(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default) ⇒ SubAccountCreateWorker

Gets an asset group account create process info by the asset group work id. Required scopes: organization_sub_account_read



414
415
416
417
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 414

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default)
  data, _status_code, _headers = (organization_id, asset_group_id, asset_group_work_id, options)
  return data
end

#get_sub_account_create_process_by_asset_group_work_id_with_http_info(organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default) ⇒ Array<(SubAccountCreateWorker, Fixnum, Hash)>

Gets an asset group account create process info by the asset group work id. Required scopes: organization_sub_account_read



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
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
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 426

def (organization_id, asset_group_id, asset_group_work_id, options = DocuSign_Admin::GetSubAccountCreateProcessByAssetGroupWorkIdOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if organization_id.nil?
  # verify the required parameter 'asset_group_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if asset_group_id.nil?
  # verify the required parameter 'asset_group_work_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_group_work_id' when calling ProvisionAssetGroupApi.get_sub_account_create_process_by_asset_group_work_id" if asset_group_work_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/assetGroup/{assetGroupId}/subAccountCreated/{assetGroupWorkId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'assetGroupId' + '}', asset_group_id.to_s).sub('{' + 'assetGroupWorkId' + '}', asset_group_work_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'SubAccountCreateWorker')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_sub_account_create_process_by_asset_group_work_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sub_account_create_processes_by_org_id(organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default) ⇒ SubAccountCreateWorkerResponse

Gets all asset group account creation processes for an organization id. Required scopes: organization_sub_account_read



474
475
476
477
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 474

def (organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default)
  data, _status_code, _headers = (organization_id, options)
  return data
end

#get_sub_account_create_processes_by_org_id_with_http_info(organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default) ⇒ Array<(SubAccountCreateWorkerResponse, Fixnum, Hash)>

Gets all asset group account creation processes for an organization id. Required scopes: organization_sub_account_read



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'lib/docusign_admin/api/provision_asset_group_api.rb', line 484

def (organization_id, options = DocuSign_Admin::GetSubAccountCreateProcessesByOrgIdOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProvisionAssetGroupApi.get_sub_account_create_processes_by_org_id ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProvisionAssetGroupApi.get_sub_account_create_processes_by_org_id" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/subAccountsCreated".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'SubAccountCreateWorkerResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvisionAssetGroupApi#get_sub_account_create_processes_by_org_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end