Class: Rafflesia::DatabaseJoinCoverageLedgers

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseJoinCoverageLedgers

Returns a new instance of DatabaseJoinCoverageLedgers.



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

def initialize(client)
  @client = client
end

Instance Method Details

#create(candidate_cells: nil, certification_cells: nil, dataset_name: nil, dataset_version: nil, drift_cells: nil, external_review_measurements: nil, ontology_digest: nil, path_cells: nil, unsafe_controls: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCoverageLedgerData

POST /v1/database_join_coverage_ledgers

Parameters:

Returns:



48
49
50
51
52
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
 
# File 'lib/rafflesia/database_join_coverage_ledgers.rb', line 48

def create(
  candidate_cells: nil,
  certification_cells: nil,
  dataset_name: nil,
  dataset_version: nil,
  drift_cells: nil,
  external_review_measurements: nil,
  ontology_digest: nil,
  path_cells: nil,
  unsafe_controls: nil,
  request_options: {}
)
  body = {
    'candidate_cells' => candidate_cells,
    'certification_cells' => certification_cells,
    'dataset_name' => dataset_name,
    'dataset_version' => dataset_version,
    'drift_cells' => drift_cells,
    'external_review_measurements' => external_review_measurements,
    'ontology_digest' => ontology_digest,
    'path_cells' => path_cells,
    'unsafe_controls' => unsafe_controls
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/database_join_coverage_ledgers',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCoverageLedgerData.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(ledger_id:, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCoverageLedgerData

GET /v1/database_join_coverage_ledgers/ledger_id

Parameters:

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

    (see Rafflesia::Types::RequestOptions)

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rafflesia/database_join_coverage_ledgers.rb', line 87

def get(
  ledger_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/database_join_coverage_ledgers/#{Rafflesia::Util.encode_path(ledger_id)}",
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCoverageLedgerData.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: 100, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCoverageLedgerListData

GET /v1/database_join_coverage_ledgers

Parameters:

  • limit (Integer, nil) (defaults to: 100)
  • 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_coverage_ledgers.rb', line 17

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