Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 5 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
!/**/*.ts
!/**/*.js
!/**/*.mjs
!/**/*.json
!/package.json
!/jsr.json
!/dist/**/*.json
!/esm/**/*.json
!/**/*.map

/eslint.config.mjs
/.oxlintrc.json
/cjs
/.tshy
/.tshy-*
Expand Down
1,711 changes: 858 additions & 853 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

10 changes: 9 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ generation:
securityFeb2025: false
sharedErrorComponentsApr2025: false
sharedNestedComponentsJan2026: false
nameOverrideFeb2026: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
Expand All @@ -28,7 +29,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 2.18.0
version: 2.19.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
Expand All @@ -43,6 +44,7 @@ typescript:
license: MIT
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
apiPromiseHelpers: false
author: Shippo
baseErrorName: ShippoError
clientServerStatusCodesAsErrors: true
Expand All @@ -52,7 +54,9 @@ typescript:
enableMCPServer: false
enableReactQuery: false
enumFormat: union
eventStreamClassName: EventStream
exportZodModelNamespace: false
fixEnumNameSanitization: false
flatAdditionalProperties: false
flattenGlobalSecurity: true
flatteningOrder: body-first
Expand Down Expand Up @@ -82,10 +86,14 @@ typescript:
packageName: shippo
preApplyUnionDiscriminators: true
preserveModelFieldNames: false
privateIdentifierPrefix: '#'
requestExtras: false
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
useOxlint: false
useTsgo: false
zodVersion: v4-mini
13 changes: 6 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
speakeasyVersion: 1.703.0
speakeasyVersion: 1.791.0
sources:
openapi:
sourceNamespace: openapi
sourceRevisionDigest: sha256:c208771df136d45dab2274136b01935cd8e58bd401d279e52a0462e7a583844e
sourceBlobDigest: sha256:9d565638d38d71cf19ab8d618d41827fd0c831d827a8325daa048ba358ef8d85
sourceRevisionDigest: sha256:2cf76f8a42391be79d350a7dffacd28b696fee0a34a8ce7fa8ab3b4b836070b3
sourceBlobDigest: sha256:4c4d7bfcf710fde4bf5cff88930e0f4da04dcd16c252eae617d5f70a5f5557dd
tags:
- latest
- speakeasy-sdk-regen-1768781767
- "2018-02-08"
targets:
first-target:
source: openapi
sourceNamespace: openapi
sourceRevisionDigest: sha256:c208771df136d45dab2274136b01935cd8e58bd401d279e52a0462e7a583844e
sourceBlobDigest: sha256:9d565638d38d71cf19ab8d618d41827fd0c831d827a8325daa048ba358ef8d85
sourceRevisionDigest: sha256:2cf76f8a42391be79d350a7dffacd28b696fee0a34a8ce7fa8ab3b4b836070b3
sourceBlobDigest: sha256:4c4d7bfcf710fde4bf5cff88930e0f4da04dcd16c252eae617d5f70a5f5557dd
codeSamplesNamespace: openapi-typescript-code-samples
codeSamplesRevisionDigest: sha256:7d5786910277818fc38b8b9be697abdd56b65945ed83b93fdc33669e5a583db9
codeSamplesRevisionDigest: sha256:a546b18a1a7c57b93ea21515d792106221adc67dfd4d8cbc7fc7c9dc85406118
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
4 changes: 2 additions & 2 deletions FUNCTIONS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Standalone Functions

> [!NOTE]
> This section is useful if you are using a bundler and targetting browsers and
> This section is useful if you are using a bundler and targeting browsers and
> runtimes where the size of an application affects performance and load times.

Every method in this SDK is also available as a standalone function. This
alternative API is suitable when targetting the browser or serverless runtimes
alternative API is suitable when targeting the browser or serverless runtimes
and using a bundler to build your application since all unused functionality
will be tree-shaken away. This includes code for unused methods, Zod schemas,
encoding helpers and response handlers. The result is dramatically smaller
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ const shippo = new Shippo({
});

async function run() {
const result = await shippo.addresses.list({
const result = await shippo.addresses.list(undefined, undefined, {
retries: {
strategy: "backoff",
backoff: {
Expand Down Expand Up @@ -270,19 +270,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.

The following example shows how to use the `"beforeRequest"` hook to to add a
custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors:
The following example shows how to:
- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors

```typescript
import { Shippo } from "shippo";
import { ProxyAgent } from "undici";
import { HTTPClient } from "shippo/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,4 +386,14 @@ Based on:
### Generated
- [typescript v2.18.0] .
### Releases
- [NPM v2.18.0] https://www.npmjs.com/package/shippo/v/2.18.0 - .
- [NPM v2.18.0] https://www.npmjs.com/package/shippo/v/2.18.0 - .

## 2026-07-27 00:30:53
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.791.0 (2.924.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v2.19.0] .
### Releases
- [NPM v2.19.0] https://www.npmjs.com/package/shippo/v/2.19.0 - .
50 changes: 25 additions & 25 deletions docs/models/components/address.md

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/models/components/addresscompletecreaterequest.md

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/models/components/addresscreaterequest.md

Large diffs are not rendered by default.

Loading
Loading