Skip to content

Commit 867c358

Browse files
feat(api): api update
1 parent cb6b641 commit 867c358

253 files changed

Lines changed: 2116 additions & 1694 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 29
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-8446c4e394ac1eeeab4eea23ba29649287af8cf410607dc8eea7ad6ec7d39861.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-4dc4e58ef402ce5362e0a8988b3928a8bfa0d5ba847f7ad8b14226a0cf282f28.yml

README.md

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- x-release-please-start-version -->
44

5-
[![Maven Central](https://img.shields.io/maven-central/v/com.arcade_engine.api/arcade-java)](https://central.sonatype.com/artifact/com.arcade_engine.api/arcade-java/0.0.1-alpha.0)
5+
[![Maven Central](https://img.shields.io/maven-central/v/dev.arcade/arcade-java)](https://central.sonatype.com/artifact/dev.arcade/arcade-java/0.0.1-alpha.0)
66

77
<!-- x-release-please-end -->
88

@@ -19,14 +19,14 @@ The REST API documentation can be found on [docs.arcade.dev](https://docs.arcade
1919
### Gradle
2020

2121
```kotlin
22-
implementation("com.arcade_engine.api:arcade-java:0.0.1-alpha.0")
22+
implementation("dev.arcade:arcade-java:0.0.1-alpha.0")
2323
```
2424

2525
### Maven
2626

2727
```xml
2828
<dependency>
29-
<groupId>com.arcade_engine.api</groupId>
29+
<groupId>dev.arcade</groupId>
3030
<artifactId>arcade-java</artifactId>
3131
<version>0.0.1-alpha.0</version>
3232
</dependency>
@@ -41,11 +41,11 @@ This library requires Java 8 or later.
4141
## Usage
4242

4343
```java
44-
import com.arcade_engine.api.client.ArcadeClient;
45-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
46-
import com.arcade_engine.api.models.ExecuteToolRequest;
47-
import com.arcade_engine.api.models.ExecuteToolResponse;
48-
import com.arcade_engine.api.models.ToolExecuteParams;
44+
import dev.arcade.client.ArcadeClient;
45+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
46+
import dev.arcade.models.ExecuteToolRequest;
47+
import dev.arcade.models.ExecuteToolResponse;
48+
import dev.arcade.models.ToolExecuteParams;
4949

5050
// Configures using the `ARCADE_API_KEY` environment variable
5151
ArcadeClient client = ArcadeOkHttpClient.fromEnv();
@@ -63,8 +63,8 @@ ExecuteToolResponse executeToolResponse = client.tools().execute(params);
6363
Configure the client using environment variables:
6464

6565
```java
66-
import com.arcade_engine.api.client.ArcadeClient;
67-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
66+
import dev.arcade.client.ArcadeClient;
67+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
6868

6969
// Configures using the `ARCADE_API_KEY` environment variable
7070
ArcadeClient client = ArcadeOkHttpClient.fromEnv();
@@ -73,8 +73,8 @@ ArcadeClient client = ArcadeOkHttpClient.fromEnv();
7373
Or manually:
7474

7575
```java
76-
import com.arcade_engine.api.client.ArcadeClient;
77-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
76+
import dev.arcade.client.ArcadeClient;
77+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
7878

7979
ArcadeClient client = ArcadeOkHttpClient.builder()
8080
.apiKey("My API Key")
@@ -84,8 +84,8 @@ ArcadeClient client = ArcadeOkHttpClient.builder()
8484
Or using a combination of the two approaches:
8585

8686
```java
87-
import com.arcade_engine.api.client.ArcadeClient;
88-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
87+
import dev.arcade.client.ArcadeClient;
88+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
8989

9090
ArcadeClient client = ArcadeOkHttpClient.builder()
9191
// Configures using the `ARCADE_API_KEY` environment variable
@@ -123,11 +123,11 @@ Because each class is immutable, builder modification will _never_ affect alread
123123
The default client is synchronous. To switch to asynchronous execution, call the `async()` method:
124124

125125
```java
126-
import com.arcade_engine.api.client.ArcadeClient;
127-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
128-
import com.arcade_engine.api.models.ExecuteToolRequest;
129-
import com.arcade_engine.api.models.ExecuteToolResponse;
130-
import com.arcade_engine.api.models.ToolExecuteParams;
126+
import dev.arcade.client.ArcadeClient;
127+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
128+
import dev.arcade.models.ExecuteToolRequest;
129+
import dev.arcade.models.ExecuteToolResponse;
130+
import dev.arcade.models.ToolExecuteParams;
131131
import java.util.concurrent.CompletableFuture;
132132

133133
// Configures using the `ARCADE_API_KEY` environment variable
@@ -144,11 +144,11 @@ CompletableFuture<ExecuteToolResponse> executeToolResponse = client.async().tool
144144
Or create an asynchronous client from the beginning:
145145

146146
```java
147-
import com.arcade_engine.api.client.ArcadeClientAsync;
148-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClientAsync;
149-
import com.arcade_engine.api.models.ExecuteToolRequest;
150-
import com.arcade_engine.api.models.ExecuteToolResponse;
151-
import com.arcade_engine.api.models.ToolExecuteParams;
147+
import dev.arcade.client.ArcadeClientAsync;
148+
import dev.arcade.client.okhttp.ArcadeOkHttpClientAsync;
149+
import dev.arcade.models.ExecuteToolRequest;
150+
import dev.arcade.models.ExecuteToolResponse;
151+
import dev.arcade.models.ToolExecuteParams;
152152
import java.util.concurrent.CompletableFuture;
153153

154154
// Configures using the `ARCADE_API_KEY` environment variable
@@ -168,7 +168,7 @@ The asynchronous client supports the same options as the synchronous one, except
168168

169169
The SDK throws custom unchecked exception types:
170170

171-
- [`ArcadeServiceException`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/errors/ArcadeServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
171+
- [`ArcadeServiceException`](arcade-java-core/src/main/kotlin/dev/arcade/errors/ArcadeServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
172172

173173
| Status | Exception |
174174
| ------ | ------------------------------- |
@@ -181,11 +181,11 @@ The SDK throws custom unchecked exception types:
181181
| 5xx | `InternalServerException` |
182182
| others | `UnexpectedStatusCodeException` |
183183

184-
- [`ArcadeIoException`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/errors/ArcadeIoException.kt): I/O networking errors.
184+
- [`ArcadeIoException`](arcade-java-core/src/main/kotlin/dev/arcade/errors/ArcadeIoException.kt): I/O networking errors.
185185

186-
- [`ArcadeInvalidDataException`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/errors/ArcadeInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
186+
- [`ArcadeInvalidDataException`](arcade-java-core/src/main/kotlin/dev/arcade/errors/ArcadeInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
187187

188-
- [`ArcadeException`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/errors/ArcadeException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
188+
- [`ArcadeException`](arcade-java-core/src/main/kotlin/dev/arcade/errors/ArcadeException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
189189

190190
## Logging
191191

@@ -222,8 +222,8 @@ The API may also explicitly instruct the SDK to retry or not retry a response.
222222
To set a custom number of retries, configure the client using the `maxRetries` method:
223223

224224
```java
225-
import com.arcade_engine.api.client.ArcadeClient;
226-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
225+
import dev.arcade.client.ArcadeClient;
226+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
227227

228228
ArcadeClient client = ArcadeOkHttpClient.builder()
229229
.fromEnv()
@@ -238,9 +238,9 @@ Requests time out after 1 minute by default.
238238
To set a custom timeout, configure the method call using the `timeout` method:
239239

240240
```java
241-
import com.arcade_engine.api.models.ExecuteToolRequest;
242-
import com.arcade_engine.api.models.ExecuteToolResponse;
243-
import com.arcade_engine.api.models.ToolExecuteParams;
241+
import dev.arcade.models.ExecuteToolRequest;
242+
import dev.arcade.models.ExecuteToolResponse;
243+
import dev.arcade.models.ToolExecuteParams;
244244

245245
ExecuteToolResponse executeToolResponse = client.tools().execute(
246246
params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
@@ -250,8 +250,8 @@ ExecuteToolResponse executeToolResponse = client.tools().execute(
250250
Or configure the default for all method calls at the client level:
251251

252252
```java
253-
import com.arcade_engine.api.client.ArcadeClient;
254-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
253+
import dev.arcade.client.ArcadeClient;
254+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
255255
import java.time.Duration;
256256

257257
ArcadeClient client = ArcadeOkHttpClient.builder()
@@ -265,8 +265,8 @@ ArcadeClient client = ArcadeOkHttpClient.builder()
265265
To route requests through a proxy, configure the client using the `proxy` method:
266266

267267
```java
268-
import com.arcade_engine.api.client.ArcadeClient;
269-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
268+
import dev.arcade.client.ArcadeClient;
269+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
270270
import java.net.InetSocketAddress;
271271
import java.net.Proxy;
272272

@@ -289,8 +289,8 @@ The SDK is typed for convenient usage of the documented API. However, it also su
289289
To set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:
290290

291291
```java
292-
import com.arcade_engine.api.core.JsonValue;
293-
import com.arcade_engine.api.models.ToolExecuteParams;
292+
import dev.arcade.core.JsonValue;
293+
import dev.arcade.models.ToolExecuteParams;
294294

295295
ToolExecuteParams params = ToolExecuteParams.builder()
296296
.putAdditionalHeader("Secret-Header", "42")
@@ -301,11 +301,11 @@ ToolExecuteParams params = ToolExecuteParams.builder()
301301

302302
These can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods. You can also set undocumented parameters on nested headers, query params, or body classes using the `putAdditionalProperty` method. These properties can be accessed on the built object later using the `_additionalProperties()` method.
303303

304-
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/core/JsonValue.kt) object to its setter:
304+
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](arcade-java-core/src/main/kotlin/dev/arcade/core/JsonValue.kt) object to its setter:
305305

306306
```java
307-
import com.arcade_engine.api.models.ExecuteToolRequest;
308-
import com.arcade_engine.api.models.ToolExecuteParams;
307+
import dev.arcade.models.ExecuteToolRequest;
308+
import dev.arcade.models.ToolExecuteParams;
309309

310310
ToolExecuteParams params = ToolExecuteParams.builder()
311311
.executeToolRequest(ExecuteToolRequest.builder()
@@ -319,7 +319,7 @@ ToolExecuteParams params = ToolExecuteParams.builder()
319319
To access undocumented response properties, call the `_additionalProperties()` method:
320320

321321
```java
322-
import com.arcade_engine.api.core.JsonValue;
322+
import dev.arcade.core.JsonValue;
323323
import java.util.Map;
324324

325325
Map<String, JsonValue> additionalProperties = client.tools().execute(params)._additionalProperties();
@@ -349,7 +349,7 @@ String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
349349
To access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:
350350

351351
```java
352-
import com.arcade_engine.api.core.JsonField;
352+
import dev.arcade.core.JsonField;
353353
import java.util.Optional;
354354

355355
JsonField<Object> field = client.tools().execute(params)._field();
@@ -372,22 +372,22 @@ if (field.isMissing()) {
372372

373373
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.
374374

375-
By default, the SDK will not throw an exception in this case. It will throw [`ArcadeInvalidDataException`](arcade-java-core/src/main/kotlin/com/arcade_engine/api/errors/ArcadeInvalidDataException.kt) only if you directly access the property.
375+
By default, the SDK will not throw an exception in this case. It will throw [`ArcadeInvalidDataException`](arcade-java-core/src/main/kotlin/dev/arcade/errors/ArcadeInvalidDataException.kt) only if you directly access the property.
376376

377377
If you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:
378378

379379
```java
380-
import com.arcade_engine.api.models.ExecuteToolResponse;
380+
import dev.arcade.models.ExecuteToolResponse;
381381

382382
ExecuteToolResponse executeToolResponse = client.tools().execute(params).validate();
383383
```
384384

385385
Or configure the method call to validate the response using the `responseValidation` method:
386386

387387
```java
388-
import com.arcade_engine.api.models.ExecuteToolRequest;
389-
import com.arcade_engine.api.models.ExecuteToolResponse;
390-
import com.arcade_engine.api.models.ToolExecuteParams;
388+
import dev.arcade.models.ExecuteToolRequest;
389+
import dev.arcade.models.ExecuteToolResponse;
390+
import dev.arcade.models.ToolExecuteParams;
391391

392392
ExecuteToolResponse executeToolResponse = client.tools().execute(
393393
params, RequestOptions.builder().responseValidation(true).build()
@@ -397,8 +397,8 @@ ExecuteToolResponse executeToolResponse = client.tools().execute(
397397
Or configure the default for all method calls at the client level:
398398

399399
```java
400-
import com.arcade_engine.api.client.ArcadeClient;
401-
import com.arcade_engine.api.client.okhttp.ArcadeOkHttpClient;
400+
import dev.arcade.client.ArcadeClient;
401+
import dev.arcade.client.okhttp.ArcadeOkHttpClient;
402402

403403
ArcadeClient client = ArcadeOkHttpClient.builder()
404404
.fromEnv()

arcade-java-client-okhttp/src/main/kotlin/com/arcade_engine/api/client/okhttp/ArcadeOkHttpClient.kt renamed to arcade-java-client-okhttp/src/main/kotlin/dev/arcade/client/okhttp/ArcadeOkHttpClient.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// File generated from our OpenAPI spec by Stainless.
22

3-
package com.arcade_engine.api.client.okhttp
3+
package dev.arcade.client.okhttp
44

5-
import com.arcade_engine.api.client.ArcadeClient
6-
import com.arcade_engine.api.client.ArcadeClientImpl
7-
import com.arcade_engine.api.core.ClientOptions
8-
import com.arcade_engine.api.core.http.Headers
9-
import com.arcade_engine.api.core.http.QueryParams
105
import com.fasterxml.jackson.databind.json.JsonMapper
6+
import dev.arcade.client.ArcadeClient
7+
import dev.arcade.client.ArcadeClientImpl
8+
import dev.arcade.core.ClientOptions
9+
import dev.arcade.core.http.Headers
10+
import dev.arcade.core.http.QueryParams
1111
import java.net.Proxy
1212
import java.time.Clock
1313
import java.time.Duration

arcade-java-client-okhttp/src/main/kotlin/com/arcade_engine/api/client/okhttp/ArcadeOkHttpClientAsync.kt renamed to arcade-java-client-okhttp/src/main/kotlin/dev/arcade/client/okhttp/ArcadeOkHttpClientAsync.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// File generated from our OpenAPI spec by Stainless.
22

3-
package com.arcade_engine.api.client.okhttp
3+
package dev.arcade.client.okhttp
44

5-
import com.arcade_engine.api.client.ArcadeClientAsync
6-
import com.arcade_engine.api.client.ArcadeClientAsyncImpl
7-
import com.arcade_engine.api.core.ClientOptions
8-
import com.arcade_engine.api.core.http.Headers
9-
import com.arcade_engine.api.core.http.QueryParams
105
import com.fasterxml.jackson.databind.json.JsonMapper
6+
import dev.arcade.client.ArcadeClientAsync
7+
import dev.arcade.client.ArcadeClientAsyncImpl
8+
import dev.arcade.core.ClientOptions
9+
import dev.arcade.core.http.Headers
10+
import dev.arcade.core.http.QueryParams
1111
import java.net.Proxy
1212
import java.time.Clock
1313
import java.time.Duration

arcade-java-client-okhttp/src/main/kotlin/com/arcade_engine/api/client/okhttp/OkHttpClient.kt renamed to arcade-java-client-okhttp/src/main/kotlin/dev/arcade/client/okhttp/OkHttpClient.kt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
package com.arcade_engine.api.client.okhttp
2-
3-
import com.arcade_engine.api.core.RequestOptions
4-
import com.arcade_engine.api.core.checkRequired
5-
import com.arcade_engine.api.core.http.Headers
6-
import com.arcade_engine.api.core.http.HttpClient
7-
import com.arcade_engine.api.core.http.HttpMethod
8-
import com.arcade_engine.api.core.http.HttpRequest
9-
import com.arcade_engine.api.core.http.HttpRequestBody
10-
import com.arcade_engine.api.core.http.HttpResponse
11-
import com.arcade_engine.api.errors.ArcadeIoException
1+
package dev.arcade.client.okhttp
2+
3+
import dev.arcade.core.RequestOptions
4+
import dev.arcade.core.checkRequired
5+
import dev.arcade.core.http.Headers
6+
import dev.arcade.core.http.HttpClient
7+
import dev.arcade.core.http.HttpMethod
8+
import dev.arcade.core.http.HttpRequest
9+
import dev.arcade.core.http.HttpRequestBody
10+
import dev.arcade.core.http.HttpResponse
11+
import dev.arcade.errors.ArcadeIoException
1212
import java.io.IOException
1313
import java.io.InputStream
1414
import java.net.Proxy

arcade-java-core/src/main/kotlin/com/arcade_engine/api/services/async/AdminServiceAsync.kt

Lines changed: 0 additions & 16 deletions
This file was deleted.

arcade-java-core/src/main/kotlin/com/arcade_engine/api/services/blocking/AdminService.kt

Lines changed: 0 additions & 16 deletions
This file was deleted.

arcade-java-core/src/main/kotlin/com/arcade_engine/api/client/ArcadeClient.kt renamed to arcade-java-core/src/main/kotlin/dev/arcade/client/ArcadeClient.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// File generated from our OpenAPI spec by Stainless.
22

3-
package com.arcade_engine.api.client
4-
5-
import com.arcade_engine.api.services.blocking.AdminService
6-
import com.arcade_engine.api.services.blocking.AuthService
7-
import com.arcade_engine.api.services.blocking.ChatService
8-
import com.arcade_engine.api.services.blocking.HealthService
9-
import com.arcade_engine.api.services.blocking.ToolService
10-
import com.arcade_engine.api.services.blocking.WorkerService
3+
package dev.arcade.client
4+
5+
import dev.arcade.services.blocking.AdminService
6+
import dev.arcade.services.blocking.AuthService
7+
import dev.arcade.services.blocking.ChatService
8+
import dev.arcade.services.blocking.HealthService
9+
import dev.arcade.services.blocking.ToolService
10+
import dev.arcade.services.blocking.WorkerService
1111

1212
/**
1313
* A client for interacting with the Arcade REST API synchronously. You can also switch to

0 commit comments

Comments
 (0)