Skip to content

Commit 4b9a83a

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.418.4
1 parent b22efa4 commit 4b9a83a

File tree

259 files changed

+6259
-3092
lines changed

Some content is hidden

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

259 files changed

+6259
-3092
lines changed

.speakeasy/gen.lock

Lines changed: 498 additions & 30 deletions
Large diffs are not rendered by default.

.speakeasy/workflow.lock

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
speakeasyVersion: 1.400.0
1+
speakeasyVersion: 1.418.4
22
sources:
33
speakeasy:
44
sourceNamespace: speakeasy
5-
sourceRevisionDigest: sha256:780f67279a06564bd229dec0bc85843b7304309e58668de26325742aa8c7b921
6-
sourceBlobDigest: sha256:88704527b94e0f552679a1b9305054543883de59097a5102e669d5f049d7929e
5+
sourceRevisionDigest: sha256:47bca971492067a07c0629d20b88479d90212694d0ada5f91ef1dbca8715a2e2
6+
sourceBlobDigest: sha256:5a33a72ecd981d0911b9b9b045e98430d055c44cbcd69f3652ec19c5b497f959
77
tags:
88
- latest
99
- main
1010
targets:
1111
speakeasy-client-sdk-csharp:
1212
source: speakeasy
1313
sourceNamespace: speakeasy
14-
sourceRevisionDigest: sha256:780f67279a06564bd229dec0bc85843b7304309e58668de26325742aa8c7b921
15-
sourceBlobDigest: sha256:88704527b94e0f552679a1b9305054543883de59097a5102e669d5f049d7929e
14+
sourceRevisionDigest: sha256:47bca971492067a07c0629d20b88479d90212694d0ada5f91ef1dbca8715a2e2
15+
sourceBlobDigest: sha256:5a33a72ecd981d0911b9b9b045e98430d055c44cbcd69f3652ec19c5b497f959
1616
codeSamplesNamespace: code-samples-csharp-speakeasy-client-sdk-csharp
17-
codeSamplesRevisionDigest: sha256:f4c81795d8921b1fc5c4ada4b7c29196d1435a034ec4c259d2c889209884384e
17+
codeSamplesRevisionDigest: sha256:cc5ce439a6dd214ba3772f4fe190e402cb46889427982b422dc9879c3535638b
1818
workflow:
1919
workflowVersion: 1.0.0
2020
speakeasyVersion: latest

NUGET.md

Lines changed: 36 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -24,44 +24,6 @@ var res = await sdk.Apis.GetApisAsync(req);
2424
```
2525
<!-- End SDK Example Usage [usage] -->
2626

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 `workspaceID` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetWorkspace`. 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-
| workspaceID | string | | The WorkspaceID parameter. |
44-
45-
46-
### Example
47-
48-
```csharp
49-
using SpeakeasySDK;
50-
using SpeakeasySDK.Models.Operations;
51-
using SpeakeasySDK.Models.Shared;
52-
53-
var sdk = new SDK(security: new Security() {
54-
APIKey = "<YOUR_API_KEY_HERE>",
55-
});
56-
57-
GetWorkspaceRequest req = new GetWorkspaceRequest() {};
58-
59-
var res = await sdk.Workspaces.GetWorkspaceAsync(req);
60-
61-
// handle response
62-
```
63-
<!-- End Global Parameters [global-parameters] -->
64-
6527
<!-- Start Retries [retries] -->
6628
## Retries
6729

@@ -79,7 +41,7 @@ var sdk = new SDK(security: new Security() {
7941

8042
GetWorkspaceAccessRequest req = new GetWorkspaceAccessRequest() {};
8143

82-
var res = await sdk.Auth.GetWorkspaceAccessAsync(
44+
var res = await sdk.Auth.GetAccessAsync(
8345
retryConfig: new RetryConfig(
8446
strategy: RetryConfig.RetryStrategy.BACKOFF,
8547
backoff: new BackoffStrategy(
@@ -89,7 +51,9 @@ var res = await sdk.Auth.GetWorkspaceAccessAsync(
8951
exponent: 1.1
9052
),
9153
retryConnectionErrors: false
92-
),req);
54+
),
55+
req
56+
);
9357

9458
// handle response
9559
```
@@ -118,7 +82,7 @@ var sdk = new SDK(
11882

11983
GetWorkspaceAccessRequest req = new GetWorkspaceAccessRequest() {};
12084

121-
var res = await sdk.Auth.GetWorkspaceAccessAsync(req);
85+
var res = await sdk.Auth.GetAccessAsync(req);
12286

12387
// handle response
12488
```
@@ -127,12 +91,23 @@ var res = await sdk.Auth.GetWorkspaceAccessAsync(req);
12791
<!-- Start Error Handling [errors] -->
12892
## Error Handling
12993

130-
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
94+
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.
95+
96+
By default, an API error will raise a `SpeakeasySDK.Models.Errors.SDKException` exception, which has the following properties:
97+
98+
| Property | Type | Description |
99+
|---------------|-----------------------|-----------------------|
100+
| `Message` | *string* | The error message |
101+
| `StatusCode` | *int* | The HTTP status code |
102+
| `RawResponse` | *HttpResponseMessage* | The raw HTTP response |
103+
| `Body` | *string* | The response content |
104+
105+
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 `DeleteApiAsync` method throws the following exceptions:
131106

132-
| Error Object | Status Code | Content Type |
107+
| Error Type | Status Code | Content Type |
133108
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
134-
| SpeakeasySDK.Models.Errors.Error | 5XX | application/json |
135-
| SpeakeasySDK.Models.Errors.SDKException | 4xx-5xx | */* |
109+
| SpeakeasySDK.Models.Errors.Error | 4XX | application/json |
110+
| SpeakeasySDK.Models.Errors.SDKException | 5XX | \*/\* |
136111

137112
### Example
138113

@@ -149,21 +124,26 @@ var sdk = new SDK(security: new Security() {
149124

150125
try
151126
{
152-
GetWorkspaceFeatureFlagsRequest req = new GetWorkspaceFeatureFlagsRequest() {};
127+
DeleteApiRequest req = new DeleteApiRequest() {
128+
ApiID = "<id>",
129+
VersionID = "<id>",
130+
};
153131

154-
var res = await sdk.Workspaces.GetWorkspaceFeatureFlagsAsync(req);
132+
var res = await sdk.Apis.DeleteApiAsync(req);
155133

156134
// handle response
157135
}
158136
catch (Exception ex)
159137
{
160138
if (ex is Error)
161139
{
162-
// handle exception
140+
// Handle exception data
141+
throw;
163142
}
164143
else if (ex is SpeakeasySDK.Models.Errors.SDKException)
165144
{
166-
// handle exception
145+
// Handle default exception
146+
throw;
167147
}
168148
}
169149
```
@@ -194,10 +174,11 @@ The default server can also be overridden globally by passing a URL to the `serv
194174

195175
This SDK supports the following security schemes globally:
196176

197-
| Name | Type | Scheme |
198-
| ----------- | ----------- | ----------- |
199-
| `APIKey` | apiKey | API key |
200-
| `Bearer` | http | HTTP Bearer |
177+
| Name | Type | Scheme |
178+
| --------------------- | --------------------- | --------------------- |
179+
| `APIKey` | apiKey | API key |
180+
| `Bearer` | http | HTTP Bearer |
181+
| `WorkspaceIdentifier` | apiKey | API key |
201182

202183
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
203184
```csharp
@@ -210,8 +191,8 @@ var sdk = new SDK(security: new Security() {
210191
});
211192

212193
DeleteApiRequest req = new DeleteApiRequest() {
213-
ApiID = "<value>",
214-
VersionID = "<value>",
194+
ApiID = "<id>",
195+
VersionID = "<id>",
215196
};
216197

217198
var res = await sdk.Apis.DeleteApiAsync(req);

0 commit comments

Comments
 (0)