pds-metronome

metronome

Metronome - the Ruby gem for the Metronome API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

From Ruby gems

gem install ./metronome-1.0.0.gem

or add this to your Gemfile:

gem 'metronome', '~> 1.0.0'

Build this gem

To build the Ruby code into a gem:

gem build metronome.gemspec

Then either install the gem locally:

(for development, run gem install --dev ./metronome-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to a Gemfile for a project that depends on this gem:

gem 'metronome', '~> 1.0.0'

Install from Git

The Ruby gem is hosted at a git repository: https://github.com/Private-Data-Services/metronome-client-libs You can add the following in your Gemfile:

gem 'metronome', :git => 'https://github.com/Private-Data-Services/metronome-client-libs/tree/main/ruby'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Examples are available in the ruby client examples folder

Please follow the installation procedure and then run the following code:

# Load the gem
require 'metronome'

# Setup authorization
Metronome.configure do |config|
  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
  config.customer_id = "YOUR-CUSTOMER-ID"  # Only characters [a-z0-9\-] allowed.  You invent this value to identify your organisation.
  config.region = "eu-north-1"  # Select from one of our available regions.  Mail [e-mail] to request a new region.
end

api_instance = Metronome::AccessManagementApi.new
api_key = 'api_key_example' # String | 

begin
  result = api_instance.get_api_key(api_key)
  p result
rescue Metronome::ApiError => e
  puts "Exception when calling AccessManagementApi->get_api_key: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://YOUR-CUSTOMER-ID.api.REGION.privatedataservices.com You should only need to use or know this value when you use the REST API directly. The server name is handled by this client automatically.

Class	Method	HTTP request	Description
Metronome::AccessManagementApi	get_api_key	GET /v1/metronome/api-keys/{api-key}
Metronome::AccessManagementApi	get_many_api_keys	GET /v1/metronome/api-keys
Metronome::AccessManagementApi	put_api_key	PUT /v1/metronome/api-keys/{api-key}
Metronome::AccessManagementApi	sign_up	PUT /v1/metronome/sign-up
Metronome::DataExpiryApi	get_expiry_notices	GET /v1/metronome/expiry-notices/{date}
Metronome::ItemAccessApi	expire_item	DELETE /v1/metronome/items/{item-id}
Metronome::ItemAccessApi	expire_sub_item	DELETE /v1/metronome/items/{item-id}/{sub-item-id}
Metronome::ItemAccessApi	get_item_log	GET /v1/metronome/items/{item-id}/log
Metronome::ItemAccessApi	get_item_metadata	GET /v1/metronome/items/{item-id}
Metronome::ItemAccessApi	get_item_policies	GET /v1/metronome/items/{item-id}/policies
Metronome::ItemAccessApi	get_sub_item_log	GET /v1/metronome/items/{item-id}/{sub-item-id}/log
Metronome::ItemAccessApi	get_sub_item_metadata	GET /v1/metronome/items/{item-id}/{sub-item-id}
Metronome::ItemAccessApi	get_sub_item_policies	GET /v1/metronome/items/{item-id}/{sub-item-id}/policies
Metronome::PolicyManagementApi	get_many_policies	GET /v1/metronome/policies
Metronome::PolicyManagementApi	get_policy	GET /v1/metronome/policies/{policy-id}
Metronome::PolicyManagementApi	get_policy_log	GET /v1/metronome/policies/{policy-id}/log
Metronome::PolicyManagementApi	get_policy_members	GET /v1/metronome/policies/{policy-id}/members
Metronome::PolicyManagementApi	put_policy	PUT /v1/metronome/policies/{policy-id}
Metronome::TelemetryApi	post_telemetry	POST /v1/metronome/telemetry

Documentation for Models

• Metronome::AccessType
• Metronome::AgingOffsetUnit
• Metronome::AgingStrategy
• Metronome::ApiKeyData
• Metronome::ApiKeyDataListResponse
• Metronome::ApiKeyListResponse
• Metronome::CreateApiKeyRequest
• Metronome::CreateOrModifyApiKeyResponse
• Metronome::CreateOrModifyPolicyRequest
• Metronome::CreateOrModifyPolicyResponse
• Metronome::ExpireItemResponse
• Metronome::ExpireSubItemResponse
• Metronome::ExpiryResponse
• Metronome::ExpiryResponsePendingInner
• Metronome::GetManyApiKeys200Response
• Metronome::GetManyPolicies200Response
• Metronome::ItemExpiry
• Metronome::ItemMetadataResponse
• Metronome::ItemOrSubItemAccessLog
• Metronome::ItemOrSubItemPolicyResponse
• Metronome::ModifyApiKeyRequest
• Metronome::Permission
• Metronome::PermissionDeniedResponse
• Metronome::PolicyData
• Metronome::PolicyDataListResponse
• Metronome::PolicyListResponse
• Metronome::PutApiKeyRequest
• Metronome::SignupRequest
• Metronome::SignupResponse
• Metronome::SubItemMetadataResponse
• Metronome::SubItemsExpiry
• Metronome::TelemetryObservation
• Metronome::TelemetryRequest
• Metronome::ValidationErrorResponseInner
• Metronome::ValidationProblem

Documentation for Authorization

API key must always be set during configuration except for the AccessManagementApi->sign_up call.

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header