Class: FinchAPI::Models::RequestForwardingForwardResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/request_forwarding_forward_response.rb

Defined Under Namespace

Classes: Request

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data:, headers:, request:, status_code:) ⇒ RequestForwardingForwardResponse

Returns a new instance of RequestForwardingForwardResponse.

Parameters:



6
 
# File 'lib/finch-api/models/request_forwarding_forward_response.rb', line 6

def initialize(data:, headers:, request:, status_code:, **) = super

Instance Attribute Details

#data ⇒ String?

A string representation of the HTTP response body of the forwarded request’s

response received from the underlying integration’s API. This field may be null
in the case where the upstream system’s response is empty.

Returns:

  • (String, nil) 


12
 
# File 'lib/finch-api/models/request_forwarding_forward_response.rb', line 12

required :data, String, nil?: true

#headers ⇒ Object?

The HTTP headers of the forwarded request’s response, exactly as received from

the underlying integration’s API.

Returns:

  • (Object, nil) 


19
 
# File 'lib/finch-api/models/request_forwarding_forward_response.rb', line 19

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

#request ⇒ FinchAPI::Models::RequestForwardingForwardResponse::Request

An object containing details of your original forwarded request, for your ease

of reference.

Returns:



26
 
# File 'lib/finch-api/models/request_forwarding_forward_response.rb', line 26

required :request, -> { FinchAPI::Models::RequestForwardingForwardResponse::Request }

#status_code ⇒ Integer

The HTTP status code of the forwarded request’s response, exactly received from

the underlying integration’s API. This value will be returned as an integer.

Returns:

  • (Integer) 


33
 
# File 'lib/finch-api/models/request_forwarding_forward_response.rb', line 33

required :status_code, Integer, api_name: :statusCode