Client Class Documentation

The following parameters are configurable for the API Client:

Parameter	Type	Description
`environment`	Environment	The API environment. Default: `Environment.SANDBOX`
`connection`	`Faraday::Connection`	The Faraday connection object passed by the SDK user for making requests
`timeout`	`Float`	The value to use for connection timeout. Default: 60
`max_retries`	`Integer`	The number of times to retry an endpoint call if it fails. Default: 0
`retry_interval`	`Float`	Pause in seconds between retries. Default: 1
`backoff_factor`	`Float`	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
`retry_statuses`	`Array`	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
`retry_methods`	`Array`	A list of HTTP methods to retry. Default: %i[get put]
`skip_ssl_cert_verification`	`boolean`	Set to true to allow skipping ssl certificate verification

The API client can be initialized as follows:

client = Hapi::Client.new(
  environment: Environment::SANDBOX,
)

VONQ Hiring API Client

The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.