Class: Rafflesia::HomologyResultReleases

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ HomologyResultReleases

Returns a new instance of HomologyResultReleases.



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

def initialize(client)
  @client = client
end

Instance Method Details

#create(homology_search_id:, database: nil, release: nil, request_options: {}) ⇒ Rafflesia::EnvelopeHomologyResultRelease

POST /v1/homology_result_releases

Parameters:

  • database (String, nil) (defaults to: nil) —

    Logical query database. Defaults to homology_search_results.

  • homology_search_id (String) —

    Completed retained hsrch_ resource to materialize.

  • release (String, nil) (defaults to: nil) —

    Immutable logical release. Defaults to a value derived from the retained result digest.

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

    (see Rafflesia::Types::RequestOptions)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rafflesia/homology_result_releases.rb', line 45

def create(
  homology_search_id:,
  database: nil,
  release: nil,
  request_options: {}
)
  body = {
    'database' => database,
    'homology_search_id' => homology_search_id,
    'release' => release
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/homology_result_releases',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHomologyResultRelease.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

#get(homology_result_release_id:, request_options: {}) ⇒ Rafflesia::EnvelopeHomologyResultRelease

GET /v1/homology_result_releases/homology_result_release_id

Parameters:

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

    (see Rafflesia::Types::RequestOptions)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rafflesia/homology_result_releases.rb', line 72

def get(
  homology_result_release_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/homology_result_releases/#{Rafflesia::Util.encode_path(homology_result_release_id)}",
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHomologyResultRelease.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

#list(limit: nil, starting_after: nil, request_options: {}) ⇒ Rafflesia::EnvelopeHomologyResultReleaseList

GET /v1/homology_result_releases

Parameters:

  • limit (Integer, nil) (defaults to: nil)
  • starting_after (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rafflesia/homology_result_releases.rb', line 18

def list(
  limit: nil,
  starting_after: nil,
  request_options: {}
)
  params = {
    'limit' => limit,
    'starting_after' => starting_after
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/homology_result_releases',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHomologyResultReleaseList.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