Merge pull request #4 from orbcorp/release-please--branches--main--changes--next

release: 0.1.0-alpha.2

Author: sskhandek

.gitignore

@@ -1,3 +1,4 @@
+.prism.log
 .gradle
 .idea
 build

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.1"
+  ".": "0.1.0-alpha.2"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 90
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-6bef7452aabfcad0e298c7e0bbbd90aa6a1d954ad99a04fe756b827fd12a7ce9.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-75733a914692b0abe72ba99d622fc55b20da1c7fa7f73e2bfee30dfe32b66a51.yml

CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 0.1.0-alpha.2 (2024-06-28)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/orbcorp/orb-java/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** endpoint expects amount of new allocation price to be a string, not a number ([#10](https://github.com/orbcorp/orb-java/issues/10))
+
+### Features
+
+* **api:** add support for adding allocation price to subscription ([#8](https://github.com/orbcorp/orb-java/issues/8)) ([d150c33](https://github.com/orbcorp/orb-java/commit/d150c33743c505658aeb09b639ea4b739ad4322c))
+* **api:** add support for query param include_all_blocks ([#11](https://github.com/orbcorp/orb-java/issues/11)) ([73d5e94](https://github.com/orbcorp/orb-java/commit/73d5e9453745dda4c138bed77c3dc71b306f37f3))
+* **api:** external connections made optional when updating items ([#9](https://github.com/orbcorp/orb-java/issues/9)) ([d1a63a3](https://github.com/orbcorp/orb-java/commit/d1a63a3edcd71535e421b9ded0f749e96d18b253))
+* **api:** updates ([#5](https://github.com/orbcorp/orb-java/issues/5)) ([fb8c7d9](https://github.com/orbcorp/orb-java/commit/fb8c7d974e51d260d1bb9aa1f93021a64288589a))
+* **client:** add support for `putQueryParam` on `ClientOptions` ([#6](https://github.com/orbcorp/orb-java/issues/6)) ([71d82b0](https://github.com/orbcorp/orb-java/commit/71d82b0545a51df2abb8ebfe852991d9f740d498))
+
+
+### Bug Fixes
+
+* **api:** endpoint expects amount of new allocation price to be a string, not a number ([#10](https://github.com/orbcorp/orb-java/issues/10)) ([f38419a](https://github.com/orbcorp/orb-java/commit/f38419a6c6b10b5137d573dfc9c7f5a96a302348))
+
+
+### Chores
+
+* **docs:** improve Coupon description ([#7](https://github.com/orbcorp/orb-java/issues/7)) ([4d1d183](https://github.com/orbcorp/orb-java/commit/4d1d183eba7883c30007edc2aac0ab27c5e62600))
+* **docs:** updates price intervals docs ([#12](https://github.com/orbcorp/orb-java/issues/12)) ([554df1b](https://github.com/orbcorp/orb-java/commit/554df1b92b83237d8f88cea66bee47524ee8d9db))
+* gitignore test server logs ([#13](https://github.com/orbcorp/orb-java/issues/13)) ([11e4ebc](https://github.com/orbcorp/orb-java/commit/11e4ebc52501ab8c6ea3ba15eff0ef82134eda89))
+
+
+### Documentation
+
+* small updates ([#3](https://github.com/orbcorp/orb-java/issues/3)) ([11b888b](https://github.com/orbcorp/orb-java/commit/11b888b44a0063a15bb0bdee64273659b9cc4514))
+
 ## 0.1.0-alpha.1 (2024-06-06)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/orbcorp/orb-java/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

README.md

@@ -2,7 +2,7 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.withorb.api/orb-java)](https://central.sonatype.com/artifact/com.withorb.api/orb-java/0.1.0-alpha.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.withorb.api/orb-java)](https://central.sonatype.com/artifact/com.withorb.api/orb-java/0.1.0-alpha.2)
 
 <!-- x-release-please-end -->
 
@@ -25,7 +25,7 @@ The REST API documentation can be found [on docs.withorb.com](https://docs.with
 <!-- x-release-please-start-version -->
 
 ```kotlin
-implementation("com.withorb.api:orb-java:0.1.0-alpha.1")
+implementation("com.withorb.api:orb-java:0.1.0-alpha.2")
 ```
 
 #### Maven
@@ -34,7 +34,7 @@ implementation("com.withorb.api:orb-java:0.1.0-alpha.1")
 <dependency>
     <groupId>com.withorb.api</groupId>
     <artifactId>orb-java</artifactId>
-    <version>0.1.0-alpha.1</version>
+    <version>0.1.0-alpha.2</version>
 </dependency>
 ```
 

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 
 allprojects {
     group = "com.withorb.api"
-    version = "0.1.0-alpha.1" // x-release-please-version
+    version = "0.1.0-alpha.2" // x-release-please-version
 }
 
 

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

@@ -18,6 +18,7 @@ private constructor(
     @get:JvmName("apiKey") val apiKey: String,
     @get:JvmName("webhookSecret") val webhookSecret: String?,
     @get:JvmName("headers") val headers: ListMultimap<String, String>,
+    @get:JvmName("queryParams") val queryParams: ListMultimap<String, String>,
     @get:JvmName("responseValidation") val responseValidation: Boolean,
 ) {
 
@@ -37,6 +38,7 @@ private constructor(
         private var clock: Clock = Clock.systemUTC()
         private var baseUrl: String = PRODUCTION_URL
         private var headers: MutableMap<String, MutableList<String>> = mutableMapOf()
+        private var queryParams: MutableMap<String, MutableList<String>> = mutableMapOf()
         private var responseValidation: Boolean = false
         private var maxRetries: Int = 2
         private var apiKey: String? = null
@@ -69,6 +71,25 @@ private constructor(
 
         fun removeHeader(name: String) = apply { this.headers.put(name, mutableListOf()) }
 
+        fun queryParams(queryParams: Map<String, Iterable<String>>) = apply {
+            this.queryParams.clear()
+            putAllQueryParams(queryParams)
+        }
+
+        fun putQueryParam(name: String, value: String) = apply {
+            this.queryParams.getOrPut(name) { mutableListOf() }.add(value)
+        }
+
+        fun putQueryParams(name: String, values: Iterable<String>) = apply {
+            this.queryParams.getOrPut(name) { mutableListOf() }.addAll(values)
+        }
+
+        fun putAllQueryParams(queryParams: Map<String, Iterable<String>>) = apply {
+            queryParams.forEach(this::putQueryParams)
+        }
+
+        fun removeQueryParam(name: String) = apply { this.queryParams.put(name, mutableListOf()) }
+
         fun responseValidation(responseValidation: Boolean) = apply {
             this.responseValidation = responseValidation
         }
@@ -89,6 +110,7 @@ private constructor(
             checkNotNull(apiKey) { "`apiKey` is required but was not set" }
 
             val headers = ArrayListMultimap.create<String, String>()
+            val queryParams = ArrayListMultimap.create<String, String>()
             headers.put("X-Stainless-Lang", "java")
             headers.put("X-Stainless-Arch", getOsArch())
             headers.put("X-Stainless-OS", getOsName())
@@ -99,6 +121,7 @@ private constructor(
                 headers.put("Authorization", "Bearer ${apiKey}")
             }
             this.headers.forEach(headers::replaceValues)
+            this.queryParams.forEach(queryParams::replaceValues)
 
             return ClientOptions(
                 RetryingHttpClient.builder()
@@ -113,6 +136,7 @@ private constructor(
                 apiKey!!,
                 webhookSecret,
                 headers.toUnmodifiable(),
+                queryParams.toUnmodifiable(),
                 responseValidation,
             )
         }

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

@@ -29,13 +29,29 @@ import java.util.Objects
 import java.util.Optional
 
 /**
- * A coupon represents a reusable discount configuration, and have an attached redemption code that
- * can be issued to your end users. Coupons are most often used in self-serve signup or upgrade
- * flows in your checkout experience or billing portal.
+ * A coupon represents a reusable discount configuration that can be applied either as a fixed
+ * currency amount or as a percentage of the usage cost. Coupons are activated using a redemption
+ * code, which applies the discount to a subscription or invoice. The duration of a coupon
+ * determines how long it remains available for use by end users.
  *
- * To redeem a coupon, pass the `redemption_code` property in the
- * [create subscription](create-subscription.api.mdx) or
- * [schedule plan change](schedule-plan-change.api.mdx) request.
+ * ## How to use coupons
+ *
+ * Coupons can be created using the Orb dashboard or programmatically through the API. Once a coupon
+ * is created, it can be managed and applied programmatically via the API. To redeem a coupon, use
+ * the `redemption_code` property when [creating a subscription](create-subscription.api.mdx) or
+ * when scheduling a [plan change](schedule-plan-change.api.mdx).
+ *
+ * ## When to use coupons
+ *
+ * A common use case for coupons is through self-serve signup or upgrade flows in your checkout
+ * experience or billing portal. Coupons can also be used as one-off to incentivize use for custom
+ * agreements.
+ *
+ * Coupons are effective when launching new features and encouraging existing users to upgrade to a
+ * higher tier. For example, you could create a coupon code "UPGRADE20" that offers a 20% discount
+ * on the first month of the new plan. This code can be applied during the upgrade process in your
+ * billing portal, making it straightforward for users to benefit from the new features at a reduced
+ * cost.
  */
 @JsonDeserialize(builder = Coupon.Builder::class)
 @NoAutoDetect

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

@@ -14,6 +14,7 @@ constructor(
     private val externalCustomerId: String,
     private val currency: String?,
     private val cursor: String?,
+    private val includeAllBlocks: Boolean?,
     private val limit: Long?,
     private val additionalQueryParams: Map<String, List<String>>,
     private val additionalHeaders: Map<String, List<String>>,
@@ -26,13 +27,16 @@ constructor(
 
     fun cursor(): Optional<String> = Optional.ofNullable(cursor)
 
+    fun includeAllBlocks(): Optional<Boolean> = Optional.ofNullable(includeAllBlocks)
+
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     @JvmSynthetic
     internal fun getQueryParams(): Map<String, List<String>> {
         val params = mutableMapOf<String, List<String>>()
         this.currency?.let { params.put("currency", listOf(it.toString())) }
         this.cursor?.let { params.put("cursor", listOf(it.toString())) }
+        this.includeAllBlocks?.let { params.put("include_all_blocks", listOf(it.toString())) }
         this.limit?.let { params.put("limit", listOf(it.toString())) }
         params.putAll(additionalQueryParams)
         return params.toUnmodifiable()
@@ -62,6 +66,7 @@ constructor(
             this.externalCustomerId == other.externalCustomerId &&
             this.currency == other.currency &&
             this.cursor == other.cursor &&
+            this.includeAllBlocks == other.includeAllBlocks &&
             this.limit == other.limit &&
             this.additionalQueryParams == other.additionalQueryParams &&
             this.additionalHeaders == other.additionalHeaders &&
@@ -73,6 +78,7 @@ constructor(
             externalCustomerId,
             currency,
             cursor,
+            includeAllBlocks,
             limit,
             additionalQueryParams,
             additionalHeaders,
@@ -81,7 +87,7 @@ constructor(
     }
 
     override fun toString() =
-        "CustomerCreditListByExternalIdParams{externalCustomerId=$externalCustomerId, currency=$currency, cursor=$cursor, limit=$limit, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"
+        "CustomerCreditListByExternalIdParams{externalCustomerId=$externalCustomerId, currency=$currency, cursor=$cursor, includeAllBlocks=$includeAllBlocks, limit=$limit, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"
 
     fun toBuilder() = Builder().from(this)
 
@@ -96,6 +102,7 @@ constructor(
         private var externalCustomerId: String? = null
         private var currency: String? = null
         private var cursor: String? = null
+        private var includeAllBlocks: Boolean? = null
         private var limit: Long? = null
         private var additionalQueryParams: MutableMap<String, MutableList<String>> = mutableMapOf()
         private var additionalHeaders: MutableMap<String, MutableList<String>> = mutableMapOf()
@@ -108,6 +115,7 @@ constructor(
             this.externalCustomerId = customerCreditListByExternalIdParams.externalCustomerId
             this.currency = customerCreditListByExternalIdParams.currency
             this.cursor = customerCreditListByExternalIdParams.cursor
+            this.includeAllBlocks = customerCreditListByExternalIdParams.includeAllBlocks
             this.limit = customerCreditListByExternalIdParams.limit
             additionalQueryParams(customerCreditListByExternalIdParams.additionalQueryParams)
             additionalHeaders(customerCreditListByExternalIdParams.additionalHeaders)
@@ -127,6 +135,11 @@ constructor(
          */
         fun cursor(cursor: String) = apply { this.cursor = cursor }
 
+        /** Include all blocks, not just active ones. */
+        fun includeAllBlocks(includeAllBlocks: Boolean) = apply {
+            this.includeAllBlocks = includeAllBlocks
+        }
+
         /** The number of items to fetch. Defaults to 20. */
         fun limit(limit: Long) = apply { this.limit = limit }
 
@@ -191,6 +204,7 @@ constructor(
                 },
                 currency,
                 cursor,
+                includeAllBlocks,
                 limit,
                 additionalQueryParams.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
                 additionalHeaders.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),

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

@@ -29,6 +29,7 @@ private constructor(
     private val expiryDate: JsonField<OffsetDateTime>,
     private val perUnitCostBasis: JsonField<String>,
     private val status: JsonField<Status>,
+    private val maximumInitialBalance: JsonField<Double>,
     private val additionalProperties: Map<String, JsonValue>,
 ) {
 
@@ -51,6 +52,9 @@ private constructor(
 
     fun status(): Status = status.getRequired("status")
 
+    fun maximumInitialBalance(): Optional<Double> =
+        Optional.ofNullable(maximumInitialBalance.getNullable("maximum_initial_balance"))
+
     @JsonProperty("id") @ExcludeMissing fun _id() = id
 
     @JsonProperty("balance") @ExcludeMissing fun _balance() = balance
@@ -63,6 +67,10 @@ private constructor(
 
     @JsonProperty("status") @ExcludeMissing fun _status() = status
 
+    @JsonProperty("maximum_initial_balance")
+    @ExcludeMissing
+    fun _maximumInitialBalance() = maximumInitialBalance
+
     @JsonAnyGetter
     @ExcludeMissing
     fun _additionalProperties(): Map<String, JsonValue> = additionalProperties
@@ -75,6 +83,7 @@ private constructor(
             expiryDate()
             perUnitCostBasis()
             status()
+            maximumInitialBalance()
             validated = true
         }
     }
@@ -93,6 +102,7 @@ private constructor(
             this.expiryDate == other.expiryDate &&
             this.perUnitCostBasis == other.perUnitCostBasis &&
             this.status == other.status &&
+            this.maximumInitialBalance == other.maximumInitialBalance &&
             this.additionalProperties == other.additionalProperties
     }
 
@@ -106,14 +116,15 @@ private constructor(
                     expiryDate,
                     perUnitCostBasis,
                     status,
+                    maximumInitialBalance,
                     additionalProperties,
                 )
         }
         return hashCode
     }
 
     override fun toString() =
-        "CustomerCreditListByExternalIdResponse{id=$id, balance=$balance, effectiveDate=$effectiveDate, expiryDate=$expiryDate, perUnitCostBasis=$perUnitCostBasis, status=$status, additionalProperties=$additionalProperties}"
+        "CustomerCreditListByExternalIdResponse{id=$id, balance=$balance, effectiveDate=$effectiveDate, expiryDate=$expiryDate, perUnitCostBasis=$perUnitCostBasis, status=$status, maximumInitialBalance=$maximumInitialBalance, additionalProperties=$additionalProperties}"
 
     companion object {
 
@@ -128,6 +139,7 @@ private constructor(
         private var expiryDate: JsonField<OffsetDateTime> = JsonMissing.of()
         private var perUnitCostBasis: JsonField<String> = JsonMissing.of()
         private var status: JsonField<Status> = JsonMissing.of()
+        private var maximumInitialBalance: JsonField<Double> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -140,6 +152,8 @@ private constructor(
             this.expiryDate = customerCreditListByExternalIdResponse.expiryDate
             this.perUnitCostBasis = customerCreditListByExternalIdResponse.perUnitCostBasis
             this.status = customerCreditListByExternalIdResponse.status
+            this.maximumInitialBalance =
+                customerCreditListByExternalIdResponse.maximumInitialBalance
             additionalProperties(customerCreditListByExternalIdResponse.additionalProperties)
         }
 
@@ -185,6 +199,15 @@ private constructor(
         @ExcludeMissing
         fun status(status: JsonField<Status>) = apply { this.status = status }
 
+        fun maximumInitialBalance(maximumInitialBalance: Double) =
+            maximumInitialBalance(JsonField.of(maximumInitialBalance))
+
+        @JsonProperty("maximum_initial_balance")
+        @ExcludeMissing
+        fun maximumInitialBalance(maximumInitialBalance: JsonField<Double>) = apply {
+            this.maximumInitialBalance = maximumInitialBalance
+        }
+
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
             this.additionalProperties.putAll(additionalProperties)
@@ -207,6 +230,7 @@ private constructor(
                 expiryDate,
                 perUnitCostBasis,
                 status,
+                maximumInitialBalance,
                 additionalProperties.toUnmodifiable(),
             )
     }