Class: Merge::Filestorage::AsyncAsyncPassthroughClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/filestorage/async_passthrough/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Filestorage::AsyncAsyncPassthroughClient

Parameters:



100
101
102
 
# File 'lib/merge_ruby_client/filestorage/async_passthrough/client.rb', line 100

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



96
97
98
 
# File 'lib/merge_ruby_client/filestorage/async_passthrough/client.rb', line 96

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ Merge::Filestorage::AsyncPassthroughReciept

Asynchronously pull data from an endpoint not currently supported by Merge.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.async_passthrough.create(request: { method: GET, path: "/scooters" })

Parameters:

  • request (Hash) —

    Request of type Merge::Filestorage::DataPassthroughRequest, as a Hash

    • :method (Merge::Filestorage::MethodEnum)

    • :path (String)

    • :base_url_override (String)

    • :data (String)

    • :multipart_form_data (Array<Merge::Filestorage::MultipartFormFieldRequest>)

    • :headers (Hash=> Object)

    • :request_format (Merge::Filestorage::RequestFormatEnum)

    • :normalize_response (Boolean)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/merge_ruby_client/filestorage/async_passthrough/client.rb', line 124

def create(request:, request_options: nil)
  Async do
    response = @request_client.conn.post do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/async-passthrough"
    end
    Merge::Filestorage::AsyncPassthroughReciept.from_json(json_object: response.body)
  end
end

#retrieve(async_passthrough_receipt_id:, request_options: nil) ⇒ Merge::Filestorage::RemoteResponse

Retrieves data from earlier async-passthrough POST request

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.async_passthrough.retrieve(async_passthrough_receipt_id: "async_passthrough_receipt_id")

Parameters:

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/merge_ruby_client/filestorage/async_passthrough/client.rb', line 157

def retrieve(async_passthrough_receipt_id:, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/async-passthrough/#{async_passthrough_receipt_id}"
    end
    Merge::Filestorage::RemoteResponse.from_json(json_object: response.body)
  end
end