pnap_billing_api 2.0.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -0
- data/VERSION +1 -1
- data/docs/ApplicableDiscountDetails.md +24 -0
- data/docs/ApplicableDiscounts.md +1 -1
- data/docs/BandwidthRecord.md +5 -3
- data/docs/CreditDetails.md +49 -0
- data/docs/CreditDetailsBase.md +20 -0
- data/docs/CreditTypeEnum.md +15 -0
- data/docs/DiscountDetails.md +2 -2
- data/docs/DiscountTypeEnum.md +15 -0
- data/docs/GpuConfigurationMetadata.md +20 -0
- data/docs/OperatingSystemRecord.md +5 -3
- data/docs/PricingPlan.md +2 -2
- data/docs/PromoCreditDetails.md +24 -0
- data/docs/PublicSubnetRecord.md +5 -3
- data/docs/RatedUsageProductCategoryEnum.md +15 -0
- data/docs/RatedUsageRecord.md +6 -4
- data/docs/ReservationAutoRenewDisableRequest.md +1 -1
- data/docs/ServerProductMetadata.md +3 -1
- data/docs/ServerRecord.md +5 -3
- data/docs/StorageRecord.md +5 -3
- data/docs/SystemCreditCauseEnum.md +15 -0
- data/docs/SystemCreditDetails.md +22 -0
- data/lib/pnap_billing_api/models/applicable_discount_details.rb +294 -0
- data/lib/pnap_billing_api/models/applicable_discounts.rb +1 -1
- data/lib/pnap_billing_api/models/bandwidth_record.rb +14 -16
- data/lib/pnap_billing_api/models/credit_details.rb +105 -0
- data/lib/pnap_billing_api/models/credit_details_base.rb +261 -0
- data/lib/pnap_billing_api/models/credit_type_enum.rb +40 -0
- data/lib/pnap_billing_api/models/discount_details.rb +1 -14
- data/lib/pnap_billing_api/models/discount_type_enum.rb +41 -0
- data/lib/pnap_billing_api/models/gpu_configuration_metadata.rb +226 -0
- data/lib/pnap_billing_api/models/operating_system_record.rb +14 -16
- data/lib/pnap_billing_api/models/promo_credit_details.rb +301 -0
- data/lib/pnap_billing_api/models/public_subnet_record.rb +14 -16
- data/lib/pnap_billing_api/models/rated_usage_product_category_enum.rb +43 -0
- data/lib/pnap_billing_api/models/rated_usage_record.rb +16 -18
- data/lib/pnap_billing_api/models/server_product_metadata.rb +16 -4
- data/lib/pnap_billing_api/models/server_record.rb +14 -16
- data/lib/pnap_billing_api/models/storage_record.rb +14 -16
- data/lib/pnap_billing_api/models/system_credit_cause_enum.rb +39 -0
- data/lib/pnap_billing_api/models/system_credit_details.rb +283 -0
- data/lib/pnap_billing_api.rb +10 -0
- data/spec/models/applicable_discount_details_spec.rb +54 -0
- data/spec/models/bandwidth_record_spec.rb +6 -4
- data/spec/models/credit_details_base_spec.rb +42 -0
- data/spec/models/credit_details_spec.rb +32 -0
- data/spec/models/credit_type_enum_spec.rb +30 -0
- data/spec/models/discount_details_spec.rb +0 -4
- data/spec/models/discount_type_enum_spec.rb +30 -0
- data/spec/models/gpu_configuration_metadata_spec.rb +42 -0
- data/spec/models/operating_system_record_spec.rb +6 -4
- data/spec/models/promo_credit_details_spec.rb +54 -0
- data/spec/models/public_subnet_record_spec.rb +6 -4
- data/spec/models/rated_usage_product_category_enum_spec.rb +30 -0
- data/spec/models/rated_usage_record_spec.rb +6 -4
- data/spec/models/server_product_metadata_spec.rb +6 -0
- data/spec/models/server_record_spec.rb +6 -4
- data/spec/models/storage_record_spec.rb +6 -4
- data/spec/models/system_credit_cause_enum_spec.rb +30 -0
- data/spec/models/system_credit_details_spec.rb +48 -0
- metadata +71 -31
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f6f1ad26dca22ee78bfe4ee3bd2efdba35b3b420ef4a6adfd6c9aaf02b2d20dd
|
4
|
+
data.tar.gz: 43e0d76af97a5406ff933395df75602f364d8d690865abbde55ec36790b71ad4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5c40d83e21346c920db631516625888a8dcb23220e97c3059431694213491b02ceff56c40815610bae95705807bd4753d3b8bff2d388bc64b9d49f3ca7c0bc2d
|
7
|
+
data.tar.gz: 79897dcfbe4611c910135e1f1c1ad83b1fe1d1fc40f95ec822c5f442edf3195acf5187fa884523b7d231b12050eb0e9e19835c3f85d673e37dd741bdb3a67be8
|
data/README.md
CHANGED
@@ -137,12 +137,18 @@ Class | Method | HTTP request | Description
|
|
137
137
|
|
138
138
|
## Documentation for Models
|
139
139
|
|
140
|
+
- [BillingApi::ApplicableDiscountDetails](docs/ApplicableDiscountDetails.md)
|
140
141
|
- [BillingApi::ApplicableDiscounts](docs/ApplicableDiscounts.md)
|
141
142
|
- [BillingApi::BandwidthDetails](docs/BandwidthDetails.md)
|
142
143
|
- [BillingApi::BandwidthRecord](docs/BandwidthRecord.md)
|
143
144
|
- [BillingApi::ConfigurationDetails](docs/ConfigurationDetails.md)
|
145
|
+
- [BillingApi::CreditDetails](docs/CreditDetails.md)
|
146
|
+
- [BillingApi::CreditDetailsBase](docs/CreditDetailsBase.md)
|
147
|
+
- [BillingApi::CreditTypeEnum](docs/CreditTypeEnum.md)
|
144
148
|
- [BillingApi::DiscountDetails](docs/DiscountDetails.md)
|
149
|
+
- [BillingApi::DiscountTypeEnum](docs/DiscountTypeEnum.md)
|
145
150
|
- [BillingApi::Error](docs/Error.md)
|
151
|
+
- [BillingApi::GpuConfigurationMetadata](docs/GpuConfigurationMetadata.md)
|
146
152
|
- [BillingApi::LocationAvailabilityDetail](docs/LocationAvailabilityDetail.md)
|
147
153
|
- [BillingApi::LocationEnum](docs/LocationEnum.md)
|
148
154
|
- [BillingApi::OperatingSystemDetails](docs/OperatingSystemDetails.md)
|
@@ -154,9 +160,11 @@ Class | Method | HTTP request | Description
|
|
154
160
|
- [BillingApi::ProductAvailability](docs/ProductAvailability.md)
|
155
161
|
- [BillingApi::ProductCategoryEnum](docs/ProductCategoryEnum.md)
|
156
162
|
- [BillingApi::ProductsGet200ResponseInner](docs/ProductsGet200ResponseInner.md)
|
163
|
+
- [BillingApi::PromoCreditDetails](docs/PromoCreditDetails.md)
|
157
164
|
- [BillingApi::PublicSubnetDetails](docs/PublicSubnetDetails.md)
|
158
165
|
- [BillingApi::PublicSubnetRecord](docs/PublicSubnetRecord.md)
|
159
166
|
- [BillingApi::RatedUsageGet200ResponseInner](docs/RatedUsageGet200ResponseInner.md)
|
167
|
+
- [BillingApi::RatedUsageProductCategoryEnum](docs/RatedUsageProductCategoryEnum.md)
|
160
168
|
- [BillingApi::RatedUsageRecord](docs/RatedUsageRecord.md)
|
161
169
|
- [BillingApi::Reservation](docs/Reservation.md)
|
162
170
|
- [BillingApi::ReservationAutoRenewDisableRequest](docs/ReservationAutoRenewDisableRequest.md)
|
@@ -170,6 +178,8 @@ Class | Method | HTTP request | Description
|
|
170
178
|
- [BillingApi::ServerRecord](docs/ServerRecord.md)
|
171
179
|
- [BillingApi::StorageDetails](docs/StorageDetails.md)
|
172
180
|
- [BillingApi::StorageRecord](docs/StorageRecord.md)
|
181
|
+
- [BillingApi::SystemCreditCauseEnum](docs/SystemCreditCauseEnum.md)
|
182
|
+
- [BillingApi::SystemCreditDetails](docs/SystemCreditDetails.md)
|
173
183
|
- [BillingApi::ThresholdConfigurationDetails](docs/ThresholdConfigurationDetails.md)
|
174
184
|
|
175
185
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
2.
|
1
|
+
2.1.1
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# BillingApi::ApplicableDiscountDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **String** | A unique code associated with the discount. | |
|
8
|
+
| **type** | [**DiscountTypeEnum**](DiscountTypeEnum.md) | | |
|
9
|
+
| **value** | **Float** | The value or amount of the discount. The interpretation of this value depends on the 'type' of discount. | |
|
10
|
+
| **coupon_code** | **String** | Coupon code which is the source of the discount. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'pnap_billing_api'
|
16
|
+
|
17
|
+
instance = BillingApi::ApplicableDiscountDetails.new(
|
18
|
+
code: new-year-2022-monthly,
|
19
|
+
type: null,
|
20
|
+
value: 20.5,
|
21
|
+
coupon_code: promo234
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/ApplicableDiscounts.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **discounted_price** | **Float** | The price of the product after applying a discount. | [optional] |
|
8
|
-
| **discount_details** | [**Array<
|
8
|
+
| **discount_details** | [**Array<ApplicableDiscountDetails>**](ApplicableDiscountDetails.md) | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/BandwidthRecord.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
| **metadata** | [**BandwidthDetails**](BandwidthDetails.md) | | |
|
27
28
|
|
28
29
|
## Example
|
@@ -32,7 +33,7 @@ require 'pnap_billing_api'
|
|
32
33
|
|
33
34
|
instance = BillingApi::BandwidthRecord.new(
|
34
35
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
35
|
-
product_category:
|
36
|
+
product_category: null,
|
36
37
|
product_code: s1.c1.small,
|
37
38
|
location: null,
|
38
39
|
year_month: 2020-03,
|
@@ -50,6 +51,7 @@ instance = BillingApi::BandwidthRecord.new(
|
|
50
51
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
51
52
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
52
53
|
discount_details: null,
|
54
|
+
credit_details: null,
|
53
55
|
metadata: null
|
54
56
|
)
|
55
57
|
```
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# BillingApi::CreditDetails
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'pnap_billing_api'
|
13
|
+
|
14
|
+
BillingApi::CreditDetails.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'PromoCreditDetails',
|
18
|
+
# :'SystemCreditDetails'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'pnap_billing_api'
|
30
|
+
|
31
|
+
BillingApi::CreditDetails.build(data)
|
32
|
+
# => #<PromoCreditDetails:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
BillingApi::CreditDetails.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `PromoCreditDetails`
|
47
|
+
- `SystemCreditDetails`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# BillingApi::CreditDetailsBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **applied_amount** | **Float** | Amount applied. | |
|
8
|
+
| **type** | [**CreditTypeEnum**](CreditTypeEnum.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'pnap_billing_api'
|
14
|
+
|
15
|
+
instance = BillingApi::CreditDetailsBase.new(
|
16
|
+
applied_amount: 50,
|
17
|
+
type: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/DiscountDetails.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **code** | **String** | A unique code associated with the discount. | |
|
8
|
-
| **type** | **
|
8
|
+
| **type** | [**DiscountTypeEnum**](DiscountTypeEnum.md) | | |
|
9
9
|
| **value** | **Float** | The value or amount of the discount. The interpretation of this value depends on the 'type' of discount. | |
|
10
10
|
|
11
11
|
## Example
|
@@ -15,7 +15,7 @@ require 'pnap_billing_api'
|
|
15
15
|
|
16
16
|
instance = BillingApi::DiscountDetails.new(
|
17
17
|
code: new-year-2022-monthly,
|
18
|
-
type:
|
18
|
+
type: null,
|
19
19
|
value: 20.5
|
20
20
|
)
|
21
21
|
```
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# BillingApi::GpuConfigurationMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **count** | **Float** | GPU card count. | [optional] |
|
8
|
+
| **name** | **String** | GPU name. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'pnap_billing_api'
|
14
|
+
|
15
|
+
instance = BillingApi::GpuConfigurationMetadata.new(
|
16
|
+
count: 2,
|
17
|
+
name: Intel MAX 11000
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
| **metadata** | [**OperatingSystemDetails**](OperatingSystemDetails.md) | | |
|
27
28
|
|
28
29
|
## Example
|
@@ -32,7 +33,7 @@ require 'pnap_billing_api'
|
|
32
33
|
|
33
34
|
instance = BillingApi::OperatingSystemRecord.new(
|
34
35
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
35
|
-
product_category:
|
36
|
+
product_category: null,
|
36
37
|
product_code: s1.c1.small,
|
37
38
|
location: null,
|
38
39
|
year_month: 2020-03,
|
@@ -50,6 +51,7 @@ instance = BillingApi::OperatingSystemRecord.new(
|
|
50
51
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
51
52
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
52
53
|
discount_details: null,
|
54
|
+
credit_details: null,
|
53
55
|
metadata: null
|
54
56
|
)
|
55
57
|
```
|
data/docs/PricingPlan.md
CHANGED
@@ -23,8 +23,8 @@ require 'pnap_billing_api'
|
|
23
23
|
instance = BillingApi::PricingPlan.new(
|
24
24
|
sku: XXX-XXX-XXX,
|
25
25
|
sku_description: Hourly Rate for s1.c1.small in Phoenix,
|
26
|
-
location:
|
27
|
-
pricing_model:
|
26
|
+
location: null,
|
27
|
+
pricing_model: null,
|
28
28
|
price: 0.22,
|
29
29
|
price_unit: null,
|
30
30
|
applicable_discounts: null,
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# BillingApi::PromoCreditDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **applied_amount** | **Float** | Amount applied. | |
|
8
|
+
| **type** | [**CreditTypeEnum**](CreditTypeEnum.md) | | |
|
9
|
+
| **coupon_id** | **String** | Coupon id which is the source of the promo credit. | |
|
10
|
+
| **coupon_code** | **String** | Coupon code which is the source of the promo credit. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'pnap_billing_api'
|
16
|
+
|
17
|
+
instance = BillingApi::PromoCreditDetails.new(
|
18
|
+
applied_amount: 50,
|
19
|
+
type: null,
|
20
|
+
coupon_id: 574845ca-53e6-4e6e-ae16-3ecd2a7d8508,
|
21
|
+
coupon_code: promo234
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PublicSubnetRecord.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
| **metadata** | [**PublicSubnetDetails**](PublicSubnetDetails.md) | | |
|
27
28
|
|
28
29
|
## Example
|
@@ -32,7 +33,7 @@ require 'pnap_billing_api'
|
|
32
33
|
|
33
34
|
instance = BillingApi::PublicSubnetRecord.new(
|
34
35
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
35
|
-
product_category:
|
36
|
+
product_category: null,
|
36
37
|
product_code: s1.c1.small,
|
37
38
|
location: null,
|
38
39
|
year_month: 2020-03,
|
@@ -50,6 +51,7 @@ instance = BillingApi::PublicSubnetRecord.new(
|
|
50
51
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
51
52
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
52
53
|
discount_details: null,
|
54
|
+
credit_details: null,
|
53
55
|
metadata: null
|
54
56
|
)
|
55
57
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# BillingApi::RatedUsageProductCategoryEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'pnap_billing_api'
|
12
|
+
|
13
|
+
instance = BillingApi::RatedUsageProductCategoryEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/RatedUsageRecord.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
|
27
28
|
## Example
|
28
29
|
|
@@ -31,7 +32,7 @@ require 'pnap_billing_api'
|
|
31
32
|
|
32
33
|
instance = BillingApi::RatedUsageRecord.new(
|
33
34
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
34
|
-
product_category:
|
35
|
+
product_category: null,
|
35
36
|
product_code: s1.c1.small,
|
36
37
|
location: null,
|
37
38
|
year_month: 2020-03,
|
@@ -48,7 +49,8 @@ instance = BillingApi::RatedUsageRecord.new(
|
|
48
49
|
usage_session_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
49
50
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
50
51
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
51
|
-
discount_details: null
|
52
|
+
discount_details: null,
|
53
|
+
credit_details: null
|
52
54
|
)
|
53
55
|
```
|
54
56
|
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **cpu_frequency** | **Float** | CPU frequency in GHz. | |
|
12
12
|
| **network** | **String** | Server network. | |
|
13
13
|
| **storage** | **String** | Server storage. | |
|
14
|
+
| **gpu_configurations** | [**Array<GpuConfigurationMetadata>**](GpuConfigurationMetadata.md) | GPU configurations | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = BillingApi::ServerProductMetadata.new(
|
|
24
25
|
cores_per_cpu: 2,
|
25
26
|
cpu_frequency: 2.7,
|
26
27
|
network: 2x 25Gbps,
|
27
|
-
storage: 2x 2TB NVMe
|
28
|
+
storage: 2x 2TB NVMe,
|
29
|
+
gpu_configurations: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/ServerRecord.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
| **metadata** | [**ServerDetails**](ServerDetails.md) | | |
|
27
28
|
|
28
29
|
## Example
|
@@ -32,7 +33,7 @@ require 'pnap_billing_api'
|
|
32
33
|
|
33
34
|
instance = BillingApi::ServerRecord.new(
|
34
35
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
35
|
-
product_category:
|
36
|
+
product_category: null,
|
36
37
|
product_code: s1.c1.small,
|
37
38
|
location: null,
|
38
39
|
year_month: 2020-03,
|
@@ -50,6 +51,7 @@ instance = BillingApi::ServerRecord.new(
|
|
50
51
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
51
52
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
52
53
|
discount_details: null,
|
54
|
+
credit_details: null,
|
53
55
|
metadata: null
|
54
56
|
)
|
55
57
|
```
|
data/docs/StorageRecord.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique identifier of the rated usage record. | |
|
8
|
-
| **product_category** | **
|
8
|
+
| **product_category** | [**RatedUsageProductCategoryEnum**](RatedUsageProductCategoryEnum.md) | | |
|
9
9
|
| **product_code** | **String** | The code identifying the product associated to this usage record. | |
|
10
10
|
| **location** | [**LocationEnum**](LocationEnum.md) | | |
|
11
11
|
| **year_month** | **String** | Year and month of the usage record. | [optional] |
|
@@ -22,7 +22,8 @@
|
|
22
22
|
| **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. | |
|
23
23
|
| **correlation_id** | **String** | Holds usage record id | |
|
24
24
|
| **reservation_id** | **String** | Reservation id associated with this rated usage record. | [optional] |
|
25
|
-
| **discount_details** | [**
|
25
|
+
| **discount_details** | [**ApplicableDiscountDetails**](ApplicableDiscountDetails.md) | | [optional] |
|
26
|
+
| **credit_details** | [**Array<CreditDetails>**](CreditDetails.md) | | [optional] |
|
26
27
|
| **metadata** | [**StorageDetails**](StorageDetails.md) | | |
|
27
28
|
|
28
29
|
## Example
|
@@ -32,7 +33,7 @@ require 'pnap_billing_api'
|
|
32
33
|
|
33
34
|
instance = BillingApi::StorageRecord.new(
|
34
35
|
id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
35
|
-
product_category:
|
36
|
+
product_category: null,
|
36
37
|
product_code: s1.c1.small,
|
37
38
|
location: null,
|
38
39
|
year_month: 2020-03,
|
@@ -50,6 +51,7 @@ instance = BillingApi::StorageRecord.new(
|
|
50
51
|
correlation_id: ec4a9d49-1cef-49e9-b85e-b560f88bcd26,
|
51
52
|
reservation_id: c32a24a1-5949-4b60-99c0-c8aaa3a92b04,
|
52
53
|
discount_details: null,
|
54
|
+
credit_details: null,
|
53
55
|
metadata: null
|
54
56
|
)
|
55
57
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# BillingApi::SystemCreditCauseEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'pnap_billing_api'
|
12
|
+
|
13
|
+
instance = BillingApi::SystemCreditCauseEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# BillingApi::SystemCreditDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **applied_amount** | **Float** | Amount applied. | |
|
8
|
+
| **type** | [**CreditTypeEnum**](CreditTypeEnum.md) | | |
|
9
|
+
| **cause** | [**SystemCreditCauseEnum**](SystemCreditCauseEnum.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'pnap_billing_api'
|
15
|
+
|
16
|
+
instance = BillingApi::SystemCreditDetails.new(
|
17
|
+
applied_amount: 50,
|
18
|
+
type: null,
|
19
|
+
cause: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|