Class: Rafflesia::Refs

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/refs.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Refs

Returns a new instance of Refs.



9
10
11
 
# File 'lib/rafflesia/refs.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#resolve(query:, allow_network: nil, limit: nil, source_snapshot_refs: nil, request_options: {}) ⇒ Rafflesia::EnvelopeTargetResolveData

POST /v1/refs/resolve

Parameters:

  • allow_network (Boolean, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)
  • query (String)
  • source_snapshot_refs (Array<String>, nil) (defaults to: nil) —

    Source snapshot refs whose records table should be searched for deterministic candidates.

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rafflesia/refs.rb', line 20

def resolve(
  query:,
  allow_network: nil,
  limit: nil,
  source_snapshot_refs: nil,
  request_options: {}
)
  body = {
    'allow_network' => allow_network,
    'limit' => limit,
    'query' => query,
    'source_snapshot_refs' => source_snapshot_refs
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/refs/resolve',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeTargetResolveData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end