ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2

goshippo · Dec 23, 2024 · 7abbec1 · 7abbec1
1 parent 20d925a
commit 7abbec1
Show file tree

Hide file tree

Showing 92 changed files with 342 additions and 717 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 csharp:
-  version: 5.0.0-beta.9
+  version: 5.0.0-beta.10
   additionalDependencies: []
   author: Shippo
   clientServerStatusCodesAsErrors: true

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.447.0
+speakeasyVersion: 1.459.2
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:33370e133d3ed110a28d8f54ab74952099de562bdc22dc5386cb760f0fe01b2d
-        sourceBlobDigest: sha256:8c66d55b10c00886e8fd1f2b6ea6b233bccf17f622fed046dcf302d5da3f91f5
+        sourceRevisionDigest: sha256:2fff240d749b54e310180850573addb6dc76b773500099dd5733050589813766
+        sourceBlobDigest: sha256:cd9da3407a166b3f3649622b362cd9710086eee23be01fef701736f0c030f6ed
         tags:
             - latest
-            - speakeasy-sdk-regen-1732636811
+            - speakeasy-sdk-regen-1733098817
             - "2018-02-08"
 targets:
     csharp:
         source: openapi
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:33370e133d3ed110a28d8f54ab74952099de562bdc22dc5386cb760f0fe01b2d
-        sourceBlobDigest: sha256:8c66d55b10c00886e8fd1f2b6ea6b233bccf17f622fed046dcf302d5da3f91f5
-        codeSamplesNamespace: openapi-code-samples
-        codeSamplesRevisionDigest: sha256:647654e9271aa56042482d39883ea26ee4daadfc87152727f13dfbf47db42237
+        sourceRevisionDigest: sha256:2fff240d749b54e310180850573addb6dc76b773500099dd5733050589813766
+        sourceBlobDigest: sha256:cd9da3407a166b3f3649622b362cd9710086eee23be01fef701736f0c030f6ed
+        codeSamplesNamespace: openapi-csharp-code-samples
+        codeSamplesRevisionDigest: sha256:07dc36953b1ecd672b9175c578e955dd31a9eaa8199c9f84295ee575ebe374fb
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -34,5 +34,5 @@ workflow:
                     apiKey: $nuget_api_key
             codeSamples:
                 registry:
-                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-csharp-code-samples
                 blocking: false
diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -15,5 +15,5 @@ targets:
                 apiKey: $nuget_api_key
         codeSamples:
             registry:
-                location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                location: registry.speakeasyapi.dev/shippo/shippo/openapi-csharp-code-samples
             blocking: false
diff --git a/NUGET.md b/NUGET.md
@@ -8,7 +8,32 @@
 
 ```csharp
 using Shippo;
-using Shippo.Models.Requests;
+using Shippo.Models.Components;
+
+var sdk = new ShippoSDK(shippoApiVersion: "2018-02-08");
+
+WebhookPayloadBatch req = new WebhookPayloadBatch() {};
+
+await sdk.BatchAsync(req);
+
+// handle response
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| 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
+using Shippo;
 using Shippo.Models.Components;
 
 var sdk = new ShippoSDK(
@@ -24,7 +49,7 @@ var res = await sdk.Addresses.ListAsync(
 
 // handle response
 ```
-<!-- End SDK Example Usage [usage] -->
+<!-- End Authentication [security] -->
 
 <!-- Start Error Handling [errors] -->
 ## Error Handling
@@ -53,10 +78,9 @@ When custom error responses are specified for an operation, the SDK may also thr
 
 ```csharp
 using Shippo;
-using Shippo.Models.Requests;
 using Shippo.Models.Components;
-using System;
 using Shippo.Models.Errors;
+using Shippo.Models.Requests;
 
 var sdk = new ShippoSDK(
     apiKeyHeader: "<YOUR_API_KEY_HERE>",
@@ -108,7 +132,6 @@ catch (Exception ex)
 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(
@@ -127,36 +150,4 @@ var res = await sdk.Addresses.ListAsync(
 ```
 <!-- End Server Selection [server] -->
 
-<!-- Start Authentication [security] -->
-## Authentication
-
-### Per-Client Security Schemes
-
-This SDK supports the following security scheme globally:
-
-| 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
-using Shippo;
-using Shippo.Models.Requests;
-using Shippo.Models.Components;
-
-var sdk = new ShippoSDK(
-    apiKeyHeader: "<YOUR_API_KEY_HERE>",
-    shippoApiVersion: "2018-02-08"
-);
-
-var res = await sdk.Addresses.ListAsync(
-    page: 1,
-    results: 5,
-    shippoApiVersion: "2018-02-08"
-);
-
-// handle response
-```
-<!-- End Authentication [security] -->
-
 <!-- Placeholder for Future Speakeasy SDK Sections -->
diff --git a/README.md b/README.md
@@ -21,13 +21,17 @@ 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 C# SDK](#img-srchttpsdocsgoshippocomimageslogopng-width30-altshippo-logo-shippo-c-sdk)
+  * [SDK Installation](#sdk-installation)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Documentation](#documentation)
+  * [Available Resources and Operations](#available-resources-and-operations)
+* [Development](#development)
+  * [Contributions](#contributions)
+  * [About Shippo](#about-shippo)
 
-* [SDK Installation](#sdk-installation)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Authentication](#authentication)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -55,19 +59,13 @@ dotnet add reference Shippo/Shippo.csproj
 
 ```csharp
 using Shippo;
-using Shippo.Models.Requests;
 using Shippo.Models.Components;
 
-var sdk = new ShippoSDK(
-    apiKeyHeader: "<YOUR_API_KEY_HERE>",
-    shippoApiVersion: "2018-02-08"
-);
+var sdk = new ShippoSDK(shippoApiVersion: "2018-02-08");
 
-var res = await sdk.Addresses.ListAsync(
-    page: 1,
-    results: 5,
-    shippoApiVersion: "2018-02-08"
-);
+WebhookPayloadBatch req = new WebhookPayloadBatch() {};
+
+await sdk.BatchAsync(req);
 
 // handle response
 ```

diff --git a/RELEASES.md b/RELEASES.md
@@ -108,4 +108,14 @@ Based on:
 ### Generated
 - [csharp v5.0.0-beta.9] .
 ### Releases
-- [NuGet v5.0.0-beta.9] https://www.nuget.org/packages/Shippo/5.0.0-beta.9 - .
+- [NuGet v5.0.0-beta.9] https://www.nuget.org/packages/Shippo/5.0.0-beta.9 - .
+
+## 2024-12-23 00:18:40
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [csharp v5.0.0-beta.10] .
+### Releases
+- [NuGet v5.0.0-beta.10] https://www.nuget.org/packages/Shippo/5.0.0-beta.10 - .
diff --git a/Shippo/Addresses.cs b/Shippo/Addresses.cs
@@ -14,13 +14,13 @@ namespace Shippo
     using Shippo.Models.Components;
     using Shippo.Models.Errors;
     using Shippo.Models.Requests;
-    using Shippo.Utils.Retries;
     using Shippo.Utils;
+    using Shippo.Utils.Retries;
+    using System;
     using System.Collections.Generic;
-    using System.Net.Http.Headers;
     using System.Net.Http;
+    using System.Net.Http.Headers;
     using System.Threading.Tasks;
-    using System;
 
     /// <summary>
     /// Addresses are the locations a parcel is being shipped **from** and **to**. They represent company and residential places. Among other things, you can use address objects to create shipments, calculate shipping rates, and purchase shipping labels.<br/>
@@ -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.9";
-        private const string _sdkGenVersion = "2.463.0";
+        private const string _sdkVersion = "5.0.0-beta.10";
+        private const string _sdkGenVersion = "2.483.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.9 2.463.0 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.10 2.483.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

diff --git a/Shippo/Batches.cs b/Shippo/Batches.cs
@@ -14,13 +14,13 @@ namespace Shippo
     using Shippo.Models.Components;
     using Shippo.Models.Errors;
     using Shippo.Models.Requests;
-    using Shippo.Utils.Retries;
     using Shippo.Utils;
+    using Shippo.Utils.Retries;
+    using System;
     using System.Collections.Generic;
-    using System.Net.Http.Headers;
     using System.Net.Http;
+    using System.Net.Http.Headers;
     using System.Threading.Tasks;
-    using System;
 
     /// <summary>
     /// A batch is a technique for creating multiple labels at once. Use the  batch object to create and purchase many shipments in two API calls. After creating the batch, retrieve the batch to verify that all shipments are valid. You can add and remove shipments after you have created the batch. When all shipments are valid you can purchase the batch and retrieve all the shipping labels.<br/>
@@ -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.9";
-        private const string _sdkGenVersion = "2.463.0";
+        private const string _sdkVersion = "5.0.0-beta.10";
+        private const string _sdkGenVersion = "2.483.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.9 2.463.0 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.10 2.483.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

diff --git a/Shippo/CarrierAccounts.cs b/Shippo/CarrierAccounts.cs
@@ -14,13 +14,13 @@ namespace Shippo
     using Shippo.Models.Components;
     using Shippo.Models.Errors;
     using Shippo.Models.Requests;
-    using Shippo.Utils.Retries;
     using Shippo.Utils;
+    using Shippo.Utils.Retries;
+    using System;
     using System.Collections.Generic;
-    using System.Net.Http.Headers;
     using System.Net.Http;
+    using System.Net.Http.Headers;
     using System.Threading.Tasks;
-    using System;
 
     /// <summary>
     /// Carriers are the companies who deliver your package. Shippo uses Carrier account objects as credentials to retrieve shipping rates and purchase labels from shipping Carriers.<br/>
@@ -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.9";
-        private const string _sdkGenVersion = "2.463.0";
+        private const string _sdkVersion = "5.0.0-beta.10";
+        private const string _sdkGenVersion = "2.483.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.9 2.463.0 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.10 2.483.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

diff --git a/Shippo/CarrierParcelTemplates.cs b/Shippo/CarrierParcelTemplates.cs
@@ -14,13 +14,13 @@ namespace Shippo
     using Shippo.Models.Components;
     using Shippo.Models.Errors;
     using Shippo.Models.Requests;
-    using Shippo.Utils.Retries;
     using Shippo.Utils;
+    using Shippo.Utils.Retries;
+    using System;
     using System.Collections.Generic;
-    using System.Net.Http.Headers;
     using System.Net.Http;
+    using System.Net.Http.Headers;
     using System.Threading.Tasks;
-    using System;
 
     /// <summary>
     /// A carrier parcel template represents a package used for shipping that has preset dimensions defined by a carrier. Some examples of a carrier parcel template include USPS Flat Rate Box and Fedex Small Pak. When using a carrier parcel template, the rates returned may be limited to the carrier that provides the box. You can create user parcel templates using a carrier parcel template. Shippo takes the dimensions of the carrier parcel template but you must configure the weight.<br/>
@@ -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.9";
-        private const string _sdkGenVersion = "2.463.0";
+        private const string _sdkVersion = "5.0.0-beta.10";
+        private const string _sdkGenVersion = "2.483.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.9 2.463.0 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.10 2.483.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;

diff --git a/Shippo/CustomsDeclarations.cs b/Shippo/CustomsDeclarations.cs
@@ -14,13 +14,13 @@ namespace Shippo
     using Shippo.Models.Components;
     using Shippo.Models.Errors;
     using Shippo.Models.Requests;
-    using Shippo.Utils.Retries;
     using Shippo.Utils;
+    using Shippo.Utils.Retries;
+    using System;
     using System.Collections.Generic;
-    using System.Net.Http.Headers;
     using System.Net.Http;
+    using System.Net.Http.Headers;
     using System.Threading.Tasks;
-    using System;
 
     /// <summary>
     /// Customs declarations are relevant information, including one or multiple customs items, you need to provide for <br/>
@@ -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.9";
-        private const string _sdkGenVersion = "2.463.0";
+        private const string _sdkVersion = "5.0.0-beta.10";
+        private const string _sdkGenVersion = "2.483.1";
         private const string _openapiDocVersion = "2018-02-08";
-        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.9 2.463.0 2018-02-08 Shippo";
+        private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.10 2.483.1 2018-02-08 Shippo";
         private string _serverUrl = "";
         private ISpeakeasyHttpClient _client;
         private Func<Shippo.Models.Components.Security>? _securitySource;