Class: DocuSign_Rooms::FormDetailsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = FormDetailsApi.default) ⇒ FormDetailsApi

Returns a new instance of FormDetailsApi.



20
21
22
 
# File 'lib/docusign_rooms/api/form_details_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_rooms/api/form_details_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#get_form_details(form_id, account_id) ⇒ FormDetails

Gets form based on Id. Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.

Parameters:

  • form_id —

    Form ID

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



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

def get_form_details(form_id, )
  data, _status_code, _headers = get_form_details_with_http_info(form_id, )
  return data
end

#get_form_details_with_http_info(form_id, account_id) ⇒ Array<(FormDetails, Fixnum, Hash)>

Gets form based on Id. Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.

Parameters:

  • form_id —

    Form ID

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    FormDetails data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/docusign_rooms/api/form_details_api.rb', line 39

def get_form_details_with_http_info(form_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormDetailsApi.get_form_details ..."
  end
  # verify the required parameter 'form_id' is set
  fail ArgumentError, "Missing the required parameter 'form_id' when calling FormDetailsApi.get_form_details" if form_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormDetailsApi.get_form_details" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/forms/{formId}/details".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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