Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.7
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Dec 17, 2024
1 parent 918c382 commit 12bd1ed
Show file tree
Hide file tree
Showing 448 changed files with 8,540 additions and 1,788 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/react-query
/funcs
/core.*
/__tests__
Expand Down
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
**/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts
!/**/*.js
!/**/*.map
Expand Down
44 changes: 27 additions & 17 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ generation:
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
typescript:
version: 2.14.1
version: 2.15.0
additionalDependencies:
dependencies: {}
devDependencies:
Expand Down
21 changes: 11 additions & 10 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
speakeasyVersion: 1.401.2
speakeasyVersion: 1.455.7
sources:
openapi:
sourceNamespace: openapi
sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
sourceRevisionDigest: sha256:c8995570af15a76d5808db2c54b0edef33de7970e0cab4cc056ffba6bb786213
sourceBlobDigest: sha256:1b88a763bf9a88c705175433cac246f726297ba1d331abf5d03334a6e25e9b89
tags:
- latest
- main
- speakeasy-sdk-regen-1732753737
- "2018-02-08"
targets:
first-target:
source: openapi
sourceNamespace: openapi
sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
codeSamplesNamespace: openapi-code-samples
codeSamplesRevisionDigest: sha256:df1a9ca170bc417e1e111efbc10b1f07765943764cb1cbd046d9b6efc18cfc43
sourceRevisionDigest: sha256:c8995570af15a76d5808db2c54b0edef33de7970e0cab4cc056ffba6bb786213
sourceBlobDigest: sha256:1b88a763bf9a88c705175433cac246f726297ba1d331abf5d03334a6e25e9b89
codeSamplesNamespace: openapi-typescript-code-samples
codeSamplesRevisionDigest: sha256:847e98b0dc8de9e46a17da6eebc8be8376acdf784fcabcb4457008c8894e1a97
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand All @@ -32,6 +33,6 @@ workflow:
npm:
token: $npm_token
codeSamples:
output: ""
registry:
location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
location: registry.speakeasyapi.dev/shippo/shippo/openapi-typescript-code-samples
blocking: false
2 changes: 1 addition & 1 deletion .speakeasy/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ targets:
token: $npm_token
codeSamples:
registry:
location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
location: registry.speakeasyapi.dev/shippo/shippo/openapi-typescript-code-samples
blocking: false
2 changes: 1 addition & 1 deletion FUNCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ async function run() {
const { value: result } = res;

// Handle the result
console.log(result)
console.log(result);
}

run();
Expand Down
167 changes: 85 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,22 @@ Shippo external API.: Use this API to integrate with the Shippo service

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [<img src="https://docs.goshippo.com/images/Logo.png" width="30" alt="Shippo logo"> Shippo JavaScript SDK](#img-srchttpsdocsgoshippocomimageslogopng-width30-altshippo-logo-shippo-javascript-sdk)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Custom HTTP Client](#custom-http-client)
* [Debugging](#debugging)
* [Documentation](#documentation)
* [Available Resources and Operations](#available-resources-and-operations)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
* [About Shippo](#about-shippo)

* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Debugging](#debugging)
<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
Expand Down Expand Up @@ -117,77 +121,76 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).

<summary>Available standalone functions</summary>

- [addressesCreate](docs/sdks/addresses/README.md#create)
- [addressesGet](docs/sdks/addresses/README.md#get)
- [addressesList](docs/sdks/addresses/README.md#list)
- [addressesValidate](docs/sdks/addresses/README.md#validate)
- [batchesAddShipments](docs/sdks/batches/README.md#addshipments)
- [batchesCreate](docs/sdks/batches/README.md#create)
- [batchesGet](docs/sdks/batches/README.md#get)
- [batchesPurchase](docs/sdks/batches/README.md#purchase)
- [batchesRemoveShipments](docs/sdks/batches/README.md#removeshipments)
- [carrierAccountsCreate](docs/sdks/carrieraccounts/README.md#create)
- [carrierAccountsGetRegistrationStatus](docs/sdks/carrieraccounts/README.md#getregistrationstatus)
- [carrierAccountsGet](docs/sdks/carrieraccounts/README.md#get)
- [carrierAccountsInitiateOauth2Signin](docs/sdks/carrieraccounts/README.md#initiateoauth2signin)
- [carrierAccountsList](docs/sdks/carrieraccounts/README.md#list)
- [carrierAccountsRegister](docs/sdks/carrieraccounts/README.md#register)
- [carrierAccountsUpdate](docs/sdks/carrieraccounts/README.md#update)
- [carrierParcelTemplatesGet](docs/sdks/carrierparceltemplates/README.md#get)
- [carrierParcelTemplatesList](docs/sdks/carrierparceltemplates/README.md#list)
- [customsDeclarationsCreate](docs/sdks/customsdeclarations/README.md#create)
- [customsDeclarationsGet](docs/sdks/customsdeclarations/README.md#get)
- [customsDeclarationsList](docs/sdks/customsdeclarations/README.md#list)
- [customsItemsCreate](docs/sdks/customsitems/README.md#create)
- [customsItemsGet](docs/sdks/customsitems/README.md#get)
- [customsItemsList](docs/sdks/customsitems/README.md#list)
- [manifestsCreate](docs/sdks/manifests/README.md#create)
- [manifestsGet](docs/sdks/manifests/README.md#get)
- [manifestsList](docs/sdks/manifests/README.md#list)
- [ordersCreate](docs/sdks/orders/README.md#create)
- [ordersGet](docs/sdks/orders/README.md#get)
- [ordersList](docs/sdks/orders/README.md#list)
- [parcelsCreate](docs/sdks/parcels/README.md#create)
- [parcelsGet](docs/sdks/parcels/README.md#get)
- [parcelsList](docs/sdks/parcels/README.md#list)
- [pickupsCreate](docs/sdks/pickups/README.md#create)
- [ratesAtCheckoutCreate](docs/sdks/ratesatcheckout/README.md#create)
- [ratesAtCheckoutDeleteDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate)
- [ratesAtCheckoutGetDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate)
- [ratesAtCheckoutUpdateDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate)
- [ratesGet](docs/sdks/rates/README.md#get)
- [ratesListShipmentRatesByCurrencyCode](docs/sdks/rates/README.md#listshipmentratesbycurrencycode)
- [ratesListShipmentRates](docs/sdks/rates/README.md#listshipmentrates)
- [refundsCreate](docs/sdks/refunds/README.md#create)
- [refundsGet](docs/sdks/refunds/README.md#get)
- [refundsList](docs/sdks/refunds/README.md#list)
- [serviceGroupsCreate](docs/sdks/servicegroups/README.md#create)
- [serviceGroupsDelete](docs/sdks/servicegroups/README.md#delete)
- [serviceGroupsList](docs/sdks/servicegroups/README.md#list)
- [serviceGroupsUpdate](docs/sdks/servicegroups/README.md#update)
- [shipmentsCreate](docs/sdks/shipments/README.md#create)
- [shipmentsGet](docs/sdks/shipments/README.md#get)
- [shipmentsList](docs/sdks/shipments/README.md#list)
- [shippoAccountsCreate](docs/sdks/shippoaccounts/README.md#create)
- [shippoAccountsGet](docs/sdks/shippoaccounts/README.md#get)
- [shippoAccountsList](docs/sdks/shippoaccounts/README.md#list)
- [shippoAccountsUpdate](docs/sdks/shippoaccounts/README.md#update)
- [trackingStatusCreate](docs/sdks/trackingstatus/README.md#create)
- [trackingStatusGet](docs/sdks/trackingstatus/README.md#get)
- [transactionsCreate](docs/sdks/transactions/README.md#create)
- [transactionsGet](docs/sdks/transactions/README.md#get)
- [transactionsList](docs/sdks/transactions/README.md#list)
- [userParcelTemplatesCreate](docs/sdks/userparceltemplates/README.md#create)
- [userParcelTemplatesDelete](docs/sdks/userparceltemplates/README.md#delete)
- [userParcelTemplatesGet](docs/sdks/userparceltemplates/README.md#get)
- [userParcelTemplatesList](docs/sdks/userparceltemplates/README.md#list)
- [userParcelTemplatesUpdate](docs/sdks/userparceltemplates/README.md#update)
- [webhooksCreateWebhook](docs/sdks/webhooks/README.md#createwebhook)
- [webhooksDeleteWebhook](docs/sdks/webhooks/README.md#deletewebhook)
- [webhooksGetWebhook](docs/sdks/webhooks/README.md#getwebhook)
- [webhooksListWebhooks](docs/sdks/webhooks/README.md#listwebhooks)
- [webhooksUpdateWebhook](docs/sdks/webhooks/README.md#updatewebhook)

- [`addressesCreate`](docs/sdks/addresses/README.md#create) - Create a new address
- [`addressesGet`](docs/sdks/addresses/README.md#get) - Retrieve an address
- [`addressesList`](docs/sdks/addresses/README.md#list) - List all addresses
- [`addressesValidate`](docs/sdks/addresses/README.md#validate) - Validate an address
- [`batchesAddShipments`](docs/sdks/batches/README.md#addshipments) - Add shipments to a batch
- [`batchesCreate`](docs/sdks/batches/README.md#create) - Create a batch
- [`batchesGet`](docs/sdks/batches/README.md#get) - Retrieve a batch
- [`batchesPurchase`](docs/sdks/batches/README.md#purchase) - Purchase a batch
- [`batchesRemoveShipments`](docs/sdks/batches/README.md#removeshipments) - Remove shipments from a batch
- [`carrierAccountsCreate`](docs/sdks/carrieraccounts/README.md#create) - Create a new carrier account
- [`carrierAccountsGet`](docs/sdks/carrieraccounts/README.md#get) - Retrieve a carrier account
- [`carrierAccountsGetRegistrationStatus`](docs/sdks/carrieraccounts/README.md#getregistrationstatus) - Get Carrier Registration status
- [`carrierAccountsInitiateOauth2Signin`](docs/sdks/carrieraccounts/README.md#initiateoauth2signin) - Connect an existing carrier account using OAuth 2.0
- [`carrierAccountsList`](docs/sdks/carrieraccounts/README.md#list) - List all carrier accounts
- [`carrierAccountsRegister`](docs/sdks/carrieraccounts/README.md#register) - Add a Shippo carrier account
- [`carrierAccountsUpdate`](docs/sdks/carrieraccounts/README.md#update) - Update a carrier account
- [`carrierParcelTemplatesGet`](docs/sdks/carrierparceltemplates/README.md#get) - Retrieve a carrier parcel templates
- [`carrierParcelTemplatesList`](docs/sdks/carrierparceltemplates/README.md#list) - List all carrier parcel templates
- [`customsDeclarationsCreate`](docs/sdks/customsdeclarations/README.md#create) - Create a new customs declaration
- [`customsDeclarationsGet`](docs/sdks/customsdeclarations/README.md#get) - Retrieve a customs declaration
- [`customsDeclarationsList`](docs/sdks/customsdeclarations/README.md#list) - List all customs declarations
- [`customsItemsCreate`](docs/sdks/customsitems/README.md#create) - Create a new customs item
- [`customsItemsGet`](docs/sdks/customsitems/README.md#get) - Retrieve a customs item
- [`customsItemsList`](docs/sdks/customsitems/README.md#list) - List all customs items
- [`manifestsCreate`](docs/sdks/manifests/README.md#create) - Create a new manifest
- [`manifestsGet`](docs/sdks/manifests/README.md#get) - Retrieve a manifest
- [`manifestsList`](docs/sdks/manifests/README.md#list) - List all manifests
- [`ordersCreate`](docs/sdks/orders/README.md#create) - Create a new order
- [`ordersGet`](docs/sdks/orders/README.md#get) - Retrieve an order
- [`ordersList`](docs/sdks/orders/README.md#list) - List all orders
- [`parcelsCreate`](docs/sdks/parcels/README.md#create) - Create a new parcel
- [`parcelsGet`](docs/sdks/parcels/README.md#get) - Retrieve an existing parcel
- [`parcelsList`](docs/sdks/parcels/README.md#list) - List all parcels
- [`pickupsCreate`](docs/sdks/pickups/README.md#create) - Create a pickup
- [`ratesAtCheckoutCreate`](docs/sdks/ratesatcheckout/README.md#create) - Generate a live rates request
- [`ratesAtCheckoutDeleteDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate) - Clear current default parcel template
- [`ratesAtCheckoutGetDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate) - Show current default parcel template
- [`ratesAtCheckoutUpdateDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate) - Update default parcel template
- [`ratesGet`](docs/sdks/rates/README.md#get) - Retrieve a rate
- [`ratesListShipmentRates`](docs/sdks/rates/README.md#listshipmentrates) - Retrieve shipment rates
- [`ratesListShipmentRatesByCurrencyCode`](docs/sdks/rates/README.md#listshipmentratesbycurrencycode) - Retrieve shipment rates in currency
- [`refundsCreate`](docs/sdks/refunds/README.md#create) - Create a refund
- [`refundsGet`](docs/sdks/refunds/README.md#get) - Retrieve a refund
- [`refundsList`](docs/sdks/refunds/README.md#list) - List all refunds
- [`serviceGroupsCreate`](docs/sdks/servicegroups/README.md#create) - Create a new service group
- [`serviceGroupsDelete`](docs/sdks/servicegroups/README.md#delete) - Delete a service group
- [`serviceGroupsList`](docs/sdks/servicegroups/README.md#list) - List all service groups
- [`serviceGroupsUpdate`](docs/sdks/servicegroups/README.md#update) - Update an existing service group
- [`shipmentsCreate`](docs/sdks/shipments/README.md#create) - Create a new shipment
- [`shipmentsGet`](docs/sdks/shipments/README.md#get) - Retrieve a shipment
- [`shipmentsList`](docs/sdks/shipments/README.md#list) - List all shipments
- [`shippoAccountsCreate`](docs/sdks/shippoaccounts/README.md#create) - Create a Shippo Account
- [`shippoAccountsGet`](docs/sdks/shippoaccounts/README.md#get) - Retrieve a Shippo Account
- [`shippoAccountsList`](docs/sdks/shippoaccounts/README.md#list) - List all Shippo Accounts
- [`shippoAccountsUpdate`](docs/sdks/shippoaccounts/README.md#update) - Update a Shippo Account
- [`trackingStatusCreate`](docs/sdks/trackingstatus/README.md#create) - Register a tracking webhook
- [`trackingStatusGet`](docs/sdks/trackingstatus/README.md#get) - Get a tracking status
- [`transactionsCreate`](docs/sdks/transactions/README.md#create) - Create a shipping label
- [`transactionsGet`](docs/sdks/transactions/README.md#get) - Retrieve a shipping label
- [`transactionsList`](docs/sdks/transactions/README.md#list) - List all shipping labels
- [`userParcelTemplatesCreate`](docs/sdks/userparceltemplates/README.md#create) - Create a new user parcel template
- [`userParcelTemplatesDelete`](docs/sdks/userparceltemplates/README.md#delete) - Delete a user parcel template
- [`userParcelTemplatesGet`](docs/sdks/userparceltemplates/README.md#get) - Retrieves a user parcel template
- [`userParcelTemplatesList`](docs/sdks/userparceltemplates/README.md#list) - List all user parcel templates
- [`userParcelTemplatesUpdate`](docs/sdks/userparceltemplates/README.md#update) - Update an existing user parcel template
- [`webhooksCreateWebhook`](docs/sdks/webhooks/README.md#createwebhook) - Create a new webhook
- [`webhooksDeleteWebhook`](docs/sdks/webhooks/README.md#deletewebhook) - Delete a specific webhook
- [`webhooksGetWebhook`](docs/sdks/webhooks/README.md#getwebhook) - Retrieve a specific webhook
- [`webhooksListWebhooks`](docs/sdks/webhooks/README.md#listwebhooks) - List all webhooks
- [`webhooksUpdateWebhook`](docs/sdks/webhooks/README.md#updatewebhook) - Update an existing webhook

</details>
<!-- End Standalone functions [standalone-funcs] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,4 +336,14 @@ Based on:
### Generated
- [typescript v2.14.1] .
### Releases
- [NPM v2.14.1] https://www.npmjs.com/package/shippo/v/2.14.1 - .
- [NPM v2.14.1] https://www.npmjs.com/package/shippo/v/2.14.1 - .

## 2024-12-17 00:29:24
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.455.7 (2.480.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v2.15.0] .
### Releases
- [NPM v2.15.0] https://www.npmjs.com/package/shippo/v/2.15.0 - .
19 changes: 6 additions & 13 deletions docs/models/components/addressfrom.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# AddressFrom

## Example Usage

```typescript
import { AddressFrom } from "shippo/models/components";
## Supported Types

### `components.AddressCreateRequest`

let value: AddressFrom = {
```typescript
const value: components.AddressCreateRequest = {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
Expand All @@ -23,17 +24,9 @@ let value: AddressFrom = {
};
```

## Supported Types

### `components.AddressCreateRequest`

```typescript
const value: components.AddressCreateRequest = /* values here */
```

### `string`

```typescript
const value: string = /* values here */
const value: string = "d799c2679e644279b59fe661ac8fa488";
```

19 changes: 6 additions & 13 deletions docs/models/components/addressreturn.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# AddressReturn

## Example Usage

```typescript
import { AddressReturn } from "shippo/models/components";
## Supported Types

### `components.AddressCreateRequest`

let value: AddressReturn = {
```typescript
const value: components.AddressCreateRequest = {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
Expand All @@ -23,17 +24,9 @@ let value: AddressReturn = {
};
```

## Supported Types

### `components.AddressCreateRequest`

```typescript
const value: components.AddressCreateRequest = /* values here */
```

### `string`

```typescript
const value: string = /* values here */
const value: string = "d799c2679e644279b59fe661ac8fa488";
```

19 changes: 6 additions & 13 deletions docs/models/components/addressto.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# AddressTo

## Example Usage

```typescript
import { AddressTo } from "shippo/models/components";
## Supported Types

### `components.AddressCreateRequest`

let value: AddressTo = {
```typescript
const value: components.AddressCreateRequest = {
name: "Shwan Ippotle",
company: "Shippo",
street1: "215 Clayton St.",
Expand All @@ -23,17 +24,9 @@ let value: AddressTo = {
};
```

## Supported Types

### `components.AddressCreateRequest`

```typescript
const value: components.AddressCreateRequest = /* values here */
```

### `string`

```typescript
const value: string = /* values here */
const value: string = "d799c2679e644279b59fe661ac8fa489";
```

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { AddressValidationResultsMessageCodeEnum } from "shippo/models/components";

let value: AddressValidationResultsMessageCodeEnum = "Multiple Responses";
let value: AddressValidationResultsMessageCodeEnum = "geocoded_street";
```

## Values
Expand Down
Loading

0 comments on commit 12bd1ed

Please sign in to comment.