feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 116
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-a44cccd16bb58080f7cc0669999403f6ed3f77287fad901caa6fd2523f2fbafd.yml
-openapi_spec_hash: af6444648d0b2a70b7f7ad234bd37541
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-1aabbd8715a871e993abf67f0bf9c1d6793b4f197c4b2f11fc7a76453590cd6c.yml
+openapi_spec_hash: 3e5878f87e74881d882a69e1ccdc25a3
 config_hash: 1f535c1fa222aacf28b636eed21bec72

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

@@ -136,7 +136,7 @@ private constructor(
 
     fun externalCustomerId(): Optional<String> = Optional.ofNullable(externalCustomerId)
 
-    /** The currency to use. */
+    /** The currency or custom pricing unit to use. */
     fun currency(): Optional<String> = Optional.ofNullable(currency)
 
     /** Costs returned are exclusive of `timeframe_end`. */
@@ -205,7 +205,7 @@ private constructor(
         fun externalCustomerId(externalCustomerId: Optional<String>) =
             externalCustomerId(externalCustomerId.getOrNull())
 
-        /** The currency to use. */
+        /** The currency or custom pricing unit to use. */
         fun currency(currency: String?) = apply { this.currency = currency }
 
         /** Alias for calling [Builder.currency] with `currency.orElse(null)`. */

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

@@ -136,7 +136,7 @@ private constructor(
 
     fun customerId(): Optional<String> = Optional.ofNullable(customerId)
 
-    /** The currency to use. */
+    /** The currency or custom pricing unit to use. */
     fun currency(): Optional<String> = Optional.ofNullable(currency)
 
     /** Costs returned are exclusive of `timeframe_end`. */
@@ -195,7 +195,7 @@ private constructor(
         /** Alias for calling [Builder.customerId] with `customerId.orElse(null)`. */
         fun customerId(customerId: Optional<String>) = customerId(customerId.getOrNull())
 
-        /** The currency to use. */
+        /** The currency or custom pricing unit to use. */
         fun currency(currency: String?) = apply { this.currency = currency }
 
         /** Alias for calling [Builder.currency] with `currency.orElse(null)`. */

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

@@ -1229,11 +1229,10 @@ private constructor(
                  * date for the invoice. If you intend the invoice to be due on issue, set this
                  * to 0.
                  *
-                 * @throws OrbInvalidDataException if the JSON field has an unexpected type or is
-                 *   unexpectedly missing or null (e.g. if the server responded with an unexpected
-                 *   value).
+                 * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if
+                 *   the server responded with an unexpected value).
                  */
-                fun netTerms(): Long = netTerms.getRequired("net_terms")
+                fun netTerms(): Optional<Long> = netTerms.getOptional("net_terms")
 
                 /**
                  * An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -1380,7 +1379,17 @@ private constructor(
                      * issue date for the invoice. If you intend the invoice to be due on issue, set
                      * this to 0.
                      */
-                    fun netTerms(netTerms: Long) = netTerms(JsonField.of(netTerms))
+                    fun netTerms(netTerms: Long?) = netTerms(JsonField.ofNullable(netTerms))
+
+                    /**
+                     * Alias for [Builder.netTerms].
+                     *
+                     * This unboxed primitive overload exists for backwards compatibility.
+                     */
+                    fun netTerms(netTerms: Long) = netTerms(netTerms as Long?)
+
+                    /** Alias for calling [Builder.netTerms] with `netTerms.orElse(null)`. */
+                    fun netTerms(netTerms: Optional<Long>) = netTerms(netTerms.getOrNull())
 
                     /**
                      * Sets [Builder.netTerms] to an arbitrary JSON value.

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

@@ -1221,11 +1221,10 @@ private constructor(
                  * date for the invoice. If you intend the invoice to be due on issue, set this
                  * to 0.
                  *
-                 * @throws OrbInvalidDataException if the JSON field has an unexpected type or is
-                 *   unexpectedly missing or null (e.g. if the server responded with an unexpected
-                 *   value).
+                 * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if
+                 *   the server responded with an unexpected value).
                  */
-                fun netTerms(): Long = netTerms.getRequired("net_terms")
+                fun netTerms(): Optional<Long> = netTerms.getOptional("net_terms")
 
                 /**
                  * An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -1372,7 +1371,17 @@ private constructor(
                      * issue date for the invoice. If you intend the invoice to be due on issue, set
                      * this to 0.
                      */
-                    fun netTerms(netTerms: Long) = netTerms(JsonField.of(netTerms))
+                    fun netTerms(netTerms: Long?) = netTerms(JsonField.ofNullable(netTerms))
+
+                    /**
+                     * Alias for [Builder.netTerms].
+                     *
+                     * This unboxed primitive overload exists for backwards compatibility.
+                     */
+                    fun netTerms(netTerms: Long) = netTerms(netTerms as Long?)
+
+                    /** Alias for calling [Builder.netTerms] with `netTerms.orElse(null)`. */
+                    fun netTerms(netTerms: Optional<Long>) = netTerms(netTerms.getOrNull())
 
                     /**
                      * Sets [Builder.netTerms] to an arbitrary JSON value.

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

@@ -103,8 +103,10 @@ private constructor(
     fun emailDelivery(): Optional<Boolean> = body.emailDelivery()
 
     /**
-     * The external customer ID. This can only be set if empty and the customer has no past or
-     * current subscriptions.
+     * The external customer ID. This can only be set if the customer has no existing external
+     * customer ID. Since this action may change usage quantities for all existing subscriptions, it
+     * is disallowed if the customer has issued invoices with usage line items and subject to the
+     * same restrictions as backdated subscription creation.
      *
      * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
      *   responded with an unexpected value).
@@ -632,8 +634,10 @@ private constructor(
         }
 
         /**
-         * The external customer ID. This can only be set if empty and the customer has no past or
-         * current subscriptions.
+         * The external customer ID. This can only be set if the customer has no existing external
+         * customer ID. Since this action may change usage quantities for all existing
+         * subscriptions, it is disallowed if the customer has issued invoices with usage line items
+         * and subject to the same restrictions as backdated subscription creation.
          */
         fun externalCustomerId(externalCustomerId: String?) = apply {
             body.externalCustomerId(externalCustomerId)
@@ -1284,8 +1288,10 @@ private constructor(
         fun emailDelivery(): Optional<Boolean> = emailDelivery.getOptional("email_delivery")
 
         /**
-         * The external customer ID. This can only be set if empty and the customer has no past or
-         * current subscriptions.
+         * The external customer ID. This can only be set if the customer has no existing external
+         * customer ID. Since this action may change usage quantities for all existing
+         * subscriptions, it is disallowed if the customer has issued invoices with usage line items
+         * and subject to the same restrictions as backdated subscription creation.
          *
          * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -1859,8 +1865,10 @@ private constructor(
             }
 
             /**
-             * The external customer ID. This can only be set if empty and the customer has no past
-             * or current subscriptions.
+             * The external customer ID. This can only be set if the customer has no existing
+             * external customer ID. Since this action may change usage quantities for all existing
+             * subscriptions, it is disallowed if the customer has issued invoices with usage line
+             * items and subject to the same restrictions as backdated subscription creation.
              */
             fun externalCustomerId(externalCustomerId: String?) =
                 externalCustomerId(JsonField.ofNullable(externalCustomerId))

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

@@ -104,8 +104,10 @@ private constructor(
     fun emailDelivery(): Optional<Boolean> = body.emailDelivery()
 
     /**
-     * The external customer ID. This can only be set if empty and the customer has no past or
-     * current subscriptions.
+     * The external customer ID. This can only be set if the customer has no existing external
+     * customer ID. Since this action may change usage quantities for all existing subscriptions, it
+     * is disallowed if the customer has issued invoices with usage line items and subject to the
+     * same restrictions as backdated subscription creation.
      *
      * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
      *   responded with an unexpected value).
@@ -628,8 +630,10 @@ private constructor(
         }
 
         /**
-         * The external customer ID. This can only be set if empty and the customer has no past or
-         * current subscriptions.
+         * The external customer ID. This can only be set if the customer has no existing external
+         * customer ID. Since this action may change usage quantities for all existing
+         * subscriptions, it is disallowed if the customer has issued invoices with usage line items
+         * and subject to the same restrictions as backdated subscription creation.
          */
         fun externalCustomerId(externalCustomerId: String?) = apply {
             body.externalCustomerId(externalCustomerId)
@@ -1280,8 +1284,10 @@ private constructor(
         fun emailDelivery(): Optional<Boolean> = emailDelivery.getOptional("email_delivery")
 
         /**
-         * The external customer ID. This can only be set if empty and the customer has no past or
-         * current subscriptions.
+         * The external customer ID. This can only be set if the customer has no existing external
+         * customer ID. Since this action may change usage quantities for all existing
+         * subscriptions, it is disallowed if the customer has issued invoices with usage line items
+         * and subject to the same restrictions as backdated subscription creation.
          *
          * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -1855,8 +1861,10 @@ private constructor(
             }
 
             /**
-             * The external customer ID. This can only be set if empty and the customer has no past
-             * or current subscriptions.
+             * The external customer ID. This can only be set if the customer has no existing
+             * external customer ID. Since this action may change usage quantities for all existing
+             * subscriptions, it is disallowed if the customer has issued invoices with usage line
+             * items and subject to the same restrictions as backdated subscription creation.
              */
             fun externalCustomerId(externalCustomerId: String?) =
                 externalCustomerId(JsonField.ofNullable(externalCustomerId))

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

@@ -21,10 +21,12 @@ import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
 /**
- * This endpoint allows you to update the `metadata` property on an invoice. If you pass null for
- * the metadata value, it will clear any existing metadata for that invoice.
+ * This endpoint allows you to update the `metadata`, `net_terms`, and `due_date` properties on an
+ * invoice. If you pass null for the metadata value, it will clear any existing metadata for that
+ * invoice.
  *
- * `metadata` can be modified regardless of invoice state.
+ * `metadata` can be modified regardless of invoice state. `net_terms` and `due_date` can only be
+ * modified if the invoice is in a `draft` state.
  */
 class InvoiceUpdateParams
 private constructor(

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

@@ -39,7 +39,7 @@ private constructor(
 
     fun subscriptionId(): Optional<String> = Optional.ofNullable(subscriptionId)
 
-    /** The currency to use. */
+    /** The currency or custom pricing unit to use. */
     fun currency(): Optional<String> = Optional.ofNullable(currency)
 
     /** Costs returned are exclusive of `timeframe_end`. */
@@ -101,7 +101,7 @@ private constructor(
         fun subscriptionId(subscriptionId: Optional<String>) =
             subscriptionId(subscriptionId.getOrNull())
 
-        /** The currency to use. */
+        /** The currency or custom pricing unit to use. */
         fun currency(currency: String?) = apply { this.currency = currency }
 
         /** Alias for calling [Builder.currency] with `currency.orElse(null)`. */

orb-java-core/src/main/kotlin/com/withorb/api/services/async/InvoiceServiceAsync.kt

@@ -45,10 +45,12 @@ interface InvoiceServiceAsync {
     ): CompletableFuture<Invoice>
 
     /**
-     * This endpoint allows you to update the `metadata` property on an invoice. If you pass null
-     * for the metadata value, it will clear any existing metadata for that invoice.
+     * This endpoint allows you to update the `metadata`, `net_terms`, and `due_date` properties on
+     * an invoice. If you pass null for the metadata value, it will clear any existing metadata for
+     * that invoice.
      *
-     * `metadata` can be modified regardless of invoice state.
+     * `metadata` can be modified regardless of invoice state. `net_terms` and `due_date` can only
+     * be modified if the invoice is in a `draft` state.
      */
     fun update(invoiceId: String): CompletableFuture<Invoice> =
         update(invoiceId, InvoiceUpdateParams.none())