Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.9 KB

DataPassthroughRequest.md

File metadata and controls

32 lines (26 loc) · 1.9 KB

MergeHRISClient::DataPassthroughRequest

Properties

Name Type Description Notes
method MethodEnum
path String The path of the request in the third party's platform.
base_url_override String An optional override of the third party's base url for the request. [optional]
data String The data with the request. You must include a `request_format` parameter matching the data's format [optional]
multipart_form_data Array<MultipartFormFieldRequest> Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. [optional]
headers Hash<String, AnyType> The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. [optional]
request_format RequestFormatEnum [optional]
normalize_response Boolean Optional. If true, the response will always be an object of the form `{&quot;type&quot;: T, &quot;value&quot;: ...}` where `T` will be one of `string, boolean, number, null, array, object`. [optional]

Example

require 'merge_hris_client'

instance = MergeHRISClient::DataPassthroughRequest.new(
  method: POST,
  path: /scooters,
  base_url_override: https://api.example.com,
  data: {&quot;company&quot;: &quot;Lime&quot;, &quot;model&quot;: &quot;Gen 2.5&quot;},
  multipart_form_data: null,
  headers: {&quot;EXTRA-HEADER&quot;:&quot;value&quot;},
  request_format: JSON,
  normalize_response: null
)