Class: Pinnacle::IdempotencyRequestOptions

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, api_key: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil) ⇒ Pinnacle::IdempotencyRequestOptions

Parameters:

  • base_url (String) (defaults to: nil)
  • api_key (String) (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) 


153
154
155
156
157
158
159
160
161
 
# File 'lib/requests.rb', line 153

def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
               additional_body_parameters: nil, timeout_in_seconds: nil)
  @base_url = base_url
  @api_key = api_key
  @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}) 


142
143
144
 
# File 'lib/requests.rb', line 142

def additional_body_parameters
  @additional_body_parameters
end

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

Returns:

  • (Hash{String => Object}) 


138
139
140
 
# File 'lib/requests.rb', line 138

def additional_headers
  @additional_headers
end

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

Returns:

  • (Hash{String => Object}) 


140
141
142
 
# File 'lib/requests.rb', line 140

def additional_query_parameters
  @additional_query_parameters
end

#api_key ⇒ String (readonly)

Returns:

  • (String) 


136
137
138
 
# File 'lib/requests.rb', line 136

def api_key
  @api_key
end

#base_url ⇒ String (readonly)

Returns:

  • (String) 


134
135
136
 
# File 'lib/requests.rb', line 134

def base_url
  @base_url
end

#timeout_in_seconds ⇒ Long (readonly)

Returns:

  • (Long) 


144
145
146
 
# File 'lib/requests.rb', line 144

def timeout_in_seconds
  @timeout_in_seconds
end