You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// Configures using the `ARCADE_API_KEY` environment variable
@@ -168,7 +168,7 @@ The asynchronous client supports the same options as the synchronous one, except
168
168
169
169
The SDK throws custom unchecked exception types:
170
170
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:
-[`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.
187
187
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.
189
189
190
190
## Logging
191
191
@@ -222,8 +222,8 @@ The API may also explicitly instruct the SDK to retry or not retry a response.
222
222
To set a custom number of retries, configure the client using the `maxRetries` method:
@@ -289,8 +289,8 @@ The SDK is typed for convenient usage of the documented API. However, it also su
289
289
To set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:
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.
303
303
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:
@@ -349,7 +349,7 @@ String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
349
349
To access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:
350
350
351
351
```java
352
-
importcom.arcade_engine.api.core.JsonField;
352
+
importdev.arcade.core.JsonField;
353
353
importjava.util.Optional;
354
354
355
355
JsonField<Object> field = client.tools().execute(params)._field();
@@ -372,22 +372,22 @@ if (field.isMissing()) {
372
372
373
373
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.
374
374
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.
376
376
377
377
If you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:
0 commit comments