Class: DocuSign_Click::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_click/api/accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = AccountsApi.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



125
126
127
 
# File 'lib/docusign_click/api/accounts_api.rb', line 125

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



123
124
125
 
# File 'lib/docusign_click/api/accounts_api.rb', line 123

def api_client
  @api_client
end

Instance Method Details

#create_bulk_clickwrap_agreements(account_id, clickwrap_id, bulk_clickwrap_request) ⇒ nil

Starts an export of clickwrap agreements for a specified date range. Starts an asynchronus process to export clickwrap agreements for a specified date range. An email will be sent to the creator after it has been processed. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • bulk_clickwrap_request —

    Data used to start a bulk agreements export. (optional parameter)

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/docusign_click/api/accounts_api.rb', line 135

def create_bulk_clickwrap_agreements(, clickwrap_id, bulk_clickwrap_request)
  create_bulk_clickwrap_agreements_with_http_info(, clickwrap_id,  bulk_clickwrap_request)
  return nil
end

#create_bulk_clickwrap_agreements_with_http_info(account_id, clickwrap_id, bulk_clickwrap_request) ⇒ Array<(nil, Fixnum, Hash)>

Starts an export of clickwrap agreements for a specified date range. Starts an asynchronus process to export clickwrap agreements for a specified date range. An email will be sent to the creator after it has been processed. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • bulk_clickwrap_request —

    Data used to start a bulk agreements export. (optional parameter)

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/docusign_click/api/accounts_api.rb', line 146

def create_bulk_clickwrap_agreements_with_http_info(, clickwrap_id, bulk_clickwrap_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create_bulk_clickwrap_agreements ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_bulk_clickwrap_agreements" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.create_bulk_clickwrap_agreements" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/bulk_agreements".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_clickwrap(account_id, clickwrap_request) ⇒ ClickwrapVersionSummaryResponse

Creates a clickwrap for an account. Creates a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



188
189
190
191
 
# File 'lib/docusign_click/api/accounts_api.rb', line 188

def create_clickwrap(, clickwrap_request)
  data, _status_code, _headers = create_clickwrap_with_http_info(,  clickwrap_request)
  return data
end

#create_clickwrap_version(account_id, clickwrap_id, clickwrap_request) ⇒ ClickwrapVersionSummaryResponse

Creates a new clickwrap version. Creates a new version of an existing clickwrap. In a new version, you can replace the uploaded documents, change the display settings, and change the name of the clickwrap. The version number is automatically incremented based on the last version of the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



240
241
242
243
 
# File 'lib/docusign_click/api/accounts_api.rb', line 240

def create_clickwrap_version(, clickwrap_id, clickwrap_request)
  data, _status_code, _headers = create_clickwrap_version_with_http_info(, clickwrap_id,  clickwrap_request)
  return data
end

#create_clickwrap_version_with_http_info(account_id, clickwrap_id, clickwrap_request) ⇒ Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>

Creates a new clickwrap version. Creates a new version of an existing clickwrap. In a new version, you can replace the uploaded documents, change the display settings, and change the name of the clickwrap. The version number is automatically incremented based on the last version of the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/docusign_click/api/accounts_api.rb', line 251

def create_clickwrap_version_with_http_info(, clickwrap_id, clickwrap_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create_clickwrap_version ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_clickwrap_version" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.create_clickwrap_version" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_clickwrap_with_http_info(account_id, clickwrap_request) ⇒ Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>

Creates a clickwrap for an account. Creates a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



198
199
200
201
202
203
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
 
# File 'lib/docusign_click/api/accounts_api.rb', line 198

def create_clickwrap_with_http_info(, clickwrap_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create_clickwrap ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_clickwrap" if .nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_has_agreed(account_id, clickwrap_id, user_agreement_request) ⇒ UserAgreementResponse

Creates a unique URL for the agreement that you can embed in your application. Creates a unique URL for the agreement that you can embed in your application. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage and click.send. The request must include at least the clientUserId. This is a value that you generate to identify the unique recipient of the agreement. If you are using a [dynamic content][] document, you can supply the values in the documentData property of the request, like this: “‘json { "clientUserId": "cl-bc7f-48a9", "documentData": { "fullName": "T. J. Fanning", "email": "[email protected]", "company": "Fanning Indusdtries", "title": "Cat wrangler", "date": "2022-10-13T05:17:14-07:00" } } “` A response will look like this. The agreementUrl is unique to the user identified by the clientUserId. Your user can open the URL to approve the agreement. The documentData property appears only if you provided it in the request. “`json { "accountId": "624e3e00-xxxx-xxxx-xxxx-43918c520dab", "clickwrapId": "0e64e4a7-xxxx-xxxx-xxxx-ce5a93b162af", "clientUserId": "tcl-bc7f-48a9j", "agreementId": "1f346c7d-xxxx-xxxx-xxxx-a5c968666785", "documents": [ . . .], "consumerDisclosureEnabled": true, "agreementUrl": "demo.docusign.net/clickapi/v1/redeem?agreementToken=AcTZT8g … cxEqrUsA1lQ8DPPy05dE0", "createdOn": "2022-10-20T16:27:25.1287685Z", "status": "created", "versionId": "5957716d-xxxx-xxxx-xxxx-e1594f00ff12", "versionNumber": 1, "settings": { "displayName": "Agree with me", "hasDeclineButton": true, . . . "statementAlignment": "bottom" }, "documentData": { "fullName": "T. J. Fanning", "email": "[email protected]", "company": "Fanning Indusdtries", "title": "Cat wrangler", "date": "2022-10-13T05:17:14-07:00" } } “` This method returns the following result codes and response bodies depending on whether the user has agreed. | Agreed | Response code | Response body | | :—– | :———— | :——————— | | No | 201 | Full response as above | | Yes | 200 | No response (empty) | ### Related topics - [Add dynamic content to your clickwrap][dynamic content] - [How to embed a clickwrap] [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#add-dynamic-content-to-your-clickwrap [embedding]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content [embed-howto]: /docs/click-api/how-to/embed-clickwraps/

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • user_agreement_request —

    Data used to create the agreement. (optional parameter)

Returns:



295
296
297
298
 
# File 'lib/docusign_click/api/accounts_api.rb', line 295

def create_has_agreed(, clickwrap_id, user_agreement_request)
  data, _status_code, _headers = create_has_agreed_with_http_info(, clickwrap_id,  user_agreement_request)
  return data
end

#create_has_agreed_with_http_info(account_id, clickwrap_id, user_agreement_request) ⇒ Array<(UserAgreementResponse, Fixnum, Hash)>

Creates a unique URL for the agreement that you can embed in your application. Creates a unique URL for the agreement that you can embed in your application. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60; and &#x60;click.send&#x60;. The request must include at least the &#x60;clientUserId&#x60;. This is a value that you generate to identify the unique recipient of the agreement. If you are using a [dynamic content][] document, you can supply the values in the documentData property of the request, like this: &#x60;&#x60;&#x60;json { &quot;clientUserId&quot;: &quot;cl-bc7f-48a9&quot;, &quot;documentData&quot;: { &quot;fullName&quot;: &quot;T. J. Fanning&quot;, &quot;email&quot;: &quot;[email protected]&quot;, &quot;company&quot;: &quot;Fanning Indusdtries&quot;, &quot;title&quot;: &quot;Cat wrangler&quot;, &quot;date&quot;: &quot;2022-10-13T05:17:14-07:00&quot; } } &#x60;&#x60;&#x60; A response will look like this. The &#x60;agreementUrl&#x60; is unique to the user identified by the &#x60;clientUserId&#x60;. Your user can open the URL to approve the agreement. The &#x60;documentData&#x60; property appears only if you provided it in the request. &#x60;&#x60;&#x60;json { &quot;accountId&quot;: &quot;624e3e00-xxxx-xxxx-xxxx-43918c520dab&quot;, &quot;clickwrapId&quot;: &quot;0e64e4a7-xxxx-xxxx-xxxx-ce5a93b162af&quot;, &quot;clientUserId&quot;: &quot;tcl-bc7f-48a9j&quot;, &quot;agreementId&quot;: &quot;1f346c7d-xxxx-xxxx-xxxx-a5c968666785&quot;, &quot;documents&quot;: [ . . .], &quot;consumerDisclosureEnabled&quot;: true, &quot;agreementUrl&quot;: &quot;demo.docusign.net/clickapi/v1/redeem?agreementToken&#x3D;AcTZT8g … cxEqrUsA1lQ8DPPy05dE0&quot;, &quot;createdOn&quot;: &quot;2022-10-20T16:27:25.1287685Z&quot;, &quot;status&quot;: &quot;created&quot;, &quot;versionId&quot;: &quot;5957716d-xxxx-xxxx-xxxx-e1594f00ff12&quot;, &quot;versionNumber&quot;: 1, &quot;settings&quot;: { &quot;displayName&quot;: &quot;Agree with me&quot;, &quot;hasDeclineButton&quot;: true, . . . &quot;statementAlignment&quot;: &quot;bottom&quot; }, &quot;documentData&quot;: { &quot;fullName&quot;: &quot;T. J. Fanning&quot;, &quot;email&quot;: &quot;[email protected]&quot;, &quot;company&quot;: &quot;Fanning Indusdtries&quot;, &quot;title&quot;: &quot;Cat wrangler&quot;, &quot;date&quot;: &quot;2022-10-13T05:17:14-07:00&quot; } } &#x60;&#x60;&#x60; This method returns the following result codes and response bodies depending on whether the user has agreed. | Agreed | Response code | Response body | | :—– | :———— | :——————— | | No | 201 | Full response as above | | Yes | 200 | No response (empty) | ### Related topics - [Add dynamic content to your clickwrap][dynamic content] - [How to embed a clickwrap] [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#add-dynamic-content-to-your-clickwrap [embedding]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content [embed-howto]: /docs/click-api/how-to/embed-clickwraps/

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • user_agreement_request —

    Data used to create the agreement. (optional parameter)

Returns:

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

    UserAgreementResponse data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/docusign_click/api/accounts_api.rb', line 306

def create_has_agreed_with_http_info(, clickwrap_id, user_agreement_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create_has_agreed ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_has_agreed" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.create_has_agreed" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_clickwrap(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapOptions.default) ⇒ ClickwrapVersionsDeleteResponse

Deletes a clickwrap and all of its versions. Deletes the clickwrap specified by clickwrapId and all of its versions. Active clickwraps are not deleted [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::DeleteClickwrapOptions —

    Options for modifying the behavior of the function.

Returns:



350
351
352
353
 
# File 'lib/docusign_click/api/accounts_api.rb', line 350

def delete_clickwrap(, clickwrap_id, options = DocuSign_Click::DeleteClickwrapOptions.default)
  data, _status_code, _headers = delete_clickwrap_with_http_info(, clickwrap_id, options)
  return data
end

#delete_clickwrap_version(account_id, clickwrap_id, version_id) ⇒ ClickwrapVersionDeleteResponse

Deletes a clickwrap version by version ID. Deletes the clickwrap version specified by versionId of the clickwrap specified by clickwrapId. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

Returns:



406
407
408
409
 
# File 'lib/docusign_click/api/accounts_api.rb', line 406

def delete_clickwrap_version(, clickwrap_id, version_id)
  data, _status_code, _headers = delete_clickwrap_version_with_http_info(, clickwrap_id, version_id)
  return data
end

#delete_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id) ⇒ Array<(ClickwrapVersionDeleteResponse, Fixnum, Hash)>

Deletes a clickwrap version by version ID. Deletes the clickwrap version specified by &#x60;versionId&#x60; of the clickwrap specified by &#x60;clickwrapId&#x60;. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

Returns:



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/docusign_click/api/accounts_api.rb', line 417

def delete_clickwrap_version_with_http_info(, clickwrap_id, version_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_clickwrap_version ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_clickwrap_version" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.delete_clickwrap_version" if clickwrap_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.delete_clickwrap_version" if version_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_clickwrap_versions(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default) ⇒ ClickwrapVersionsDeleteResponse

Deletes the versions of a clickwrap. Deletes all versions of a clickwrap, or only the ones specified in the clickwrapVersionIds query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::DeleteClickwrapVersionsOptions —

    Options for modifying the behavior of the function.

Returns:



463
464
465
466
 
# File 'lib/docusign_click/api/accounts_api.rb', line 463

def delete_clickwrap_versions(, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default)
  data, _status_code, _headers = delete_clickwrap_versions_with_http_info(, clickwrap_id, options)
  return data
end

#delete_clickwrap_versions_with_http_info(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default) ⇒ Array<(ClickwrapVersionsDeleteResponse, Fixnum, Hash)>

Deletes the versions of a clickwrap. Deletes all versions of a clickwrap, or only the ones specified in the &#x60;clickwrapVersionIds&#x60; query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::DeleteClickwrapVersionsOptions —

    Options for modifying the behavior of the function.

Returns:



474
475
476
477
478
479
480
481
482
483
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
 
# File 'lib/docusign_click/api/accounts_api.rb', line 474

def delete_clickwrap_versions_with_http_info(, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_clickwrap_versions ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_clickwrap_versions" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.delete_clickwrap_versions" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#delete_clickwrap_with_http_info(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapOptions.default) ⇒ Array<(ClickwrapVersionsDeleteResponse, Fixnum, Hash)>

Deletes a clickwrap and all of its versions. Deletes the clickwrap specified by &#x60;clickwrapId&#x60; and all of its versions. Active clickwraps are not deleted [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::DeleteClickwrapOptions —

    Options for modifying the behavior of the function.

Returns:



361
362
363
364
365
366
367
368
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
 
# File 'lib/docusign_click/api/accounts_api.rb', line 361

def delete_clickwrap_with_http_info(, clickwrap_id, options = DocuSign_Click::DeleteClickwrapOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_clickwrap ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_clickwrap" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.delete_clickwrap" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#delete_clickwraps(account_id, options = DocuSign_Click::DeleteClickwrapsOptions.default) ⇒ ClickwrapsDeleteResponse

Deletes clickwraps for an account. Deletes all clickwraps for an account or only the ones specified in the clickwrapIds query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • DocuSign_Click::DeleteClickwrapsOptions —

    Options for modifying the behavior of the function.

Returns:



518
519
520
521
 
# File 'lib/docusign_click/api/accounts_api.rb', line 518

def delete_clickwraps(, options = DocuSign_Click::DeleteClickwrapsOptions.default)
  data, _status_code, _headers = delete_clickwraps_with_http_info(, options)
  return data
end

#delete_clickwraps_with_http_info(account_id, options = DocuSign_Click::DeleteClickwrapsOptions.default) ⇒ Array<(ClickwrapsDeleteResponse, Fixnum, Hash)>

Deletes clickwraps for an account. Deletes all clickwraps for an account or only the ones specified in the &#x60;clickwrapIds&#x60; query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • DocuSign_Click::DeleteClickwrapsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ClickwrapsDeleteResponse data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/docusign_click/api/accounts_api.rb', line 528

def delete_clickwraps_with_http_info(, options = DocuSign_Click::DeleteClickwrapsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_clickwraps ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_clickwraps" if .nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

#get_agreement(account_id, agreement_id, clickwrap_id) ⇒ UserAgreementResponse

Gets a specific agreement for a specified clickwrap. Gets the agreement specified by agreementId. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage or click.send.

Parameters:

  • account_id —

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

  • agreement_id —

    The agreement ID.

  • clickwrap_id —

    The ID of the clickwrap.

Returns:



571
572
573
574
 
# File 'lib/docusign_click/api/accounts_api.rb', line 571

def get_agreement(, agreement_id, clickwrap_id)
  data, _status_code, _headers = get_agreement_with_http_info(, agreement_id, clickwrap_id)
  return data
end

#get_agreement_document(account_id, clickwrap_id, order_or_disclosure, version_id) ⇒ Document

Downloads a document at an order within the agreement. Downloads a specific document from the agreement presented to the user. [Required authentication scopes](/docs/click-api/click101/auth/): click.sign

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • order_or_disclosure —

    The order of the document or consumer_disclosure.

  • version_id —

    The ID of the clickwrap version.

Returns:



629
630
631
632
 
# File 'lib/docusign_click/api/accounts_api.rb', line 629

def get_agreement_document(, clickwrap_id, order_or_disclosure, version_id)
  data, _status_code, _headers = get_agreement_document_with_http_info(, clickwrap_id, order_or_disclosure, version_id)
  return data
end

#get_agreement_document_with_http_info(account_id, clickwrap_id, order_or_disclosure, version_id) ⇒ Array<(Document, Fixnum, Hash)>

Downloads a document at an order within the agreement. Downloads a specific document from the agreement presented to the user. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.sign&#x60;

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • order_or_disclosure —

    The order of the document or consumer_disclosure.

  • version_id —

    The ID of the clickwrap version.

Returns:

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

    Document data, response status code and response headers



641
642
643
644
645
646
647
648
649
650
651
652
653
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
 
# File 'lib/docusign_click/api/accounts_api.rb', line 641

def get_agreement_document_with_http_info(, clickwrap_id, order_or_disclosure, version_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_agreement_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agreement_document" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_agreement_document" if clickwrap_id.nil?
  # verify the required parameter 'order_or_disclosure' is set
  fail ArgumentError, "Missing the required parameter 'order_or_disclosure' when calling AccountsApi.get_agreement_document" if order_or_disclosure.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.get_agreement_document" if version_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/documents/{orderOrDisclosure}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'orderOrDisclosure' + '}', order_or_disclosure.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_agreement_pdf(account_id, agreement_id, clickwrap_id, options = DocuSign_Click::GetAgreementPdfOptions.default) ⇒ File

Gets the completed user agreement PDF. Gets the PDF of agreementId for the clickwrap specified by clickwrapId. The response to this method is the bytes of the PDF file. The response includes the HTTP header application/pdf. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage or click.send.

Parameters:

  • account_id —

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

  • agreement_id —

    The agreement ID.

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::GetAgreementPdfOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


690
691
692
693
 
# File 'lib/docusign_click/api/accounts_api.rb', line 690

def get_agreement_pdf(, agreement_id, clickwrap_id, options = DocuSign_Click::GetAgreementPdfOptions.default)
  data, _status_code, _headers = get_agreement_pdf_with_http_info(, agreement_id, clickwrap_id, options)
  return data
end

#get_agreement_pdf_with_http_info(account_id, agreement_id, clickwrap_id, options = DocuSign_Click::GetAgreementPdfOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets the completed user agreement PDF. Gets the PDF of &#x60;agreementId&#x60; for the clickwrap specified by &#x60;clickwrapId&#x60;. The response to this method is the bytes of the PDF file. The response includes the HTTP header &#x60;application/pdf&#x60;. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60; or &#x60;click.send&#x60;.

Parameters:

  • account_id —

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

  • agreement_id —

    The agreement ID.

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::GetAgreementPdfOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/docusign_click/api/accounts_api.rb', line 702

def get_agreement_pdf_with_http_info(, agreement_id, clickwrap_id, options = DocuSign_Click::GetAgreementPdfOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_agreement_pdf ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agreement_pdf" if .nil?
  # verify the required parameter 'agreement_id' is set
  fail ArgumentError, "Missing the required parameter 'agreement_id' when calling AccountsApi.get_agreement_pdf" if agreement_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_agreement_pdf" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}/download".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'agreementId' + '}', agreement_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

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

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

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_agreement_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_agreement_with_http_info(account_id, agreement_id, clickwrap_id) ⇒ Array<(UserAgreementResponse, Fixnum, Hash)>

Gets a specific agreement for a specified clickwrap. Gets the agreement specified by &#x60;agreementId&#x60;. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60; or &#x60;click.send&#x60;.

Parameters:

  • account_id —

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

  • agreement_id —

    The agreement ID.

  • clickwrap_id —

    The ID of the clickwrap.

Returns:

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

    UserAgreementResponse data, response status code and response headers



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/docusign_click/api/accounts_api.rb', line 582

def get_agreement_with_http_info(, agreement_id, clickwrap_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_agreement ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agreement" if .nil?
  # verify the required parameter 'agreement_id' is set
  fail ArgumentError, "Missing the required parameter 'agreement_id' when calling AccountsApi.get_agreement" if agreement_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_agreement" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'agreementId' + '}', agreement_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_clickwrap(account_id, clickwrap_id) ⇒ ClickwrapVersionResponse

Gets a single clickwrap object. Retrieves the definition of the specified clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

Returns:



748
749
750
751
 
# File 'lib/docusign_click/api/accounts_api.rb', line 748

def get_clickwrap(, clickwrap_id)
  data, _status_code, _headers = get_clickwrap_with_http_info(, clickwrap_id)
  return data
end

#get_clickwrap_agreements(account_id, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default) ⇒ ClickwrapAgreementsResponse

Get user agreements Retrieves the user agreements for a specified clickwrap. Each userAgreementResponse object describes a single user’s response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::GetClickwrapAgreementsOptions —

    Options for modifying the behavior of the function.

Returns:



802
803
804
805
 
# File 'lib/docusign_click/api/accounts_api.rb', line 802

def get_clickwrap_agreements(, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default)
  data, _status_code, _headers = get_clickwrap_agreements_with_http_info(, clickwrap_id, options)
  return data
end

#get_clickwrap_agreements_with_http_info(account_id, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default) ⇒ Array<(ClickwrapAgreementsResponse, Fixnum, Hash)>

Get user agreements Retrieves the user agreements for a specified clickwrap. Each &#x60;userAgreementResponse&#x60; object describes a single user&#39;s response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • DocuSign_Click::GetClickwrapAgreementsOptions —

    Options for modifying the behavior of the function.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/docusign_click/api/accounts_api.rb', line 813

def get_clickwrap_agreements_with_http_info(, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_agreements ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_agreements" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_agreements" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'client_user_id'] = options.client_user_id if !options.client_user_id.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'page_number'] = options.page_number if !options.page_number.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

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

  # form parameters
  form_params = {}

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

#get_clickwrap_version(account_id, clickwrap_id, version_id) ⇒ ClickwrapVersionResponse

Gets a specific version of a clickwrap by version ID. Gets the version specified by versionId from the clickwrap clickwrapId. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

Returns:



862
863
864
865
 
# File 'lib/docusign_click/api/accounts_api.rb', line 862

def get_clickwrap_version(, clickwrap_id, version_id)
  data, _status_code, _headers = get_clickwrap_version_with_http_info(, clickwrap_id, version_id)
  return data
end

#get_clickwrap_version_agreements(account_id, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default) ⇒ ClickwrapAgreementsResponse

Gets the agreement responses for a clickwrap version by version ID. Gets the agreement responses for a specific version. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

  • DocuSign_Click::GetClickwrapVersionAgreementsOptions —

    Options for modifying the behavior of the function.

Returns:



920
921
922
923
 
# File 'lib/docusign_click/api/accounts_api.rb', line 920

def get_clickwrap_version_agreements(, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default)
  data, _status_code, _headers = get_clickwrap_version_agreements_with_http_info(, clickwrap_id, version_id, options)
  return data
end

#get_clickwrap_version_agreements_with_http_info(account_id, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default) ⇒ Array<(ClickwrapAgreementsResponse, Fixnum, Hash)>

Gets the agreement responses for a clickwrap version by version ID. Gets the agreement responses for a specific version. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

  • DocuSign_Click::GetClickwrapVersionAgreementsOptions —

    Options for modifying the behavior of the function.

Returns:



932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/docusign_click/api/accounts_api.rb', line 932

def get_clickwrap_version_agreements_with_http_info(, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_version_agreements ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_version_agreements" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_version_agreements" if clickwrap_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.get_clickwrap_version_agreements" if version_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'client_user_id'] = options.client_user_id if !options.client_user_id.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'page_number'] = options.page_number if !options.page_number.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

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

  # form parameters
  form_params = {}

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

#get_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id) ⇒ Array<(ClickwrapVersionResponse, Fixnum, Hash)>

Gets a specific version of a clickwrap by version ID. Gets the version specified by &#x60;versionId&#x60; from the clickwrap &#x60;clickwrapId&#x60;. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

Returns:

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

    ClickwrapVersionResponse data, response status code and response headers



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/docusign_click/api/accounts_api.rb', line 873

def get_clickwrap_version_with_http_info(, clickwrap_id, version_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_version ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_version" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_version" if clickwrap_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.get_clickwrap_version" if version_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_clickwrap_versions(account_id, clickwrap_id) ⇒ ClickwrapVersionsPagedResponse

Gets all the versions of a clickwrap. Gets all the versions of a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

Returns:



982
983
984
985
 
# File 'lib/docusign_click/api/accounts_api.rb', line 982

def get_clickwrap_versions(, clickwrap_id)
  data, _status_code, _headers = get_clickwrap_versions_with_http_info(, clickwrap_id)
  return data
end

#get_clickwrap_versions_with_http_info(account_id, clickwrap_id) ⇒ Array<(ClickwrapVersionsPagedResponse, Fixnum, Hash)>

Gets all the versions of a clickwrap. Gets all the versions of a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/docusign_click/api/accounts_api.rb', line 992

def get_clickwrap_versions_with_http_info(, clickwrap_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_versions ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_versions" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_versions" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_clickwrap_with_http_info(account_id, clickwrap_id) ⇒ Array<(ClickwrapVersionResponse, Fixnum, Hash)>

Gets a single clickwrap object. Retrieves the definition of the specified clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

Returns:

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

    ClickwrapVersionResponse data, response status code and response headers



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/docusign_click/api/accounts_api.rb', line 758

def get_clickwrap_with_http_info(, clickwrap_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_clickwraps(account_id, options = DocuSign_Click::GetClickwrapsOptions.default) ⇒ ClickwrapVersionsResponse

Gets all the clickwraps for a user. Gets all the clickwraps for a user. Note: This endpoint returns a list of clickwrapVersionSummaryResponse objects. Each version of each clickwrap is returned as a separate entry in the list. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • DocuSign_Click::GetClickwrapsOptions —

    Options for modifying the behavior of the function.

Returns:



1035
1036
1037
1038
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1035

def get_clickwraps(, options = DocuSign_Click::GetClickwrapsOptions.default)
  data, _status_code, _headers = get_clickwraps_with_http_info(, options)
  return data
end

#get_clickwraps_with_http_info(account_id, options = DocuSign_Click::GetClickwrapsOptions.default) ⇒ Array<(ClickwrapVersionsResponse, Fixnum, Hash)>

Gets all the clickwraps for a user. Gets all the clickwraps for a user. Note: This endpoint returns a list of &#x60;clickwrapVersionSummaryResponse&#x60; objects. Each version of each clickwrap is returned as a separate entry in the list. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • DocuSign_Click::GetClickwrapsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ClickwrapVersionsResponse data, response status code and response headers



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1045

def get_clickwraps_with_http_info(, options = DocuSign_Click::GetClickwrapsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwraps ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwraps" if .nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'filter'] = options.filter if !options.filter.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'name'] = options.name if !options.name.nil?
  query_params[:'ownerUserId'] = options.owner_user_id if !options.owner_user_id.nil?
  query_params[:'page_number'] = options.page_number if !options.page_number.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

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

  # form parameters
  form_params = {}

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

#get_service_information ⇒ ServiceInformation

Gets the current version and other information about the Click API. The response includes information about the Click API, including the service version, build version, and linked sites. This method does not require authentication.

Returns:



1091
1092
1093
1094
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1091

def get_service_information()
  data, _status_code, _headers = get_service_information_with_http_info()
  return data
end

#get_service_information_with_http_info ⇒ Array<(ServiceInformation, Fixnum, Hash)>

Gets the current version and other information about the Click API. The response includes information about the Click API, including the service version, build version, and linked sites. This method does not require authentication.

Returns:

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

    ServiceInformation data, response status code and response headers



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1099

def get_service_information_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_service_information ..."
  end
  # resource path
  local_var_path = "/service_information".sub('{format}','json')

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_clickwrap(account_id, clickwrap_id, clickwrap_transfer_request) ⇒ ClickwrapVersionSummaryResponse

Update a clickwrap by ID. Update a subset of properties on the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • clickwrap_transfer_request —

    Data used to transfer a clickwrap from one user to another. (optional parameter)

Returns:



1139
1140
1141
1142
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1139

def update_clickwrap(, clickwrap_id, clickwrap_transfer_request)
  data, _status_code, _headers = update_clickwrap_with_http_info(, clickwrap_id,  clickwrap_transfer_request)
  return data
end

#update_clickwrap_version(account_id, clickwrap_id, version_id, clickwrap_request) ⇒ ClickwrapVersionSummaryResponse

Updates clickwrap version status and ownership. Updates the clickwrap version status and ownership by transferring from previous user ID to new user ID. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): click.manage.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



1195
1196
1197
1198
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1195

def update_clickwrap_version(, clickwrap_id, version_id, clickwrap_request)
  data, _status_code, _headers = update_clickwrap_version_with_http_info(, clickwrap_id, version_id,  clickwrap_request)
  return data
end

#update_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id, clickwrap_request) ⇒ Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>

Updates clickwrap version status and ownership. Updates the clickwrap version status and ownership by transferring from previous user ID to new user ID. Note: This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • version_id —

    The ID of the clickwrap version.

  • clickwrap_request —

    Request body for working with clickwrap. (optional parameter)

Returns:



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1207

def update_clickwrap_version_with_http_info(, clickwrap_id, version_id, clickwrap_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_clickwrap_version ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_clickwrap_version" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.update_clickwrap_version" if clickwrap_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.update_clickwrap_version" if version_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_clickwrap_with_http_info(account_id, clickwrap_id, clickwrap_transfer_request) ⇒ Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>

Update a clickwrap by ID. Update a subset of properties on the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): &#x60;click.manage&#x60;.

Parameters:

  • account_id —

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

  • clickwrap_id —

    The ID of the clickwrap.

  • clickwrap_transfer_request —

    Data used to transfer a clickwrap from one user to another. (optional parameter)

Returns:



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lib/docusign_click/api/accounts_api.rb', line 1150

def update_clickwrap_with_http_info(, clickwrap_id, clickwrap_transfer_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_clickwrap ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_clickwrap" if .nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.update_clickwrap" if clickwrap_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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