vantage-client 0.0.6 → 0.1.0.beta.2

data/docs/PingApi.md

@@ -8,11 +8,11 @@ Method | HTTP request | Description
 
 
 # **ping**
-> ping
+> Object ping
 
 
 
-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.
 
 ### Example
 ```ruby
@@ -27,7 +27,8 @@ end
 api_instance = Vantage::PingApi.new
 
 begin
-  api_instance.ping
+  result = api_instance.ping
+  p result
 rescue Vantage::ApiError => e
   puts "Exception when calling PingApi->ping: #{e}"
 end
@@ -38,7 +39,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+**Object**
 
 ### Authorization
 

data/docs/PricesApi.md

@@ -67,7 +67,7 @@ Name | Type | Description  | Notes
 
 
 # **get_prices**
-> Prices get_prices(product_id)
+> Prices get_prices(product_id, opts)
 
 
 
@@ -87,9 +87,13 @@ api_instance = Vantage::PricesApi.new
 
 product_id = 'product_id_example' # String | 
 
+opts = { 
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
+}
 
 begin
-  result = api_instance.get_prices(product_id)
+  result = api_instance.get_prices(product_id, opts)
   p result
 rescue Vantage::ApiError => e
   puts "Exception when calling PricesApi->get_prices: #{e}"
@@ -101,6 +105,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **product_id** | **String**|  | 
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
 
 ### Return type
 
@@ -190,7 +196,9 @@ api_instance = Vantage::PricesApi.new
 opts = { 
   provider_id: 'provider_id_example', # String | Query by Provider to list all Products across all Services for a Provider. e.g. aws
   service_id: 'service_id_example', # String | Query by Service to list all Products for a specific provider service. e.g. aws-ec2
-  name: 'name_example' # String | Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
+  name: 'name_example', # String | Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
 }
 
 begin
@@ -208,6 +216,8 @@ Name | Type | Description  | Notes
  **provider_id** | **String**| Query by Provider to list all Products across all Services for a Provider. e.g. aws | [optional] 
  **service_id** | **String**| Query by Service to list all Products for a specific provider service. e.g. aws-ec2 | [optional] 
  **name** | **String**| Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge | [optional] 
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
 
 ### Return type
 
@@ -225,7 +235,7 @@ Name | Type | Description  | Notes
 
 
 # **get_providers**
-> Providers get_providers
+> Providers get_providers(opts)
 
 
 
@@ -243,8 +253,13 @@ end
 
 api_instance = Vantage::PricesApi.new
 
+opts = { 
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
+}
+
 begin
-  result = api_instance.get_providers
+  result = api_instance.get_providers(opts)
   p result
 rescue Vantage::ApiError => e
   puts "Exception when calling PricesApi->get_providers: #{e}"
@@ -252,7 +267,11 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
 
 ### Return type
 
@@ -289,7 +308,9 @@ end
 api_instance = Vantage::PricesApi.new
 
 opts = { 
-  provider_id: 'provider_id_example' # String | Query services for a specific provider. e.g. aws
+  provider_id: 'provider_id_example', # String | Query services for a specific provider. e.g. aws
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
 }
 
 begin
@@ -305,6 +326,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **provider_id** | **String**| Query services for a specific provider. e.g. aws | [optional] 
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
 
 ### Return type
 

data/docs/Report.md

@@ -0,0 +1,13 @@
+# Vantage::Report
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**title** | **String** | The title of the cost report. | [optional] 
+**earliest_cost_date** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-01-01 or 2021-01-01T00:00:00Z. | [optional] 
+**latest_cost_date** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-07-31 or 2021-07-31T00:00:00Z. | [optional] 
+**created_at** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T00:00:00Z. | [optional] 
+**workspace** | **String** | The name of the workspace the report is a part of. | [optional] 
+
+

data/docs/Reports.md

@@ -0,0 +1,9 @@
+# Vantage::Reports
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**reports** | [**Array<Report>**](Report.md) |  | [optional] 
+
+

data/lib/vantage-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
 
@@ -17,16 +17,21 @@ require 'vantage-client/version'
 require 'vantage-client/configuration'
 
 # Models
+require 'vantage-client/models/cost'
+require 'vantage-client/models/costs'
 require 'vantage-client/models/price'
 require 'vantage-client/models/prices'
 require 'vantage-client/models/product'
 require 'vantage-client/models/products'
 require 'vantage-client/models/provider'
 require 'vantage-client/models/providers'
+require 'vantage-client/models/report'
+require 'vantage-client/models/reports'
 require 'vantage-client/models/service'
 require 'vantage-client/models/services'
 
 # APIs
+require 'vantage-client/api/costs_api'
 require 'vantage-client/api/ping_api'
 require 'vantage-client/api/prices_api'
 

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,17 +19,17 @@ 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 [nil]
+    # @return [Object]
     def ping(opts = {})
-      ping_with_http_info(opts)
-      nil
+      data, _status_code, _headers = ping_with_http_info(opts)
+      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<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
     def ping_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PingApi.ping ...'
@@ -56,7 +56,8 @@ module Vantage
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => 'Object')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PingApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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 = {}