class DocuSign_Click::AccountsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = AccountsApi.default) click to toggle source
# File lib/docusign_click/api/accounts_api.rb, line 134
def initialize(api_client = AccountsApi.default)
  @api_client = api_client
end

Public Instance Methods

create_clickwrap(account_id, clickwrap_request) click to toggle source

Creates a Clickwrap for the specified accountId

@param account_id @param clickwrap_request (optional parameter) @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 143
def create_clickwrap(account_id, clickwrap_request)
  data, _status_code, _headers = create_clickwrap_with_http_info(account_id,  clickwrap_request)
  return data
end
create_clickwrap_version(account_id, clickwrap_id, clickwrap_request) click to toggle source

Creates the clickwrap version

@param account_id @param clickwrap_id @param clickwrap_request (optional parameter) @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 195
def create_clickwrap_version(account_id, clickwrap_id, clickwrap_request)
  data, _status_code, _headers = create_clickwrap_version_with_http_info(account_id, clickwrap_id,  clickwrap_request)
  return data
end
create_clickwrap_version_with_http_info(account_id, clickwrap_id, clickwrap_request) click to toggle source

Creates the clickwrap version

@param account_id @param clickwrap_id @param clickwrap_request (optional parameter) @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 206
def create_clickwrap_version_with_http_info(account_id, 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 account_id.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' + '}', account_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 = @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) click to toggle source

Creates a Clickwrap for the specified accountId

@param account_id @param clickwrap_request (optional parameter) @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 153
def create_clickwrap_with_http_info(account_id, 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 account_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', account_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\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) click to toggle source

Checks if a user has agreed to a clickwrap and returns a response with the agreement url. Returns HttpStatusCode.OK if user has no pending agreement.

@param account_id @param clickwrap_id @param user_agreement_request (optional parameter) @return [UserAgreementResponse]

# File lib/docusign_click/api/accounts_api.rb, line 250
def create_has_agreed(account_id, clickwrap_id, user_agreement_request)
  data, _status_code, _headers = create_has_agreed_with_http_info(account_id, clickwrap_id,  user_agreement_request)
  return data
end
create_has_agreed_with_http_info(account_id, clickwrap_id, user_agreement_request) click to toggle source

Checks if a user has agreed to a clickwrap and returns a response with the agreement url. Returns HttpStatusCode.OK if user has no pending agreement.

@param account_id @param clickwrap_id @param user_agreement_request (optional parameter) @return [Array<(UserAgreementResponse, Fixnum, Hash)>] UserAgreementResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 261
def create_has_agreed_with_http_info(account_id, 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 account_id.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' + '}', account_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 = @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) click to toggle source

Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted

@param account_id @param clickwrap_id @param DocuSign_Click::DeleteClickwrapOptions Options for modifying the behavior of the function. @return [ClickwrapVersionsDeleteResponse]

# File lib/docusign_click/api/accounts_api.rb, line 305
def delete_clickwrap(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapOptions.default)
  data, _status_code, _headers = delete_clickwrap_with_http_info(account_id, clickwrap_id, options)
  return data
end
delete_clickwrap_version(account_id, clickwrap_id, version_id) click to toggle source

Delete a Clickwrap version specified by versionId

@param account_id @param clickwrap_id @param version_id @return [ClickwrapVersionDeleteResponse]

# File lib/docusign_click/api/accounts_api.rb, line 361
def delete_clickwrap_version(account_id, clickwrap_id, version_id)
  data, _status_code, _headers = delete_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id)
  return data
end
delete_clickwrap_version_by_number(account_id, clickwrap_id, version_number) click to toggle source

Delete a Clickwrap version specified by versionNumber. Use versionId instead of versionNumber

@param account_id @param clickwrap_id @param version_number @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 418
def delete_clickwrap_version_by_number(account_id, clickwrap_id, version_number)
  data, _status_code, _headers = delete_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number)
  return data
end
delete_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number) click to toggle source

Delete a Clickwrap version specified by versionNumber. Use versionId instead of versionNumber

@param account_id @param clickwrap_id @param version_number @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 429
def delete_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_clickwrap_version_by_number ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_clickwrap_version_by_number" if account_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.delete_clickwrap_version_by_number" if clickwrap_id.nil?
  # verify the required parameter 'version_number' is set
  fail ArgumentError, "Missing the required parameter 'version_number' when calling AccountsApi.delete_clickwrap_version_by_number" if version_number.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionNumber' + '}', version_number.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 => 'ClickwrapVersionSummaryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#delete_clickwrap_version_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id) click to toggle source

Delete a Clickwrap version specified by versionId

@param account_id @param clickwrap_id @param version_id @return [Array<(ClickwrapVersionDeleteResponse, Fixnum, Hash)>] ClickwrapVersionDeleteResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 372
def delete_clickwrap_version_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active.

@param account_id @param clickwrap_id @param DocuSign_Click::DeleteClickwrapVersionsOptions Options for modifying the behavior of the function. @return [ClickwrapVersionsDeleteResponse]

# File lib/docusign_click/api/accounts_api.rb, line 475
def delete_clickwrap_versions(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default)
  data, _status_code, _headers = delete_clickwrap_versions_with_http_info(account_id, clickwrap_id, options)
  return data
end
delete_clickwrap_versions_with_http_info(account_id, clickwrap_id, options = DocuSign_Click::DeleteClickwrapVersionsOptions.default) click to toggle source

Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active.

@param account_id @param clickwrap_id @param DocuSign_Click::DeleteClickwrapVersionsOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapVersionsDeleteResponse, Fixnum, Hash)>] ClickwrapVersionsDeleteResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 486
def delete_clickwrap_versions_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted

@param account_id @param clickwrap_id @param DocuSign_Click::DeleteClickwrapOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapVersionsDeleteResponse, Fixnum, Hash)>] ClickwrapVersionsDeleteResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 316
def delete_clickwrap_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps.

@param account_id @param DocuSign_Click::DeleteClickwrapsOptions Options for modifying the behavior of the function. @return [ClickwrapsDeleteResponse]

# File lib/docusign_click/api/accounts_api.rb, line 530
def delete_clickwraps(account_id, options = DocuSign_Click::DeleteClickwrapsOptions.default)
  data, _status_code, _headers = delete_clickwraps_with_http_info(account_id, options)
  return data
end
delete_clickwraps_with_http_info(account_id, options = DocuSign_Click::DeleteClickwrapsOptions.default) click to toggle source

Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps.

@param account_id @param DocuSign_Click::DeleteClickwrapsOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapsDeleteResponse, Fixnum, Hash)>] ClickwrapsDeleteResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 540
def delete_clickwraps_with_http_info(account_id, 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 account_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.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) click to toggle source

@param account_id @param agreement_id @param clickwrap_id @return [UserAgreementResponse]

# File lib/docusign_click/api/accounts_api.rb, line 583
def get_agreement(account_id, agreement_id, clickwrap_id)
  data, _status_code, _headers = get_agreement_with_http_info(account_id, agreement_id, clickwrap_id)
  return data
end
get_agreement_pdf(account_id, agreement_id, clickwrap_id) click to toggle source

@param account_id @param agreement_id @param clickwrap_id @return [nil]

# File lib/docusign_click/api/accounts_api.rb, line 640
def get_agreement_pdf(account_id, agreement_id, clickwrap_id)
  get_agreement_pdf_with_http_info(account_id, agreement_id, clickwrap_id)
  return nil
end
get_agreement_pdf_with_http_info(account_id, agreement_id, clickwrap_id) click to toggle source

@param account_id @param agreement_id @param clickwrap_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 651
def get_agreement_pdf_with_http_info(account_id, agreement_id, clickwrap_id)
  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 account_id.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' + '}', account_id.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)
  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) click to toggle source

@param account_id @param agreement_id @param clickwrap_id @return [Array<(UserAgreementResponse, Fixnum, Hash)>] UserAgreementResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 594
def get_agreement_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Gets the clickwrap for an account specified by clickwrapId

@param account_id @param clickwrap_id @return [ClickwrapVersionResponse]

# File lib/docusign_click/api/accounts_api.rb, line 695
def get_clickwrap(account_id, clickwrap_id)
  data, _status_code, _headers = get_clickwrap_with_http_info(account_id, clickwrap_id)
  return data
end
get_clickwrap_agreements(account_id, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default) click to toggle source

Gets the Clickwraps for an account

@param account_id @param clickwrap_id @param DocuSign_Click::GetClickwrapAgreementsOptions Options for modifying the behavior of the function. @return [ClickwrapAgreementsResponse]

# File lib/docusign_click/api/accounts_api.rb, line 749
def get_clickwrap_agreements(account_id, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default)
  data, _status_code, _headers = get_clickwrap_agreements_with_http_info(account_id, clickwrap_id, options)
  return data
end
get_clickwrap_agreements_with_http_info(account_id, clickwrap_id, options = DocuSign_Click::GetClickwrapAgreementsOptions.default) click to toggle source

Gets the Clickwraps for an account

@param account_id @param clickwrap_id @param DocuSign_Click::GetClickwrapAgreementsOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapAgreementsResponse, Fixnum, Hash)>] ClickwrapAgreementsResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 760
def get_clickwrap_agreements_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Gets the Clickwrap version by clickwrapId and versionId for an account

@param account_id @param clickwrap_id @param version_id @return [ClickwrapVersionResponse]

# File lib/docusign_click/api/accounts_api.rb, line 809
def get_clickwrap_version(account_id, clickwrap_id, version_id)
  data, _status_code, _headers = get_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id)
  return data
end
get_clickwrap_version_agreements(account_id, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default) click to toggle source

Gets the agreement responses for a clickwrap version

@param account_id @param clickwrap_id @param version_id @param DocuSign_Click::GetClickwrapVersionAgreementsOptions Options for modifying the behavior of the function. @return [ClickwrapAgreementsResponse]

# File lib/docusign_click/api/accounts_api.rb, line 867
def get_clickwrap_version_agreements(account_id, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default)
  data, _status_code, _headers = get_clickwrap_version_agreements_with_http_info(account_id, clickwrap_id, version_id, options)
  return data
end
get_clickwrap_version_agreements_by_number(account_id, clickwrap_id, version_number, options = DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions.default) click to toggle source

Gets the agreement responses for a clickwrap version

@param account_id @param clickwrap_id @param version_number @param DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions Options for modifying the behavior of the function. @return [ClickwrapAgreementsResponse]

# File lib/docusign_click/api/accounts_api.rb, line 931
def get_clickwrap_version_agreements_by_number(account_id, clickwrap_id, version_number, options = DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions.default)
  data, _status_code, _headers = get_clickwrap_version_agreements_by_number_with_http_info(account_id, clickwrap_id, version_number, options)
  return data
end
get_clickwrap_version_agreements_by_number_with_http_info(account_id, clickwrap_id, version_number, options = DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions.default) click to toggle source

Gets the agreement responses for a clickwrap version

@param account_id @param clickwrap_id @param version_number @param DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapAgreementsResponse, Fixnum, Hash)>] ClickwrapAgreementsResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 943
def get_clickwrap_version_agreements_by_number_with_http_info(account_id, clickwrap_id, version_number, options = DocuSign_Click::GetClickwrapVersionAgreementsByNumberOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_version_agreements_by_number ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_version_agreements_by_number" if account_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_version_agreements_by_number" if clickwrap_id.nil?
  # verify the required parameter 'version_number' is set
  fail ArgumentError, "Missing the required parameter 'version_number' when calling AccountsApi.get_clickwrap_version_agreements_by_number" if version_number.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionNumber' + '}', version_number.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_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_clickwrap_version_agreements_with_http_info(account_id, clickwrap_id, version_id, options = DocuSign_Click::GetClickwrapVersionAgreementsOptions.default) click to toggle source

Gets the agreement responses for a clickwrap version

@param account_id @param clickwrap_id @param version_id @param DocuSign_Click::GetClickwrapVersionAgreementsOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapAgreementsResponse, Fixnum, Hash)>] ClickwrapAgreementsResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 879
def get_clickwrap_version_agreements_with_http_info(account_id, 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 account_id.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' + '}', account_id.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_by_number(account_id, clickwrap_id, version_number) click to toggle source

Gets the Clickwrap version by clickwrapId and versionNumber for an account

@param account_id @param clickwrap_id @param version_number @return [ClickwrapVersionResponse]

# File lib/docusign_click/api/accounts_api.rb, line 994
def get_clickwrap_version_by_number(account_id, clickwrap_id, version_number)
  data, _status_code, _headers = get_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number)
  return data
end
get_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number) click to toggle source

Gets the Clickwrap version by clickwrapId and versionNumber for an account

@param account_id @param clickwrap_id @param version_number @return [Array<(ClickwrapVersionResponse, Fixnum, Hash)>] ClickwrapVersionResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1005
def get_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_clickwrap_version_by_number ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_clickwrap_version_by_number" if account_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_clickwrap_version_by_number" if clickwrap_id.nil?
  # verify the required parameter 'version_number' is set
  fail ArgumentError, "Missing the required parameter 'version_number' when calling AccountsApi.get_clickwrap_version_by_number" if version_number.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionNumber' + '}', version_number.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_by_number\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) click to toggle source

Gets the Clickwrap version by clickwrapId and versionId for an account

@param account_id @param clickwrap_id @param version_id @return [Array<(ClickwrapVersionResponse, Fixnum, Hash)>] ClickwrapVersionResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 820
def get_clickwrap_version_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Gets all the versions of a clickwrap for an account

@param account_id @param clickwrap_id @return [ClickwrapVersionsPagedResponse]

# File lib/docusign_click/api/accounts_api.rb, line 1050
def get_clickwrap_versions(account_id, clickwrap_id)
  data, _status_code, _headers = get_clickwrap_versions_with_http_info(account_id, clickwrap_id)
  return data
end
get_clickwrap_versions_with_http_info(account_id, clickwrap_id) click to toggle source

Gets all the versions of a clickwrap for an account

@param account_id @param clickwrap_id @return [Array<(ClickwrapVersionsPagedResponse, Fixnum, Hash)>] ClickwrapVersionsPagedResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1060
def get_clickwrap_versions_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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) click to toggle source

Gets the clickwrap for an account specified by clickwrapId

@param account_id @param clickwrap_id @return [Array<(ClickwrapVersionResponse, Fixnum, Hash)>] ClickwrapVersionResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 705
def get_clickwrap_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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) click to toggle source

Gets the Clickwraps for an account

@param account_id @param DocuSign_Click::GetClickwrapsOptions Options for modifying the behavior of the function. @return [ClickwrapVersionsResponse]

# File lib/docusign_click/api/accounts_api.rb, line 1103
def get_clickwraps(account_id, options = DocuSign_Click::GetClickwrapsOptions.default)
  data, _status_code, _headers = get_clickwraps_with_http_info(account_id, options)
  return data
end
get_clickwraps_with_http_info(account_id, options = DocuSign_Click::GetClickwrapsOptions.default) click to toggle source

Gets the Clickwraps for an account

@param account_id @param DocuSign_Click::GetClickwrapsOptions Options for modifying the behavior of the function. @return [Array<(ClickwrapVersionsResponse, Fixnum, Hash)>] ClickwrapVersionsResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1113
def get_clickwraps_with_http_info(account_id, 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 account_id.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.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[:'shared'] = options.shared if !options.shared.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() click to toggle source

Provides base service and version access information.

@return [ServiceInformation]

# File lib/docusign_click/api/accounts_api.rb, line 1158
def get_service_information()
  data, _status_code, _headers = get_service_information_with_http_info()
  return data
end
get_service_information_with_http_info() click to toggle source

Provides base service and version access information.

@return [Array<(ServiceInformation, Fixnum, Hash)>] ServiceInformation data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1166
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) click to toggle source

Updates the clickwrap specified by clickwrapId

@param account_id @param clickwrap_id @param clickwrap_transfer_request (optional parameter) @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 1206
def update_clickwrap(account_id, clickwrap_id, clickwrap_transfer_request)
  data, _status_code, _headers = update_clickwrap_with_http_info(account_id, clickwrap_id,  clickwrap_transfer_request)
  return data
end
update_clickwrap_version(account_id, clickwrap_id, version_id, clickwrap_request) click to toggle source

Updates the clickwrap version specified by versionId

@param account_id @param clickwrap_id @param version_id @param clickwrap_request (optional parameter) @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 1262
def update_clickwrap_version(account_id, clickwrap_id, version_id, clickwrap_request)
  data, _status_code, _headers = update_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id,  clickwrap_request)
  return data
end
update_clickwrap_version_by_number(account_id, clickwrap_id, version_number, clickwrap_request) click to toggle source

Updates the clickwrap version specified by versionNumber. Use versionId instead of versionNumber

@param account_id @param clickwrap_id @param version_number @param clickwrap_request (optional parameter) @return [ClickwrapVersionSummaryResponse]

# File lib/docusign_click/api/accounts_api.rb, line 1321
def update_clickwrap_version_by_number(account_id, clickwrap_id, version_number, clickwrap_request)
  data, _status_code, _headers = update_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number,  clickwrap_request)
  return data
end
update_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number, clickwrap_request) click to toggle source

Updates the clickwrap version specified by versionNumber. Use versionId instead of versionNumber

@param account_id @param clickwrap_id @param version_number @param clickwrap_request (optional parameter) @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1333
def update_clickwrap_version_by_number_with_http_info(account_id, clickwrap_id, version_number, clickwrap_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_clickwrap_version_by_number ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_clickwrap_version_by_number" if account_id.nil?
  # verify the required parameter 'clickwrap_id' is set
  fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.update_clickwrap_version_by_number" if clickwrap_id.nil?
  # verify the required parameter 'version_number' is set
  fail ArgumentError, "Missing the required parameter 'version_number' when calling AccountsApi.update_clickwrap_version_by_number" if version_number.nil?
  # resource path
  local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'versionNumber' + '}', version_number.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_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_clickwrap_version_with_http_info(account_id, clickwrap_id, version_id, clickwrap_request) click to toggle source

Updates the clickwrap version specified by versionId

@param account_id @param clickwrap_id @param version_id @param clickwrap_request (optional parameter) @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1274
def update_clickwrap_version_with_http_info(account_id, 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 account_id.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' + '}', account_id.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) click to toggle source

Updates the clickwrap specified by clickwrapId

@param account_id @param clickwrap_id @param clickwrap_transfer_request (optional parameter) @return [Array<(ClickwrapVersionSummaryResponse, Fixnum, Hash)>] ClickwrapVersionSummaryResponse data, response status code and response headers

# File lib/docusign_click/api/accounts_api.rb, line 1217
def update_clickwrap_with_http_info(account_id, 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 account_id.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' + '}', account_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 = @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