Class: DocuSign_Admin::OrgConnectApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = OrgConnectApi.default) ⇒ OrgConnectApi

Returns a new instance of OrgConnectApi.



41
42
43
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 41

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



39
40
41
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 39

def api_client
  @api_client
end

Instance Method Details

#create_organization_connect_config(organization_id, connect_request) ⇒ OrganizationConnectConfigurationDetailsResponse

Adds a Connect configuration for an organization Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_request —

    Add an organization Connect request

Returns:



50
51
52
53
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 50

def create_organization_connect_config(organization_id, connect_request)
  data, _status_code, _headers = create_organization_connect_config_with_http_info(organization_id,  connect_request)
  return data
end

#create_organization_connect_config_with_http_info(organization_id, connect_request) ⇒ Array<(OrganizationConnectConfigurationDetailsResponse, Fixnum, Hash)>

Adds a Connect configuration for an organization Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_request —

    Add an organization Connect request

Returns:



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
92
93
94
95
96
97
98
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 60

def create_organization_connect_config_with_http_info(organization_id, connect_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.create_organization_connect_config ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.create_organization_connect_config" if organization_id.nil?
  # verify the required parameter 'connect_request' is set
  fail ArgumentError, "Missing the required parameter 'connect_request' when calling OrgConnectApi.create_organization_connect_config" if connect_request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect".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(connect_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 => 'OrganizationConnectConfigurationDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#create_organization_connect_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_connect_hmac_secret(organization_id, key_id) ⇒ OrganizationConnectHmacSecretsResponse

Deletes information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • key_id —

    The key ID Guid

Returns:



105
106
107
108
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 105

def delete_connect_hmac_secret(organization_id, key_id)
  data, _status_code, _headers = delete_connect_hmac_secret_with_http_info(organization_id, key_id)
  return data
end

#delete_connect_hmac_secret_with_http_info(organization_id, key_id) ⇒ Array<(OrganizationConnectHmacSecretsResponse, Fixnum, Hash)>

Deletes information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • key_id —

    The key ID Guid

Returns:



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
145
146
147
148
149
150
151
152
153
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 115

def delete_connect_hmac_secret_with_http_info(organization_id, key_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.delete_connect_hmac_secret ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.delete_connect_hmac_secret" if organization_id.nil?
  # verify the required parameter 'key_id' is set
  fail ArgumentError, "Missing the required parameter 'key_id' when calling OrgConnectApi.delete_connect_hmac_secret" if key_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/secret/{keyId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'keyId' + '}', key_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(: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 => 'OrganizationConnectHmacSecretsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#delete_connect_hmac_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_organization_connect_config(organization_id, connect_id) ⇒ Object

Deletes information about an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

Returns:

  • (Object) 


160
161
162
163
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 160

def delete_organization_connect_config(organization_id, connect_id)
  data, _status_code, _headers = delete_organization_connect_config_with_http_info(organization_id, connect_id)
  return data
end

#delete_organization_connect_config_with_http_info(organization_id, connect_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes information about an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

Returns:

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

    Object data, response status code and response headers



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

def delete_organization_connect_config_with_http_info(organization_id, connect_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.delete_organization_connect_config ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.delete_organization_connect_config" if organization_id.nil?
  # verify the required parameter 'connect_id' is set
  fail ArgumentError, "Missing the required parameter 'connect_id' when calling OrgConnectApi.delete_organization_connect_config" if connect_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/{connectId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'connectId' + '}', connect_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(: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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#delete_organization_connect_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_organization_connect_o_auth_configuration(organization_id) ⇒ Object

Deletes an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:

  • (Object) 


214
215
216
217
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 214

def delete_organization_connect_o_auth_configuration(organization_id)
  data, _status_code, _headers = delete_organization_connect_o_auth_configuration_with_http_info(organization_id)
  return data
end

#delete_organization_connect_o_auth_configuration_with_http_info(organization_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:

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

    Object data, response status code and response headers



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
254
255
256
257
258
259
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 223

def delete_organization_connect_o_auth_configuration_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.delete_organization_connect_o_auth_configuration ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.delete_organization_connect_o_auth_configuration" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/oauth".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(: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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#delete_organization_connect_o_auth_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_connect_hmac_secrets(organization_id) ⇒ OrganizationConnectHmacSecretsResponse

Returns information about Connect HMAC secrets Required scopes: connect_org_hmac_read_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



265
266
267
268
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 265

def get_connect_hmac_secrets(organization_id)
  data, _status_code, _headers = get_connect_hmac_secrets_with_http_info(organization_id)
  return data
end

#get_connect_hmac_secrets_with_http_info(organization_id) ⇒ Array<(OrganizationConnectHmacSecretsResponse, Fixnum, Hash)>

Returns information about Connect HMAC secrets Required scopes: connect_org_hmac_read_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



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
309
310
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 274

def get_connect_hmac_secrets_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.get_connect_hmac_secrets ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.get_connect_hmac_secrets" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/secret".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 => 'OrganizationConnectHmacSecretsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#get_connect_hmac_secrets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_connect_config(organization_id, connect_id) ⇒ OrganizationConnectConfigurationDetailsResponse

Returns an organization-level Connect configuration Required scopes: connect_org_config_read_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

Returns:



317
318
319
320
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 317

def get_organization_connect_config(organization_id, connect_id)
  data, _status_code, _headers = get_organization_connect_config_with_http_info(organization_id, connect_id)
  return data
end

#get_organization_connect_config_with_http_info(organization_id, connect_id) ⇒ Array<(OrganizationConnectConfigurationDetailsResponse, Fixnum, Hash)>

Returns an organization-level Connect configuration Required scopes: connect_org_config_read_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

Returns:



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

def get_organization_connect_config_with_http_info(organization_id, connect_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.get_organization_connect_config ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.get_organization_connect_config" if organization_id.nil?
  # verify the required parameter 'connect_id' is set
  fail ArgumentError, "Missing the required parameter 'connect_id' when calling OrgConnectApi.get_organization_connect_config" if connect_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/{connectId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'connectId' + '}', connect_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 => 'OrganizationConnectConfigurationDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#get_organization_connect_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_connect_configs(organization_id, options = DocuSign_Admin::GetOrganizationConnectConfigsOptions.default) ⇒ OrganizationConnectConfigsResponse

Returns a list of Connect configurations under an organization Required scopes: connect_org_config_read_api

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetOrganizationConnectConfigsOptions —

    Options for modifying the behavior of the function.

Returns:



372
373
374
375
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 372

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

#get_organization_connect_configs_with_http_info(organization_id, options = DocuSign_Admin::GetOrganizationConnectConfigsOptions.default) ⇒ Array<(OrganizationConnectConfigsResponse, Fixnum, Hash)>

Returns a list of Connect configurations under an organization Required scopes: connect_org_config_read_api

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetOrganizationConnectConfigsOptions —

    Options for modifying the behavior of the function.

Returns:



382
383
384
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
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 382

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

  # query parameters
  query_params = {}
  query_params[:'sortBy'] = options.sort_by if !options.sort_by.nil?
  query_params[:'siteId'] = options.site_id if !options.site_id.nil?
  query_params[:'accountId'] = options. if !options..nil?
  query_params[:'allowEnvelopePublish'] = options.allow_envelope_publish if !options.allow_envelope_publish.nil?
  query_params[:'q'] = options.q if !options.q.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 => 'OrganizationConnectConfigsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#get_organization_connect_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_connect_o_auth_configuration(organization_id) ⇒ Object

Returns information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_read_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:

  • (Object) 


429
430
431
432
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 429

def get_organization_connect_o_auth_configuration(organization_id)
  data, _status_code, _headers = get_organization_connect_o_auth_configuration_with_http_info(organization_id)
  return data
end

#get_organization_connect_o_auth_configuration_with_http_info(organization_id) ⇒ Array<(Object, Fixnum, Hash)>

Returns information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_read_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:

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

    Object data, response status code and response headers



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
468
469
470
471
472
473
474
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 438

def get_organization_connect_o_auth_configuration_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.get_organization_connect_o_auth_configuration ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.get_organization_connect_o_auth_configuration" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/oauth".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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#get_organization_connect_o_auth_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_connect_hmac_secret(organization_id) ⇒ OrganizationConnectHmacSecretsResponse

Saves information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



480
481
482
483
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 480

def post_connect_hmac_secret(organization_id)
  data, _status_code, _headers = post_connect_hmac_secret_with_http_info(organization_id)
  return data
end

#post_connect_hmac_secret_with_http_info(organization_id) ⇒ Array<(OrganizationConnectHmacSecretsResponse, Fixnum, Hash)>

Saves information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



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
523
524
525
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 489

def post_connect_hmac_secret_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.post_connect_hmac_secret ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.post_connect_hmac_secret" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/secret".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(: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 => 'OrganizationConnectHmacSecretsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#post_connect_hmac_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_organization_connect_o_auth_configuration(organization_id, configuration) ⇒ OrganizationConnectOAuthConfiguration

Saves information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • configuration —

    Add an organization-level Connect OAuth configuration

Returns:



532
533
534
535
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 532

def post_organization_connect_o_auth_configuration(organization_id, configuration)
  data, _status_code, _headers = post_organization_connect_o_auth_configuration_with_http_info(organization_id,  configuration)
  return data
end

#post_organization_connect_o_auth_configuration_with_http_info(organization_id, configuration) ⇒ Array<(OrganizationConnectOAuthConfiguration, Fixnum, Hash)>

Saves information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • configuration —

    Add an organization-level Connect OAuth configuration

Returns:



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 542

def post_organization_connect_o_auth_configuration_with_http_info(organization_id, configuration)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.post_organization_connect_o_auth_configuration ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.post_organization_connect_o_auth_configuration" if organization_id.nil?
  # verify the required parameter 'configuration' is set
  fail ArgumentError, "Missing the required parameter 'configuration' when calling OrgConnectApi.post_organization_connect_o_auth_configuration" if configuration.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/oauth".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(configuration)
  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 => 'OrganizationConnectOAuthConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#post_organization_connect_o_auth_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_organization_connect_o_auth_configuration(organization_id, configuration) ⇒ OrganizationConnectOAuthConfiguration

Updates information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • configuration —

    Update an organization-level Connect OAuth configuration

Returns:



587
588
589
590
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 587

def put_organization_connect_o_auth_configuration(organization_id, configuration)
  data, _status_code, _headers = put_organization_connect_o_auth_configuration_with_http_info(organization_id,  configuration)
  return data
end

#put_organization_connect_o_auth_configuration_with_http_info(organization_id, configuration) ⇒ Array<(OrganizationConnectOAuthConfiguration, Fixnum, Hash)>

Updates information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • configuration —

    Update an organization-level Connect OAuth configuration

Returns:



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 597

def put_organization_connect_o_auth_configuration_with_http_info(organization_id, configuration)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.put_organization_connect_o_auth_configuration ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.put_organization_connect_o_auth_configuration" if organization_id.nil?
  # verify the required parameter 'configuration' is set
  fail ArgumentError, "Missing the required parameter 'configuration' when calling OrgConnectApi.put_organization_connect_o_auth_configuration" if configuration.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/oauth".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(configuration)
  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 => 'OrganizationConnectOAuthConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#put_organization_connect_o_auth_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organization_connect_config(organization_id, connect_id, connect_request) ⇒ OrganizationConnectConfigurationDetailsResponse

Updates an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

  • connect_request —

    Add an organization Connect request

Returns:



643
644
645
646
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 643

def update_organization_connect_config(organization_id, connect_id, connect_request)
  data, _status_code, _headers = update_organization_connect_config_with_http_info(organization_id, connect_id,  connect_request)
  return data
end

#update_organization_connect_config_with_http_info(organization_id, connect_id, connect_request) ⇒ Array<(OrganizationConnectConfigurationDetailsResponse, Fixnum, Hash)>

Updates an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

  • organization_id —

    The organization ID Guid

  • connect_id —

    The configuration ID Guid

  • connect_request —

    Add an organization Connect request

Returns:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/docusign_admin/api/org_connect_api.rb', line 654

def update_organization_connect_config_with_http_info(organization_id, connect_id, connect_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgConnectApi.update_organization_connect_config ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrgConnectApi.update_organization_connect_config" if organization_id.nil?
  # verify the required parameter 'connect_id' is set
  fail ArgumentError, "Missing the required parameter 'connect_id' when calling OrgConnectApi.update_organization_connect_config" if connect_id.nil?
  # verify the required parameter 'connect_request' is set
  fail ArgumentError, "Missing the required parameter 'connect_request' when calling OrgConnectApi.update_organization_connect_config" if connect_request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/connect/{connectId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'connectId' + '}', connect_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(connect_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 => 'OrganizationConnectConfigurationDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgConnectApi#update_organization_connect_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end