Module: SafetyKit::Internal::Type::RequestParameters Private

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Converter

Constant Summary collapse

SafetyKit =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (:request_opts)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#request_optionsSafetyKit::request_opts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Options to specify HTTP behaviour for this request.

@return [SafetyKit::RequestOptions, Hash{Symbol=>Object}]

Returns:

  • (SafetyKit::request_opts)


# File 'lib/safety_kit/internal/type/request_parameters.rb', line 8

Class Method Details

.included(mod) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • mod (Module)

Raises:

  • (ArgumentError)


14
15
16
17
18
# File 'lib/safety_kit/internal/type/request_parameters.rb', line 14

def self.included(mod)
  raise ArgumentError.new(mod) unless mod <= SafetyKit::Internal::Type::BaseModel

  mod.optional(:request_options, SafetyKit::RequestOptions)
end