Class: NewDemoApiClient::MetadataClient

Inherits:
Object
  • Object
show all
Defined in:
lib/test_sdk/metadata/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ NewDemoApiClient::MetadataClient

Parameters:



14
15
16
 
# File 'lib/test_sdk/metadata/client.rb', line 14

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ NewDemoApiClient::RequestClient (readonly)

Returns:



10
11
12
 
# File 'lib/test_sdk/metadata/client.rb', line 10

def request_client
  @request_client
end

Instance Method Details

#get_diligence_metadata(group_id:, request_options: nil) ⇒ NewDemoApiClient::AllDataMetadataResponse

Retrieve select metadata about all diligence data for a group.

Examples:

api = NewDemoApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: NewDemoApiClient::Environment::DEFAULT,
  token: "YOUR_AUTH_TOKEN"
)
api.metadata.get_diligence_metadata(group_id: 1)

Parameters:

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/test_sdk/metadata/client.rb', line 30

def get_diligence_metadata(group_id:, request_options: nil)
  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.token unless request_options&.token.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)}/api/v1/group/#{group_id}/data/metadata"
  end
  NewDemoApiClient::AllDataMetadataResponse.from_json(json_object: response.body)
end