Class: FinchAPI::Models::RequestForwardingForwardParams

Inherits:
BaseModel
  • Object
show all
Includes:
Type::RequestParameters
Defined in:
lib/finch-api/models/request_forwarding_forward_params.rb

Instance Attribute Summary collapse

Attributes included from Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Type::RequestParameters

included

Constructor Details

#initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) ⇒ RequestForwardingForwardParams

Returns a new instance of RequestForwardingForwardParams.

Parameters:

  • method_ (String)
  • route (String)
  • data (String, nil) (defaults to: nil)
  • headers (Object, nil) (defaults to: nil)
  • params (Object, nil) (defaults to: nil)
  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


8
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 8

def initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}, **) = super

Instance Attribute Details

#data ⇒ String?

The body for the forwarded request. This value must be specified as either a

string or a valid JSON object.

Returns:

  • (String, nil) 


30
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 30

optional :data, String, nil?: true

#headers ⇒ Object?

The HTTP headers to include on the forwarded request. This value must be

specified as an object of key-value pairs. Example:
`{"Content-Type": "application/xml", "X-API-Version": "v1" }`

Returns:

  • (Object, nil) 


38
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 38

optional :headers, FinchAPI::Unknown, nil?: true

#method_ ⇒ String

The HTTP method for the forwarded request. Valid values include: ‘GET` , `POST`

, `PUT` , `DELETE` , and `PATCH`.

Returns:

  • (String) 


15
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 15

required :method_, String, api_name: :method

#params ⇒ Object?

The query parameters for the forwarded request. This value must be specified as

a valid JSON object rather than a query string.

Returns:

  • (Object, nil) 


45
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 45

optional :params, FinchAPI::Unknown, nil?: true

#route ⇒ String

The URL route path for the forwarded request. This value must begin with a

forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
underscores.

Returns:

  • (String) 


23
 
# File 'lib/finch-api/models/request_forwarding_forward_params.rb', line 23

required :route, String