Skip to content

Commit a042107

Browse files
shippo-sdks[bot]speakeasybot
shippo-sdks[bot]
and
speakeasybot
authored
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2 (#11)
Co-authored-by: speakeasybot <[email protected]>
1 parent 147defb commit a042107

File tree

465 files changed

+5471
-3466
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

465 files changed

+5471
-3466
lines changed

‎.speakeasy/gen.lock

Lines changed: 1233 additions & 551 deletions
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ generation:
1212
auth:
1313
oAuth2ClientCredentialsEnabled: true
1414
csharp:
15-
version: 5.0.0-beta.4
15+
version: 5.0.0-beta.5
1616
additionalDependencies: []
1717
author: Shippo
1818
clientServerStatusCodesAsErrors: true
1919
disableNamespacePascalCasingApr2024: true
2020
dotnetVersion: net6.0
21+
enableSourceLink: false
2122
flattenGlobalSecurity: true
2223
imports:
2324
option: openapi
@@ -27,9 +28,12 @@ csharp:
2728
operations: Models/Requests
2829
shared: Models/Components
2930
webhooks: Models/Webhooks
31+
includeDebugSymbols: false
3032
inputModelSuffix: input
3133
license: MIT License
3234
maxMethodParams: 3
3335
outputModelSuffix: output
3436
packageName: Shippo
37+
packageTags: ""
3538
responseFormat: flat
39+
sourceDirectory: ""

‎.speakeasy/workflow.lock

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
speakeasyVersion: 1.327.0
1+
speakeasyVersion: 1.401.2
22
sources:
33
openapi:
44
sourceNamespace: openapi
5-
sourceRevisionDigest: sha256:b5a922d3b0c4c6410583f963b8af59c7e544e81490db81bd004e86fe8cf06d45
6-
sourceBlobDigest: sha256:d22d7427b397fc6b66ed98e3075265860e4caab1485770e98ab979ce468057f2
5+
sourceRevisionDigest: sha256:6c174e4396bf7257a6e1e755c9cf74d699fe12acf90d720564f9bd29b3f2146a
6+
sourceBlobDigest: sha256:d20d1d724adbc75bf8db343aa4c16e626daaadbb57e55e4d1b486ea2277b1bb5
77
tags:
88
- latest
99
- main
1010
targets:
1111
csharp:
1212
source: openapi
1313
sourceNamespace: openapi
14-
sourceRevisionDigest: sha256:b5a922d3b0c4c6410583f963b8af59c7e544e81490db81bd004e86fe8cf06d45
15-
sourceBlobDigest: sha256:d22d7427b397fc6b66ed98e3075265860e4caab1485770e98ab979ce468057f2
16-
outLocation: /github/workspace/repo
14+
sourceRevisionDigest: sha256:6c174e4396bf7257a6e1e755c9cf74d699fe12acf90d720564f9bd29b3f2146a
15+
sourceBlobDigest: sha256:d20d1d724adbc75bf8db343aa4c16e626daaadbb57e55e4d1b486ea2277b1bb5
1716
workflow:
1817
workflowVersion: 1.0.0
1918
speakeasyVersion: latest

‎CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
4+
5+
## How to Report Issues
6+
7+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
8+
9+
- A clear and descriptive title
10+
- Steps to reproduce the issue
11+
- Expected and actual behavior
12+
- Any relevant logs, screenshots, or error messages
13+
- Information about your environment (e.g., operating system, software versions)
14+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
15+
16+
## Issue Triage and Upstream Fixes
17+
18+
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
19+
20+
## Contact
21+
22+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
23+
24+
Thank you for your understanding and cooperation!
25+
26+
The Maintainers

‎NUGET.md

Lines changed: 28 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -8,60 +8,23 @@
88

99
```csharp
1010
using Shippo;
11-
using Shippo.Models.Components;
1211
using Shippo.Models.Requests;
13-
14-
var sdk = new ShippoSDK(
15-
apiKeyHeader: "<YOUR_API_KEY_HERE>",
16-
shippoApiVersion: "2018-02-08");
17-
18-
var res = await sdk.Addresses.ListAsync(
19-
page: 1,
20-
results: 5,
21-
shippoApiVersion: "2018-02-08");
22-
23-
// handle response
24-
```
25-
<!-- End SDK Example Usage [usage] -->
26-
27-
<!-- Start Global Parameters [global-parameters] -->
28-
## Global Parameters
29-
30-
## Global Parameters
31-
32-
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
33-
34-
For example, you can set `SHIPPO-API-VERSION` to `"2018-02-08"` at SDK initialization and then you do not have to pass the same value on calls to operations like `List`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
35-
36-
37-
### Available Globals
38-
39-
The following global parameter is available.
40-
41-
| Name | Type | Required | Description |
42-
| ---- | ---- |:--------:| ----------- |
43-
| shippoApiVersion | string | | String used to pick a non-default API version to use |
44-
45-
46-
### Example
47-
48-
```csharp
49-
using Shippo;
5012
using Shippo.Models.Components;
51-
using Shippo.Models.Requests;
5213

5314
var sdk = new ShippoSDK(
5415
apiKeyHeader: "<YOUR_API_KEY_HERE>",
55-
shippoApiVersion: "2018-02-08");
16+
shippoApiVersion: "2018-02-08"
17+
);
5618

5719
var res = await sdk.Addresses.ListAsync(
5820
page: 1,
5921
results: 5,
60-
shippoApiVersion: "2018-02-08");
22+
shippoApiVersion: "2018-02-08"
23+
);
6124

6225
// handle response
6326
```
64-
<!-- End Global Parameters [global-parameters] -->
27+
<!-- End SDK Example Usage [usage] -->
6528

6629
<!-- Start Error Handling [errors] -->
6730
## Error Handling
@@ -79,45 +42,50 @@ Handling errors in this SDK should largely match your expectations. All operati
7942

8043
```csharp
8144
using Shippo;
45+
using Shippo.Models.Requests;
8246
using Shippo.Models.Components;
8347
using System;
8448
using Shippo.Models.Errors;
85-
using Shippo.Models.Requests;
8649

8750
var sdk = new ShippoSDK(
8851
apiKeyHeader: "<YOUR_API_KEY_HERE>",
89-
shippoApiVersion: "2018-02-08");
90-
91-
InitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {
92-
CarrierAccountObjectId = "<value>",
93-
RedirectUri = "http://fine-cummerbund.biz",
94-
};
52+
shippoApiVersion: "2018-02-08"
53+
);
9554

9655
try
9756
{
57+
InitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {
58+
CarrierAccountObjectId = "<value>",
59+
RedirectUri = "https://enlightened-mortise.com/",
60+
};
61+
9862
var res = await sdk.CarrierAccounts.InitiateOauth2SigninAsync(req);
63+
9964
// handle response
10065
}
10166
catch (Exception ex)
10267
{
10368
if (ex is InitiateOauth2SigninResponseBody)
10469
{
105-
// handle exception
70+
// Handle exception data
71+
throw;
10672
}
10773
else if (ex is InitiateOauth2SigninCarrierAccountsResponseBody)
10874
{
109-
// handle exception
75+
// Handle exception data
76+
throw;
11077
}
11178
else if (ex is InitiateOauth2SigninCarrierAccountsResponseResponseBody)
11279
{
113-
// handle exception
80+
// Handle exception data
81+
throw;
11482
}
115-
else if (ex is Shippo.Models.Errors.SDKException)
83+
else if (ex is Models.Errors.SDKException)
11684
{
117-
// handle exception
85+
// Handle default exception
86+
throw;
11887
}
11988
}
120-
12189
```
12290
<!-- End Error Handling [errors] -->
12391

@@ -154,17 +122,19 @@ This SDK supports the following security scheme globally:
154122
To authenticate with the API the `APIKeyHeader` parameter must be set when initializing the SDK client instance. For example:
155123
```csharp
156124
using Shippo;
157-
using Shippo.Models.Components;
158125
using Shippo.Models.Requests;
126+
using Shippo.Models.Components;
159127

160128
var sdk = new ShippoSDK(
161129
apiKeyHeader: "<YOUR_API_KEY_HERE>",
162-
shippoApiVersion: "2018-02-08");
130+
shippoApiVersion: "2018-02-08"
131+
);
163132

164133
var res = await sdk.Addresses.ListAsync(
165134
page: 1,
166135
results: 5,
167-
shippoApiVersion: "2018-02-08");
136+
shippoApiVersion: "2018-02-08"
137+
);
168138

169139
// handle response
170140
```

‎README.md

Lines changed: 50 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,38 @@ apiKeyHeader:"shippo_test_595d9cb0c0e14497bf07e75ecfec6c6d"
1313
```
1414

1515

16+
<!-- Start Summary [summary] -->
17+
## Summary
18+
19+
Shippo external API.: Use this API to integrate with the Shippo service
20+
<!-- End Summary [summary] -->
21+
22+
<!-- Start Table of Contents [toc] -->
23+
## Table of Contents
24+
25+
* [SDK Installation](#sdk-installation)
26+
* [SDK Example Usage](#sdk-example-usage)
27+
* [Available Resources and Operations](#available-resources-and-operations)
28+
* [Error Handling](#error-handling)
29+
* [Server Selection](#server-selection)
30+
* [Authentication](#authentication)
31+
<!-- End Table of Contents [toc] -->
32+
1633
<!-- Start SDK Installation [installation] -->
1734
## SDK Installation
1835

1936
### NuGet
2037

38+
To add the [NuGet](https://www.nuget.org/) package to a .NET project:
2139
```bash
2240
dotnet add package Shippo
2341
```
2442

2543
### Locally
2644

45+
To add a reference to a local instance of the SDK in a .NET project:
2746
```bash
28-
dotnet add reference path/to/Shippo.csproj
47+
dotnet add reference Shippo/Shippo.csproj
2948
```
3049
<!-- End SDK Installation [installation] -->
3150

@@ -36,17 +55,19 @@ dotnet add reference path/to/Shippo.csproj
3655

3756
```csharp
3857
using Shippo;
39-
using Shippo.Models.Components;
4058
using Shippo.Models.Requests;
59+
using Shippo.Models.Components;
4160

4261
var sdk = new ShippoSDK(
4362
apiKeyHeader: "<YOUR_API_KEY_HERE>",
44-
shippoApiVersion: "2018-02-08");
63+
shippoApiVersion: "2018-02-08"
64+
);
4565

4666
var res = await sdk.Addresses.ListAsync(
4767
page: 1,
4868
results: 5,
49-
shippoApiVersion: "2018-02-08");
69+
shippoApiVersion: "2018-02-08"
70+
);
5071

5172
// handle response
5273
```
@@ -101,6 +122,9 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
101122
<!-- Start Available Resources and Operations [operations] -->
102123
## Available Resources and Operations
103124

125+
<details open>
126+
<summary>Available methods</summary>
127+
104128
### [Addresses](docs/sdks/addresses/README.md)
105129

106130
* [List](docs/sdks/addresses/README.md#list) - List all addresses
@@ -126,6 +150,11 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
126150
* [Register](docs/sdks/carrieraccounts/README.md#register) - Add a Shippo carrier account
127151
* [GetRegistrationStatus](docs/sdks/carrieraccounts/README.md#getregistrationstatus) - Get Carrier Registration status
128152

153+
### [CarrierParcelTemplates](docs/sdks/carrierparceltemplates/README.md)
154+
155+
* [List](docs/sdks/carrierparceltemplates/README.md#list) - List all carrier parcel templates
156+
* [Get](docs/sdks/carrierparceltemplates/README.md#get) - Retrieve a carrier parcel templates
157+
129158
### [CustomsDeclarations](docs/sdks/customsdeclarations/README.md)
130159

131160
* [List](docs/sdks/customsdeclarations/README.md#list) - List all customs declarations
@@ -138,13 +167,6 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
138167
* [Create](docs/sdks/customsitems/README.md#create) - Create a new customs item
139168
* [Get](docs/sdks/customsitems/README.md#get) - Retrieve a customs item
140169

141-
### [RatesAtCheckout](docs/sdks/ratesatcheckout/README.md)
142-
143-
* [Create](docs/sdks/ratesatcheckout/README.md#create) - Generate a live rates request
144-
* [GetDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate) - Show current default parcel template
145-
* [UpdateDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate) - Update default parcel template
146-
* [DeleteDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate) - Clear current default parcel template
147-
148170
### [Manifests](docs/sdks/manifests/README.md)
149171

150172
* [List](docs/sdks/manifests/README.md#list) - List all manifests
@@ -157,11 +179,6 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
157179
* [Create](docs/sdks/orders/README.md#create) - Create a new order
158180
* [Get](docs/sdks/orders/README.md#get) - Retrieve an order
159181

160-
### [CarrierParcelTemplates](docs/sdks/carrierparceltemplates/README.md)
161-
162-
* [List](docs/sdks/carrierparceltemplates/README.md#list) - List all carrier parcel templates
163-
* [Get](docs/sdks/carrierparceltemplates/README.md#get) - Retrieve a carrier parcel templates
164-
165182
### [Parcels](docs/sdks/parcels/README.md)
166183

167184
* [List](docs/sdks/parcels/README.md#list) - List all parcels
@@ -178,6 +195,13 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
178195
* [ListShipmentRates](docs/sdks/rates/README.md#listshipmentrates) - Retrieve shipment rates
179196
* [ListShipmentRatesByCurrencyCode](docs/sdks/rates/README.md#listshipmentratesbycurrencycode) - Retrieve shipment rates in currency
180197

198+
### [RatesAtCheckout](docs/sdks/ratesatcheckout/README.md)
199+
200+
* [Create](docs/sdks/ratesatcheckout/README.md#create) - Generate a live rates request
201+
* [GetDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate) - Show current default parcel template
202+
* [UpdateDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate) - Update default parcel template
203+
* [DeleteDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate) - Clear current default parcel template
204+
181205
### [Refunds](docs/sdks/refunds/README.md)
182206

183207
* [Create](docs/sdks/refunds/README.md#create) - Create a refund
@@ -197,6 +221,14 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
197221
* [Create](docs/sdks/shipments/README.md#create) - Create a new shipment
198222
* [Get](docs/sdks/shipments/README.md#get) - Retrieve a shipment
199223

224+
### [ShippoAccounts](docs/sdks/shippoaccounts/README.md)
225+
226+
* [List](docs/sdks/shippoaccounts/README.md#list) - List all Shippo Accounts
227+
* [Create](docs/sdks/shippoaccounts/README.md#create) - Create a Shippo Account
228+
* [Get](docs/sdks/shippoaccounts/README.md#get) - Retrieve a Shippo Account
229+
* [Update](docs/sdks/shippoaccounts/README.md#update) - Update a Shippo Account
230+
231+
200232
### [TrackingStatus](docs/sdks/trackingstatus/README.md)
201233

202234
* [Create](docs/sdks/trackingstatus/README.md#create) - Register a tracking webhook
@@ -216,20 +248,15 @@ Review our full guides and references at [https://docs.goshippo.com/](https://do
216248
* [Get](docs/sdks/userparceltemplates/README.md#get) - Retrieves a user parcel template
217249
* [Update](docs/sdks/userparceltemplates/README.md#update) - Update an existing user parcel template
218250

219-
### [ShippoAccounts](docs/sdks/shippoaccounts/README.md)
220-
221-
* [List](docs/sdks/shippoaccounts/README.md#list) - List all Shippo Accounts
222-
* [Create](docs/sdks/shippoaccounts/README.md#create) - Create a Shippo Account
223-
* [Get](docs/sdks/shippoaccounts/README.md#get) - Retrieve a Shippo Account
224-
* [Update](docs/sdks/shippoaccounts/README.md#update) - Update a Shippo Account
225-
226251
### [Webhooks](docs/sdks/webhooks/README.md)
227252

228253
* [CreateWebhook](docs/sdks/webhooks/README.md#createwebhook) - Create a new webhook
229254
* [ListWebhooks](docs/sdks/webhooks/README.md#listwebhooks) - List all webhooks
230255
* [GetWebhook](docs/sdks/webhooks/README.md#getwebhook) - Retrieve a specific webhook
231256
* [UpdateWebhook](docs/sdks/webhooks/README.md#updatewebhook) - Update an existing webhook
232257
* [DeleteWebhook](docs/sdks/webhooks/README.md#deletewebhook) - Delete a specific webhook
258+
259+
</details>
233260
<!-- End Available Resources and Operations [operations] -->
234261

235262

0 commit comments

Comments
 (0)