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-26020bd285825dac04bf642a414ea07c786fc6e42ee6bbcf795e11f8db426519.yml
-openapi_spec_hash: 897fedec83f0960539b3aa4ec0e3308d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-297c7ce95bc0aa1ac6f324a487515f49b8a30b74eb9d39ca9dcd2d9cf065f0ef.yml
+openapi_spec_hash: 29e9af981bc78379336079bb4208c54d
 config_hash: 1f73a949b649ecfe6ec68ba1bb459dc2

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

@@ -5730,6 +5730,9 @@ private constructor(
                 /** Alias for calling [price] with `Price.ofMinimum(minimum)`. */
                 fun price(minimum: Price.Minimum) = price(Price.ofMinimum(minimum))
 
+                /** Alias for calling [price] with `Price.ofEventOutput(eventOutput)`. */
+                fun price(eventOutput: Price.EventOutput) = price(Price.ofEventOutput(eventOutput))
+
                 /** Either the fixed fee quantity or the usage during the service period. */
                 fun quantity(quantity: Double) = quantity(JsonField.of(quantity))
 

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

@@ -5194,6 +5194,9 @@ private constructor(
             /** Alias for calling [price] with `Price.ofMinimum(minimum)`. */
             fun price(minimum: Price.Minimum) = price(Price.ofMinimum(minimum))
 
+            /** Alias for calling [price] with `Price.ofEventOutput(eventOutput)`. */
+            fun price(eventOutput: Price.EventOutput) = price(Price.ofEventOutput(eventOutput))
+
             /** Either the fixed fee quantity or the usage during the service period. */
             fun quantity(quantity: Double) = quantity(JsonField.of(quantity))
 

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

@@ -5188,6 +5188,9 @@ private constructor(
             /** Alias for calling [price] with `Price.ofMinimum(minimum)`. */
             fun price(minimum: Price.Minimum) = price(Price.ofMinimum(minimum))
 
+            /** Alias for calling [price] with `Price.ofEventOutput(eventOutput)`. */
+            fun price(eventOutput: Price.EventOutput) = price(Price.ofEventOutput(eventOutput))
+
             /** Either the fixed fee quantity or the usage during the service period. */
             fun quantity(quantity: Double) = quantity(JsonField.of(quantity))
 

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

@@ -1110,6 +1110,9 @@ private constructor(
         /** Alias for calling [price] with `Price.ofMinimum(minimum)`. */
         fun price(minimum: Price.Minimum) = price(Price.ofMinimum(minimum))
 
+        /** Alias for calling [price] with `Price.ofEventOutput(eventOutput)`. */
+        fun price(eventOutput: Price.EventOutput) = price(Price.ofEventOutput(eventOutput))
+
         /** Either the fixed fee quantity or the usage during the service period. */
         fun quantity(quantity: Double) = quantity(JsonField.of(quantity))
 

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

@@ -18,6 +18,7 @@ import com.withorb.api.errors.OrbInvalidDataException
 import java.time.OffsetDateTime
 import java.util.Collections
 import java.util.Objects
+import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
 /**
@@ -33,6 +34,7 @@ private constructor(
     private val externalConnections: JsonField<List<ExternalConnection>>,
     private val metadata: JsonField<Metadata>,
     private val name: JsonField<String>,
+    private val archivedAt: JsonField<OffsetDateTime>,
     private val additionalProperties: MutableMap<String, JsonValue>,
 ) {
 
@@ -47,21 +49,31 @@ private constructor(
         externalConnections: JsonField<List<ExternalConnection>> = JsonMissing.of(),
         @JsonProperty("metadata") @ExcludeMissing metadata: JsonField<Metadata> = JsonMissing.of(),
         @JsonProperty("name") @ExcludeMissing name: JsonField<String> = JsonMissing.of(),
-    ) : this(id, createdAt, externalConnections, metadata, name, mutableMapOf())
+        @JsonProperty("archived_at")
+        @ExcludeMissing
+        archivedAt: JsonField<OffsetDateTime> = JsonMissing.of(),
+    ) : this(id, createdAt, externalConnections, metadata, name, archivedAt, mutableMapOf())
 
     /**
+     * The Orb-assigned unique identifier for the item.
+     *
      * @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).
      */
     fun id(): String = id.getRequired("id")
 
     /**
+     * The time at which the item was created.
+     *
      * @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).
      */
     fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
 
     /**
+     * A list of external connections for this item, used to sync with external invoicing and tax
+     * systems.
+     *
      * @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).
      */
@@ -79,11 +91,21 @@ private constructor(
     fun metadata(): Metadata = metadata.getRequired("metadata")
 
     /**
+     * The name of the item.
+     *
      * @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).
      */
     fun name(): String = name.getRequired("name")
 
+    /**
+     * The time at which the item was archived. If null, the item is not archived.
+     *
+     * @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
+     *   responded with an unexpected value).
+     */
+    fun archivedAt(): Optional<OffsetDateTime> = archivedAt.getOptional("archived_at")
+
     /**
      * Returns the raw JSON value of [id].
      *
@@ -124,6 +146,15 @@ private constructor(
      */
     @JsonProperty("name") @ExcludeMissing fun _name(): JsonField<String> = name
 
+    /**
+     * Returns the raw JSON value of [archivedAt].
+     *
+     * Unlike [archivedAt], this method doesn't throw if the JSON field has an unexpected type.
+     */
+    @JsonProperty("archived_at")
+    @ExcludeMissing
+    fun _archivedAt(): JsonField<OffsetDateTime> = archivedAt
+
     @JsonAnySetter
     private fun putAdditionalProperty(key: String, value: JsonValue) {
         additionalProperties.put(key, value)
@@ -161,6 +192,7 @@ private constructor(
         private var externalConnections: JsonField<MutableList<ExternalConnection>>? = null
         private var metadata: JsonField<Metadata>? = null
         private var name: JsonField<String>? = null
+        private var archivedAt: JsonField<OffsetDateTime> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -170,9 +202,11 @@ private constructor(
             externalConnections = item.externalConnections.map { it.toMutableList() }
             metadata = item.metadata
             name = item.name
+            archivedAt = item.archivedAt
             additionalProperties = item.additionalProperties.toMutableMap()
         }
 
+        /** The Orb-assigned unique identifier for the item. */
         fun id(id: String) = id(JsonField.of(id))
 
         /**
@@ -183,6 +217,7 @@ private constructor(
          */
         fun id(id: JsonField<String>) = apply { this.id = id }
 
+        /** The time at which the item was created. */
         fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
 
         /**
@@ -194,6 +229,10 @@ private constructor(
          */
         fun createdAt(createdAt: JsonField<OffsetDateTime>) = apply { this.createdAt = createdAt }
 
+        /**
+         * A list of external connections for this item, used to sync with external invoicing and
+         * tax systems.
+         */
         fun externalConnections(externalConnections: List<ExternalConnection>) =
             externalConnections(JsonField.of(externalConnections))
 
@@ -236,6 +275,7 @@ private constructor(
          */
         fun metadata(metadata: JsonField<Metadata>) = apply { this.metadata = metadata }
 
+        /** The name of the item. */
         fun name(name: String) = name(JsonField.of(name))
 
         /**
@@ -246,6 +286,23 @@ private constructor(
          */
         fun name(name: JsonField<String>) = apply { this.name = name }
 
+        /** The time at which the item was archived. If null, the item is not archived. */
+        fun archivedAt(archivedAt: OffsetDateTime?) = archivedAt(JsonField.ofNullable(archivedAt))
+
+        /** Alias for calling [Builder.archivedAt] with `archivedAt.orElse(null)`. */
+        fun archivedAt(archivedAt: Optional<OffsetDateTime>) = archivedAt(archivedAt.getOrNull())
+
+        /**
+         * Sets [Builder.archivedAt] to an arbitrary JSON value.
+         *
+         * You should usually call [Builder.archivedAt] with a well-typed [OffsetDateTime] value
+         * instead. This method is primarily for setting the field to an undocumented or not yet
+         * supported value.
+         */
+        fun archivedAt(archivedAt: JsonField<OffsetDateTime>) = apply {
+            this.archivedAt = archivedAt
+        }
+
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
             putAllAdditionalProperties(additionalProperties)
@@ -288,6 +345,7 @@ private constructor(
                 checkRequired("externalConnections", externalConnections).map { it.toImmutable() },
                 checkRequired("metadata", metadata),
                 checkRequired("name", name),
+                archivedAt,
                 additionalProperties.toMutableMap(),
             )
     }
@@ -304,6 +362,7 @@ private constructor(
         externalConnections().forEach { it.validate() }
         metadata().validate()
         name()
+        archivedAt()
         validated = true
     }
 
@@ -326,8 +385,13 @@ private constructor(
             (if (createdAt.asKnown().isPresent) 1 else 0) +
             (externalConnections.asKnown().getOrNull()?.sumOf { it.validity().toInt() } ?: 0) +
             (metadata.asKnown().getOrNull()?.validity() ?: 0) +
-            (if (name.asKnown().isPresent) 1 else 0)
+            (if (name.asKnown().isPresent) 1 else 0) +
+            (if (archivedAt.asKnown().isPresent) 1 else 0)
 
+    /**
+     * Represents a connection between an Item and an external system for invoicing or tax
+     * calculation purposes.
+     */
     class ExternalConnection
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(
@@ -347,13 +411,17 @@ private constructor(
         ) : this(externalConnectionName, externalEntityId, mutableMapOf())
 
         /**
+         * The name of the external system this item is connected to.
+         *
          * @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).
          */
         fun externalConnectionName(): ExternalConnectionName =
             externalConnectionName.getRequired("external_connection_name")
 
         /**
+         * The identifier of this item in the external system.
+         *
          * @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).
          */
@@ -419,6 +487,7 @@ private constructor(
                 additionalProperties = externalConnection.additionalProperties.toMutableMap()
             }
 
+            /** The name of the external system this item is connected to. */
             fun externalConnectionName(externalConnectionName: ExternalConnectionName) =
                 externalConnectionName(JsonField.of(externalConnectionName))
 
@@ -434,6 +503,7 @@ private constructor(
                     this.externalConnectionName = externalConnectionName
                 }
 
+            /** The identifier of this item in the external system. */
             fun externalEntityId(externalEntityId: String) =
                 externalEntityId(JsonField.of(externalEntityId))
 
@@ -519,6 +589,7 @@ private constructor(
             (externalConnectionName.asKnown().getOrNull()?.validity() ?: 0) +
                 (if (externalEntityId.asKnown().isPresent) 1 else 0)
 
+        /** The name of the external system this item is connected to. */
         class ExternalConnectionName
         @JsonCreator
         private constructor(private val value: JsonField<String>) : Enum {
@@ -823,15 +894,24 @@ private constructor(
             externalConnections == other.externalConnections &&
             metadata == other.metadata &&
             name == other.name &&
+            archivedAt == other.archivedAt &&
             additionalProperties == other.additionalProperties
     }
 
     private val hashCode: Int by lazy {
-        Objects.hash(id, createdAt, externalConnections, metadata, name, additionalProperties)
+        Objects.hash(
+            id,
+            createdAt,
+            externalConnections,
+            metadata,
+            name,
+            archivedAt,
+            additionalProperties,
+        )
     }
 
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "Item{id=$id, createdAt=$createdAt, externalConnections=$externalConnections, metadata=$metadata, name=$name, additionalProperties=$additionalProperties}"
+        "Item{id=$id, createdAt=$createdAt, externalConnections=$externalConnections, metadata=$metadata, name=$name, archivedAt=$archivedAt, additionalProperties=$additionalProperties}"
 }

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

@@ -15,6 +15,7 @@ import com.withorb.api.errors.OrbInvalidDataException
 import java.util.Collections
 import java.util.Objects
 
+/** A minimal representation of an Item containing only the essential identifying information. */
 class ItemSlim
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(
@@ -30,12 +31,16 @@ private constructor(
     ) : this(id, name, mutableMapOf())
 
     /**
+     * The Orb-assigned unique identifier for the item.
+     *
      * @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).
      */
     fun id(): String = id.getRequired("id")
 
     /**
+     * The name of the item.
+     *
      * @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).
      */
@@ -95,6 +100,7 @@ private constructor(
             additionalProperties = itemSlim.additionalProperties.toMutableMap()
         }
 
+        /** The Orb-assigned unique identifier for the item. */
         fun id(id: String) = id(JsonField.of(id))
 
         /**
@@ -105,6 +111,7 @@ private constructor(
          */
         fun id(id: JsonField<String>) = apply { this.id = id }
 
+        /** The name of the item. */
         fun name(name: String) = name(JsonField.of(name))
 
         /**

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

@@ -594,6 +594,10 @@ private constructor(
             "Body{externalConnections=$externalConnections, metadata=$metadata, name=$name, additionalProperties=$additionalProperties}"
     }
 
+    /**
+     * Represents a connection between an Item and an external system for invoicing or tax
+     * calculation purposes.
+     */
     class ExternalConnection
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(
@@ -613,13 +617,17 @@ private constructor(
         ) : this(externalConnectionName, externalEntityId, mutableMapOf())
 
         /**
+         * The name of the external system this item is connected to.
+         *
          * @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).
          */
         fun externalConnectionName(): ExternalConnectionName =
             externalConnectionName.getRequired("external_connection_name")
 
         /**
+         * The identifier of this item in the external system.
+         *
          * @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).
          */
@@ -685,6 +693,7 @@ private constructor(
                 additionalProperties = externalConnection.additionalProperties.toMutableMap()
             }
 
+            /** The name of the external system this item is connected to. */
             fun externalConnectionName(externalConnectionName: ExternalConnectionName) =
                 externalConnectionName(JsonField.of(externalConnectionName))
 
@@ -700,6 +709,7 @@ private constructor(
                     this.externalConnectionName = externalConnectionName
                 }
 
+            /** The identifier of this item in the external system. */
             fun externalEntityId(externalEntityId: String) =
                 externalEntityId(JsonField.of(externalEntityId))
 
@@ -785,6 +795,7 @@ private constructor(
             (externalConnectionName.asKnown().getOrNull()?.validity() ?: 0) +
                 (if (externalEntityId.asKnown().isPresent) 1 else 0)
 
+        /** The name of the external system this item is connected to. */
         class ExternalConnectionName
         @JsonCreator
         private constructor(private val value: JsonField<String>) : Enum {