module Faraday

@!parse

# ConnectionOptions contains the configurable properties for a Faraday
# connection object.
class ConnectionOptions < Options; end

@!parse

# @!attribute method
#   @return [Symbol] HTTP method (`:get`, `:post`)
#
# @!attribute body
#   @return [String] The request body that will eventually be converted to a
#   string.
#
# @!attribute url
#   @return [URI] URI instance for the current request.
#
# @!attribute request
#   @return [Hash] options for configuring the request.
#   Options for configuring the request.
#
#   - `:timeout`       - time limit for the entire request (Integer in
#                        seconds)
#   - `:open_timeout`  - time limit for just the connection phase (e.g.
#                        handshake) (Integer in seconds)
#   - `:read_timeout`  - time limit for the first response byte received from
#                        the server (Integer in seconds)
#   - `:write_timeout` - time limit for the client to send the request to the
#                        server (Integer in seconds)
#   - `:on_data`       - Proc for streaming
#   - `:proxy`         - Hash of proxy options
#       - `:uri`         - Proxy server URI
#       - `:user`        - Proxy server username
#       - `:password`    - Proxy server password
#
# @!attribute request_headers
#   @return [Hash] HTTP Headers to be sent to the server.
#
# @!attribute ssl
#   @return [Hash] options for configuring SSL requests
#
# @!attribute parallel_manager
#   @return [Object] sent if the connection is in parallel mode
#
# @!attribute params
#   @return [Hash]
#
# @!attribute response
#   @return [Response]
#
# @!attribute response_headers
#   @return [Hash] HTTP headers from the server
#
# @!attribute status
#   @return [Integer] HTTP response status code
#
# @!attribute reason_phrase
#   @return [String]
class Env < Options; end

@!parse

# ProxyOptions contains the configurable properties for the proxy
# configuration used when making an HTTP request.
class ProxyOptions < Options; end

Used to setup URLs, params, headers, and the request body in a sane manner.

@example

@connection.post do |req|
  req.url 'http://localhost', 'a' => '1' # 'http://localhost?a=1'
  req.headers['b'] = '2' # Header
  req.params['c']  = '3' # GET Param
  req['b']         = '2' # also Header
  req.body = 'abc'
end

@!attribute http_method

@return [Symbol] the HTTP method of the Request

@!attribute path

@return [URI, String] the path

@!attribute params

@return [Hash] query parameters

@!attribute headers

@return [Faraday::Utils::Headers] headers

@!attribute body

@return [String] body

@!attribute options

@return [RequestOptions] options

@!parse

# RequestOptions contains the configurable properties for a Faraday request.
class RequestOptions < Options; end

@!parse

# SSL-related options.
#
# @!attribute verify
#   @return [Boolean] whether to verify SSL certificates or not
#
# @!attribute verify_hostname
#   @return [Boolean] whether to enable hostname verification on server certificates
#           during the handshake or not (see https://github.com/ruby/openssl/pull/60)
#
# @!attribute hostname
#   @return [String] Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D)
#
# @!attribute ca_file
#   @return [String] CA file
#
# @!attribute ca_path
#   @return [String] CA path
#
# @!attribute verify_mode
#   @return [Integer] Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
#
# @!attribute cert_store
#   @return [OpenSSL::X509::Store] certificate store
#
# @!attribute client_cert
#   @return [String, OpenSSL::X509::Certificate] client certificate
#
# @!attribute client_key
#   @return [String, OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] client key
#
# @!attribute certificate
#   @return [OpenSSL::X509::Certificate] certificate (Excon only)
#
# @!attribute private_key
#   @return [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] private key (Excon only)
#
# @!attribute verify_depth
#   @return [Integer] maximum depth for the certificate chain verification
#
# @!attribute version
#   @return [String, Symbol] SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D)
#
# @!attribute min_version
#   @return [String, Symbol] minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D)
#
# @!attribute max_version
#   @return [String, Symbol] maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)
#
# @!attribute ciphers
#   @return [String] cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D)
class SSLOptions < Options; end