Response

Determine if the response code was 200 "OK" response.

Determine if the response code was 201 "Created" response.

Determine if the response code was 202 "Accepted" response.

Determine if the response code was the given status code and the body has no content.

Determine if the response code was a 301 "Moved Permanently".

Determine if the response code was a 302 "Found" response.

Determine if the response code was a 304 "Not Modified" response.

Determine if the response was a 400 "Bad Request" response.

Determine if the response was a 401 "Unauthorized" response.

Determine if the response was a 402 "Payment Required" response.

Determine if the response was a 403 "Forbidden" response.

Determine if the response was a 404 "Not Found" response.

Determine if the response was a 408 "Request Timeout" response.

Determine if the response was a 409 "Conflict" response.

Determine if the response was a 422 "Unprocessable Content" response.

Determine if the response was a 422 "Unprocessable Content" response.

Determine if the response was a 429 "Too Many Requests" response.

Call the given Closure with this instance then return the instance.

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Check if macro is registered.

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Dynamically handle calls to the class.

Dynamically handle calls to the class.

Create a new response instance.

Get the response body.

Read lines from the current response body position without rewinding.

Decode non-empty JSON lines from the current response body position.

Get the decoded JSON body of the response as an array or scalar value.

Get the decoded JSON body of the response as an object.

Example: If the response body is: [ {"id": 1, "name": "John"}, {"id": 2, "name": "Jane"} ]

This method will return an array of objects. Scalar JSON values remain their decoded scalar type.

Set a custom decode callback.

The callback will be invoked with the following parameters:

• string $body: The raw response body.
• bool $asObject: Whether JSON objects should be decoded as objects.

Decode the given response body.

Get the decoded JSON body of the response as a collection.

Get the decoded JSON body of the response as a fluent object.

Get the body of the response as a PHP resource.

Get a header from the response.

Get the headers from the response.

Get the status code of the response.

Get the reason phrase of the response.

Get the effective URI of the response.

Determine if the request was successful.

Determine if the response was a redirect.

Determine if the integration considers the response failed.

Determine if the response indicates a client error occurred.

Determine if the response indicates a server error occurred.

Execute the given callback if there was a server or client error.

Get the response cookies.

Get the handler stats of the response.

Close the stream and any underlying resources.

Get the underlying PSR response for the response.

Create an exception when the integration considers the response throwable.

Create a new request exception for the response.

Throw an exception when the integration considers the response throwable.

Throw an exception if a server or client error occurred and the given condition evaluates to true.

Throw an exception if a server or client error occurred and the given condition evaluates to false.

Throw an exception if the response status code matches the given code.

Throw an exception unless the response status code matches the given code.

Throw an exception if the response status code is a 4xx level code.

Throw an exception if the response status code is a 5xx level code.

Indicate that request exceptions should be truncated to the given length.

Indicate that request exceptions should not be truncated.

Dump the content from the response.

Dump the content from the response and end the script.

Dump the headers from the response.

Dump the headers from the response and end the script.

Determine if the given offset exists.

Get the value for a given offset.

Set the value at the given offset.

Unset the value at the given offset.

Flush all static state.

Get the body of the response.

Create a Saloon response from a framework response.

Get the response body stream.

Get the pending request.

Get the connector.

Get the original request.

Get the final application-owned PSR request.

Determine if the response should throw a request exception.

Convert the response into a data object.

Convert the response into a data object or fail.

Convert the XML response into a SimpleXMLElement.

Parse the HTML or XML response into a DOM crawler.

Convert the response into a data URL.

Create a temporary resource containing the response body.

Save the response body to a path or resource.

Determine if the response came from the cache.

Set whether the response came from the cache.

Determine if the response came from a mock client.

Set whether the response came from a mock client.

Determine if the response came from a short-circuit source.

Set the fake response that produced this response.

Get the fake response that produced this response.