Class: WorkOS::Types::RequestOptions

Inherits:

Object

• Object
• WorkOS::Types::RequestOptions

Defined in:

lib/workos/types/request_options.rb

Overview

Documentation-only class describing the per-request override keys accepted by every generated service method via the ‘request_options` keyword argument.

Instance Attribute Summary

• #api_key ⇒ String^? readonly

  Override the client-level API key for this request.

• #base_url ⇒ String^? readonly

  Override the base URL for this request.

• #extra_headers ⇒ Hash{String => String}^? readonly

  Additional HTTP headers to send with this request.

• #idempotency_key ⇒ String^? readonly

  Set a custom Idempotency-Key header for this request.

• #max_retries ⇒ Integer^? readonly

  Override the maximum number of retries for this request.

• #timeout ⇒ Integer^? readonly

  Override the HTTP timeout (seconds) for this request.

Instance Attribute Details

#api_key ⇒ String^? (readonly)

Returns Override the client-level API key for this request.

Returns:

• (String, nil) —

  Override the client-level API key for this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end

#base_url ⇒ String^? (readonly)

Returns Override the base URL for this request.

Returns:

• (String, nil) —

  Override the base URL for this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end

#extra_headers ⇒ Hash{String => String}^? (readonly)

Returns Additional HTTP headers to send with this request.

Returns:

• (Hash{String => String}, nil) —

  Additional HTTP headers to send with this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end

#idempotency_key ⇒ String^? (readonly)

Returns Set a custom Idempotency-Key header for this request.

Returns:

• (String, nil) —

  Set a custom Idempotency-Key header for this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end

#max_retries ⇒ Integer^? (readonly)

Returns Override the maximum number of retries for this request.

Returns:

• (Integer, nil) —

  Override the maximum number of retries for this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end

#timeout ⇒ Integer^? (readonly)

Returns Override the HTTP timeout (seconds) for this request.

Returns:

• (Integer, nil) —

  Override the HTTP timeout (seconds) for this request.

# File 'lib/workos/types/request_options.rb', line 28

class RequestOptions
  # This class is never instantiated — it exists solely for YARD
  # documentation. Service methods accept a plain Hash.
end