pnap_billing_api 1.0.0

data/docs/ProductAvailability.md

@@ -0,0 +1,22 @@
+# BillingApi::ProductAvailability
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_code** | **String** | Product code. |  |
+| **product_category** | **String** | Product category. |  |
+| **location_availability_details** | [**Array<LocationAvailabilityDetail>**](LocationAvailabilityDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ProductAvailability.new(
+  product_code: d1.c1.small,
+  product_category: SERVER,
+  location_availability_details: null
+)
+```
+

data/docs/ProductCategoryEnum.md

@@ -0,0 +1,15 @@
+# BillingApi::ProductCategoryEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ProductCategoryEnum.new()
+```
+

data/docs/ProductsApi.md

@@ -0,0 +1,167 @@
+# BillingApi::ProductsApi
+
+All URIs are relative to *https://api.phoenixnap.com/billing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**product_availability_get**](ProductsApi.md#product_availability_get) | **GET** /product-availability | List all Product availabilities. |
+| [**products_get**](ProductsApi.md#products_get) | **GET** /products | List all Products. |
+
+
+## product_availability_get
+
+> <Array<ProductAvailability>> product_availability_get(opts)
+
+List all Product availabilities.
+
+Retrieves the list of product availability details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_billing_api'
+# setup authorization
+BillingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BillingApi::ProductsApi.new
+opts = {
+  product_category: ['SERVER'], # Array<String> | Product category. Currently only SERVER category is supported.
+  product_code: ['inner_example'], # Array<String> | 
+  show_only_min_quantity_available: true, # Boolean | Show only locations where product with requested quantity is available or all locations where product is offered.
+  location: [BillingApi::LocationEnum::PHX], # Array<LocationEnum> | 
+  solution: ['SERVER_RANCHER'], # Array<String> | 
+  min_quantity: 2 # Float | Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively.
+}
+
+begin
+  # List all Product availabilities.
+  result = api_instance.product_availability_get(opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ProductsApi->product_availability_get: #{e}"
+end
+```
+
+#### Using the product_availability_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ProductAvailability>>, Integer, Hash)> product_availability_get_with_http_info(opts)
+
+```ruby
+begin
+  # List all Product availabilities.
+  data, status_code, headers = api_instance.product_availability_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ProductAvailability>>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ProductsApi->product_availability_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_category** | [**Array&lt;String&gt;**](String.md) | Product category. Currently only SERVER category is supported. | [optional] |
+| **product_code** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **show_only_min_quantity_available** | **Boolean** | Show only locations where product with requested quantity is available or all locations where product is offered. | [optional][default to true] |
+| **location** | [**Array&lt;LocationEnum&gt;**](LocationEnum.md) |  | [optional] |
+| **solution** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **min_quantity** | **Float** | Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively. | [optional] |
+
+### Return type
+
+[**Array&lt;ProductAvailability&gt;**](ProductAvailability.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## products_get
+
+> <Array<ProductsGet200ResponseInner>> products_get(opts)
+
+List all Products.
+
+Retrieves all Products.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_billing_api'
+# setup authorization
+BillingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BillingApi::ProductsApi.new
+opts = {
+  product_code: 's1.c1.small', # String | 
+  product_category: 'SERVER', # String | 
+  sku_code: 'xxx-xxx-xxx', # String | 
+  location: 'PHX' # String | 
+}
+
+begin
+  # List all Products.
+  result = api_instance.products_get(opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ProductsApi->products_get: #{e}"
+end
+```
+
+#### Using the products_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ProductsGet200ResponseInner>>, Integer, Hash)> products_get_with_http_info(opts)
+
+```ruby
+begin
+  # List all Products.
+  data, status_code, headers = api_instance.products_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ProductsGet200ResponseInner>>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ProductsApi->products_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_code** | **String** |  | [optional] |
+| **product_category** | **String** |  | [optional] |
+| **sku_code** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+
+### Return type
+
+[**Array&lt;ProductsGet200ResponseInner&gt;**](ProductsGet200ResponseInner.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProductsGet200ResponseInner.md

@@ -0,0 +1,82 @@
+# BillingApi::ProductsGet200ResponseInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::ProductsGet200ResponseInner.openapi_one_of
+# =>
+# [
+#   :'Product',
+#   :'ServerProduct'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::ProductsGet200ResponseInner.openapi_discriminator_name
+# => :'product_category'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::ProductsGet200ResponseInner.openapi_discriminator_mapping
+# =>
+# {
+#   :'BANDWIDTH' => :'Product',
+#   :'OPERATING_SYSTEM' => :'Product',
+#   :'PUBLIC_IP' => :'Product',
+#   :'SERVER' => :'ServerProduct',
+#   :'STORAGE' => :'Product'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::ProductsGet200ResponseInner.build(data)
+# => #<Product:0x00007fdd4aab02a0>
+
+BillingApi::ProductsGet200ResponseInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Product`
+- `ServerProduct`
+- `nil` (if no type matches)
+

data/docs/PublicSubnetDetails.md

@@ -0,0 +1,22 @@
+# BillingApi::PublicSubnetDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Public Subnet identifier as returned by the BMC API. | [optional] |
+| **cidr** | **String** | Classless Inter-Domain Routing |  |
+| **size** | **String** | CIDR size |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::PublicSubnetDetails.new(
+  id: 83604275-bdba-490a-b87a-978e8dffdb14,
+  cidr: 192.168.0.15/24,
+  size: /24
+)
+```
+

data/docs/PublicSubnetRecord.md

@@ -0,0 +1,56 @@
+# BillingApi::PublicSubnetRecord
+
+## 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** | [**PublicSubnetDetails**](PublicSubnetDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::PublicSubnetRecord.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/RatedUsageApi.md

@@ -0,0 +1,155 @@
+# BillingApi::RatedUsageApi
+
+All URIs are relative to *https://api.phoenixnap.com/billing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**rated_usage_get**](RatedUsageApi.md#rated_usage_get) | **GET** /rated-usage | List the rated usage. |
+| [**rated_usage_month_to_date_get**](RatedUsageApi.md#rated_usage_month_to_date_get) | **GET** /rated-usage/month-to-date | List the rated usage records for the current calendar month. |
+
+
+## rated_usage_get
+
+> <Array<RatedUsageGet200ResponseInner>> rated_usage_get(from_year_month, to_year_month, opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_billing_api'
+# setup authorization
+BillingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BillingApi::RatedUsageApi.new
+from_year_month = '2020-03' # String | From year month (inclusive) to filter rated usage records by.
+to_year_month = '2020-04' # String | To year month (inclusive) to filter rated usage records by.
+opts = {
+  product_category: BillingApi::ProductCategoryEnum::SERVER # ProductCategoryEnum | The product category
+}
+
+begin
+  # List the rated usage.
+  result = api_instance.rated_usage_get(from_year_month, to_year_month, opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling RatedUsageApi->rated_usage_get: #{e}"
+end
+```
+
+#### Using the rated_usage_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RatedUsageGet200ResponseInner>>, Integer, Hash)> rated_usage_get_with_http_info(from_year_month, to_year_month, opts)
+
+```ruby
+begin
+  # List the rated usage.
+  data, status_code, headers = api_instance.rated_usage_get_with_http_info(from_year_month, to_year_month, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RatedUsageGet200ResponseInner>>
+rescue BillingApi::ApiError => e
+  puts "Error when calling RatedUsageApi->rated_usage_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_year_month** | **String** | From year month (inclusive) to filter rated usage records by. |  |
+| **to_year_month** | **String** | To year month (inclusive) to filter rated usage records by. |  |
+| **product_category** | [**ProductCategoryEnum**](.md) | The product category | [optional] |
+
+### Return type
+
+[**Array&lt;RatedUsageGet200ResponseInner&gt;**](RatedUsageGet200ResponseInner.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rated_usage_month_to_date_get
+
+> <Array<RatedUsageGet200ResponseInner>> rated_usage_month_to_date_get(opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_billing_api'
+# setup authorization
+BillingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BillingApi::RatedUsageApi.new
+opts = {
+  product_category: BillingApi::ProductCategoryEnum::SERVER # ProductCategoryEnum | The product category
+}
+
+begin
+  # List the rated usage records for the current calendar month.
+  result = api_instance.rated_usage_month_to_date_get(opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling RatedUsageApi->rated_usage_month_to_date_get: #{e}"
+end
+```
+
+#### Using the rated_usage_month_to_date_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RatedUsageGet200ResponseInner>>, Integer, Hash)> rated_usage_month_to_date_get_with_http_info(opts)
+
+```ruby
+begin
+  # List the rated usage records for the current calendar month.
+  data, status_code, headers = api_instance.rated_usage_month_to_date_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RatedUsageGet200ResponseInner>>
+rescue BillingApi::ApiError => e
+  puts "Error when calling RatedUsageApi->rated_usage_month_to_date_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_category** | [**ProductCategoryEnum**](.md) | The product category | [optional] |
+
+### Return type
+
+[**Array&lt;RatedUsageGet200ResponseInner&gt;**](RatedUsageGet200ResponseInner.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RatedUsageGet200ResponseInner.md

@@ -0,0 +1,88 @@
+# BillingApi::RatedUsageGet200ResponseInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::RatedUsageGet200ResponseInner.openapi_one_of
+# =>
+# [
+#   :'BandwidthRecord',
+#   :'OperatingSystemRecord',
+#   :'PublicSubnetRecord',
+#   :'ServerRecord',
+#   :'StorageRecord'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::RatedUsageGet200ResponseInner.openapi_discriminator_name
+# => :'product_category'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::RatedUsageGet200ResponseInner.openapi_discriminator_mapping
+# =>
+# {
+#   :'bandwidth' => :'BandwidthRecord',
+#   :'bmc-server' => :'ServerRecord',
+#   :'operating-system' => :'OperatingSystemRecord',
+#   :'public-ip' => :'PublicSubnetRecord',
+#   :'storage' => :'StorageRecord'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pnap_billing_api'
+
+BillingApi::RatedUsageGet200ResponseInner.build(data)
+# => #<BandwidthRecord:0x00007fdd4aab02a0>
+
+BillingApi::RatedUsageGet200ResponseInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BandwidthRecord`
+- `OperatingSystemRecord`
+- `PublicSubnetRecord`
+- `ServerRecord`
+- `StorageRecord`
+- `nil` (if no type matches)
+

data/docs/RatedUsageRecord.md

@@ -0,0 +1,54 @@
+# BillingApi::RatedUsageRecord
+
+## 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] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::RatedUsageRecord.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
+)
+```
+