Class: DocuSign_Rooms::SpecialCircumstanceTypesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = SpecialCircumstanceTypesApi.default) ⇒ SpecialCircumstanceTypesApi

Returns a new instance of SpecialCircumstanceTypesApi.



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

def initialize(api_client = SpecialCircumstanceTypesApi.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/special_circumstance_types_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#get_special_circumstance_types ⇒ GlobalSpecialCircumstanceTypes

Retrieves the list of valid special circumstance types. Returns a list of special circumstance types

Returns:



27
28
29
30
 
# File 'lib/docusign_rooms/api/special_circumstance_types_api.rb', line 27

def get_special_circumstance_types()
  data, _status_code, _headers = get_special_circumstance_types_with_http_info()
  return data
end

#get_special_circumstance_types_with_http_info ⇒ Array<(GlobalSpecialCircumstanceTypes, Fixnum, Hash)>

Retrieves the list of valid special circumstance types. Returns a list of special circumstance types

Returns:



35
36
37
38
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
 
# File 'lib/docusign_rooms/api/special_circumstance_types_api.rb', line 35

def get_special_circumstance_types_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpecialCircumstanceTypesApi.get_special_circumstance_types ..."
  end
  # resource path
  local_var_path = "/v2/special_circumstance_types".sub('{format}','json')

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