feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-42aa43f3893eef31a351e066bf0cf8c56da8c857ccbb45eb7dd58739ad43bd86.yml
-openapi_spec_hash: e6b8c1e707036539d88a7b79af864a49
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-c075f748a7de8ecdccf11a8f2374682b0efd84f1318147274a838bf2fdd73b58.yml
+openapi_spec_hash: ae918b8f348f1b7d3252a59dac36c453
 config_hash: 1f73a949b649ecfe6ec68ba1bb459dc2

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

@@ -43,7 +43,17 @@ private constructor(
     fun description(): Optional<String> = body.description()
 
     /**
-     * Amount already collected to apply to the customer's balance.
+     * Mark all pending invoices that are payable as paid. If amount is also provided, mark as paid
+     * and credit the difference to the customer's balance.
+     *
+     * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
+     *   responded with an unexpected value).
+     */
+    fun markAsPaid(): Optional<Boolean> = body.markAsPaid()
+
+    /**
+     * Amount already collected to apply to the customer's balance. If mark_as_paid is also
+     * provided, credit the difference to the customer's balance.
      *
      * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
      *   responded with an unexpected value).
@@ -57,6 +67,13 @@ private constructor(
      */
     fun _description(): JsonField<String> = body._description()
 
+    /**
+     * Returns the raw JSON value of [markAsPaid].
+     *
+     * Unlike [markAsPaid], this method doesn't throw if the JSON field has an unexpected type.
+     */
+    fun _markAsPaid(): JsonField<Boolean> = body._markAsPaid()
+
     /**
      * Returns the raw JSON value of [previouslyCollectedAmount].
      *
@@ -119,6 +136,7 @@ private constructor(
          * This is generally only useful if you are already constructing the body separately.
          * Otherwise, it's more convenient to use the top-level setters instead:
          * - [description]
+         * - [markAsPaid]
          * - [previouslyCollectedAmount]
          */
         fun body(body: Body) = apply { this.body = body.toBuilder() }
@@ -138,7 +156,35 @@ private constructor(
          */
         fun description(description: JsonField<String>) = apply { body.description(description) }
 
-        /** Amount already collected to apply to the customer's balance. */
+        /**
+         * Mark all pending invoices that are payable as paid. If amount is also provided, mark as
+         * paid and credit the difference to the customer's balance.
+         */
+        fun markAsPaid(markAsPaid: Boolean?) = apply { body.markAsPaid(markAsPaid) }
+
+        /**
+         * Alias for [Builder.markAsPaid].
+         *
+         * This unboxed primitive overload exists for backwards compatibility.
+         */
+        fun markAsPaid(markAsPaid: Boolean) = markAsPaid(markAsPaid as Boolean?)
+
+        /** Alias for calling [Builder.markAsPaid] with `markAsPaid.orElse(null)`. */
+        fun markAsPaid(markAsPaid: Optional<Boolean>) = markAsPaid(markAsPaid.getOrNull())
+
+        /**
+         * Sets [Builder.markAsPaid] to an arbitrary JSON value.
+         *
+         * You should usually call [Builder.markAsPaid] with a well-typed [Boolean] value instead.
+         * This method is primarily for setting the field to an undocumented or not yet supported
+         * value.
+         */
+        fun markAsPaid(markAsPaid: JsonField<Boolean>) = apply { body.markAsPaid(markAsPaid) }
+
+        /**
+         * Amount already collected to apply to the customer's balance. If mark_as_paid is also
+         * provided, credit the difference to the customer's balance.
+         */
         fun previouslyCollectedAmount(previouslyCollectedAmount: String?) = apply {
             body.previouslyCollectedAmount(previouslyCollectedAmount)
         }
@@ -308,6 +354,7 @@ private constructor(
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(
         private val description: JsonField<String>,
+        private val markAsPaid: JsonField<Boolean>,
         private val previouslyCollectedAmount: JsonField<String>,
         private val additionalProperties: MutableMap<String, JsonValue>,
     ) {
@@ -317,10 +364,13 @@ private constructor(
             @JsonProperty("description")
             @ExcludeMissing
             description: JsonField<String> = JsonMissing.of(),
+            @JsonProperty("mark_as_paid")
+            @ExcludeMissing
+            markAsPaid: JsonField<Boolean> = JsonMissing.of(),
             @JsonProperty("previously_collected_amount")
             @ExcludeMissing
             previouslyCollectedAmount: JsonField<String> = JsonMissing.of(),
-        ) : this(description, previouslyCollectedAmount, mutableMapOf())
+        ) : this(description, markAsPaid, previouslyCollectedAmount, mutableMapOf())
 
         /**
          * Description to apply to the balance transaction representing this credit.
@@ -331,7 +381,17 @@ private constructor(
         fun description(): Optional<String> = description.getOptional("description")
 
         /**
-         * Amount already collected to apply to the customer's balance.
+         * Mark all pending invoices that are payable as paid. If amount is also provided, mark as
+         * paid and credit the difference to the customer's balance.
+         *
+         * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the
+         *   server responded with an unexpected value).
+         */
+        fun markAsPaid(): Optional<Boolean> = markAsPaid.getOptional("mark_as_paid")
+
+        /**
+         * Amount already collected to apply to the customer's balance. If mark_as_paid is also
+         * provided, credit the difference to the customer's balance.
          *
          * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -348,6 +408,15 @@ private constructor(
         @ExcludeMissing
         fun _description(): JsonField<String> = description
 
+        /**
+         * Returns the raw JSON value of [markAsPaid].
+         *
+         * Unlike [markAsPaid], this method doesn't throw if the JSON field has an unexpected type.
+         */
+        @JsonProperty("mark_as_paid")
+        @ExcludeMissing
+        fun _markAsPaid(): JsonField<Boolean> = markAsPaid
+
         /**
          * Returns the raw JSON value of [previouslyCollectedAmount].
          *
@@ -380,12 +449,14 @@ private constructor(
         class Builder internal constructor() {
 
             private var description: JsonField<String> = JsonMissing.of()
+            private var markAsPaid: JsonField<Boolean> = JsonMissing.of()
             private var previouslyCollectedAmount: JsonField<String> = JsonMissing.of()
             private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
             @JvmSynthetic
             internal fun from(body: Body) = apply {
                 description = body.description
+                markAsPaid = body.markAsPaid
                 previouslyCollectedAmount = body.previouslyCollectedAmount
                 additionalProperties = body.additionalProperties.toMutableMap()
             }
@@ -407,7 +478,35 @@ private constructor(
                 this.description = description
             }
 
-            /** Amount already collected to apply to the customer's balance. */
+            /**
+             * Mark all pending invoices that are payable as paid. If amount is also provided, mark
+             * as paid and credit the difference to the customer's balance.
+             */
+            fun markAsPaid(markAsPaid: Boolean?) = markAsPaid(JsonField.ofNullable(markAsPaid))
+
+            /**
+             * Alias for [Builder.markAsPaid].
+             *
+             * This unboxed primitive overload exists for backwards compatibility.
+             */
+            fun markAsPaid(markAsPaid: Boolean) = markAsPaid(markAsPaid as Boolean?)
+
+            /** Alias for calling [Builder.markAsPaid] with `markAsPaid.orElse(null)`. */
+            fun markAsPaid(markAsPaid: Optional<Boolean>) = markAsPaid(markAsPaid.getOrNull())
+
+            /**
+             * Sets [Builder.markAsPaid] to an arbitrary JSON value.
+             *
+             * You should usually call [Builder.markAsPaid] with a well-typed [Boolean] value
+             * instead. This method is primarily for setting the field to an undocumented or not yet
+             * supported value.
+             */
+            fun markAsPaid(markAsPaid: JsonField<Boolean>) = apply { this.markAsPaid = markAsPaid }
+
+            /**
+             * Amount already collected to apply to the customer's balance. If mark_as_paid is also
+             * provided, credit the difference to the customer's balance.
+             */
             fun previouslyCollectedAmount(previouslyCollectedAmount: String?) =
                 previouslyCollectedAmount(JsonField.ofNullable(previouslyCollectedAmount))
 
@@ -454,7 +553,12 @@ private constructor(
              * Further updates to this [Builder] will not mutate the returned instance.
              */
             fun build(): Body =
-                Body(description, previouslyCollectedAmount, additionalProperties.toMutableMap())
+                Body(
+                    description,
+                    markAsPaid,
+                    previouslyCollectedAmount,
+                    additionalProperties.toMutableMap(),
+                )
         }
 
         private var validated: Boolean = false
@@ -465,6 +569,7 @@ private constructor(
             }
 
             description()
+            markAsPaid()
             previouslyCollectedAmount()
             validated = true
         }
@@ -486,6 +591,7 @@ private constructor(
         @JvmSynthetic
         internal fun validity(): Int =
             (if (description.asKnown().isPresent) 1 else 0) +
+                (if (markAsPaid.asKnown().isPresent) 1 else 0) +
                 (if (previouslyCollectedAmount.asKnown().isPresent) 1 else 0)
 
         override fun equals(other: Any?): Boolean {
@@ -495,18 +601,19 @@ private constructor(
 
             return other is Body &&
                 description == other.description &&
+                markAsPaid == other.markAsPaid &&
                 previouslyCollectedAmount == other.previouslyCollectedAmount &&
                 additionalProperties == other.additionalProperties
         }
 
         private val hashCode: Int by lazy {
-            Objects.hash(description, previouslyCollectedAmount, additionalProperties)
+            Objects.hash(description, markAsPaid, previouslyCollectedAmount, additionalProperties)
         }
 
         override fun hashCode(): Int = hashCode
 
         override fun toString() =
-            "Body{description=$description, previouslyCollectedAmount=$previouslyCollectedAmount, additionalProperties=$additionalProperties}"
+            "Body{description=$description, markAsPaid=$markAsPaid, previouslyCollectedAmount=$previouslyCollectedAmount, additionalProperties=$additionalProperties}"
     }
 
     override fun equals(other: Any?): Boolean {

orb-java-core/src/test/kotlin/com/withorb/api/models/SubscriptionChangeApplyParamsTest.kt

@@ -12,6 +12,7 @@ internal class SubscriptionChangeApplyParamsTest {
         SubscriptionChangeApplyParams.builder()
             .subscriptionChangeId("subscription_change_id")
             .description("description")
+            .markAsPaid(true)
             .previouslyCollectedAmount("previously_collected_amount")
             .build()
     }
@@ -34,12 +35,14 @@ internal class SubscriptionChangeApplyParamsTest {
             SubscriptionChangeApplyParams.builder()
                 .subscriptionChangeId("subscription_change_id")
                 .description("description")
+                .markAsPaid(true)
                 .previouslyCollectedAmount("previously_collected_amount")
                 .build()
 
         val body = params._body()
 
         assertThat(body.description()).contains("description")
+        assertThat(body.markAsPaid()).contains(true)
         assertThat(body.previouslyCollectedAmount()).contains("previously_collected_amount")
     }
 

orb-java-core/src/test/kotlin/com/withorb/api/services/async/SubscriptionChangeServiceAsyncTest.kt

@@ -41,6 +41,7 @@ internal class SubscriptionChangeServiceAsyncTest {
                 SubscriptionChangeApplyParams.builder()
                     .subscriptionChangeId("subscription_change_id")
                     .description("description")
+                    .markAsPaid(true)
                     .previouslyCollectedAmount("previously_collected_amount")
                     .build()
             )

orb-java-core/src/test/kotlin/com/withorb/api/services/blocking/SubscriptionChangeServiceTest.kt

@@ -39,6 +39,7 @@ internal class SubscriptionChangeServiceTest {
                 SubscriptionChangeApplyParams.builder()
                     .subscriptionChangeId("subscription_change_id")
                     .description("description")
+                    .markAsPaid(true)
                     .previouslyCollectedAmount("previously_collected_amount")
                     .build()
             )