Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.385.0
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Sep 2, 2024
1 parent 147defb commit 3d18886
Show file tree
Hide file tree
Showing 457 changed files with 3,364 additions and 2,785 deletions.
223 changes: 109 additions & 114 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
csharp:
version: 5.0.0-beta.4
version: 5.0.0-beta.5
additionalDependencies: []
author: Shippo
clientServerStatusCodesAsErrors: true
disableNamespacePascalCasingApr2024: true
dotnetVersion: net6.0
enableSourceLink: false
flattenGlobalSecurity: true
imports:
option: openapi
Expand All @@ -27,9 +28,11 @@ csharp:
operations: Models/Requests
shared: Models/Components
webhooks: Models/Webhooks
includeDebugSymbols: false
inputModelSuffix: input
license: MIT License
maxMethodParams: 3
outputModelSuffix: output
packageName: Shippo
packageTags: ""
responseFormat: flat
8 changes: 4 additions & 4 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ speakeasyVersion: 1.327.0
sources:
openapi:
sourceNamespace: openapi
sourceRevisionDigest: sha256:b5a922d3b0c4c6410583f963b8af59c7e544e81490db81bd004e86fe8cf06d45
sourceBlobDigest: sha256:d22d7427b397fc6b66ed98e3075265860e4caab1485770e98ab979ce468057f2
sourceRevisionDigest: sha256:0d76e11809b547d7a1e170ab1b092b1ed59cc5c41cb3ad2b3f7f84d798fde139
sourceBlobDigest: sha256:5ae2d6bba8d9fb79116865e0fcdc8788af057372ffbce30263b315c20224e921
tags:
- latest
- main
targets:
csharp:
source: openapi
sourceNamespace: openapi
sourceRevisionDigest: sha256:b5a922d3b0c4c6410583f963b8af59c7e544e81490db81bd004e86fe8cf06d45
sourceBlobDigest: sha256:d22d7427b397fc6b66ed98e3075265860e4caab1485770e98ab979ce468057f2
sourceRevisionDigest: sha256:0d76e11809b547d7a1e170ab1b092b1ed59cc5c41cb3ad2b3f7f84d798fde139
sourceBlobDigest: sha256:5ae2d6bba8d9fb79116865e0fcdc8788af057372ffbce30263b315c20224e921
outLocation: /github/workspace/repo
workflow:
workflowVersion: 1.0.0
Expand Down
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to This Repository

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.

## How to Report Issues

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:

- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed

## Issue Triage and Upstream Fixes

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.

## Contact

If you have any questions or need further assistance, please feel free to reach out by opening an issue.

Thank you for your understanding and cooperation!

The Maintainers
72 changes: 19 additions & 53 deletions NUGET.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,60 +8,23 @@

```csharp
using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;

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 SDK Example Usage [usage] -->

<!-- Start Global Parameters [global-parameters] -->
## Global Parameters

## Global Parameters

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.

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.


### Available Globals

The following global parameter is available.

| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| shippoApiVersion | string | | String used to pick a non-default API version to use |


### Example

```csharp
using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;

var sdk = new ShippoSDK(
apiKeyHeader: "<YOUR_API_KEY_HERE>",
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

var res = await sdk.Addresses.ListAsync(
page: 1,
results: 5,
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

// handle response
```
<!-- End Global Parameters [global-parameters] -->
<!-- End SDK Example Usage [usage] -->

<!-- Start Error Handling [errors] -->
## Error Handling
Expand All @@ -79,23 +42,25 @@ Handling errors in this SDK should largely match your expectations. All operati

```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>",
shippoApiVersion: "2018-02-08");

InitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {
CarrierAccountObjectId = "<value>",
RedirectUri = "http://fine-cummerbund.biz",
};
shippoApiVersion: "2018-02-08"
);

try
{
InitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {
CarrierAccountObjectId = "<value>",
RedirectUri = "http://fine-cummerbund.biz",
};

var res = await sdk.CarrierAccounts.InitiateOauth2SigninAsync(req);

// handle response
}
catch (Exception ex)
Expand All @@ -117,7 +82,6 @@ catch (Exception ex)
// handle exception
}
}

```
<!-- End Error Handling [errors] -->

Expand Down Expand Up @@ -154,17 +118,19 @@ This SDK supports the following security scheme globally:
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;
using Shippo.Models.Requests;
using Shippo.Models.Components;

var sdk = new ShippoSDK(
apiKeyHeader: "<YOUR_API_KEY_HERE>",
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

var res = await sdk.Addresses.ListAsync(
page: 1,
results: 5,
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

// handle response
```
Expand Down
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,38 @@ apiKeyHeader:"shippo_test_595d9cb0c0e14497bf07e75ecfec6c6d"
```


<!-- Start Summary [summary] -->
## Summary

Shippo external API.: Use this API to integrate with the Shippo service
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents

* [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] -->
## SDK Installation

### NuGet

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

### Locally

To add a reference to a local instance of the SDK in a .NET project:
```bash
dotnet add reference path/to/Shippo.csproj
dotnet add reference Shippo/Shippo.csproj
```
<!-- End SDK Installation [installation] -->

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

```csharp
using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;
using Shippo.Models.Components;

var sdk = new ShippoSDK(
apiKeyHeader: "<YOUR_API_KEY_HERE>",
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

var res = await sdk.Addresses.ListAsync(
page: 1,
results: 5,
shippoApiVersion: "2018-02-08");
shippoApiVersion: "2018-02-08"
);

// handle response
```
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,14 @@ Based on:
### Generated
- [csharp v5.0.0-beta.4] .
### Releases
- [NuGet v5.0.0-beta.4] https://www.nuget.org/packages/Shippo/5.0.0-beta.4 - .
- [NuGet v5.0.0-beta.4] https://www.nuget.org/packages/Shippo/5.0.0-beta.4 - .

## 2024-09-02 00:17:21
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [csharp v5.0.0-beta.5] .
### Releases
- [NuGet v5.0.0-beta.5] https://www.nuget.org/packages/Shippo/5.0.0-beta.5 - .
12 changes: 6 additions & 6 deletions Shippo/Addresses.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
//
// Changes to this file may cause incorrect behavior and will be lost when
// the code is regenerated.
Expand Down Expand Up @@ -80,15 +80,15 @@ public class Addresses: IAddresses
{
public SDKConfig SDKConfiguration { get; private set; }
private const string _language = "csharp";
private const string _sdkVersion = "5.0.0-beta.4";
private const string _sdkGenVersion = "2.359.6";
private const string _sdkVersion = "5.0.0-beta.5";
private const string _sdkGenVersion = "2.407.2";
private const string _openapiDocVersion = "2018-02-08";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.4 2.359.6 2018-02-08 Shippo";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.5 2.407.2 2018-02-08 Shippo";
private string _serverUrl = "";
private ISpeakeasyHttpClient _client;
private Func<Security>? _securitySource;
private Func<Shippo.Models.Components.Security>? _securitySource;

public Addresses(ISpeakeasyHttpClient client, Func<Security>? securitySource, string serverUrl, SDKConfig config)
public Addresses(ISpeakeasyHttpClient client, Func<Shippo.Models.Components.Security>? securitySource, string serverUrl, SDKConfig config)
{
_client = client;
_securitySource = securitySource;
Expand Down
12 changes: 6 additions & 6 deletions Shippo/Batches.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
//
// Changes to this file may cause incorrect behavior and will be lost when
// the code is regenerated.
Expand Down Expand Up @@ -111,15 +111,15 @@ public class Batches: IBatches
{
public SDKConfig SDKConfiguration { get; private set; }
private const string _language = "csharp";
private const string _sdkVersion = "5.0.0-beta.4";
private const string _sdkGenVersion = "2.359.6";
private const string _sdkVersion = "5.0.0-beta.5";
private const string _sdkGenVersion = "2.407.2";
private const string _openapiDocVersion = "2018-02-08";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.4 2.359.6 2018-02-08 Shippo";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.5 2.407.2 2018-02-08 Shippo";
private string _serverUrl = "";
private ISpeakeasyHttpClient _client;
private Func<Security>? _securitySource;
private Func<Shippo.Models.Components.Security>? _securitySource;

public Batches(ISpeakeasyHttpClient client, Func<Security>? securitySource, string serverUrl, SDKConfig config)
public Batches(ISpeakeasyHttpClient client, Func<Shippo.Models.Components.Security>? securitySource, string serverUrl, SDKConfig config)
{
_client = client;
_securitySource = securitySource;
Expand Down
14 changes: 7 additions & 7 deletions Shippo/CarrierAccounts.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
//
// Changes to this file may cause incorrect behavior and will be lost when
// the code is regenerated.
Expand Down Expand Up @@ -113,15 +113,15 @@ public class CarrierAccounts: ICarrierAccounts
{
public SDKConfig SDKConfiguration { get; private set; }
private const string _language = "csharp";
private const string _sdkVersion = "5.0.0-beta.4";
private const string _sdkGenVersion = "2.359.6";
private const string _sdkVersion = "5.0.0-beta.5";
private const string _sdkGenVersion = "2.407.2";
private const string _openapiDocVersion = "2018-02-08";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.4 2.359.6 2018-02-08 Shippo";
private const string _userAgent = "speakeasy-sdk/csharp 5.0.0-beta.5 2.407.2 2018-02-08 Shippo";
private string _serverUrl = "";
private ISpeakeasyHttpClient _client;
private Func<Security>? _securitySource;
private Func<Shippo.Models.Components.Security>? _securitySource;

public CarrierAccounts(ISpeakeasyHttpClient client, Func<Security>? securitySource, string serverUrl, SDKConfig config)
public CarrierAccounts(ISpeakeasyHttpClient client, Func<Shippo.Models.Components.Security>? securitySource, string serverUrl, SDKConfig config)
{
_client = client;
_securitySource = securitySource;
Expand Down Expand Up @@ -504,7 +504,7 @@ public async Task<InitiateOauth2SigninResponse> InitiateOauth2SigninAsync(Initia
int responseStatusCode = (int)httpResponse.StatusCode;
if(responseStatusCode == 302)
{
return new InitiateOauth2SigninResponse();;
return new InitiateOauth2SigninResponse();
}
else if(responseStatusCode == 400)
{
Expand Down
Loading

0 comments on commit 3d18886

Please sign in to comment.