pnap_billing_api 1.0.0

data/docs/StorageDetails.md

@@ -0,0 +1,28 @@
+# BillingApi::StorageDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_storage_id** | **String** | Network storage ID. |  |
+| **network_storage_name** | **String** | Network storage name. |  |
+| **volume_id** | **String** | Volume ID. |  |
+| **volume_name** | **String** | Volume name. |  |
+| **capacity_in_gb** | **Integer** | Capacity in GB. |  |
+| **created_on** | **Time** | Timestamp when the record was created. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::StorageDetails.new(
+  network_storage_id: 123asd239-323las2d2-123123a,
+  network_storage_name: First network storage.,
+  volume_id: 123asd239-323las2d2-123123a,
+  volume_name: First volume.,
+  capacity_in_gb: 150000,
+  created_on: 2020-03-19T16:39Z
+)
+```
+

data/docs/StorageRecord.md

@@ -0,0 +1,56 @@
+# BillingApi::StorageRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier of the rated usage record. |  |
+| **product_category** | **String** | The category of the product associated with this usage record. |  |
+| **product_code** | **String** | The code identifying the product associated to this usage record. |  |
+| **location** | [**LocationEnum**](LocationEnum.md) |  |  |
+| **year_month** | **String** | Year and month of the usage record. | [optional] |
+| **start_date_time** | **Time** | The point in time (in UTC) when usage has started. |  |
+| **end_date_time** | **Time** | The point in time (in UTC) until usage has been rated. |  |
+| **cost** | **Integer** | The rated usage in cents. |  |
+| **cost_before_discount** | **Integer** | The cost in cents before discount. | [optional] |
+| **cost_description** | **String** | The rated usage cost description. | [optional] |
+| **price_model** | **String** | The price model applied to this usage record. |  |
+| **unit_price** | **Float** | The unit price. |  |
+| **unit_price_description** | **String** | User friendly description of the unit price. |  |
+| **quantity** | **Float** | The number of units being charged. |  |
+| **active** | **Boolean** | A flag indicating whether the rated usage record is still active. |  |
+| **usage_session_id** | **String** | The usage session ID is used to correlate rated usage records across periods of time. For example, a server used for over a month will generate multiple rated usage records. The entire usage session cost can be computed by aggregating the records having the same usage session ID. It is usual to have one rated usage record per month or invoice. |  |
+| **correlation_id** | **String** | Holds usage record id |  |
+| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
+| **discount_details** | [**DiscountDetails**](DiscountDetails.md) |  | [optional] |
+| **metadata** | [**StorageDetails**](StorageDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::StorageRecord.new(
+  id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
+  product_category: bmc-server,
+  product_code: s1.c1.small,
+  location: null,
+  year_month: 2020-03,
+  start_date_time: 2020-03-19T16:39Z,
+  end_date_time: 2020-03-20T17:00Z,
+  cost: 384,
+  cost_before_discount: 15456,
+  cost_description: 24 Hour(s) @ $0.16 /Hour,
+  price_model: hourly,
+  unit_price: 0.16,
+  unit_price_description: per hour,
+  quantity: 24,
+  active: true,
+  usage_session_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
+  correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
+  reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
+  discount_details: null,
+  metadata: null
+)
+```
+

data/docs/ThresholdConfigurationDetails.md

@@ -0,0 +1,18 @@
+# BillingApi::ThresholdConfigurationDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **threshold_amount** | **Float** | Threshold billing amount. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ThresholdConfigurationDetails.new(
+  threshold_amount: 100
+)
+```
+

data/lib/pnap_billing_api/api/billing_configurations_api.rb

@@ -0,0 +1,79 @@
+=begin
+#Billing API
+
+#Automate your infrastructure billing with the Bare Metal Cloud Billing API. Reserve your server instances to ensure guaranteed resource availability for 12, 24, and 36 months. Retrieve your server’s rated usage for a given period and enable or disable auto-renewals.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/phoenixnap-bare-metal-cloud-billing-models' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/billing/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'cgi'
+
+module BillingApi
+  class BillingConfigurationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieves billing configuration associated with the authenticated account.
+    # Retrieves billing configuration associated with the authenticated account.
+    # @param [Hash] opts the optional parameters
+    # @return [ConfigurationDetails]
+    def account_billing_configuration_me_get(opts = {})
+      data, _status_code, _headers = account_billing_configuration_me_get_with_http_info(opts)
+      data
+    end
+
+    # Retrieves billing configuration associated with the authenticated account.
+    # Retrieves billing configuration associated with the authenticated account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConfigurationDetails, Integer, Hash)>] ConfigurationDetails data, response status code and response headers
+    def account_billing_configuration_me_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingConfigurationsApi.account_billing_configuration_me_get ...'
+      end
+      # resource path
+      local_var_path = '/account-billing-configurations/me'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConfigurationDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BillingConfigurationsApi.account_billing_configuration_me_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BillingConfigurationsApi#account_billing_configuration_me_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pnap_billing_api/api/products_api.rb

@@ -0,0 +1,174 @@
+=begin
+#Billing API
+
+#Automate your infrastructure billing with the Bare Metal Cloud Billing API. Reserve your server instances to ensure guaranteed resource availability for 12, 24, and 36 months. Retrieve your server’s rated usage for a given period and enable or disable auto-renewals.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/phoenixnap-bare-metal-cloud-billing-models' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/billing/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'cgi'
+
+module BillingApi
+  class ProductsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List all Product availabilities.
+    # Retrieves the list of product availability details.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :product_category Product category. Currently only SERVER category is supported.
+    # @option opts [Array<String>] :product_code 
+    # @option opts [Boolean] :show_only_min_quantity_available Show only locations where product with requested quantity is available or all locations where product is offered. (default to true)
+    # @option opts [Array<LocationEnum>] :location 
+    # @option opts [Array<String>] :solution 
+    # @option opts [Float] :min_quantity Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively.
+    # @return [Array<ProductAvailability>]
+    def product_availability_get(opts = {})
+      data, _status_code, _headers = product_availability_get_with_http_info(opts)
+      data
+    end
+
+    # List all Product availabilities.
+    # Retrieves the list of product availability details.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :product_category Product category. Currently only SERVER category is supported.
+    # @option opts [Array<String>] :product_code 
+    # @option opts [Boolean] :show_only_min_quantity_available Show only locations where product with requested quantity is available or all locations where product is offered. (default to true)
+    # @option opts [Array<LocationEnum>] :location 
+    # @option opts [Array<String>] :solution 
+    # @option opts [Float] :min_quantity Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively.
+    # @return [Array<(Array<ProductAvailability>, Integer, Hash)>] Array<ProductAvailability> data, response status code and response headers
+    def product_availability_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductsApi.product_availability_get ...'
+      end
+      allowable_values = ["SERVER"]
+      if @api_client.config.client_side_validation && opts[:'product_category'] && !opts[:'product_category'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"product_category\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["SERVER_RANCHER"]
+      if @api_client.config.client_side_validation && opts[:'solution'] && !opts[:'solution'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"solution\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/product-availability'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'productCategory'] = @api_client.build_collection_param(opts[:'product_category'], :multi) if !opts[:'product_category'].nil?
+      query_params[:'productCode'] = @api_client.build_collection_param(opts[:'product_code'], :multi) if !opts[:'product_code'].nil?
+      query_params[:'showOnlyMinQuantityAvailable'] = opts[:'show_only_min_quantity_available'] if !opts[:'show_only_min_quantity_available'].nil?
+      query_params[:'location'] = @api_client.build_collection_param(opts[:'location'], :multi) if !opts[:'location'].nil?
+      query_params[:'solution'] = @api_client.build_collection_param(opts[:'solution'], :multi) if !opts[:'solution'].nil?
+      query_params[:'minQuantity'] = opts[:'min_quantity'] if !opts[:'min_quantity'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ProductAvailability>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ProductsApi.product_availability_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProductsApi#product_availability_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all Products.
+    # Retrieves all Products.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :product_code 
+    # @option opts [String] :product_category 
+    # @option opts [String] :sku_code 
+    # @option opts [String] :location 
+    # @return [Array<ProductsGet200ResponseInner>]
+    def products_get(opts = {})
+      data, _status_code, _headers = products_get_with_http_info(opts)
+      data
+    end
+
+    # List all Products.
+    # Retrieves all Products.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :product_code 
+    # @option opts [String] :product_category 
+    # @option opts [String] :sku_code 
+    # @option opts [String] :location 
+    # @return [Array<(Array<ProductsGet200ResponseInner>, Integer, Hash)>] Array<ProductsGet200ResponseInner> data, response status code and response headers
+    def products_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductsApi.products_get ...'
+      end
+      # resource path
+      local_var_path = '/products'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'productCode'] = opts[:'product_code'] if !opts[:'product_code'].nil?
+      query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?
+      query_params[:'skuCode'] = opts[:'sku_code'] if !opts[:'sku_code'].nil?
+      query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ProductsGet200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ProductsApi.products_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProductsApi#products_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pnap_billing_api/api/rated_usage_api.rb

@@ -0,0 +1,156 @@
+=begin
+#Billing API
+
+#Automate your infrastructure billing with the Bare Metal Cloud Billing API. Reserve your server instances to ensure guaranteed resource availability for 12, 24, and 36 months. Retrieve your server’s rated usage for a given period and enable or disable auto-renewals.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/phoenixnap-bare-metal-cloud-billing-models' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/billing/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'cgi'
+
+module BillingApi
+  class RatedUsageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List the rated usage.
+    # Retrieves all rated usage for given time period. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date & times are in UTC.
+    # @param from_year_month [String] From year month (inclusive) to filter rated usage records by.
+    # @param to_year_month [String] To year month (inclusive) to filter rated usage records by.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductCategoryEnum] :product_category The product category
+    # @return [Array<RatedUsageGet200ResponseInner>]
+    def rated_usage_get(from_year_month, to_year_month, opts = {})
+      data, _status_code, _headers = rated_usage_get_with_http_info(from_year_month, to_year_month, opts)
+      data
+    end
+
+    # List the rated usage.
+    # Retrieves all rated usage for given time period. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date &amp; times are in UTC.
+    # @param from_year_month [String] From year month (inclusive) to filter rated usage records by.
+    # @param to_year_month [String] To year month (inclusive) to filter rated usage records by.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductCategoryEnum] :product_category The product category
+    # @return [Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>] Array<RatedUsageGet200ResponseInner> data, response status code and response headers
+    def rated_usage_get_with_http_info(from_year_month, to_year_month, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RatedUsageApi.rated_usage_get ...'
+      end
+      # verify the required parameter 'from_year_month' is set
+      if @api_client.config.client_side_validation && from_year_month.nil?
+        fail ArgumentError, "Missing the required parameter 'from_year_month' when calling RatedUsageApi.rated_usage_get"
+      end
+      # verify the required parameter 'to_year_month' is set
+      if @api_client.config.client_side_validation && to_year_month.nil?
+        fail ArgumentError, "Missing the required parameter 'to_year_month' when calling RatedUsageApi.rated_usage_get"
+      end
+      # resource path
+      local_var_path = '/rated-usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fromYearMonth'] = from_year_month
+      query_params[:'toYearMonth'] = to_year_month
+      query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<RatedUsageGet200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"RatedUsageApi.rated_usage_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RatedUsageApi#rated_usage_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List the rated usage records for the current calendar month.
+    # Retrieves all rated usage for the current calendar month. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date & times are in UTC.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductCategoryEnum] :product_category The product category
+    # @return [Array<RatedUsageGet200ResponseInner>]
+    def rated_usage_month_to_date_get(opts = {})
+      data, _status_code, _headers = rated_usage_month_to_date_get_with_http_info(opts)
+      data
+    end
+
+    # List the rated usage records for the current calendar month.
+    # Retrieves all rated usage for the current calendar month. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date &amp; times are in UTC.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductCategoryEnum] :product_category The product category
+    # @return [Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>] Array<RatedUsageGet200ResponseInner> data, response status code and response headers
+    def rated_usage_month_to_date_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RatedUsageApi.rated_usage_month_to_date_get ...'
+      end
+      # resource path
+      local_var_path = '/rated-usage/month-to-date'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<RatedUsageGet200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"RatedUsageApi.rated_usage_month_to_date_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RatedUsageApi#rated_usage_month_to_date_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end