spartera_api_sdk 1.0.58

data/lib/spartera_api_sdk/models/user.rb

@@ -0,0 +1,327 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SparteraApiSdk
+  # Individual users within a company
+  class User
+    attr_accessor :user_id
+
+    attr_accessor :company_id
+
+    attr_accessor :function_id
+
+    attr_accessor :status
+
+    attr_accessor :email_address
+
+    attr_accessor :timezone
+
+    attr_accessor :date_created
+
+    attr_accessor :last_updated
+
+    attr_accessor :active
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_id' => :'user_id',
+        :'company_id' => :'company_id',
+        :'function_id' => :'function_id',
+        :'status' => :'status',
+        :'email_address' => :'email_address',
+        :'timezone' => :'timezone',
+        :'date_created' => :'date_created',
+        :'last_updated' => :'last_updated',
+        :'active' => :'active'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_id' => :'String',
+        :'company_id' => :'String',
+        :'function_id' => :'String',
+        :'status' => :'String',
+        :'email_address' => :'String',
+        :'timezone' => :'String',
+        :'date_created' => :'String',
+        :'last_updated' => :'String',
+        :'active' => :'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 `SparteraApiSdk::User` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SparteraApiSdk::User`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'function_id')
+        self.function_id = attributes[:'function_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      end
+
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @company_id.nil?
+      return false if @status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_id Value to be assigned
+    def company_id=(company_id)
+      if company_id.nil?
+        fail ArgumentError, 'company_id cannot be nil'
+      end
+
+      @company_id = company_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    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 &&
+          user_id == o.user_id &&
+          company_id == o.company_id &&
+          function_id == o.function_id &&
+          status == o.status &&
+          email_address == o.email_address &&
+          timezone == o.timezone &&
+          date_created == o.date_created &&
+          last_updated == o.last_updated &&
+          active == o.active
+    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
+      [user_id, company_id, function_id, status, email_address, timezone, date_created, last_updated, active].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = SparteraApiSdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/spartera_api_sdk/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+module SparteraApiSdk
+  VERSION = '1.0.58'
+end

data/lib/spartera_api_sdk.rb

@@ -0,0 +1,62 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+# Common files
+require 'spartera_api_sdk/api_client'
+require 'spartera_api_sdk/api_error'
+require 'spartera_api_sdk/version'
+require 'spartera_api_sdk/configuration'
+
+# Models
+require 'spartera_api_sdk/models/alert'
+require 'spartera_api_sdk/models/apikey'
+require 'spartera_api_sdk/models/asset'
+require 'spartera_api_sdk/models/assetpricehistory'
+require 'spartera_api_sdk/models/cloudprovider'
+require 'spartera_api_sdk/models/company'
+require 'spartera_api_sdk/models/connection'
+require 'spartera_api_sdk/models/error'
+require 'spartera_api_sdk/models/favorite'
+require 'spartera_api_sdk/models/inline_object'
+require 'spartera_api_sdk/models/inline_object1'
+require 'spartera_api_sdk/models/inline_object2'
+require 'spartera_api_sdk/models/inline_object3'
+require 'spartera_api_sdk/models/user'
+
+# APIs
+require 'spartera_api_sdk/api/api_keys_api'
+require 'spartera_api_sdk/api/alerts_api'
+require 'spartera_api_sdk/api/asset_price_history_api'
+require 'spartera_api_sdk/api/assets_api'
+require 'spartera_api_sdk/api/cloud_providers_api'
+require 'spartera_api_sdk/api/companies_api'
+require 'spartera_api_sdk/api/connections_api'
+require 'spartera_api_sdk/api/favorites_api'
+require 'spartera_api_sdk/api/users_api'
+
+module SparteraApiSdk
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SparteraApiSdk.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)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spartera_api_sdk.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "spartera_api_sdk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spartera_api_sdk"
+  s.version     = SparteraApiSdk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tony D"]
+  s.email       = ["tony@spartera.com"]
+  s.homepage    = "https://github.com/spartera-com/spartera-ruby-sdk"
+  s.summary     = "Spartera API Ruby SDK"
+  s.description = "Official SDK for Spartera API - Interface to manage companies' accounts and process insights remotely"
+  s.license     = "Apache-2.0"
+
+  s.required_ruby_version = ">= 2.7.0"
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart', '~> 1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/alerts_api_spec.rb

@@ -0,0 +1,126 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SparteraApiSdk::AlertsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AlertsApi' do
+  before do
+    # run before each test
+    @api_instance = SparteraApiSdk::AlertsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AlertsApi' do
+    it 'should create an instance of AlertsApi' do
+      expect(@api_instance).to be_instance_of(SparteraApiSdk::AlertsApi)
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_alert_id_delete
+  # Delete single alert by ID
+  # @param company_id 
+  # @param user_id 
+  # @param alert_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_alert_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_alert_id_get
+  # Get single alert by ID
+  # @param company_id 
+  # @param user_id 
+  # @param alert_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_alert_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_alert_id_patch
+  # Update an existing alert by ID
+  # @param company_id 
+  # @param user_id 
+  # @param alert_id 
+  # @param alert 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_alert_id_patch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_asset_asset_id_all_get
+  # Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+  # @param company_id 
+  # @param user_id 
+  # @param asset_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_asset_asset_id_all_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_asset_asset_id_get
+  # Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+  # @param company_id 
+  # @param user_id 
+  # @param asset_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_asset_asset_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_get
+  # Get a list of all alerts for a specific user
+  # @param company_id 
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_users_user_id_alerts_post
+  # POST /companies/{company_id}/users/{user_id}/alerts
+  # @param company_id 
+  # @param user_id 
+  # @param alert 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_users_user_id_alerts_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/api_keys_api_spec.rb

@@ -0,0 +1,93 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SparteraApiSdk::APIKeysApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'APIKeysApi' do
+  before do
+    # run before each test
+    @api_instance = SparteraApiSdk::APIKeysApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of APIKeysApi' do
+    it 'should create an instance of APIKeysApi' do
+      expect(@api_instance).to be_instance_of(SparteraApiSdk::APIKeysApi)
+    end
+  end
+
+  # unit tests for companies_company_id_api_keys_api_key_id_get
+  # Get single API key by ID
+  # @param company_id 
+  # @param api_key_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_api_keys_api_key_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_api_keys_api_key_id_patch
+  # Update an existing API key by ID
+  # @param company_id 
+  # @param api_key_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_api_keys_api_key_id_patch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_api_keys_get
+  # Get all API keys
+  # @param company_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_api_keys_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_api_keys_post
+  # Create single API key
+  # @param company_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_api_keys_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for companies_company_id_api_keys_token_delete
+  # Delete single API key by token
+  # @param company_id 
+  # @param token 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'companies_company_id_api_keys_token_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end