pnap_billing_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90aaa7e94c20034a1a3d60e538f24edeb2df60a101c39455a667c15027a7d9d7
+  data.tar.gz: 38aa25e461ca137de61053aed52a7bd4674e8a885cad43a48d7866289dc248c5
+SHA512:
+  metadata.gz: f2a8c17c43abe5fa18de55e01fee40786c2c03748c0c019d72523093fe55618120a57ee355416747ff1cc2caba792f70065a786e3aba800ce4345af8e9205cbc
+  data.tar.gz: ba71acc4a3c4385c3caa409f171d57bc323af26d29165391d505b15f155cbe6c68877f076b33503d542a1d15fbf56dfc3190eaee9fc78f352b132b772a968251

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,187 @@
+# pnap_billing_api
+
+BillingApi - the Ruby gem for the 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>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_billing_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_billing_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_billing_api-<VERSION>.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pnap_billing_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_billing_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'BillingApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_billing_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'BillingApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_billing_api'
+
+# Setup authorization
+BillingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+end
+
+api_instance = BillingApi::BillingConfigurationsApi.new
+
+begin
+  #Retrieves billing configuration associated with the authenticated account.
+  result = api_instance.account_billing_configuration_me_get
+  p result
+rescue BillingApi::ApiError => e
+  puts "Exception when calling BillingConfigurationsApi->account_billing_configuration_me_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_billing_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+BillingApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/billing/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BillingApi::BillingConfigurationsApi* | [**account_billing_configuration_me_get**](docs/BillingConfigurationsApi.md#account_billing_configuration_me_get) | **GET** /account-billing-configurations/me | Retrieves billing configuration associated with the authenticated account.
+*BillingApi::ProductsApi* | [**product_availability_get**](docs/ProductsApi.md#product_availability_get) | **GET** /product-availability | List all Product availabilities.
+*BillingApi::ProductsApi* | [**products_get**](docs/ProductsApi.md#products_get) | **GET** /products | List all Products.
+*BillingApi::RatedUsageApi* | [**rated_usage_get**](docs/RatedUsageApi.md#rated_usage_get) | **GET** /rated-usage | List the rated usage.
+*BillingApi::RatedUsageApi* | [**rated_usage_month_to_date_get**](docs/RatedUsageApi.md#rated_usage_month_to_date_get) | **GET** /rated-usage/month-to-date | List the rated usage records for the current calendar month.
+*BillingApi::ReservationsApi* | [**reservations_get**](docs/ReservationsApi.md#reservations_get) | **GET** /reservations | List all Reservations.
+*BillingApi::ReservationsApi* | [**reservations_post**](docs/ReservationsApi.md#reservations_post) | **POST** /reservations | Create a reservation.
+*BillingApi::ReservationsApi* | [**reservations_reservation_id_actions_auto_renew_disable_post**](docs/ReservationsApi.md#reservations_reservation_id_actions_auto_renew_disable_post) | **POST** /reservations/{reservationId}/actions/auto-renew/disable | Disable auto-renewal for reservation by id.
+*BillingApi::ReservationsApi* | [**reservations_reservation_id_actions_auto_renew_enable_post**](docs/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.
+*BillingApi::ReservationsApi* | [**reservations_reservation_id_actions_convert_post**](docs/ReservationsApi.md#reservations_reservation_id_actions_convert_post) | **POST** /reservations/{reservationId}/actions/convert | Convert reservation pricing model by reservation ID.
+*BillingApi::ReservationsApi* | [**reservations_reservation_id_get**](docs/ReservationsApi.md#reservations_reservation_id_get) | **GET** /reservations/{reservationId} | Get a reservation.
+
+
+## Documentation for Models
+
+ - [BillingApi::ApplicableDiscounts](docs/ApplicableDiscounts.md)
+ - [BillingApi::BandwidthDetails](docs/BandwidthDetails.md)
+ - [BillingApi::BandwidthRecord](docs/BandwidthRecord.md)
+ - [BillingApi::ConfigurationDetails](docs/ConfigurationDetails.md)
+ - [BillingApi::DiscountDetails](docs/DiscountDetails.md)
+ - [BillingApi::Error](docs/Error.md)
+ - [BillingApi::LocationAvailabilityDetail](docs/LocationAvailabilityDetail.md)
+ - [BillingApi::LocationEnum](docs/LocationEnum.md)
+ - [BillingApi::OperatingSystemDetails](docs/OperatingSystemDetails.md)
+ - [BillingApi::OperatingSystemRecord](docs/OperatingSystemRecord.md)
+ - [BillingApi::PriceUnitEnum](docs/PriceUnitEnum.md)
+ - [BillingApi::PricingPlan](docs/PricingPlan.md)
+ - [BillingApi::Product](docs/Product.md)
+ - [BillingApi::ProductAvailability](docs/ProductAvailability.md)
+ - [BillingApi::ProductCategoryEnum](docs/ProductCategoryEnum.md)
+ - [BillingApi::ProductsGet200ResponseInner](docs/ProductsGet200ResponseInner.md)
+ - [BillingApi::PublicSubnetDetails](docs/PublicSubnetDetails.md)
+ - [BillingApi::PublicSubnetRecord](docs/PublicSubnetRecord.md)
+ - [BillingApi::RatedUsageGet200ResponseInner](docs/RatedUsageGet200ResponseInner.md)
+ - [BillingApi::RatedUsageRecord](docs/RatedUsageRecord.md)
+ - [BillingApi::Reservation](docs/Reservation.md)
+ - [BillingApi::ReservationAutoRenewDisableRequest](docs/ReservationAutoRenewDisableRequest.md)
+ - [BillingApi::ReservationInvoicingModelEnum](docs/ReservationInvoicingModelEnum.md)
+ - [BillingApi::ReservationModelEnum](docs/ReservationModelEnum.md)
+ - [BillingApi::ReservationRequest](docs/ReservationRequest.md)
+ - [BillingApi::ServerDetails](docs/ServerDetails.md)
+ - [BillingApi::ServerProduct](docs/ServerProduct.md)
+ - [BillingApi::ServerProductMetadata](docs/ServerProductMetadata.md)
+ - [BillingApi::ServerRecord](docs/ServerRecord.md)
+ - [BillingApi::StorageDetails](docs/StorageDetails.md)
+ - [BillingApi::StorageRecord](docs/StorageRecord.md)
+ - [BillingApi::ThresholdConfigurationDetails](docs/ThresholdConfigurationDetails.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - bmc: Grants full access to bmc-api.
+  - bmc.read: Grants read only access to bmc-api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/ApplicableDiscounts.md

@@ -0,0 +1,20 @@
+# BillingApi::ApplicableDiscounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discounted_price** | **Float** | The price of the product after applying a discount. | [optional] |
+| **discount_details** | [**Array<DiscountDetails>**](DiscountDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::ApplicableDiscounts.new(
+  discounted_price: 107.5,
+  discount_details: null
+)
+```
+

data/docs/BandwidthDetails.md

@@ -0,0 +1,24 @@
+# BillingApi::BandwidthDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ingress_gb** | **Float** | The amount of GB consumed in ingress (IN). |  |
+| **egress_gb** | **Float** | The amount of GB consumed in egress (OUT). |  |
+| **package_quantity** | **Float** | Package size per month. | [optional] |
+| **package_unit** | **String** | Package size unit. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::BandwidthDetails.new(
+  ingress_gb: 1.33,
+  egress_gb: 1.33,
+  package_quantity: 15,
+  package_unit: null
+)
+```
+

data/docs/BandwidthRecord.md

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

@@ -0,0 +1,74 @@
+# BillingApi::BillingConfigurationsApi
+
+All URIs are relative to *https://api.phoenixnap.com/billing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_billing_configuration_me_get**](BillingConfigurationsApi.md#account_billing_configuration_me_get) | **GET** /account-billing-configurations/me | Retrieves billing configuration associated with the authenticated account. |
+
+
+## account_billing_configuration_me_get
+
+> <ConfigurationDetails> account_billing_configuration_me_get
+
+Retrieves billing configuration associated with the authenticated account.
+
+Retrieves billing configuration associated with the 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::BillingConfigurationsApi.new
+
+begin
+  # Retrieves billing configuration associated with the authenticated account.
+  result = api_instance.account_billing_configuration_me_get
+  p result
+rescue BillingApi::ApiError => e
+  puts "Error when calling BillingConfigurationsApi->account_billing_configuration_me_get: #{e}"
+end
+```
+
+#### Using the account_billing_configuration_me_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConfigurationDetails>, Integer, Hash)> account_billing_configuration_me_get_with_http_info
+
+```ruby
+begin
+  # Retrieves billing configuration associated with the authenticated account.
+  data, status_code, headers = api_instance.account_billing_configuration_me_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConfigurationDetails>
+rescue BillingApi::ApiError => e
+  puts "Error when calling BillingConfigurationsApi->account_billing_configuration_me_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConfigurationDetails**](ConfigurationDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ConfigurationDetails.md

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

data/docs/DiscountDetails.md

@@ -0,0 +1,22 @@
+# BillingApi::DiscountDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | A unique code associated with the discount. |  |
+| **type** | **String** | The type of discount applied. |  |
+| **value** | **Float** | The value or amount of the discount. The interpretation of this value depends on the 'type' of discount.  |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::DiscountDetails.new(
+  code: new-year-2022-monthly,
+  type: PRODUCT_CATEGORY_PERCENTAGE,
+  value: 20.5
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# BillingApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/LocationAvailabilityDetail.md

@@ -0,0 +1,26 @@
+# BillingApi::LocationAvailabilityDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**LocationEnum**](LocationEnum.md) |  |  |
+| **min_quantity_requested** | **Float** | Requested quantity. |  |
+| **min_quantity_available** | **Boolean** | Is product available in specific location for requested quantity |  |
+| **available_quantity** | **Float** | Total available quantity of product in specific location. Max value is 10. |  |
+| **solutions** | **Array<String>** | Solutions supported in specific location for a product. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::LocationAvailabilityDetail.new(
+  location: null,
+  min_quantity_requested: 2,
+  min_quantity_available: true,
+  available_quantity: 5,
+  solutions: null
+)
+```
+

data/docs/LocationEnum.md

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

data/docs/OperatingSystemDetails.md

@@ -0,0 +1,20 @@
+# BillingApi::OperatingSystemDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores** | **Integer** | Number of cores. |  |
+| **correlation_id** | **String** | Correlation is used to associate Operating System License charges and the Server on which it was installed. In this scenario, the correlation ID will be equal to the rated usage record ID representing the charge for the Server. |  |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::OperatingSystemDetails.new(
+  cores: 2,
+  correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26
+)
+```
+

data/docs/OperatingSystemRecord.md

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

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

data/docs/PricingPlan.md

@@ -0,0 +1,36 @@
+# BillingApi::PricingPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sku** | **String** | The SKU identifying this pricing plan. |  |
+| **sku_description** | **String** | Description of this pricing plan. | [optional] |
+| **location** | **String** | The code identifying the location. |  |
+| **pricing_model** | **String** | The pricing model. |  |
+| **price** | **Float** | The price per unit. |  |
+| **price_unit** | [**PriceUnitEnum**](PriceUnitEnum.md) |  |  |
+| **applicable_discounts** | [**ApplicableDiscounts**](ApplicableDiscounts.md) |  | [optional] |
+| **correlated_product_code** | **String** | Product code of the product this product is correlated with | [optional] |
+| **package_quantity** | **Float** | Package size per month. | [optional] |
+| **package_unit** | **String** | Package size unit. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::PricingPlan.new(
+  sku: XXX-XXX-XXX,
+  sku_description: Hourly Rate for s1.c1.small in Phoenix,
+  location: PHX,
+  pricing_model: HOURLY,
+  price: 0.22,
+  price_unit: null,
+  applicable_discounts: null,
+  correlated_product_code: s1.c1.small,
+  package_quantity: 50,
+  package_unit: null
+)
+```
+

data/docs/Product.md

@@ -0,0 +1,22 @@
+# BillingApi::Product
+
+## 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] |
+
+## Example
+
+```ruby
+require 'pnap_billing_api'
+
+instance = BillingApi::Product.new(
+  product_code: s1.c1.small,
+  product_category: SERVER,
+  plans: null
+)
+```
+