Skip to content

Commit ededc4d

Browse files
feat(api): api update
1 parent 21b4047 commit ededc4d

File tree

5 files changed

+38
-20
lines changed

5 files changed

+38
-20
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 139
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-3c7ee3ec9931aaeeb5e015a598812cde9edc09f114adb8759ef4c2054c90f7dc.yml
3-
openapi_spec_hash: a14720041156fe4f353449142edacf0d
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-563cf1475c193333d5f8cab934fbf844e439db6218c5b9eccb089b5c1d797b4b.yml
3+
openapi_spec_hash: f2b06aac248aecb248e975af25f3911c
44
config_hash: 3279841440b02d4e8303c961d6983492

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,11 @@ import kotlin.jvm.optionals.getOrNull
7878
* pass `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for
7979
* the customer for the credits pre-purchase. Note that you _must_ provide the
8080
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying the
81-
* cost basis with the number of credit units added. Additionally, Orb also enforces invoice
82-
* generation when a non-zero `per_unit_cost_basis` value is provided.
81+
* cost basis with the number of credit units added.
82+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
83+
* `invoice_settings` must be included
84+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required to
85+
* determine the due date
8386
*
8487
* ## Deducting Credits
8588
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb
@@ -1892,7 +1895,7 @@ private constructor(
18921895
* based on the invoice or issuance date, depending on the account's configured due
18931896
* date calculation method. A value of '0' here represents that the invoice is due
18941897
* on issue, whereas a value of '30' represents that the customer has 30 days to pay
1895-
* the invoice. Do not set this field if you want to set a custom due date.
1898+
* the invoice. You must set either `net_terms` or `custom_due_date`, but not both.
18961899
*
18971900
* @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if
18981901
* the server responded with an unexpected value).
@@ -2169,8 +2172,8 @@ private constructor(
21692172
* based on the invoice or issuance date, depending on the account's configured
21702173
* due date calculation method. A value of '0' here represents that the invoice
21712174
* is due on issue, whereas a value of '30' represents that the customer has 30
2172-
* days to pay the invoice. Do not set this field if you want to set a custom
2173-
* due date.
2175+
* days to pay the invoice. You must set either `net_terms` or
2176+
* `custom_due_date`, but not both.
21742177
*/
21752178
fun netTerms(netTerms: Long?) = netTerms(JsonField.ofNullable(netTerms))
21762179

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,11 @@ import kotlin.jvm.optionals.getOrNull
7878
* pass `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for
7979
* the customer for the credits pre-purchase. Note that you _must_ provide the
8080
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying the
81-
* cost basis with the number of credit units added. Additionally, Orb also enforces invoice
82-
* generation when a non-zero `per_unit_cost_basis` value is provided.
81+
* cost basis with the number of credit units added.
82+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
83+
* `invoice_settings` must be included
84+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required to
85+
* determine the due date
8386
*
8487
* ## Deducting Credits
8588
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb
@@ -1884,7 +1887,7 @@ private constructor(
18841887
* based on the invoice or issuance date, depending on the account's configured due
18851888
* date calculation method. A value of '0' here represents that the invoice is due
18861889
* on issue, whereas a value of '30' represents that the customer has 30 days to pay
1887-
* the invoice. Do not set this field if you want to set a custom due date.
1890+
* the invoice. You must set either `net_terms` or `custom_due_date`, but not both.
18881891
*
18891892
* @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if
18901893
* the server responded with an unexpected value).
@@ -2161,8 +2164,8 @@ private constructor(
21612164
* based on the invoice or issuance date, depending on the account's configured
21622165
* due date calculation method. A value of '0' here represents that the invoice
21632166
* is due on issue, whereas a value of '30' represents that the customer has 30
2164-
* days to pay the invoice. Do not set this field if you want to set a custom
2165-
* due date.
2167+
* days to pay the invoice. You must set either `net_terms` or
2168+
* `custom_due_date`, but not both.
21662169
*/
21672170
fun netTerms(netTerms: Long?) = netTerms(JsonField.ofNullable(netTerms))
21682171

orb-java-core/src/main/kotlin/com/withorb/api/services/async/customers/credits/LedgerServiceAsync.kt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,11 @@ interface LedgerServiceAsync {
179179
* you pass `invoice_settings` in the body of this request, Orb will also generate a one-off
180180
* invoice for the customer for the credits pre-purchase. Note that you _must_ provide the
181181
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying
182-
* the cost basis with the number of credit units added. Additionally, Orb also enforces invoice
183-
* generation when a non-zero `per_unit_cost_basis` value is provided.
182+
* the cost basis with the number of credit units added.
183+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
184+
* `invoice_settings` must be included
185+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required
186+
* to determine the due date
184187
*
185188
* ## Deducting Credits
186189
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`.
@@ -305,8 +308,11 @@ interface LedgerServiceAsync {
305308
* you pass `invoice_settings` in the body of this request, Orb will also generate a one-off
306309
* invoice for the customer for the credits pre-purchase. Note that you _must_ provide the
307310
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying
308-
* the cost basis with the number of credit units added. Additionally, Orb also enforces invoice
309-
* generation when a non-zero `per_unit_cost_basis` value is provided.
311+
* the cost basis with the number of credit units added.
312+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
313+
* `invoice_settings` must be included
314+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required
315+
* to determine the due date
310316
*
311317
* ## Deducting Credits
312318
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`.

orb-java-core/src/main/kotlin/com/withorb/api/services/blocking/customers/credits/LedgerService.kt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,11 @@ interface LedgerService {
174174
* you pass `invoice_settings` in the body of this request, Orb will also generate a one-off
175175
* invoice for the customer for the credits pre-purchase. Note that you _must_ provide the
176176
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying
177-
* the cost basis with the number of credit units added. Additionally, Orb also enforces invoice
178-
* generation when a non-zero `per_unit_cost_basis` value is provided.
177+
* the cost basis with the number of credit units added.
178+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
179+
* `invoice_settings` must be included
180+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required
181+
* to determine the due date
179182
*
180183
* ## Deducting Credits
181184
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`.
@@ -299,8 +302,11 @@ interface LedgerService {
299302
* you pass `invoice_settings` in the body of this request, Orb will also generate a one-off
300303
* invoice for the customer for the credits pre-purchase. Note that you _must_ provide the
301304
* `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying
302-
* the cost basis with the number of credit units added. Additionally, Orb also enforces invoice
303-
* generation when a non-zero `per_unit_cost_basis` value is provided.
305+
* the cost basis with the number of credit units added.
306+
* * if `per_unit_cost_basis` is greater than zero, an invoice will be generated and
307+
* `invoice_settings` must be included
308+
* * if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required
309+
* to determine the due date
304310
*
305311
* ## Deducting Credits
306312
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`.

0 commit comments

Comments
 (0)