Class: Rafflesia::DatabaseJoinCandidateReviews

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseJoinCandidateReviews

Returns a new instance of DatabaseJoinCandidateReviews.



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

def initialize(client)
  @client = client
end

Instance Method Details

#create(candidate_id:, decision:, review_version:, reviewer:, cardinality: nil, coordinate_notes: nil, evidence_references: nil, is_direction_reviewed: nil, is_identifier_namespace_reviewed: nil, is_lossy: nil, is_range_mapping: nil, rejection_reason: nil, semantic_basis: nil, supersedes_review_id: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateReviewData

POST /v1/database_join_candidate_reviews

Parameters:

  • candidate_id (String)
  • cardinality (Rafflesia::Types::DatabaseJoinCandidateReviewRequestCardinality, nil) (defaults to: nil)
  • coordinate_notes (String, nil) (defaults to: nil)
  • decision (Rafflesia::Types::DatabaseJoinCandidateReviewRequestDecision)
  • evidence_references (Array<Rafflesia::OntologyReviewEvidenceReference>, nil) (defaults to: nil)
  • is_direction_reviewed (Boolean, nil) (defaults to: nil)
  • is_identifier_namespace_reviewed (Boolean, nil) (defaults to: nil)
  • is_lossy (Boolean, nil) (defaults to: nil)
  • is_range_mapping (Boolean, nil) (defaults to: nil)
  • rejection_reason (String, nil) (defaults to: nil)
  • review_version (String)
  • reviewer (String)
  • semantic_basis (String, nil) (defaults to: nil)
  • supersedes_review_id (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/rafflesia/database_join_candidate_reviews.rb', line 53

def create(
  candidate_id:,
  decision:,
  review_version:,
  reviewer:,
  cardinality: nil,
  coordinate_notes: nil,
  evidence_references: nil,
  is_direction_reviewed: nil,
  is_identifier_namespace_reviewed: nil,
  is_lossy: nil,
  is_range_mapping: nil,
  rejection_reason: nil,
  semantic_basis: nil,
  supersedes_review_id: nil,
  request_options: {}
)
  body = {
    'candidate_id' => candidate_id,
    'cardinality' => cardinality,
    'coordinate_notes' => coordinate_notes,
    'decision' => decision,
    'evidence_references' => evidence_references,
    'is_direction_reviewed' => is_direction_reviewed,
    'is_identifier_namespace_reviewed' => is_identifier_namespace_reviewed,
    'is_lossy' => is_lossy,
    'is_range_mapping' => is_range_mapping,
    'rejection_reason' => rejection_reason,
    'review_version' => review_version,
    'reviewer' => reviewer,
    'semantic_basis' => semantic_basis,
    'supersedes_review_id' => supersedes_review_id
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/database_join_candidate_reviews',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateReviewData.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(review_id:, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateReviewData

GET /v1/database_join_candidate_reviews/review_id

Parameters:

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

    (see Rafflesia::Types::RequestOptions)

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rafflesia/database_join_candidate_reviews.rb', line 102

def get(
  review_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/database_join_candidate_reviews/#{Rafflesia::Util.encode_path(review_id)}",
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateReviewData.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(candidate_id:, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateReviewListData

GET /v1/database_join_candidate_reviews

Parameters:

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

    (see Rafflesia::Types::RequestOptions)

Returns:



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

def list(
  candidate_id:,
  request_options: {}
)
  params = {
    'candidate_id' => candidate_id
  }
  response = @client.request(
    method: :get,
    path: '/v1/database_join_candidate_reviews',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateReviewListData.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