pnap_billing_api 1.0.0

data/docs/Reservation.md

@@ -0,0 +1,48 @@
+# BillingApi::Reservation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The reservation identifier. |  |
+| **product_code** | **String** | The code identifying the product. This code has significant across all locations. |  |
+| **product_category** | **String** | The product category. |  |
+| **location** | [**LocationEnum**](LocationEnum.md) |  |  |
+| **reservation_model** | [**ReservationModelEnum**](ReservationModelEnum.md) |  |  |
+| **initial_invoice_model** | [**ReservationInvoicingModelEnum**](ReservationInvoicingModelEnum.md) |  | [optional] |
+| **start_date_time** | **Time** | The point in time (in UTC) when the reservation starts. |  |
+| **end_date_time** | **Time** | The point in time (in UTC) when the reservation end. | [optional] |
+| **last_renewal_date_time** | **Time** | The point in time (in UTC) when the reservation was renewed last. | [optional] |
+| **next_renewal_date_time** | **Time** | The point in time (in UTC) when the reservation will be renewed if auto renew is set to true. | [optional] |
+| **auto_renew** | **Boolean** | A flag indicating whether the reservation will auto-renew (default is true). |  |
+| **sku** | **String** | The sku that will be applied to this reservation. It is useful to find out the price by querying the /product endpoint. |  |
+| **price** | **Float** | Reservation price. |  |
+| **price_unit** | [**PriceUnitEnum**](PriceUnitEnum.md) |  |  |
+| **assigned_resource_id** | **String** | The resource ID currently being assigned to Reservation. | [optional] |
+| **next_billing_date** | **Date** | Next billing date for Reservation. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::Reservation.new(
+  id: 83604275-bdba-490a-b87a-978e8dffdb14,
+  product_code: s1.c1.small,
+  product_category: server,
+  location: null,
+  reservation_model: null,
+  initial_invoice_model: null,
+  start_date_time: 2020-03-19T16:39Z,
+  end_date_time: 2020-04-19T16:39Z,
+  last_renewal_date_time: 2020-03-19T16:39Z,
+  next_renewal_date_time: 2020-04-19T16:39Z,
+  auto_renew: true,
+  sku: XXX-XXX-XXX,
+  price: 175,
+  price_unit: null,
+  assigned_resource_id: 83604275-bdba-490a-b87a-978e8dffdb14,
+  next_billing_date: Sun Apr 19 00:00:00 UTC 2020
+)
+```
+

data/docs/ReservationAutoRenewDisableRequest.md

@@ -0,0 +1,18 @@
+# BillingApi::ReservationAutoRenewDisableRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_renew_disable_reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ReservationAutoRenewDisableRequest.new(
+  auto_renew_disable_reason: null
+)
+```
+

data/docs/ReservationInvoicingModelEnum.md

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

data/docs/ReservationModelEnum.md

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

data/docs/ReservationRequest.md

@@ -0,0 +1,18 @@
+# BillingApi::ReservationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** | The sku code of product pricing plan. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ReservationRequest.new(
+  sku: XXX-XXX-XXX
+)
+```
+

data/docs/ReservationsApi.md

@@ -0,0 +1,439 @@
+# BillingApi::ReservationsApi
+
+All URIs are relative to *https://api.phoenixnap.com/billing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**reservations_get**](ReservationsApi.md#reservations_get) | **GET** /reservations | List all Reservations. |
+| [**reservations_post**](ReservationsApi.md#reservations_post) | **POST** /reservations | Create a reservation. |
+| [**reservations_reservation_id_actions_auto_renew_disable_post**](ReservationsApi.md#reservations_reservation_id_actions_auto_renew_disable_post) | **POST** /reservations/{reservationId}/actions/auto-renew/disable | Disable auto-renewal for reservation by id. |
+| [**reservations_reservation_id_actions_auto_renew_enable_post**](ReservationsApi.md#reservations_reservation_id_actions_auto_renew_enable_post) | **POST** /reservations/{reservationId}/actions/auto-renew/enable | Enable auto-renewal for unexpired reservation by reservation id. |
+| [**reservations_reservation_id_actions_convert_post**](ReservationsApi.md#reservations_reservation_id_actions_convert_post) | **POST** /reservations/{reservationId}/actions/convert | Convert reservation pricing model by reservation ID. |
+| [**reservations_reservation_id_get**](ReservationsApi.md#reservations_reservation_id_get) | **GET** /reservations/{reservationId} | Get a reservation. |
+
+
+## reservations_get
+
+> <Array<Reservation>> reservations_get(opts)
+
+List all Reservations.
+
+Retrieves all reservations associated with the authenticated account. 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::ReservationsApi.new
+opts = {
+  product_category: BillingApi::ProductCategoryEnum::SERVER # ProductCategoryEnum | The product category
+}
+
+begin
+  # List all Reservations.
+  result = api_instance.reservations_get(opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_get: #{e}"
+end
+```
+
+#### Using the reservations_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Reservation>>, Integer, Hash)> reservations_get_with_http_info(opts)
+
+```ruby
+begin
+  # List all Reservations.
+  data, status_code, headers = api_instance.reservations_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Reservation>>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_category** | [**ProductCategoryEnum**](.md) | The product category | [optional] |
+
+### Return type
+
+[**Array&lt;Reservation&gt;**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reservations_post
+
+> <Reservation> reservations_post(opts)
+
+Create a reservation.
+
+Creates new package reservation for authenticated account.
+
+### 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::ReservationsApi.new
+opts = {
+  reservation_request: BillingApi::ReservationRequest.new({sku: 'XXX-XXX-XXX'}) # ReservationRequest | 
+}
+
+begin
+  # Create a reservation.
+  result = api_instance.reservations_post(opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_post: #{e}"
+end
+```
+
+#### Using the reservations_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Reservation>, Integer, Hash)> reservations_post_with_http_info(opts)
+
+```ruby
+begin
+  # Create a reservation.
+  data, status_code, headers = api_instance.reservations_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Reservation>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reservation_request** | [**ReservationRequest**](ReservationRequest.md) |  | [optional] |
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## reservations_reservation_id_actions_auto_renew_disable_post
+
+> <Reservation> reservations_reservation_id_actions_auto_renew_disable_post(reservation_id, opts)
+
+Disable auto-renewal for reservation by id.
+
+Disable auto-renewal for reservation by reservation id.
+
+### 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::ReservationsApi.new
+reservation_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The reservation's ID.
+opts = {
+  reservation_auto_renew_disable_request: BillingApi::ReservationAutoRenewDisableRequest.new # ReservationAutoRenewDisableRequest | 
+}
+
+begin
+  # Disable auto-renewal for reservation by id.
+  result = api_instance.reservations_reservation_id_actions_auto_renew_disable_post(reservation_id, opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_auto_renew_disable_post: #{e}"
+end
+```
+
+#### Using the reservations_reservation_id_actions_auto_renew_disable_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Reservation>, Integer, Hash)> reservations_reservation_id_actions_auto_renew_disable_post_with_http_info(reservation_id, opts)
+
+```ruby
+begin
+  # Disable auto-renewal for reservation by id.
+  data, status_code, headers = api_instance.reservations_reservation_id_actions_auto_renew_disable_post_with_http_info(reservation_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Reservation>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_auto_renew_disable_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reservation_id** | **String** | The reservation&#39;s ID. |  |
+| **reservation_auto_renew_disable_request** | [**ReservationAutoRenewDisableRequest**](ReservationAutoRenewDisableRequest.md) |  | [optional] |
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## reservations_reservation_id_actions_auto_renew_enable_post
+
+> <Reservation> reservations_reservation_id_actions_auto_renew_enable_post(reservation_id)
+
+Enable auto-renewal for unexpired reservation by reservation id.
+
+Enable auto-renewal for unexpired reservation by reservation id.
+
+### 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::ReservationsApi.new
+reservation_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The reservation's ID.
+
+begin
+  # Enable auto-renewal for unexpired reservation by reservation id.
+  result = api_instance.reservations_reservation_id_actions_auto_renew_enable_post(reservation_id)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_auto_renew_enable_post: #{e}"
+end
+```
+
+#### Using the reservations_reservation_id_actions_auto_renew_enable_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Reservation>, Integer, Hash)> reservations_reservation_id_actions_auto_renew_enable_post_with_http_info(reservation_id)
+
+```ruby
+begin
+  # Enable auto-renewal for unexpired reservation by reservation id.
+  data, status_code, headers = api_instance.reservations_reservation_id_actions_auto_renew_enable_post_with_http_info(reservation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Reservation>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_auto_renew_enable_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reservation_id** | **String** | The reservation&#39;s ID. |  |
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reservations_reservation_id_actions_convert_post
+
+> <Reservation> reservations_reservation_id_actions_convert_post(reservation_id, opts)
+
+Convert reservation pricing model by reservation ID.
+
+Convert reservation pricing model by reservation id.
+
+### 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::ReservationsApi.new
+reservation_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The reservation's ID.
+opts = {
+  reservation_request: BillingApi::ReservationRequest.new({sku: 'XXX-XXX-XXX'}) # ReservationRequest | 
+}
+
+begin
+  # Convert reservation pricing model by reservation ID.
+  result = api_instance.reservations_reservation_id_actions_convert_post(reservation_id, opts)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_convert_post: #{e}"
+end
+```
+
+#### Using the reservations_reservation_id_actions_convert_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Reservation>, Integer, Hash)> reservations_reservation_id_actions_convert_post_with_http_info(reservation_id, opts)
+
+```ruby
+begin
+  # Convert reservation pricing model by reservation ID.
+  data, status_code, headers = api_instance.reservations_reservation_id_actions_convert_post_with_http_info(reservation_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Reservation>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_actions_convert_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reservation_id** | **String** | The reservation&#39;s ID. |  |
+| **reservation_request** | [**ReservationRequest**](ReservationRequest.md) |  | [optional] |
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## reservations_reservation_id_get
+
+> <Reservation> reservations_reservation_id_get(reservation_id)
+
+Get a reservation.
+
+Retrieves the reservations with the specified identifier. 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::ReservationsApi.new
+reservation_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The reservation's ID.
+
+begin
+  # Get a reservation.
+  result = api_instance.reservations_reservation_id_get(reservation_id)
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_get: #{e}"
+end
+```
+
+#### Using the reservations_reservation_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Reservation>, Integer, Hash)> reservations_reservation_id_get_with_http_info(reservation_id)
+
+```ruby
+begin
+  # Get a reservation.
+  data, status_code, headers = api_instance.reservations_reservation_id_get_with_http_info(reservation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Reservation>
+rescue BillingApi::ApiError => e
+  puts "Error when calling ReservationsApi->reservations_reservation_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reservation_id** | **String** | The reservation&#39;s ID. |  |
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ServerDetails.md

@@ -0,0 +1,20 @@
+# BillingApi::ServerDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The server identifier as returned by the BMC API. |  |
+| **hostname** | **String** | The server hostname. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ServerDetails.new(
+  id: 83604275-bdba-490a-b87a-978e8dffdb14,
+  hostname: example-server
+)
+```
+

data/docs/ServerProduct.md

@@ -0,0 +1,24 @@
+# BillingApi::ServerProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_code** | **String** | The code identifying the product. This code has significant across all locations. |  |
+| **product_category** | **String** | The product category. |  |
+| **plans** | [**Array<PricingPlan>**](PricingPlan.md) | The pricing plans available for this product. | [optional] |
+| **metadata** | [**ServerProductMetadata**](ServerProductMetadata.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ServerProduct.new(
+  product_code: s1.c1.small,
+  product_category: SERVER,
+  plans: null,
+  metadata: null
+)
+```
+

data/docs/ServerProductMetadata.md

@@ -0,0 +1,30 @@
+# BillingApi::ServerProductMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ram_in_gb** | **Float** | RAM in GB. |  |
+| **cpu** | **String** | CPU name. |  |
+| **cpu_count** | **Float** | Number of CPUs. |  |
+| **cores_per_cpu** | **Float** | The number of physical cores present on each CPU. |  |
+| **cpu_frequency** | **Float** | CPU frequency in GHz. |  |
+| **network** | **String** | Server network. |  |
+| **storage** | **String** | Server storage. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ServerProductMetadata.new(
+  ram_in_gb: 256,
+  cpu: Dual Gold 6258R,
+  cpu_count: 56,
+  cores_per_cpu: 2,
+  cpu_frequency: 2.7,
+  network: 2x 25Gbps,
+  storage: 2x 2TB NVMe
+)
+```
+

data/docs/ServerRecord.md

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