pds-metronome 0.1.0

data/lib/metronome/models/validation_problem.rb

@@ -0,0 +1,254 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Metronome
+  class ValidationProblem
+    attr_accessor :location
+
+    attr_accessor :val
+
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'location' => :'location',
+        :'val' => :'val',
+        :'description' => :'description'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'location' => :'Array<String>',
+        :'val' => :'String',
+        :'description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Metronome::ValidationProblem` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Metronome::ValidationProblem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'location')
+        if (value = attributes[:'location']).is_a?(Array)
+          self.location = value
+        end
+      end
+
+      if attributes.key?(:'val')
+        self.val = attributes[:'val']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @location.nil?
+        invalid_properties.push('invalid value for "location", location cannot be nil.')
+      end
+
+      if @val.nil?
+        invalid_properties.push('invalid value for "val", val cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @location.nil?
+      return false if @val.nil?
+      return false if @description.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          location == o.location &&
+          val == o.val &&
+          description == o.description
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [location, val, description].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Metronome.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/metronome/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+module Metronome
+  VERSION = '0.1.0'
+end

data/lib/metronome.rb

@@ -0,0 +1,80 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+# Common files
+require 'metronome/api_client'
+require 'metronome/api_error'
+require 'metronome/version'
+require 'metronome/configuration'
+
+# Models
+require 'metronome/models/access_type'
+require 'metronome/models/aging_offset_unit'
+require 'metronome/models/aging_strategy'
+require 'metronome/models/api_key_data'
+require 'metronome/models/api_key_data_list_response'
+require 'metronome/models/api_key_list_response'
+require 'metronome/models/create_api_key_request'
+require 'metronome/models/create_or_modify_api_key_response'
+require 'metronome/models/create_or_modify_policy_request'
+require 'metronome/models/create_or_modify_policy_response'
+require 'metronome/models/expire_item_response'
+require 'metronome/models/expire_sub_item_response'
+require 'metronome/models/expiry_response'
+require 'metronome/models/expiry_response_pending_inner'
+require 'metronome/models/get_many_api_keys200_response'
+require 'metronome/models/get_many_policies200_response'
+require 'metronome/models/item_expiry'
+require 'metronome/models/item_metadata_response'
+require 'metronome/models/item_or_sub_item_access_log'
+require 'metronome/models/item_or_sub_item_policy_response'
+require 'metronome/models/modify_api_key_request'
+require 'metronome/models/permission'
+require 'metronome/models/permission_denied_response'
+require 'metronome/models/policy_data'
+require 'metronome/models/policy_data_list_response'
+require 'metronome/models/policy_list_response'
+require 'metronome/models/put_api_key_request'
+require 'metronome/models/signup_request'
+require 'metronome/models/signup_response'
+require 'metronome/models/sub_item_metadata_response'
+require 'metronome/models/sub_items_expiry'
+require 'metronome/models/telemetry_observation'
+require 'metronome/models/telemetry_request'
+require 'metronome/models/validation_error_response_inner'
+require 'metronome/models/validation_problem'
+
+# APIs
+require 'metronome/api/access_management_api'
+require 'metronome/api/data_expiry_api'
+require 'metronome/api/item_access_api'
+require 'metronome/api/policy_management_api'
+require 'metronome/api/telemetry_api'
+
+module Metronome
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Metronome.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+        Configuration.default.check_required_attributes  # PDS patch
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/shell.nix

@@ -0,0 +1,6 @@
+with import <nixpkgs> {};
+
+stdenv.mkDerivation {
+  name = "metronome-ruby-client-lib";
+  buildInputs = [ ruby_3_1 vscode-with-extensions vscode-extensions.rebornix.ruby ];
+}

data/spec/api/access_management_api_spec.rb

@@ -0,0 +1,82 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Metronome::AccessManagementApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccessManagementApi' do
+  before do
+    # run before each test
+    @api_instance = Metronome::AccessManagementApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccessManagementApi' do
+    it 'should create an instance of AccessManagementApi' do
+      expect(@api_instance).to be_instance_of(Metronome::AccessManagementApi)
+    end
+  end
+
+  # unit tests for get_api_key
+  # Read a specific API key
+  # @param api_key 
+  # @param [Hash] opts the optional parameters
+  # @return [ApiKeyData]
+  describe 'get_api_key test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_many_api_keys
+  # Read many API keys alphanumerically sorted
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset The number of keys to drop from the start
+  # @option opts [Integer] :limit The number of keys to include
+  # @option opts [Boolean] :include_data Whether to include permissions, status, description etc.
+  # @return [GetManyApiKeys200Response]
+  describe 'get_many_api_keys test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for put_api_key
+  # Create or modify an API key
+  # @param api_key The API key to be modified or 'create' for a new key
+  # @param [Hash] opts the optional parameters
+  # @option opts [PutApiKeyRequest] :put_api_key_request 
+  # @return [CreateOrModifyApiKeyResponse]
+  describe 'put_api_key test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for sign_up
+  # Open end point for signing up new customers
+  # @param [Hash] opts the optional parameters
+  # @option opts [SignupRequest] :signup_request 
+  # @return [SignupResponse]
+  describe 'sign_up test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/data_expiry_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Metronome::DataExpiryApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DataExpiryApi' do
+  before do
+    # run before each test
+    @api_instance = Metronome::DataExpiryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DataExpiryApi' do
+    it 'should create an instance of DataExpiryApi' do
+      expect(@api_instance).to be_instance_of(Metronome::DataExpiryApi)
+    end
+  end
+
+  # unit tests for get_expiry_notices
+  # Read items and sub-items that will or have already been expired on the given date
+  # @param date The date to query
+  # @param [Hash] opts the optional parameters
+  # @return [ExpiryResponse]
+  describe 'get_expiry_notices test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/item_access_api_spec.rb

@@ -0,0 +1,132 @@
+=begin
+#Metronome API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@privatedataservices.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Metronome::ItemAccessApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ItemAccessApi' do
+  before do
+    # run before each test
+    @api_instance = Metronome::ItemAccessApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ItemAccessApi' do
+    it 'should create an instance of ItemAccessApi' do
+      expect(@api_instance).to be_instance_of(Metronome::ItemAccessApi)
+    end
+  end
+
+  # unit tests for expire_item
+  # Expire an item and its sub-items immediately
+  # @param item_id The ID of the item being expired
+  # @param [Hash] opts the optional parameters
+  # @return [ExpireItemResponse]
+  describe 'expire_item test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for expire_sub_item
+  # Expire a sub-item immediately
+  # @param item_id The parent item ID of the sub-item being expired
+  # @param sub_item_id The sub-item ID being expired
+  # @param [Hash] opts the optional parameters
+  # @return [ExpireSubItemResponse]
+  describe 'expire_sub_item test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_item_log
+  # Read a specific item's access log
+  # @param item_id The ID of the item to be read
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :start_date Mutually exclusive with specifying the specific sub-items to read.
+  # @option opts [Boolean] :end_date 
+  # @return [ItemOrSubItemAccessLog]
+  describe 'get_item_log test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_item_metadata
+  # Read a specific item's metadata with or without any sub-items.
+  # @param item_id The ID of the item to be read
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :all_sub_items Mutually exclusive with specifying the specific sub-items to read.
+  # @option opts [Boolean] :no_item_content 
+  # @option opts [Array<String>] :sub_item Mutually exclusive with all-sub-items&#x3D;true.  If you only wish to read a few specific sub-items with this item, include each sub-item name in multiple form parameters eg https://url/v1/metronome/items/customer-123?sub-item&#x3D;email&amp;sub-item&#x3D;mobile-phone&amp;sub-item&#x3D;address
+  # @return [ItemMetadataResponse]
+  describe 'get_item_metadata test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_item_policies
+  # Read which policies have been applied to a specific item
+  # @param item_id The ID of the item to be read
+  # @param [Hash] opts the optional parameters
+  # @return [ItemOrSubItemPolicyResponse]
+  describe 'get_item_policies test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_sub_item_log
+  # Read a specific sub-item&#39;s access log
+  # @param item_id The parent item ID of the sub-item being read
+  # @param sub_item_id The sub-item ID to be read
+  # @param [Hash] opts the optional parameters
+  # @return [ItemOrSubItemAccessLog]
+  describe 'get_sub_item_log test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_sub_item_metadata
+  # Read a specific sub-item&#39;s metadata
+  # @param item_id The parent item ID of the sub-item being read
+  # @param sub_item_id The sub-item ID to be read
+  # @param [Hash] opts the optional parameters
+  # @return [SubItemMetadataResponse]
+  describe 'get_sub_item_metadata test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_sub_item_policies
+  # Read which policies have been applied to a specific sub-item
+  # @param item_id The parent item ID of the sub-item being read
+  # @param sub_item_id The sub-item ID to be read
+  # @param [Hash] opts the optional parameters
+  # @return [ItemOrSubItemPolicyResponse]
+  describe 'get_sub_item_policies test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end