A Request is a generic model for making a HTTP request for a given HTTP Client. Whenever requests need to be made to carrier APIs, it should be through a Request model. As such, it supports native Guzzle (opens new window) requests parameters.


Properties are protected and can be accessed with their getPropertyName() getter method or set via setPropertyName(value) setter method.

httpClientHttpClientThe HTTP Client the request should use.
methodstringThe HTTP method to use. Default to POST.
endpointstringThe relative endpoint to request to.
payloadarrayThe payload of data to send.