Class: CandidApiClient::RequestOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/requests.rb

Overview

Additional options for request-specific configuration when calling APIs via the

SDK.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: nil, token: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil) ⇒ CandidApiClient::RequestOptions

Parameters:

  • base_url (String) (defaults to: nil)
  • token (String, Method) (defaults to: nil)
  • additional_headers (Hash{String => Object}) (defaults to: nil)
  • additional_query_parameters (Hash{String => Object}) (defaults to: nil)
  • additional_body_parameters (Hash{String => Object}) (defaults to: nil)
  • timeout_in_seconds (Long) (defaults to: nil) 


119
120
121
122
123
124
125
126
127
 
# File 'lib/requests.rb', line 119

def initialize(base_url: nil, token: nil, additional_headers: nil, additional_query_parameters: nil,
               additional_body_parameters: nil, timeout_in_seconds: nil)
  @base_url = base_url
  @token = token
  @additional_headers = additional_headers
  @additional_query_parameters = additional_query_parameters
  @additional_body_parameters = additional_body_parameters
  @timeout_in_seconds = timeout_in_seconds
end

Instance Attribute Details

#additional_body_parameters ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


108
109
110
 
# File 'lib/requests.rb', line 108

def additional_body_parameters
  @additional_body_parameters
end

#additional_headers ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


104
105
106
 
# File 'lib/requests.rb', line 104

def additional_headers
  @additional_headers
end

#additional_query_parameters ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


106
107
108
 
# File 'lib/requests.rb', line 106

def additional_query_parameters
  @additional_query_parameters
end

#base_url ⇒ String (readonly)

Returns:

  • (String) 


100
101
102
 
# File 'lib/requests.rb', line 100

def base_url
  @base_url
end

#timeout_in_seconds ⇒ Long (readonly)

Returns:

  • (Long) 


110
111
112
 
# File 'lib/requests.rb', line 110

def timeout_in_seconds
  @timeout_in_seconds
end

#token ⇒ String, Method (readonly)

Returns:

  • (String, Method) 


102
103
104
 
# File 'lib/requests.rb', line 102

def token
  @token
end