## Java SDK Changes Detected:

* `shippo.batches.create()`: 
  *  `request.batchShipments.[].shipment.parcels.[].[parcelCreateFromTemplateRequest].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
* `shippo.batches.addShipments()`: 
  *  `requestbody.[].shipment.parcels.[].[parcelCreateFromTemplateRequest].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
* `shippo.carrierAccounts.register()`:  `request` **Changed** **Breaking** ⚠️
* `shippo.ratesAtCheckout.create()`: 
  *  `request.parcel.[parcel].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
* `shippo.parcels.create()`: 
  *  `request.[parcelCreateFromTemplateRequest].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
  *  `response.template.[parcelTemplateCouriersPleaseEnum]` **Removed**
* `shippo.shipments.create()`: 
  *  `request.parcels.[].[parcelCreateFromTemplateRequest].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
  *  `response.parcels.[].template.[parcelTemplateCouriersPleaseEnum]` **Removed**
* `shippo.transactions.create()`: 
  *  `request.[instantTransactionCreateRequest].shipment.parcels.[].[parcelCreateFromTemplateRequest].template.[parcelTemplateCouriersPleaseEnum]` **Removed** **Breaking** ⚠️
* `shippo.carrierAccounts.list()`: 
  *  `request.carrier` **Changed**
* `shippo.parcels.list()`:  `response.results.[].template.[parcelTemplateCouriersPleaseEnum]` **Removed**
* `shippo.parcels.get()`:  `response.template.[parcelTemplateCouriersPleaseEnum]` **Removed**
* `shippo.shipments.list()`:  `response.results.[].parcels.[].template.[parcelTemplateCouriersPleaseEnum]` **Removed**
* `shippo.shipments.get()`:  `response.parcels.[].template.[parcelTemplateCouriersPleaseEnum]` **Removed**

Author: speakeasybot

.gitattributes

@@ -8,5 +8,4 @@
 *.bat           text eol=crlf
 
 # This allows generated code to be indexed correctly
-*.java linguist-generated=false
-
+*.java linguist-generated=false

.gitignore

@@ -1,3 +1,8 @@
+**/.speakeasy/temp/
+**/.speakeasy/logs/
+.speakeasy/reports
+.env
+.env.local
 # Ignore Gradle project-specific cache directory
 .gradle
 # Ignore Gradle build output directory

.speakeasy/gen.lock

@@ -4,29 +4,44 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
+    nameResolutionFeb2025: false
     parameterOrderingFeb2024: true
     requestResponseComponentNamesFeb2024: true
+    securityFeb2025: false
+    sharedErrorComponentsApr2025: false
   auth:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
+    hoistGlobalSecurity: true
+  schemas:
+    allOfMergeStrategy: shallowMerge
+  tests:
+    generateTests: true
+    generateNewTests: false
+    skipResponseBodyAssertions: false
 java:
-  version: 1.0.0-beta
+  version: 1.0.0-beta.1
   additionalDependencies: []
   additionalPlugins:
     - id 'org.jreleaser' version '1.15.0'
   artifactID: shippo-sdk
+  baseErrorName: ShippoException
   clientServerStatusCodesAsErrors: true
   companyEmail: [email protected]
   companyName: Shippo
   companyURL: www.goshippo.com
   defaultErrorName: SDKError
+  enableCustomCodeRegions: false
+  enableStreamingUploads: false
   externalDocs:
     url: https://github.com/goshippo/shippo-java-sdk
     version: ""
   flattenGlobalSecurity: true
+  generateSpringBootStarter: true
   githubURL: https://github.com/goshippo/shippo-java-sdk
   groupID: com.goshippo
   imports:
@@ -41,11 +56,13 @@ java:
     descriptions: Maven library which integrates with Shippo Multi Carrier Shipping API. This library provides access to Shippo (goshippo.com) API capabilities. Including label generation, rating, tracking and more.
     version: ""
   inputModelSuffix: input
+  languageVersion: 11
   license:
     name: The MIT License (MIT)
     shortName: MIT
     url: https://mit-license.org/
   maxMethodParams: 4
+  nullFriendlyParameters: false
   outputModelSuffix: output
   projectName: api
   templateVersion: v2

.speakeasy/gen.yaml

@@ -1,20 +1,21 @@
-speakeasyVersion: 1.448.2
+speakeasyVersion: 1.637.0
 sources:
     my-first-source:
         sourceNamespace: my-first-source
-        sourceRevisionDigest: sha256:480494c08f99f68cd119fdb481d81d31d37e4e22211cc6fd8a5197857b7580b4
-        sourceBlobDigest: sha256:422c969f0c8ded72f1dc9d756407a9d51740270b9d16fd9c4f4a9d50f4e714ba
+        sourceRevisionDigest: sha256:c7975b03b0e922bd14ceb9f47b00751e5ab098fca449707d2e20845cf7cc50f5
+        sourceBlobDigest: sha256:38d48412b95b3b5c0ed071f4887b46472950b923b239a773d7830c0ee92c6c14
         tags:
             - latest
+            - speakeasy-sdk-regen-1733703738
             - "2018-02-08"
 targets:
     my-first-target:
         source: my-first-source
         sourceNamespace: my-first-source
-        sourceRevisionDigest: sha256:480494c08f99f68cd119fdb481d81d31d37e4e22211cc6fd8a5197857b7580b4
-        sourceBlobDigest: sha256:422c969f0c8ded72f1dc9d756407a9d51740270b9d16fd9c4f4a9d50f4e714ba
+        sourceRevisionDigest: sha256:c7975b03b0e922bd14ceb9f47b00751e5ab098fca449707d2e20845cf7cc50f5
+        sourceBlobDigest: sha256:38d48412b95b3b5c0ed071f4887b46472950b923b239a773d7830c0ee92c6c14
         codeSamplesNamespace: my-first-source-java-code-samples
-        codeSamplesRevisionDigest: sha256:2b960672ec02abfbb6692e804ee954c218ece797c765654fab7f71084709ef08
+        codeSamplesRevisionDigest: sha256:329337d24c9de0e0cd3902dcc398e2f40d8ebacb90d7d4d1ac9c1caed8166159
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

.speakeasy/workflow.lock

@@ -12,7 +12,6 @@ targets:
         source: my-first-source
         publish:
             java:
-                useSonatypeLegacy: false
                 ossrhUsername: $ossrh_username
                 ossrhPassword: $ossrh_password
                 gpgSecretKey: $java_gpg_secret_key

.speakeasy/workflow.yaml

@@ -36,6 +36,7 @@ Shippo external API.: Use this API to integrate with the Shippo service
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
   * [Authentication](#authentication)
+  * [Debugging](#debugging)
 
 <!-- End Table of Contents [toc] -->
 
@@ -275,24 +276,24 @@ We provide the API and web app for all your shipping needs.<!-- Start Error Hand
 
 Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
 
-By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `initiateOauth2Signin` method throws the following exceptions:
 
-| Error Type                                                            | Status Code | Content Type     |
-| --------------------------------------------------------------------- | ----------- | ---------------- |
-| models/errors/InitiateOauth2SigninResponseBody                        | 400         | application/json |
-| models/errors/InitiateOauth2SigninCarrierAccountsResponseBody         | 401         | application/json |
-| models/errors/InitiateOauth2SigninCarrierAccountsResponseResponseBody | 404         | application/json |
-| models/errors/SDKError                                                | 4XX, 5XX    | \*/\*            |
+[`ShippoException`](./src/main/java/models/errors/ShippoException.java) is the base class for all HTTP error responses. It has the following properties:
 
-### Example
+| Method           | Type                        | Description                                                              |
+| ---------------- | --------------------------- | ------------------------------------------------------------------------ |
+| `message()`      | `String`                    | Error message                                                            |
+| `code()`         | `int`                       | HTTP response status code eg `404`                                       |
+| `headers`        | `Map<String, List<String>>` | HTTP response headers                                                    |
+| `body()`         | `byte[]`                    | HTTP body as a byte array. Can be empty array if no body is returned.    |
+| `bodyAsString()` | `String`                    | HTTP body as a UTF-8 string. Can be empty string if no body is returned. |
+| `rawResponse()`  | `HttpResponse<?>`           | Raw HTTP response (body already read and not available for re-read)      |
 
+### Example
 ```java
 package hello.world;
 
 import com.goshippo.shippo_sdk.Shippo;
-import com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseBody;
-import com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody;
-import com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninResponseBody;
+import com.goshippo.shippo_sdk.models.errors.*;
 import com.goshippo.shippo_sdk.models.operations.InitiateOauth2SigninResponse;
 import java.lang.Exception;
 
@@ -301,29 +302,50 @@ public class Application {
     public static void main(String[] args) throws InitiateOauth2SigninResponseBody, InitiateOauth2SigninCarrierAccountsResponseBody, InitiateOauth2SigninCarrierAccountsResponseResponseBody, Exception {
 
         Shippo sdk = Shippo.builder()
-                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                 .shippoApiVersion("2018-02-08")
+                .apiKeyHeader(System.getenv().getOrDefault("API_KEY_HEADER", ""))
             .build();
 
         InitiateOauth2SigninResponse res = sdk.carrierAccounts().initiateOauth2Signin()
                 .carrierAccountObjectId("<id>")
-                .redirectUri("https://enlightened-mortise.com/")
-                .state("Louisiana")
-                .shippoApiVersion("2018-02-08")
+                .redirectUri("https://ashamed-reporter.biz")
                 .call();
 
         // handle response
     }
 }
 ```
+
+### Error Classes
+**Primary error:**
+* [`ShippoException`](./src/main/java/models/errors/ShippoException.java): The base class for HTTP error responses.
+
+<details><summary>Less common errors (9)</summary>
+
+<br />
+
+**Network errors:**
+* `java.io.IOException` (always wrapped by `java.io.UncheckedIOException`). Commonly encountered subclasses of
+`IOException` include `java.net.ConnectException`, `java.net.SocketTimeoutException`, `EOFException` (there are
+many more subclasses in the JDK platform).
+
+**Inherit from [`ShippoException`](./src/main/java/models/errors/ShippoException.java)**:
+* [`com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninResponseBody`](./src/main/java/models/errors/com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninResponseBody.java): Invalid parameters provided by the user. Status code `400`. Applicable to 1 of 70 methods.*
+* [`com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseBody`](./src/main/java/models/errors/com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseBody.java): Invalid ShippoToken or unsupported carrier account provided by the user. Status code `401`. Applicable to 1 of 70 methods.*
+* [`com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody`](./src/main/java/models/errors/com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody.java): Invalid carrier account provided by the user. Status code `404`. Applicable to 1 of 70 methods.*
+
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
+The default server can be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
 ```java
 package hello.world;
 
@@ -337,14 +359,13 @@ public class Application {
 
         Shippo sdk = Shippo.builder()
                 .serverURL("https://api.goshippo.com")
-                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                 .shippoApiVersion("2018-02-08")
+                .apiKeyHeader(System.getenv().getOrDefault("API_KEY_HEADER", ""))
             .build();
 
         ListAddressesResponse res = sdk.addresses().list()
                 .page(1L)
                 .results(5L)
-                .shippoApiVersion("2018-02-08")
                 .call();
 
         if (res.addressPaginatedList().isPresent()) {
@@ -379,14 +400,13 @@ public class Application {
     public static void main(String[] args) throws Exception {
 
         Shippo sdk = Shippo.builder()
-                .apiKeyHeader("<YOUR_API_KEY_HERE>")
+                .apiKeyHeader(System.getenv().getOrDefault("API_KEY_HEADER", ""))
                 .shippoApiVersion("2018-02-08")
             .build();
 
         ListAddressesResponse res = sdk.addresses().list()
                 .page(1L)
                 .results(5L)
-                .shippoApiVersion("2018-02-08")
                 .call();
 
         if (res.addressPaginatedList().isPresent()) {
@@ -402,6 +422,37 @@ public class Application {
 <!-- No SDK Installation -->
 <!-- No SDK Example Usage -->
 <!-- No SDK Available Operations -->
+<!-- Start Debugging [debug] -->
+## Debugging
+
+### Debug
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+For request and response logging (especially json bodies), call `enableHTTPDebugLogging(boolean)` on the SDK builder like so:
+```java
+SDK.builder()
+    .enableHTTPDebugLogging(true)
+    .build();
+```
+Example output:
+```
+Sending request: http://localhost:35123/bearer#global GET
+Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
+Received response: (GET http://localhost:35123/bearer#global) 200
+Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
+Response body:
+{
+  "authenticated": true, 
+  "token": "global"
+}
+```
+__WARNING__: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
+
+__NOTE__: This is a convenience method that calls `HTTPClient.enableDebugLogging()`. The `SpeakeasyHTTPClient` honors this setting. If you are using a custom HTTP client, it is up to the custom client to honor this setting.
+
+Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
+<!-- End Debugging [debug] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 

README.md

@@ -60,4 +60,14 @@ Based on:
 ### Generated
 - [java v1.0.0-beta.3] .
 ### Releases
-- [Maven Central v1.0.0-beta.3] https://central.sonatype.com/artifact/com.goshippo/sdk/1.0.0-beta.3 - .
+- [Maven Central v1.0.0-beta.3] https://central.sonatype.com/artifact/com.goshippo/sdk/1.0.0-beta.3 - .
+
+## 2025-10-20 00:23:57
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.637.0 (2.727.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [java v1.0.0-beta.1] .
+### Releases
+- [Maven Central v1.0.0-beta.1] https://central.sonatype.com/artifact/com.goshippo/shippo-sdk/1.0.0-beta.1 - .

RELEASES.md

@@ -11,14 +11,13 @@ public class Application {
     public static void main(String[] args) throws Exception {
 
         Shippo sdk = Shippo.builder()
-                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                 .shippoApiVersion("2018-02-08")
+                .apiKeyHeader(System.getenv().getOrDefault("API_KEY_HEADER", ""))
             .build();
 
         ListAddressesResponse res = sdk.addresses().list()
                 .page(1L)
                 .results(5L)
-                .shippoApiVersion("2018-02-08")
                 .call();
 
         if (res.addressPaginatedList().isPresent()) {