Skip to content

Commit 7e80bfe

Browse files
chore(internal): change some comment formatting
1 parent cf6fd19 commit 7e80bfe

38 files changed

+150
-300
lines changed

orb-java-core/src/main/kotlin/com/withorb/api/models/ChangedSubscriptionResources.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -707,9 +707,9 @@ private constructor(
707707
* |Ireland |`eu_vat` |European VAT Number |
708708
* |Israel |`il_vat` |Israel VAT |
709709
* |Italy |`eu_vat` |European VAT Number |
710-
* |Japan |`jp_cn` |Japanese Corporate Number (_Hōjin Bangō_) |
711-
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_)|
712-
* |Japan |`jp_trn` |Japanese Tax Registration Number (_Tōroku Bangō_) |
710+
* |Japan |`jp_cn` |Japanese Corporate Number (*Hōjin Bangō*) |
711+
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)|
712+
* |Japan |`jp_trn` |Japanese Tax Registration Number (*Tōroku Bangō*) |
713713
* |Kazakhstan |`kz_bin` |Kazakhstani Business Identification Number |
714714
* |Kenya |`ke_pin` |Kenya Revenue Authority Personal Identification Number |
715715
* |Kyrgyzstan |`kg_tin` |Kyrgyzstan Tax Identification Number |
@@ -1805,9 +1805,9 @@ private constructor(
18051805
* |Ireland |`eu_vat` |European VAT Number |
18061806
* |Israel |`il_vat` |Israel VAT |
18071807
* |Italy |`eu_vat` |European VAT Number |
1808-
* |Japan |`jp_cn` |Japanese Corporate Number (_Hōjin Bangō_) |
1809-
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_)|
1810-
* |Japan |`jp_trn` |Japanese Tax Registration Number (_Tōroku Bangō_) |
1808+
* |Japan |`jp_cn` |Japanese Corporate Number (*Hōjin Bangō*) |
1809+
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)|
1810+
* |Japan |`jp_trn` |Japanese Tax Registration Number (*Tōroku Bangō*) |
18111811
* |Kazakhstan |`kz_bin` |Kazakhstani Business Identification Number |
18121812
* |Kenya |`ke_pin` |Kenya Revenue Authority Personal Identification Number |
18131813
* |Kyrgyzstan |`kg_tin` |Kyrgyzstan Tax Identification Number |

orb-java-core/src/main/kotlin/com/withorb/api/models/Customer.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -364,9 +364,9 @@ private constructor(
364364
* |Ireland |`eu_vat` |European VAT Number |
365365
* |Israel |`il_vat` |Israel VAT |
366366
* |Italy |`eu_vat` |European VAT Number |
367-
* |Japan |`jp_cn` |Japanese Corporate Number (_Hōjin Bangō_) |
368-
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_)|
369-
* |Japan |`jp_trn` |Japanese Tax Registration Number (_Tōroku Bangō_) |
367+
* |Japan |`jp_cn` |Japanese Corporate Number (*Hōjin Bangō*) |
368+
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)|
369+
* |Japan |`jp_trn` |Japanese Tax Registration Number (*Tōroku Bangō*) |
370370
* |Kazakhstan |`kz_bin` |Kazakhstani Business Identification Number |
371371
* |Kenya |`ke_pin` |Kenya Revenue Authority Personal Identification Number |
372372
* |Kyrgyzstan |`kg_tin` |Kyrgyzstan Tax Identification Number |
@@ -1160,9 +1160,9 @@ private constructor(
11601160
* |Ireland |`eu_vat` |European VAT Number |
11611161
* |Israel |`il_vat` |Israel VAT |
11621162
* |Italy |`eu_vat` |European VAT Number |
1163-
* |Japan |`jp_cn` |Japanese Corporate Number (_Hōjin Bangō_) |
1164-
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_)|
1165-
* |Japan |`jp_trn` |Japanese Tax Registration Number (_Tōroku Bangō_) |
1163+
* |Japan |`jp_cn` |Japanese Corporate Number (*Hōjin Bangō*) |
1164+
* |Japan |`jp_rn` |Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)|
1165+
* |Japan |`jp_trn` |Japanese Tax Registration Number (*Tōroku Bangō*) |
11661166
* |Kazakhstan |`kz_bin` |Kazakhstani Business Identification Number |
11671167
* |Kenya |`ke_pin` |Kenya Revenue Authority Personal Identification Number |
11681168
* |Kyrgyzstan |`kg_tin` |Kyrgyzstan Tax Identification Number |

orb-java-core/src/main/kotlin/com/withorb/api/models/CustomerCostListByExternalIdParams.kt

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ import kotlin.jvm.optionals.getOrNull
3535
* committed spend.
3636
*
3737
* ## Fetching subscriptions
38-
*
3938
* By default, this endpoint fetches the currently active subscription for the customer, and returns
4039
* cost information for the subscription's current billing period, broken down by each participating
4140
* price. If there are no currently active subscriptions, this will instead default to the most
@@ -48,17 +47,15 @@ import kotlin.jvm.optionals.getOrNull
4847
* and prices for both subscriptions will be included in the breakdown.
4948
*
5049
* ## Prepaid plans
51-
*
5250
* For plans that include prices which deduct credits rather than accrue in-arrears charges in a
5351
* billable currency, this endpoint will return the total deduction amount, in credits, for the
5452
* specified timeframe.
5553
*
5654
* ## Cumulative subtotals and totals
57-
*
5855
* Since the subtotal and total must factor in any billing-period level discounts and minimums, it's
5956
* most meaningful to consider costs relative to the start of the subscription's billing period. As
6057
* a result, by default this endpoint returns cumulative totals since the beginning of the billing
61-
* period. In particular, the `timeframe_start` of a returned timeframe window is _always_ the
58+
* period. In particular, the `timeframe_start` of a returned timeframe window is *always* the
6259
* beginning of the billing period and `timeframe_end` is incremented one day at a time to build the
6360
* result.
6461
*
@@ -76,7 +73,6 @@ import kotlin.jvm.optionals.getOrNull
7673
* | 2023-02-01 | 2023-02-06 | 36 | \$90.00 | \$90.00 |
7774
*
7875
* ### Periodic values
79-
*
8076
* When the query parameter `view_mode=periodic` is specified, Orb will return an incremental
8177
* day-by-day view of costs. In this case, there will always be a one-day difference between
8278
* `timeframe_start` and `timeframe_end` for the timeframes returned. This is a transform on top of
@@ -86,7 +82,6 @@ import kotlin.jvm.optionals.getOrNull
8682
* cost.
8783
*
8884
* ## Timeframe bounds
89-
*
9085
* For an active subscription, both timeframes should be specified in the request. If a subscription
9186
* starts or ends within the timeframe, the response will only include windows where the
9287
* subscription is active. If a subscription has ended, no timeframe bounds need to be specified and
@@ -117,7 +112,6 @@ import kotlin.jvm.optionals.getOrNull
117112
* You can see this sliced timeframe visualized [here](https://i.imgur.com/TXhYgme.png).
118113
*
119114
* ### Matrix prices
120-
*
121115
* When a price uses matrix pricing, it's important to view costs grouped by those matrix
122116
* dimensions. Orb will return `price_groups` with the `grouping_key` and `secondary_grouping_key`
123117
* based on the matrix price definition, for each `grouping_value` and `secondary_grouping_value`

orb-java-core/src/main/kotlin/com/withorb/api/models/CustomerCostListParams.kt

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ import kotlin.jvm.optionals.getOrNull
3535
* committed spend.
3636
*
3737
* ## Fetching subscriptions
38-
*
3938
* By default, this endpoint fetches the currently active subscription for the customer, and returns
4039
* cost information for the subscription's current billing period, broken down by each participating
4140
* price. If there are no currently active subscriptions, this will instead default to the most
@@ -48,17 +47,15 @@ import kotlin.jvm.optionals.getOrNull
4847
* and prices for both subscriptions will be included in the breakdown.
4948
*
5049
* ## Prepaid plans
51-
*
5250
* For plans that include prices which deduct credits rather than accrue in-arrears charges in a
5351
* billable currency, this endpoint will return the total deduction amount, in credits, for the
5452
* specified timeframe.
5553
*
5654
* ## Cumulative subtotals and totals
57-
*
5855
* Since the subtotal and total must factor in any billing-period level discounts and minimums, it's
5956
* most meaningful to consider costs relative to the start of the subscription's billing period. As
6057
* a result, by default this endpoint returns cumulative totals since the beginning of the billing
61-
* period. In particular, the `timeframe_start` of a returned timeframe window is _always_ the
58+
* period. In particular, the `timeframe_start` of a returned timeframe window is *always* the
6259
* beginning of the billing period and `timeframe_end` is incremented one day at a time to build the
6360
* result.
6461
*
@@ -76,7 +73,6 @@ import kotlin.jvm.optionals.getOrNull
7673
* | 2023-02-01 | 2023-02-06 | 36 | \$90.00 | \$90.00 |
7774
*
7875
* ### Periodic values
79-
*
8076
* When the query parameter `view_mode=periodic` is specified, Orb will return an incremental
8177
* day-by-day view of costs. In this case, there will always be a one-day difference between
8278
* `timeframe_start` and `timeframe_end` for the timeframes returned. This is a transform on top of
@@ -86,7 +82,6 @@ import kotlin.jvm.optionals.getOrNull
8682
* cost.
8783
*
8884
* ## Timeframe bounds
89-
*
9085
* For an active subscription, both timeframes should be specified in the request. If a subscription
9186
* starts or ends within the timeframe, the response will only include windows where the
9287
* subscription is active. If a subscription has ended, no timeframe bounds need to be specified and
@@ -117,7 +112,6 @@ import kotlin.jvm.optionals.getOrNull
117112
* You can see this sliced timeframe visualized [here](https://i.imgur.com/TXhYgme.png).
118113
*
119114
* ### Matrix prices
120-
*
121115
* When a price uses matrix pricing, it's important to view costs grouped by those matrix
122116
* dimensions. Orb will return `price_groups` with the `grouping_key` and `secondary_grouping_key`
123117
* based on the matrix price definition, for each `grouping_value` and `secondary_grouping_value`

0 commit comments

Comments
 (0)