@@ -10,7 +10,7 @@ Manage the building blocks of Codat, including companies, connections, and more.
1010### Gradle
1111
1212``` groovy
13- implementation 'io.codat.platform:openapi:0.2.1 '
13+ implementation 'io.codat.platform:openapi:0.3.0 '
1414```
1515<!-- End SDK Installation [installation] -->
1616
@@ -29,6 +29,8 @@ import io.codat.platform.models.operations.CreateApiKeyResponse;
2929import io.codat.platform.models.shared.* ;
3030import io.codat.platform.models.shared.CreateApiKey ;
3131import io.codat.platform.models.shared.Security ;
32+ import java.math.BigDecimal ;
33+ import java.math.BigInteger ;
3234import java.time.LocalDate ;
3335import java.time.OffsetDateTime ;
3436import java.util.Optional ;
@@ -40,7 +42,7 @@ public class Application {
4042 try {
4143 CodatPlatform sdk = CodatPlatform . builder()
4244 .security(Security . builder()
43- .authHeader(" <YOUR_API_KEY_HERE> "
45+ .authHeader(" Basic BASE_64_ENCODED(API_KEY) "
4446 .build())
4547 .build();
4648
@@ -136,9 +138,12 @@ public class Application {
136138
137139### [ webhooks()] ( docs/sdks/webhooks/README.md )
138140
139- * [ create] ( docs/sdks/webhooks/README.md#create ) - Create webhook
140- * [ get] ( docs/sdks/webhooks/README.md#get ) - Get webhook
141- * [ list] ( docs/sdks/webhooks/README.md#list ) - List webhooks
141+ * [ ~~ create~~ ] ( docs/sdks/webhooks/README.md#create ) - Create webhook :warning : ** Deprecated**
142+ * [ createConsumer] ( docs/sdks/webhooks/README.md#createconsumer ) - Create webhook consumer
143+ * [ deleteConsumer] ( docs/sdks/webhooks/README.md#deleteconsumer ) - Delete webhook consumer
144+ * [ ~~ get~~ ] ( docs/sdks/webhooks/README.md#get ) - Get webhook :warning : ** Deprecated**
145+ * [ ~~ list~~ ] ( docs/sdks/webhooks/README.md#list ) - List webhooks :warning : ** Deprecated**
146+ * [ listConsumers] ( docs/sdks/webhooks/README.md#listconsumers ) - List webhook consumers
142147<!-- End Available Resources and Operations [operations] -->
143148
144149<!-- Start Error Handling [errors] -->
@@ -161,6 +166,8 @@ import io.codat.platform.models.operations.CreateApiKeyResponse;
161166import io.codat.platform.models.shared.* ;
162167import io.codat.platform.models.shared.CreateApiKey ;
163168import io.codat.platform.models.shared.Security ;
169+ import java.math.BigDecimal ;
170+ import java.math.BigInteger ;
164171import java.time.LocalDate ;
165172import java.time.OffsetDateTime ;
166173import java.util.Optional ;
@@ -172,7 +179,7 @@ public class Application {
172179 try {
173180 CodatPlatform sdk = CodatPlatform . builder()
174181 .security(Security . builder()
175- .authHeader(" <YOUR_API_KEY_HERE> "
182+ .authHeader(" Basic BASE_64_ENCODED(API_KEY) "
176183 .build())
177184 .build();
178185
@@ -219,6 +226,8 @@ import io.codat.platform.models.operations.CreateApiKeyResponse;
219226import io.codat.platform.models.shared.* ;
220227import io.codat.platform.models.shared.CreateApiKey ;
221228import io.codat.platform.models.shared.Security ;
229+ import java.math.BigDecimal ;
230+ import java.math.BigInteger ;
222231import java.time.LocalDate ;
223232import java.time.OffsetDateTime ;
224233import java.util.Optional ;
@@ -231,7 +240,7 @@ public class Application {
231240 CodatPlatform sdk = CodatPlatform . builder()
232241 .serverIndex(0 )
233242 .security(Security . builder()
234- .authHeader(" <YOUR_API_KEY_HERE> "
243+ .authHeader(" Basic BASE_64_ENCODED(API_KEY) "
235244 .build())
236245 .build();
237246
@@ -268,6 +277,8 @@ import io.codat.platform.models.operations.CreateApiKeyResponse;
268277import io.codat.platform.models.shared.* ;
269278import io.codat.platform.models.shared.CreateApiKey ;
270279import io.codat.platform.models.shared.Security ;
280+ import java.math.BigDecimal ;
281+ import java.math.BigInteger ;
271282import java.time.LocalDate ;
272283import java.time.OffsetDateTime ;
273284import java.util.Optional ;
@@ -280,7 +291,7 @@ public class Application {
280291 CodatPlatform sdk = CodatPlatform . builder()
281292 .serverURL(" https://api.codat.io"
282293 .security(Security . builder()
283- .authHeader(" <YOUR_API_KEY_HERE> "
294+ .authHeader(" Basic BASE_64_ENCODED(API_KEY) "
284295 .build())
285296 .build();
286297
@@ -326,6 +337,8 @@ import io.codat.platform.models.operations.CreateApiKeyResponse;
326337import io.codat.platform.models.shared.* ;
327338import io.codat.platform.models.shared.CreateApiKey ;
328339import io.codat.platform.models.shared.Security ;
340+ import java.math.BigDecimal ;
341+ import java.math.BigInteger ;
329342import java.time.LocalDate ;
330343import java.time.OffsetDateTime ;
331344import java.util.Optional ;
@@ -337,7 +350,7 @@ public class Application {
337350 try {
338351 CodatPlatform sdk = CodatPlatform . builder()
339352 .security(Security . builder()
340- .authHeader(" <YOUR_API_KEY_HERE> "
353+ .authHeader(" Basic BASE_64_ENCODED(API_KEY) "
341354 .build())
342355 .build();
343356
@@ -362,6 +375,132 @@ public class Application {
362375```
363376<!-- End Authentication [security] -->
364377
378+ <!-- Start Retries [retries] -->
379+ ## Retries
380+
381+ Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
382+
383+ To change the default retry strategy for a single API call, you can provide a ` RetryConfig ` object through the ` retryConfig ` builder method:
384+ ``` java
385+ package hello.world ;
386+
387+ import io.codat.platform.CodatPlatform ;
388+ import io.codat.platform.models.operations.* ;
389+ import io.codat.platform.models.operations.CreateApiKeyResponse ;
390+ import io.codat.platform.models.shared.* ;
391+ import io.codat.platform.models.shared.CreateApiKey ;
392+ import io.codat.platform.models.shared.Security ;
393+ import io.codat.platform.utils.BackoffStrategy ;
394+ import io.codat.platform.utils.RetryConfig ;
395+ import java.math.BigDecimal ;
396+ import java.math.BigInteger ;
397+ import java.time.LocalDate ;
398+ import java.time.OffsetDateTime ;
399+ import java.util.Optional ;
400+ import java.util.concurrent.TimeUnit ;
401+ import static java.util.Map.entry ;
402+
403+ public class Application {
404+
405+ public static void main (String [] args ) {
406+ try {
407+ CodatPlatform sdk = CodatPlatform . builder()
408+ .security(Security . builder()
409+ .authHeader(" Basic BASE_64_ENCODED(API_KEY)"
410+ .build())
411+ .build();
412+
413+ CreateApiKey req = CreateApiKey . builder()
414+ .name(" azure-invoice-finance-processor"
415+ .build();
416+
417+ CreateApiKeyResponse res = sdk. settings(). createApiKey()
418+ .request(req)
419+ .retryConfig(RetryConfig . builder()
420+ .backoff(BackoffStrategy . builder()
421+ .initialInterval(1L , TimeUnit . MILLISECONDS
422+ .maxInterval(50L , TimeUnit . MILLISECONDS
423+ .maxElapsedTime(1000L , TimeUnit . MILLISECONDS
424+ .baseFactor(1.1 )
425+ .jitterFactor(0.15 )
426+ .retryConnectError(false )
427+ .build())
428+ .build())
429+ .call();
430+
431+ if (res. apiKeyDetails(). isPresent()) {
432+ // handle response
433+ }
434+ } catch (io.codat.platform.models.errors. SDKError e) {
435+ // handle exception
436+ } catch (Exception e) {
437+ // handle exception
438+ }
439+ }
440+ }
441+ ```
442+
443+ If you'd like to override the default retry strategy for all operations that support retries, you can provide a configuration at SDK initialization:
444+ ``` java
445+ package hello.world ;
446+
447+ import io.codat.platform.CodatPlatform ;
448+ import io.codat.platform.models.operations.* ;
449+ import io.codat.platform.models.operations.CreateApiKeyResponse ;
450+ import io.codat.platform.models.shared.* ;
451+ import io.codat.platform.models.shared.CreateApiKey ;
452+ import io.codat.platform.models.shared.Security ;
453+ import io.codat.platform.utils.BackoffStrategy ;
454+ import io.codat.platform.utils.RetryConfig ;
455+ import java.math.BigDecimal ;
456+ import java.math.BigInteger ;
457+ import java.time.LocalDate ;
458+ import java.time.OffsetDateTime ;
459+ import java.util.Optional ;
460+ import java.util.concurrent.TimeUnit ;
461+ import static java.util.Map.entry ;
462+
463+ public class Application {
464+
465+ public static void main (String [] args ) {
466+ try {
467+ CodatPlatform sdk = CodatPlatform . builder()
468+ .retryConfig(RetryConfig . builder()
469+ .backoff(BackoffStrategy . builder()
470+ .initialInterval(1L , TimeUnit . MILLISECONDS
471+ .maxInterval(50L , TimeUnit . MILLISECONDS
472+ .maxElapsedTime(1000L , TimeUnit . MILLISECONDS
473+ .baseFactor(1.1 )
474+ .jitterFactor(0.15 )
475+ .retryConnectError(false )
476+ .build())
477+ .build())
478+ .security(Security . builder()
479+ .authHeader(" Basic BASE_64_ENCODED(API_KEY)"
480+ .build())
481+ .build();
482+
483+ CreateApiKey req = CreateApiKey . builder()
484+ .name(" azure-invoice-finance-processor"
485+ .build();
486+
487+ CreateApiKeyResponse res = sdk. settings(). createApiKey()
488+ .request(req)
489+ .call();
490+
491+ if (res. apiKeyDetails(). isPresent()) {
492+ // handle response
493+ }
494+ } catch (io.codat.platform.models.errors. SDKError e) {
495+ // handle exception
496+ } catch (Exception e) {
497+ // handle exception
498+ }
499+ }
500+ }
501+ ```
502+ <!-- End Retries [retries] -->
503+
365504<!-- Placeholder for Future Speakeasy SDK Sections -->
366505
367506
0 commit comments