ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.440.1

.speakeasy/gen.lock

@@ -1,19 +1,19 @@
 lockVersion: 2.0.0
 id: 24fc7546-e445-46cb-91d2-49cbb44a86ac
 management:
-  docChecksum: 8b7dbe00ca1ad6842796749f88d08de0
+  docChecksum: 52cef2a60d39b3cba88408f87a6c0998
   docVersion: "2018-02-08"
-  speakeasyVersion: 1.416.0
-  generationVersion: 2.438.1
-  releaseVersion: 5.0.0-beta.7
-  configChecksum: d4429a45105d8c3a1b87a1de596ed82a
+  speakeasyVersion: 1.440.1
+  generationVersion: 2.460.1
+  releaseVersion: 5.0.0-beta.8
+  configChecksum: d3357f0a163ed55bb512b334aade9bc7
   repoURL: https://github.com/goshippo/shippo-csharp-sdk.git
   published: true
 features:
   csharp:
     additionalDependencies: 0.1.0
     constsAndDefaults: 0.0.1
-    core: 3.10.3
+    core: 3.10.5
     flattening: 2.81.3
     globalSecurity: 2.83.6
     globalSecurityCallbacks: 0.1.0
@@ -22,11 +22,12 @@ features:
     globals: 2.82.1
     includes: 2.81.1
     intellisenseMarkdownSupport: 0.1.0
+    methodArguments: 0.1.0
     nameOverrides: 2.81.2
     nullables: 0.1.0
     responseFormat: 0.0.4
     sdkHooks: 0.1.0
-    unions: 0.2.1
+    unions: 0.2.2
     webhooks: 1.0.0
 generatedFiles:
   - .gitattributes
@@ -1317,7 +1318,7 @@ examples:
         header:
           SHIPPO-API-VERSION: "2018-02-08"
       requestBody:
-        application/json: {"async": false, "label_file_type": "PDF_4x6", "metadata": "Order ID #12345", "rate": "ec9f0d3adc9441449c85d315f0997fd5"}
+        application/json: {"async": false, "label_file_type": "PDF_4x6", "metadata": "Order ID #12345", "rate": "ec9f0d3adc9441449c85d315f0997fd5", "order": "adcfdddf8ec64b84ad22772bce3ea37a"}
       responses:
         "201":
           application/json: {"created_by": {"first_name": "Shwan", "last_name": "Ippotle", "username": "shippotle@shippo.com"}, "label_file_type": "PDF_4x6", "label_url": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "messages": [{"source": "UPS", "code": "carrier_timeout", "text": "UPS API did not respond. Please try again in a few minutes."}, {"source": "UPS", "code": "carrier_timeout", "text": "UPS API did not respond. Please try again in a few minutes."}], "object_id": "915d94940ea54c3a80cbfa328722f5a1", "object_owner": "shippotle@shippo.com", "parcel": "e94c7fdfdc7b495dbb390a28d929d90a", "qr_code_url": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "rate": {"amount": "5.5", "amount_local": "5.5", "currency": "USD", "currency_local": "USD", "object_id": "adcfdddf8ec64b84ad22772bce3ea37a", "provider": "USPS", "carrier_account": "078870331023437cb917f5187429b093", "servicelevel_name": "Priority Mail", "servicelevel_token": "fedex_ground"}, "status": "SUCCESS", "tracking_number": "9499907123456123456781", "tracking_status": "DELIVERED", "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781"}

.speakeasy/gen.yaml

@@ -11,15 +11,18 @@ generation:
     requestResponseComponentNamesFeb2024: true
   auth:
     oAuth2ClientCredentialsEnabled: true
+    oAuth2PasswordEnabled: false
 csharp:
-  version: 5.0.0-beta.7
+  version: 5.0.0-beta.8
   additionalDependencies: []
   author: Shippo
   clientServerStatusCodesAsErrors: true
+  defaultErrorName: SDKException
   disableNamespacePascalCasingApr2024: true
   dotnetVersion: net6.0
-  enableSourceLink: true # Enables publishing with Source Link for better debugging
+  enableSourceLink: true
   flattenGlobalSecurity: true
+  flatteningOrder: ""
   imports:
     option: openapi
     paths:
@@ -28,16 +31,19 @@ csharp:
       operations: Models/Requests
       shared: Models/Components
       webhooks: Models/Webhooks
-  includeDebugSymbols: true # Includes .pdb files for publishing a symbol package (.snupkg)
+  includeDebugSymbols: true
   inputModelSuffix: input
   license: MIT License
   maxMethodParams: 3
+  methodArguments: infer-optional-args
   outputModelSuffix: output
   packageName: Shippo
   packageTags: USPS Fedex UPS API Shippo
   responseFormat: flat
   sourceDirectory: ""
 externalDocs:
+  version: ""
   url: https://github.com/goshippo/shippo-csharp-sdk
 info:
+  version: ""
   description: .NET 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.

.speakeasy/workflow.lock

@@ -1,18 +1,20 @@
-speakeasyVersion: 1.416.0
+speakeasyVersion: 1.440.1
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:0ddcda1c29c67f7809b5008579f86846032099e709cf4fccabc3975cfc57c4f8
-        sourceBlobDigest: sha256:2c1e7bb5cb50089dd7de31676ff4c85bf469daeb1f81e5d105b34f2ec01b8a34
+        sourceRevisionDigest: sha256:6bc7d074571a45519ae2f17168f50db0f0142b5d800fb652fd4c3e191c7926ba
+        sourceBlobDigest: sha256:51772e4135f1bd71cf69231821a9fd61e29916e8296e6fc5221dbd89b54ce20b
         tags:
             - latest
-            - main
+            - speakeasy-sdk-regen-1731284305
 targets:
     csharp:
         source: openapi
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:0ddcda1c29c67f7809b5008579f86846032099e709cf4fccabc3975cfc57c4f8
-        sourceBlobDigest: sha256:2c1e7bb5cb50089dd7de31676ff4c85bf469daeb1f81e5d105b34f2ec01b8a34
+        sourceRevisionDigest: sha256:6bc7d074571a45519ae2f17168f50db0f0142b5d800fb652fd4c3e191c7926ba
+        sourceBlobDigest: sha256:51772e4135f1bd71cf69231821a9fd61e29916e8296e6fc5221dbd89b54ce20b
+        codeSamplesNamespace: openapi-code-samples
+        codeSamplesRevisionDigest: sha256:f1495867d93ebe378159fa64d32340e39aab063eda20642c049907007da89819
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -29,3 +31,7 @@ workflow:
             publish:
                 nuget:
                     apiKey: $nuget_api_key
+            codeSamples:
+                registry:
+                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                blocking: false

NUGET.md

@@ -42,12 +42,12 @@ By default, an API error will raise a `Shippo.Models.Errors.SDKException` except
 
 When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `InitiateOauth2SigninAsync` method throws the following exceptions:
 
-| Error Type                                                                   | Status Code                                                                  | Content Type                                                                 |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| Shippo.Models.Errors.InitiateOauth2SigninResponseBody                        | 400                                                                          | application/json                                                             |
-| Shippo.Models.Errors.InitiateOauth2SigninCarrierAccountsResponseBody         | 401                                                                          | application/json                                                             |
-| Shippo.Models.Errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody | 404                                                                          | application/json                                                             |
-| Shippo.Models.Errors.SDKException                                            | 4XX, 5XX                                                                     | \*/\*                                                                        |
+| Error Type                                                                   | Status Code | Content Type     |
+| ---------------------------------------------------------------------------- | ----------- | ---------------- |
+| Shippo.Models.Errors.InitiateOauth2SigninResponseBody                        | 400         | application/json |
+| Shippo.Models.Errors.InitiateOauth2SigninCarrierAccountsResponseBody         | 401         | application/json |
+| Shippo.Models.Errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody | 404         | application/json |
+| Shippo.Models.Errors.SDKException                                            | 4XX, 5XX    | \*/\*            |
 
 ### Example
 
@@ -103,20 +103,28 @@ catch (Exception ex)
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-### Select Server by Index
-
-You can override the default server globally by passing a server index to the `serverIndex: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
-
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `https://api.goshippo.com` | None |
-
+### Override Server URL Per-Client
 
+The default server can also be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example:
+```csharp
+using Shippo;
+using Shippo.Models.Requests;
+using Shippo.Models.Components;
 
+var sdk = new ShippoSDK(
+    serverUrl: "https://api.goshippo.com",
+    apiKeyHeader: "<YOUR_API_KEY_HERE>",
+    shippoApiVersion: "2018-02-08"
+);
 
-### Override Server URL Per-Client
+var res = await sdk.Addresses.ListAsync(
+    page: 1,
+    results: 5,
+    shippoApiVersion: "2018-02-08"
+);
 
-The default server can also be overridden globally by passing a URL to the `serverUrl: str` optional parameter when initializing the SDK client instance. For example:
+// handle response
+```
 <!-- End Server Selection [server] -->
 
 <!-- Start Authentication [security] -->
@@ -126,9 +134,9 @@ The default server can also be overridden globally by passing a URL to the `serv
 
 This SDK supports the following security scheme globally:
 
-| Name           | Type           | Scheme         |
-| -------------- | -------------- | -------------- |
-| `APIKeyHeader` | apiKey         | API key        |
+| Name           | Type   | Scheme  |
+| -------------- | ------ | ------- |
+| `APIKeyHeader` | apiKey | API key |
 
 To authenticate with the API the `APIKeyHeader` parameter must be set when initializing the SDK client instance. For example:
 ```csharp

RELEASES.md

@@ -88,4 +88,14 @@ Based on:
 ### Generated
 - [csharp v5.0.0-beta.7] .
 ### Releases
-- [NuGet v5.0.0-beta.7] https://www.nuget.org/packages/Shippo/5.0.0-beta.7 - .
+- [NuGet v5.0.0-beta.7] https://www.nuget.org/packages/Shippo/5.0.0-beta.7 - .
+
+## 2024-11-18 00:19:29
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.440.1 (2.460.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [csharp v5.0.0-beta.8] .
+### Releases
+- [NuGet v5.0.0-beta.8] https://www.nuget.org/packages/Shippo/5.0.0-beta.8 - .

Shippo/Addresses.cs

@@ -80,10 +80,10 @@ public class Addresses: IAddresses
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/Batches.cs

@@ -111,10 +111,10 @@ public class Batches: IBatches
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/CarrierAccounts.cs

@@ -113,10 +113,10 @@ public class CarrierAccounts: ICarrierAccounts
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/CarrierParcelTemplates.cs

@@ -70,10 +70,10 @@ public class CarrierParcelTemplates: ICarrierParcelTemplates
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/CustomsDeclarations.cs

@@ -73,10 +73,10 @@ public class CustomsDeclarations: ICustomsDeclarations
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/CustomsItems.cs

@@ -71,10 +71,10 @@ public class CustomsItems: ICustomsItems
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/Manifests.cs

@@ -83,10 +83,10 @@ public class Manifests: IManifests
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

Shippo/Models/Components/InstantTransactionCreateRequest.cs

@@ -33,5 +33,8 @@ public class InstantTransactionCreateRequest
 
         [JsonProperty("shipment")]
         public ShipmentCreateRequest Shipment { get; set; } = default!;
+
+        [JsonProperty("order")]
+        public string? Order { get; set; }
     }
 }

Shippo/Models/Components/ServiceLevelCanadaPostEnum.cs

@@ -29,6 +29,9 @@ namespace Shippo.Models.Components
     /// | canada_post_small_packet_usa_air | Small Packet USA Air|<br/>
     /// | canada_post_tracked_packet_international | Tracked Packet International|<br/>
     /// | canada_post_small_packet_international_air | Small Package International Air|<br/>
+    /// | canada_post_small_packet_international_surface  | Small Packet International Surface<br/>
+    /// | canada_post_international_parcel_surface  | International Parcel Surface<br/>
+    /// | canada_post_international_parcel_air  | International Parcel Air<br/>
     /// 
     /// </remarks>
     /// </summary>
@@ -56,6 +59,12 @@ public enum ServiceLevelCanadaPostEnum
         CanadaPostTrackedPacketInternational,
         [JsonProperty("canada_post_small_packet_international_air")]
         CanadaPostSmallPacketInternationalAir,
+        [JsonProperty("canada_post_small_packet_international_surface")]
+        CanadaPostSmallPacketInternationalSurface,
+        [JsonProperty("canada_post_international_parcel_surface")]
+        CanadaPostInternationalParcelSurface,
+        [JsonProperty("canada_post_international_parcel_air")]
+        CanadaPostInternationalParcelAir,
     }
 
     public static class ServiceLevelCanadaPostEnumExtension

Shippo/Models/Components/TransactionCreateRequest.cs

@@ -34,5 +34,8 @@ public class TransactionCreateRequest
 
         [JsonProperty("rate")]
         public string Rate { get; set; } = default!;
+
+        [JsonProperty("order")]
+        public string? Order { get; set; }
     }
 }

Shippo/Orders.cs

@@ -93,10 +93,10 @@ public class Orders: IOrders
     {
         public SDKConfig SDKConfiguration { get; private set; }
         private const string _language = "csharp";
-        private const string _sdkVersion = "5.0.0-beta.7";
-        private const string _sdkGenVersion = "2.438.1";
+        private const string _sdkVersion = "5.0.0-beta.8";
+        private const string _sdkGenVersion = "2.460.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.7 2.438.1 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.8 2.460.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;