vantage-client 0.0.8 → 0.1.0.beta.2

data/lib/vantage-client/api/costs_api.rb

@@ -0,0 +1,185 @@
+=begin
+#Vantage
+
+#Vantage API
+
+OpenAPI spec version: 1.0.0
+Contact: support@vantage.sh
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.21
+
+=end
+
+require 'uri'
+
+module Vantage
+  class CostsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Return available Costs for the specified Cost Report and optional time period. If no time period is specified it will return all available costs for the report.
+    # @param report_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+    # @option opts [String] :end_date Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
+    # @return [Costs]
+    def get_costs(report_id, opts = {})
+      data, _status_code, _headers = get_costs_with_http_info(report_id, opts)
+      data
+    end
+
+    # Return available Costs for the specified Cost Report and optional time period. If no time period is specified it will return all available costs for the report.
+    # @param report_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+    # @option opts [String] :end_date Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
+    # @return [Array<(Costs, Fixnum, Hash)>] Costs data, response status code and response headers
+    def get_costs_with_http_info(report_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CostsApi.get_costs ...'
+      end
+      # verify the required parameter 'report_id' is set
+      if @api_client.config.client_side_validation && report_id.nil?
+        fail ArgumentError, "Missing the required parameter 'report_id' when calling CostsApi.get_costs"
+      end
+      # resource path
+      local_var_path = '/v1/reports/{report_id}/costs'.sub('{' + 'report_id' + '}', report_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Costs')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CostsApi#get_costs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Return a Cost Report.
+    # @param report_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Report]
+    def get_report(report_id, opts = {})
+      data, _status_code, _headers = get_report_with_http_info(report_id, opts)
+      data
+    end
+
+    # Return a Cost Report.
+    # @param report_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Report, Fixnum, Hash)>] Report data, response status code and response headers
+    def get_report_with_http_info(report_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CostsApi.get_report ...'
+      end
+      # verify the required parameter 'report_id' is set
+      if @api_client.config.client_side_validation && report_id.nil?
+        fail ArgumentError, "Missing the required parameter 'report_id' when calling CostsApi.get_report"
+      end
+      # resource path
+      local_var_path = '/v1/reports/{report_id}'.sub('{' + 'report_id' + '}', report_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Report')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CostsApi#get_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Return all Cost Reports.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
+    # @return [Reports]
+    def get_reports(opts = {})
+      data, _status_code, _headers = get_reports_with_http_info(opts)
+      data
+    end
+
+    # Return all Cost Reports.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
+    # @return [Array<(Reports, Fixnum, Hash)>] Reports data, response status code and response headers
+    def get_reports_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CostsApi.get_reports ...'
+      end
+      # resource path
+      local_var_path = '/v1/reports'
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Reports')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CostsApi#get_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/vantage-client/api/ping_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 Contact: support@vantage.sh
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Swagger Codegen version: 2.4.21
 
 =end
 
@@ -19,7 +19,7 @@ module Vantage
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # This is a health check endpoint that can be used to determine Vantage API healthiness. It will return a 200 success with the raw text of \"pong\" if everything is running smoothly.
+    # This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly.
     # @param [Hash] opts the optional parameters
     # @return [Object]
     def ping(opts = {})
@@ -27,7 +27,7 @@ module Vantage
       data
     end
 
-    # This is a health check endpoint that can be used to determine Vantage API healthiness. It will return a 200 success with the raw text of \"pong\" if everything is running smoothly.
+    # This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
     def ping_with_http_info(opts = {})

data/lib/vantage-client/api/prices_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 Contact: support@vantage.sh
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Swagger Codegen version: 2.4.21
 
 =end
 
@@ -78,6 +78,8 @@ module Vantage
     # Return available Prices across all Regions for a Product.
     # @param product_id 
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Prices]
     def get_prices(product_id, opts = {})
       data, _status_code, _headers = get_prices_with_http_info(product_id, opts)
@@ -87,6 +89,8 @@ module Vantage
     # Return available Prices across all Regions for a Product.
     # @param product_id 
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Array<(Prices, Fixnum, Hash)>] Prices data, response status code and response headers
     def get_prices_with_http_info(product_id, opts = {})
       if @api_client.config.debugging
@@ -101,6 +105,8 @@ module Vantage
 
       # query parameters
       query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = {}
@@ -180,6 +186,8 @@ module Vantage
     # @option opts [String] :provider_id Query by Provider to list all Products across all Services for a Provider. e.g. aws
     # @option opts [String] :service_id Query by Service to list all Products for a specific provider service. e.g. aws-ec2
     # @option opts [String] :name Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Products]
     def get_products(opts = {})
       data, _status_code, _headers = get_products_with_http_info(opts)
@@ -191,6 +199,8 @@ module Vantage
     # @option opts [String] :provider_id Query by Provider to list all Products across all Services for a Provider. e.g. aws
     # @option opts [String] :service_id Query by Service to list all Products for a specific provider service. e.g. aws-ec2
     # @option opts [String] :name Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Array<(Products, Fixnum, Hash)>] Products data, response status code and response headers
     def get_products_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -204,6 +214,8 @@ module Vantage
       query_params[:'provider_id'] = opts[:'provider_id'] if !opts[:'provider_id'].nil?
       query_params[:'service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = {}
@@ -230,6 +242,8 @@ module Vantage
     end
     # Providers are cloud infrastructure and service providers from which all cloud prices are derived. You can think of example Providers as being AWS, GCP, Cloudflare or Datadog. Currently, Vantage only supports a single provider of AWS but over time more will be added. Use this endpoint to retrieve a provider id for other API calls.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Providers]
     def get_providers(opts = {})
       data, _status_code, _headers = get_providers_with_http_info(opts)
@@ -238,6 +252,8 @@ module Vantage
 
     # Providers are cloud infrastructure and service providers from which all cloud prices are derived. You can think of example Providers as being AWS, GCP, Cloudflare or Datadog. Currently, Vantage only supports a single provider of AWS but over time more will be added. Use this endpoint to retrieve a provider id for other API calls.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Array<(Providers, Fixnum, Hash)>] Providers data, response status code and response headers
     def get_providers_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -248,6 +264,8 @@ module Vantage
 
       # query parameters
       query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = {}
@@ -275,6 +293,8 @@ module Vantage
     # Return all Services. Examples of Services are EC2 for AWS. This endpoint will return all Services by default but you have the ability to filter Services by Provider using the optional query parameter documented below.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :provider_id Query services for a specific provider. e.g. aws
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Services]
     def get_services(opts = {})
       data, _status_code, _headers = get_services_with_http_info(opts)
@@ -284,6 +304,8 @@ module Vantage
     # Return all Services. Examples of Services are EC2 for AWS. This endpoint will return all Services by default but you have the ability to filter Services by Provider using the optional query parameter documented below.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :provider_id Query services for a specific provider. e.g. aws
+    # @option opts [Integer] :page The page of results to return.
+    # @option opts [Integer] :limit The amount of results to return. The maximum is 1000
     # @return [Array<(Services, Fixnum, Hash)>] Services data, response status code and response headers
     def get_services_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -295,6 +317,8 @@ module Vantage
       # query parameters
       query_params = {}
       query_params[:'provider_id'] = opts[:'provider_id'] if !opts[:'provider_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = {}

data/lib/vantage-client/api_client.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 Contact: support@vantage.sh
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Swagger Codegen version: 2.4.21
 
 =end
 

data/lib/vantage-client/api_error.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 Contact: support@vantage.sh
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Swagger Codegen version: 2.4.21
 
 =end
 

data/lib/vantage-client/configuration.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 Contact: support@vantage.sh
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Swagger Codegen version: 2.4.21
 
 =end
 

data/lib/vantage-client/models/cost.rb

@@ -0,0 +1,215 @@
+=begin
+#Vantage
+
+#Vantage API
+
+OpenAPI spec version: 1.0.0
+Contact: support@vantage.sh
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.21
+
+=end
+
+require 'date'
+
+module Vantage
+  class Cost
+    # The date the cost was accrued. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+    attr_accessor :accrued_at
+
+    # The amount of the cost.
+    attr_accessor :amount
+
+    # The service provider where the cost was incurred. e.g. AWS
+    attr_accessor :provider
+
+    # The service which incurred the cost. e.g. Amazon ElastiCache
+    attr_accessor :service
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'accrued_at' => :'accrued_at',
+        :'amount' => :'amount',
+        :'provider' => :'provider',
+        :'service' => :'service'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'accrued_at' => :'String',
+        :'amount' => :'String',
+        :'provider' => :'String',
+        :'service' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'accrued_at')
+        self.accrued_at = attributes[:'accrued_at']
+      end
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'provider')
+        self.provider = attributes[:'provider']
+      end
+
+      if attributes.has_key?(:'service')
+        self.service = attributes[:'service']
+      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
+      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?
+      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 &&
+          accrued_at == o.accrued_at &&
+          amount == o.amount &&
+          provider == o.provider &&
+          service == o.service
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [accrued_at, amount, provider, service].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = Vantage.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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