Skip to content

Repository navigation

Commit 25184c2

Browse files
increase-releases[bot]increase-releases[bot]
authored
feat(api): api update (#1386)
Co-authored-by: increase-releases[bot] <285999079+increase-releases[bot]@users.noreply.github.com>
1 parent 43d63fb commit 25184c2

20 files changed

Lines changed: 640 additions & 120 deletions

File tree

‎.stats.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
configured_endpoints: 238
2-
openapi_spec_hash: 7f33ff43b4b498d0954b28032669a1a6
3-
config_hash: 2ae0d8aaecf01b38cbf9f9e112822c23
1+
configured_endpoints: 239
2+
openapi_spec_hash: ea35154a418c5a3cabaedc30f766fcac
3+
config_hash: 1ca082e374ef7000e2a5971e8da740e0

‎README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,54 @@ FileCreateParams params = FileCreateParams.builder()
254254
File file = client.files().create(params);
255255
```
256256

257+
## Binary responses
258+
259+
The SDK defines methods that return binary responses, which are used for API responses that shouldn't necessarily be parsed, like non-JSON data.
260+
261+
These methods return [`HttpResponse`](increase-java-core/src/main/kotlin/com/increase/api/core/http/HttpResponse.kt):
262+
263+
```java
264+
import com.increase.api.core.http.HttpResponse;
265+
import com.increase.api.models.files.FileContentsParams;
266+
267+
HttpResponse response = client.files().contents("file_makxrc67oh9l6sg7w9yc");
268+
```
269+
270+
To save the response content to a file, use the [`Files.copy(...)`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html#copy-java.io.InputStream-java.nio.file.Path-java.nio.file.CopyOption...-) method:
271+
272+
```java
273+
import com.increase.api.core.http.HttpResponse;
274+
import java.nio.file.Files;
275+
import java.nio.file.Paths;
276+
import java.nio.file.StandardCopyOption;
277+
278+
try (HttpResponse response = client.files().contents(params)) {
279+
Files.copy(
280+
response.body(),
281+
Paths.get(path),
282+
StandardCopyOption.REPLACE_EXISTING
283+
);
284+
} catch (Exception e) {
285+
System.out.println("Something went wrong!");
286+
throw new RuntimeException(e);
287+
}
288+
```
289+
290+
Or transfer the response content to any [`OutputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html):
291+
292+
```java
293+
import com.increase.api.core.http.HttpResponse;
294+
import java.nio.file.Files;
295+
import java.nio.file.Paths;
296+
297+
try (HttpResponse response = client.files().contents(params)) {
298+
response.body().transferTo(Files.newOutputStream(Paths.get(path)));
299+
} catch (Exception e) {
300+
System.out.println("Something went wrong!");
301+
throw new RuntimeException(e);
302+
}
303+
```
304+
257305
## Raw responses
258306

259307
The SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.

‎increase-java-client-okhttp/src/main/kotlin/com/increase/api/client/okhttp/OkHttpClient.kt‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -241,23 +241,6 @@ private fun HttpRequest.toRequest(client: okhttp3.OkHttpClient?): Request {
241241
val builder = Request.Builder().url(toUrl()).method(method.name, body)
242242
headers.names().forEach { name -> headers.values(name).forEach { builder.addHeader(name, it) } }
243243

244-
if (client != null) {
245-
if (
246-
!headers.names().contains("X-Stainless-Read-Timeout") && client.readTimeoutMillis != 0
247-
) {
248-
builder.addHeader(
249-
"X-Stainless-Read-Timeout",
250-
Duration.ofMillis(client.readTimeoutMillis.toLong()).seconds.toString(),
251-
)
252-
}
253-
if (!headers.names().contains("X-Stainless-Timeout") && client.callTimeoutMillis != 0) {
254-
builder.addHeader(
255-
"X-Stainless-Timeout",
256-
Duration.ofMillis(client.callTimeoutMillis.toLong()).seconds.toString(),
257-
)
258-
}
259-
}
260-
261244
return builder.build()
262245
}
263246

‎increase-java-core/src/main/kotlin/com/increase/api/core/ClientOptions.kt‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -504,14 +504,6 @@ private constructor(
504504

505505
val headers = Headers.builder()
506506
val queryParams = QueryParams.builder()
507-
headers.put("X-Stainless-Lang", "java")
508-
headers.put("X-Stainless-Arch", getOsArch())
509-
headers.put("X-Stainless-OS", getOsName())
510-
headers.put("X-Stainless-OS-Version", getOsVersion())
511-
headers.put("X-Stainless-Package-Version", getPackageVersion())
512-
headers.put("X-Stainless-Runtime", "JRE")
513-
headers.put("X-Stainless-Runtime-Version", getJavaVersion())
514-
headers.put("X-Stainless-Kotlin-Version", KotlinVersion.CURRENT.toString())
515507
// We replace after all the default headers to allow end-users to overwrite them.
516508
headers.replaceAll(this.headers.build())
517509
queryParams.replaceAll(this.queryParams.build())

‎increase-java-core/src/main/kotlin/com/increase/api/core/http/RetryingHttpClient.kt‎

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,9 @@ private constructor(
3535
override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse {
3636
var modifiedRequest = maybeAddIdempotencyHeader(request)
3737

38-
// Don't send the current retry count in the headers if the caller set their own value.
39-
val shouldSendRetryCount =
40-
!modifiedRequest.headers.names().contains("X-Stainless-Retry-Count")
41-
4238
var retries = 0
4339

4440
while (true) {
45-
if (shouldSendRetryCount) {
46-
modifiedRequest = setRetryCountHeader(modifiedRequest, retries)
47-
}
48-
4941
if (!isRetryable(modifiedRequest)) {
5042
return httpClient.execute(modifiedRequest, requestOptions)
5143
}
@@ -79,21 +71,15 @@ private constructor(
7971
): CompletableFuture<HttpResponse> {
8072
val modifiedRequest = maybeAddIdempotencyHeader(request)
8173

82-
// Don't send the current retry count in the headers if the caller set their own value.
83-
val shouldSendRetryCount =
84-
!modifiedRequest.headers.names().contains("X-Stainless-Retry-Count")
85-
8674
var retries = 0
8775

8876
fun executeWithRetries(
8977
request: HttpRequest,
9078
requestOptions: RequestOptions,
9179
): CompletableFuture<HttpResponse> {
92-
val requestWithRetryCount =
93-
if (shouldSendRetryCount) setRetryCountHeader(request, retries) else request
9480

95-
val responseFuture = httpClient.executeAsync(requestWithRetryCount, requestOptions)
96-
if (!isRetryable(requestWithRetryCount)) {
81+
val responseFuture = httpClient.executeAsync(request, requestOptions)
82+
if (!isRetryable(request)) {
9783
return responseFuture
9884
}
9985

@@ -119,7 +105,7 @@ private constructor(
119105
// All responses must be closed, so close the failed one before retrying.
120106
response?.close()
121107
return sleeper.sleepAsync(backoffDuration).thenCompose {
122-
executeWithRetries(requestWithRetryCount, requestOptions)
108+
executeWithRetries(request, requestOptions)
123109
}
124110
}
125111
) {
@@ -142,9 +128,6 @@ private constructor(
142128
// the body data aren't available on subsequent attempts.
143129
request.body?.repeatable() ?: true
144130

145-
private fun setRetryCountHeader(request: HttpRequest, retries: Int): HttpRequest =
146-
request.toBuilder().replaceHeaders("X-Stainless-Retry-Count", retries.toString()).build()
147-
148131
private fun idempotencyKey(): String = "increase-java-retry-${UUID.randomUUID()}"
149132

150133
private fun maybeAddIdempotencyHeader(request: HttpRequest): HttpRequest {

‎increase-java-core/src/main/kotlin/com/increase/api/models/events/Event.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,12 @@ private constructor(
705705
/** Occurs whenever a Physical Check is updated. */
706706
@JvmField val PHYSICAL_CHECK_UPDATED = of("physical_check.updated")
707707

708+
/** Occurs whenever a Physical Check Book is created. */
709+
@JvmField val PHYSICAL_CHECK_BOOK_CREATED = of("physical_check_book.created")
710+
711+
/** Occurs whenever a Physical Check Book is updated. */
712+
@JvmField val PHYSICAL_CHECK_BOOK_UPDATED = of("physical_check_book.updated")
713+
708714
/** Occurs whenever a Program is created. */
709715
@JvmField val PROGRAM_CREATED = of("program.created")
710716

@@ -1002,6 +1008,10 @@ private constructor(
10021008
PHYSICAL_CHECK_CREATED,
10031009
/** Occurs whenever a Physical Check is updated. */
10041010
PHYSICAL_CHECK_UPDATED,
1011+
/** Occurs whenever a Physical Check Book is created. */
1012+
PHYSICAL_CHECK_BOOK_CREATED,
1013+
/** Occurs whenever a Physical Check Book is updated. */
1014+
PHYSICAL_CHECK_BOOK_UPDATED,
10051015
/** Occurs whenever a Program is created. */
10061016
PROGRAM_CREATED,
10071017
/** Occurs whenever a Program is updated. */
@@ -1263,6 +1273,10 @@ private constructor(
12631273
PHYSICAL_CHECK_CREATED,
12641274
/** Occurs whenever a Physical Check is updated. */
12651275
PHYSICAL_CHECK_UPDATED,
1276+
/** Occurs whenever a Physical Check Book is created. */
1277+
PHYSICAL_CHECK_BOOK_CREATED,
1278+
/** Occurs whenever a Physical Check Book is updated. */
1279+
PHYSICAL_CHECK_BOOK_UPDATED,
12661280
/** Occurs whenever a Program is created. */
12671281
PROGRAM_CREATED,
12681282
/** Occurs whenever a Program is updated. */
@@ -1432,6 +1446,8 @@ private constructor(
14321446
PHYSICAL_CARD_PROFILE_UPDATED -> Value.PHYSICAL_CARD_PROFILE_UPDATED
14331447
PHYSICAL_CHECK_CREATED -> Value.PHYSICAL_CHECK_CREATED
14341448
PHYSICAL_CHECK_UPDATED -> Value.PHYSICAL_CHECK_UPDATED
1449+
PHYSICAL_CHECK_BOOK_CREATED -> Value.PHYSICAL_CHECK_BOOK_CREATED
1450+
PHYSICAL_CHECK_BOOK_UPDATED -> Value.PHYSICAL_CHECK_BOOK_UPDATED
14351451
PROGRAM_CREATED -> Value.PROGRAM_CREATED
14361452
PROGRAM_UPDATED -> Value.PROGRAM_UPDATED
14371453
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->
@@ -1575,6 +1591,8 @@ private constructor(
15751591
PHYSICAL_CARD_PROFILE_UPDATED -> Known.PHYSICAL_CARD_PROFILE_UPDATED
15761592
PHYSICAL_CHECK_CREATED -> Known.PHYSICAL_CHECK_CREATED
15771593
PHYSICAL_CHECK_UPDATED -> Known.PHYSICAL_CHECK_UPDATED
1594+
PHYSICAL_CHECK_BOOK_CREATED -> Known.PHYSICAL_CHECK_BOOK_CREATED
1595+
PHYSICAL_CHECK_BOOK_UPDATED -> Known.PHYSICAL_CHECK_BOOK_UPDATED
15781596
PROGRAM_CREATED -> Known.PROGRAM_CREATED
15791597
PROGRAM_UPDATED -> Known.PROGRAM_UPDATED
15801598
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->

‎increase-java-core/src/main/kotlin/com/increase/api/models/events/EventListParams.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,12 @@ private constructor(
730730
/** Occurs whenever a Physical Check is updated. */
731731
@JvmField val PHYSICAL_CHECK_UPDATED = of("physical_check.updated")
732732

733+
/** Occurs whenever a Physical Check Book is created. */
734+
@JvmField val PHYSICAL_CHECK_BOOK_CREATED = of("physical_check_book.created")
735+
736+
/** Occurs whenever a Physical Check Book is updated. */
737+
@JvmField val PHYSICAL_CHECK_BOOK_UPDATED = of("physical_check_book.updated")
738+
733739
/** Occurs whenever a Program is created. */
734740
@JvmField val PROGRAM_CREATED = of("program.created")
735741

@@ -1029,6 +1035,10 @@ private constructor(
10291035
PHYSICAL_CHECK_CREATED,
10301036
/** Occurs whenever a Physical Check is updated. */
10311037
PHYSICAL_CHECK_UPDATED,
1038+
/** Occurs whenever a Physical Check Book is created. */
1039+
PHYSICAL_CHECK_BOOK_CREATED,
1040+
/** Occurs whenever a Physical Check Book is updated. */
1041+
PHYSICAL_CHECK_BOOK_UPDATED,
10321042
/** Occurs whenever a Program is created. */
10331043
PROGRAM_CREATED,
10341044
/** Occurs whenever a Program is updated. */
@@ -1292,6 +1302,10 @@ private constructor(
12921302
PHYSICAL_CHECK_CREATED,
12931303
/** Occurs whenever a Physical Check is updated. */
12941304
PHYSICAL_CHECK_UPDATED,
1305+
/** Occurs whenever a Physical Check Book is created. */
1306+
PHYSICAL_CHECK_BOOK_CREATED,
1307+
/** Occurs whenever a Physical Check Book is updated. */
1308+
PHYSICAL_CHECK_BOOK_UPDATED,
12951309
/** Occurs whenever a Program is created. */
12961310
PROGRAM_CREATED,
12971311
/** Occurs whenever a Program is updated. */
@@ -1464,6 +1478,8 @@ private constructor(
14641478
PHYSICAL_CARD_PROFILE_UPDATED -> Value.PHYSICAL_CARD_PROFILE_UPDATED
14651479
PHYSICAL_CHECK_CREATED -> Value.PHYSICAL_CHECK_CREATED
14661480
PHYSICAL_CHECK_UPDATED -> Value.PHYSICAL_CHECK_UPDATED
1481+
PHYSICAL_CHECK_BOOK_CREATED -> Value.PHYSICAL_CHECK_BOOK_CREATED
1482+
PHYSICAL_CHECK_BOOK_UPDATED -> Value.PHYSICAL_CHECK_BOOK_UPDATED
14671483
PROGRAM_CREATED -> Value.PROGRAM_CREATED
14681484
PROGRAM_UPDATED -> Value.PROGRAM_UPDATED
14691485
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->
@@ -1608,6 +1624,8 @@ private constructor(
16081624
PHYSICAL_CARD_PROFILE_UPDATED -> Known.PHYSICAL_CARD_PROFILE_UPDATED
16091625
PHYSICAL_CHECK_CREATED -> Known.PHYSICAL_CHECK_CREATED
16101626
PHYSICAL_CHECK_UPDATED -> Known.PHYSICAL_CHECK_UPDATED
1627+
PHYSICAL_CHECK_BOOK_CREATED -> Known.PHYSICAL_CHECK_BOOK_CREATED
1628+
PHYSICAL_CHECK_BOOK_UPDATED -> Known.PHYSICAL_CHECK_BOOK_UPDATED
16111629
PROGRAM_CREATED -> Known.PROGRAM_CREATED
16121630
PROGRAM_UPDATED -> Known.PROGRAM_UPDATED
16131631
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->

‎increase-java-core/src/main/kotlin/com/increase/api/models/events/UnwrapWebhookEvent.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,12 @@ private constructor(
705705
/** Occurs whenever a Physical Check is updated. */
706706
@JvmField val PHYSICAL_CHECK_UPDATED = of("physical_check.updated")
707707

708+
/** Occurs whenever a Physical Check Book is created. */
709+
@JvmField val PHYSICAL_CHECK_BOOK_CREATED = of("physical_check_book.created")
710+
711+
/** Occurs whenever a Physical Check Book is updated. */
712+
@JvmField val PHYSICAL_CHECK_BOOK_UPDATED = of("physical_check_book.updated")
713+
708714
/** Occurs whenever a Program is created. */
709715
@JvmField val PROGRAM_CREATED = of("program.created")
710716

@@ -1002,6 +1008,10 @@ private constructor(
10021008
PHYSICAL_CHECK_CREATED,
10031009
/** Occurs whenever a Physical Check is updated. */
10041010
PHYSICAL_CHECK_UPDATED,
1011+
/** Occurs whenever a Physical Check Book is created. */
1012+
PHYSICAL_CHECK_BOOK_CREATED,
1013+
/** Occurs whenever a Physical Check Book is updated. */
1014+
PHYSICAL_CHECK_BOOK_UPDATED,
10051015
/** Occurs whenever a Program is created. */
10061016
PROGRAM_CREATED,
10071017
/** Occurs whenever a Program is updated. */
@@ -1263,6 +1273,10 @@ private constructor(
12631273
PHYSICAL_CHECK_CREATED,
12641274
/** Occurs whenever a Physical Check is updated. */
12651275
PHYSICAL_CHECK_UPDATED,
1276+
/** Occurs whenever a Physical Check Book is created. */
1277+
PHYSICAL_CHECK_BOOK_CREATED,
1278+
/** Occurs whenever a Physical Check Book is updated. */
1279+
PHYSICAL_CHECK_BOOK_UPDATED,
12661280
/** Occurs whenever a Program is created. */
12671281
PROGRAM_CREATED,
12681282
/** Occurs whenever a Program is updated. */
@@ -1432,6 +1446,8 @@ private constructor(
14321446
PHYSICAL_CARD_PROFILE_UPDATED -> Value.PHYSICAL_CARD_PROFILE_UPDATED
14331447
PHYSICAL_CHECK_CREATED -> Value.PHYSICAL_CHECK_CREATED
14341448
PHYSICAL_CHECK_UPDATED -> Value.PHYSICAL_CHECK_UPDATED
1449+
PHYSICAL_CHECK_BOOK_CREATED -> Value.PHYSICAL_CHECK_BOOK_CREATED
1450+
PHYSICAL_CHECK_BOOK_UPDATED -> Value.PHYSICAL_CHECK_BOOK_UPDATED
14351451
PROGRAM_CREATED -> Value.PROGRAM_CREATED
14361452
PROGRAM_UPDATED -> Value.PROGRAM_UPDATED
14371453
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->
@@ -1575,6 +1591,8 @@ private constructor(
15751591
PHYSICAL_CARD_PROFILE_UPDATED -> Known.PHYSICAL_CARD_PROFILE_UPDATED
15761592
PHYSICAL_CHECK_CREATED -> Known.PHYSICAL_CHECK_CREATED
15771593
PHYSICAL_CHECK_UPDATED -> Known.PHYSICAL_CHECK_UPDATED
1594+
PHYSICAL_CHECK_BOOK_CREATED -> Known.PHYSICAL_CHECK_BOOK_CREATED
1595+
PHYSICAL_CHECK_BOOK_UPDATED -> Known.PHYSICAL_CHECK_BOOK_UPDATED
15781596
PROGRAM_CREATED -> Known.PROGRAM_CREATED
15791597
PROGRAM_UPDATED -> Known.PROGRAM_UPDATED
15801598
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->

‎increase-java-core/src/main/kotlin/com/increase/api/models/eventsubscriptions/EventSubscription.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -999,6 +999,12 @@ private constructor(
999999
/** Occurs whenever a Physical Check is updated. */
10001000
@JvmField val PHYSICAL_CHECK_UPDATED = of("physical_check.updated")
10011001

1002+
/** Occurs whenever a Physical Check Book is created. */
1003+
@JvmField val PHYSICAL_CHECK_BOOK_CREATED = of("physical_check_book.created")
1004+
1005+
/** Occurs whenever a Physical Check Book is updated. */
1006+
@JvmField val PHYSICAL_CHECK_BOOK_UPDATED = of("physical_check_book.updated")
1007+
10021008
/** Occurs whenever a Program is created. */
10031009
@JvmField val PROGRAM_CREATED = of("program.created")
10041010

@@ -1298,6 +1304,10 @@ private constructor(
12981304
PHYSICAL_CHECK_CREATED,
12991305
/** Occurs whenever a Physical Check is updated. */
13001306
PHYSICAL_CHECK_UPDATED,
1307+
/** Occurs whenever a Physical Check Book is created. */
1308+
PHYSICAL_CHECK_BOOK_CREATED,
1309+
/** Occurs whenever a Physical Check Book is updated. */
1310+
PHYSICAL_CHECK_BOOK_UPDATED,
13011311
/** Occurs whenever a Program is created. */
13021312
PROGRAM_CREATED,
13031313
/** Occurs whenever a Program is updated. */
@@ -1561,6 +1571,10 @@ private constructor(
15611571
PHYSICAL_CHECK_CREATED,
15621572
/** Occurs whenever a Physical Check is updated. */
15631573
PHYSICAL_CHECK_UPDATED,
1574+
/** Occurs whenever a Physical Check Book is created. */
1575+
PHYSICAL_CHECK_BOOK_CREATED,
1576+
/** Occurs whenever a Physical Check Book is updated. */
1577+
PHYSICAL_CHECK_BOOK_UPDATED,
15641578
/** Occurs whenever a Program is created. */
15651579
PROGRAM_CREATED,
15661580
/** Occurs whenever a Program is updated. */
@@ -1736,6 +1750,8 @@ private constructor(
17361750
PHYSICAL_CARD_PROFILE_UPDATED -> Value.PHYSICAL_CARD_PROFILE_UPDATED
17371751
PHYSICAL_CHECK_CREATED -> Value.PHYSICAL_CHECK_CREATED
17381752
PHYSICAL_CHECK_UPDATED -> Value.PHYSICAL_CHECK_UPDATED
1753+
PHYSICAL_CHECK_BOOK_CREATED -> Value.PHYSICAL_CHECK_BOOK_CREATED
1754+
PHYSICAL_CHECK_BOOK_UPDATED -> Value.PHYSICAL_CHECK_BOOK_UPDATED
17391755
PROGRAM_CREATED -> Value.PROGRAM_CREATED
17401756
PROGRAM_UPDATED -> Value.PROGRAM_UPDATED
17411757
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->
@@ -1880,6 +1896,8 @@ private constructor(
18801896
PHYSICAL_CARD_PROFILE_UPDATED -> Known.PHYSICAL_CARD_PROFILE_UPDATED
18811897
PHYSICAL_CHECK_CREATED -> Known.PHYSICAL_CHECK_CREATED
18821898
PHYSICAL_CHECK_UPDATED -> Known.PHYSICAL_CHECK_UPDATED
1899+
PHYSICAL_CHECK_BOOK_CREATED -> Known.PHYSICAL_CHECK_BOOK_CREATED
1900+
PHYSICAL_CHECK_BOOK_UPDATED -> Known.PHYSICAL_CHECK_BOOK_UPDATED
18831901
PROGRAM_CREATED -> Known.PROGRAM_CREATED
18841902
PROGRAM_UPDATED -> Known.PROGRAM_UPDATED
18851903
PROOF_OF_AUTHORIZATION_REQUEST_CREATED ->

0 commit comments

Comments
 (0)