Skip to content

Commit 01a24dd

Browse files
AndrewBenzSWAndrewBenzSW
committed
Fix some of the API doc gen
1 parent d9aa7e0 commit 01a24dd

21 files changed

+223
-266
lines changed

‎README.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ The only configuration requirement is an [API key](https://www.shipengine.com/do
2828
using ShipEngineSDK;
2929

3030
var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__");
31-
32-
var carriers = await shipengine.ListCarriers(CancellationToken.Default);
3331
```
3432

3533

@@ -462,7 +460,6 @@ API | Method | Description
462460
- [WeightUnit](docs//models/WeightUnit.md)
463461

464462

465-
466463
## Legacy Methods
467464

468465
These methods have been deprecated in favor of the methods listed above, but are still in the SDK.
@@ -489,7 +486,7 @@ To build the project locally on your computer:
489486
1. **Clone this repo**<br>
490487
`git clone https://github.com/ShipEngine/shipengine-dotnet.git`
491488

492-
2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)**
489+
2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)**
493490

494491
3. **Install dependencies**<br>
495492
`dotnet restore`

‎docs/apis/AccountApi.md‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
2-
31
# Account Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**CreateAccountImage**](AccountApi.md#createaccountimage) | **POST** /v1/account/settings/images | Create an Account Image |
8-
| [**DeleteAccountImageById**](AccountApi.md#deleteaccountimagebyid) | **DELETE** /v1/account/settings/images/{label_image_id} | Delete Account Image By Id |
9-
| [**GetAccountSettingsImagesById**](AccountApi.md#getaccountsettingsimagesbyid) | **GET** /v1/account/settings/images/{label_image_id} | Get Account Image By ID |
10-
| [**ListAccountImages**](AccountApi.md#listaccountimages) | **GET** /v1/account/settings/images | List Account Images |
11-
| [**ListAccountSettings**](AccountApi.md#listaccountsettings) | **GET** /v1/account/settings | List Account Settings |
12-
| [**UpdateAccountSettingsImagesById**](AccountApi.md#updateaccountsettingsimagesbyid) | **PUT** /v1/account/settings/images/{label_image_id} | Update Account Image By ID |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**CreateAccountImage**](AccountApi.md#createaccountimage) | Create an Account Image |
6+
| [**DeleteAccountImageById**](AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id |
7+
| [**GetAccountSettingsImagesById**](AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID |
8+
| [**ListAccountImages**](AccountApi.md#listaccountimages) | List Account Images |
9+
| [**ListAccountSettings**](AccountApi.md#listaccountsettings) | List Account Settings |
10+
| [**UpdateAccountSettingsImagesById**](AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID |
1311

1412
<a id="createaccountimage"></a>
1513
# **CreateAccountImage**
@@ -188,9 +186,9 @@ namespace Example
188186
<a id="listaccountimages"></a>
189187
# **ListAccountImages**
190188
```csharp
191-
ListAccountSettingsImagesResponseBody ListAccountImages (, CancellationToken cancellationToken = default)
189+
ListAccountSettingsImagesResponseBody ListAccountImages (CancellationToken cancellationToken = default)
192190

193-
ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, , CancellationToken cancellationToken = default)
191+
ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, CancellationToken cancellationToken = default)
194192
```
195193

196194
List Account Images
@@ -244,9 +242,9 @@ namespace Example
244242
<a id="listaccountsettings"></a>
245243
# **ListAccountSettings**
246244
```csharp
247-
GetAccountSettingsResponseBody ListAccountSettings (, CancellationToken cancellationToken = default)
245+
GetAccountSettingsResponseBody ListAccountSettings (CancellationToken cancellationToken = default)
248246

249-
GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, , CancellationToken cancellationToken = default)
247+
GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, CancellationToken cancellationToken = default)
250248
```
251249

252250
List Account Settings
@@ -300,9 +298,9 @@ namespace Example
300298
<a id="updateaccountsettingsimagesbyid"></a>
301299
# **UpdateAccountSettingsImagesById**
302300
```csharp
303-
string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default)
301+
string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)
304302

305-
string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default)
303+
string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)
306304
```
307305

308306
Update Account Image By ID

‎docs/apis/AddressesApi.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
2-
31
# Addresses Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**ParseAddress**](AddressesApi.md#parseaddress) | **PUT** /v1/addresses/recognize | Parse an address |
8-
| [**ValidateAddress**](AddressesApi.md#validateaddress) | **POST** /v1/addresses/validate | Validate An Address |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**ParseAddress**](AddressesApi.md#parseaddress) | Parse an address |
6+
| [**ValidateAddress**](AddressesApi.md#validateaddress) | Validate An Address |
97

108
<a id="parseaddress"></a>
119
# **ParseAddress**

‎docs/apis/BatchesApi.md‎

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
2-
31
# Batches Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**AddToBatch**](BatchesApi.md#addtobatch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch |
8-
| [**CreateBatch**](BatchesApi.md#createbatch) | **POST** /v1/batches | Create A Batch |
9-
| [**DeleteBatch**](BatchesApi.md#deletebatch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id |
10-
| [**GetBatchByExternalId**](BatchesApi.md#getbatchbyexternalid) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID |
11-
| [**GetBatchById**](BatchesApi.md#getbatchbyid) | **GET** /v1/batches/{batch_id} | Get Batch By ID |
12-
| [**ListBatchErrors**](BatchesApi.md#listbatcherrors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors |
13-
| [**ListBatches**](BatchesApi.md#listbatches) | **GET** /v1/batches | List Batches |
14-
| [**ProcessBatch**](BatchesApi.md#processbatch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels |
15-
| [**RemoveFromBatch**](BatchesApi.md#removefrombatch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch |
16-
| [**UpdateBatch**](BatchesApi.md#updatebatch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**AddToBatch**](BatchesApi.md#addtobatch) | Add to a Batch |
6+
| [**CreateBatch**](BatchesApi.md#createbatch) | Create A Batch |
7+
| [**DeleteBatch**](BatchesApi.md#deletebatch) | Delete Batch By Id |
8+
| [**GetBatchByExternalId**](BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID |
9+
| [**GetBatchById**](BatchesApi.md#getbatchbyid) | Get Batch By ID |
10+
| [**ListBatchErrors**](BatchesApi.md#listbatcherrors) | Get Batch Errors |
11+
| [**ListBatches**](BatchesApi.md#listbatches) | List Batches |
12+
| [**ProcessBatch**](BatchesApi.md#processbatch) | Process Batch ID Labels |
13+
| [**RemoveFromBatch**](BatchesApi.md#removefrombatch) | Remove From Batch |
14+
| [**UpdateBatch**](BatchesApi.md#updatebatch) | Update Batch By Id |
1715

1816
<a id="addtobatch"></a>
1917
# **AddToBatch**
2018
```csharp
21-
string AddToBatch (AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
19+
string AddToBatch (AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
2220

23-
string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
21+
string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
2422
```
2523

2624
Add to a Batch
@@ -310,9 +308,9 @@ namespace Example
310308
<a id="listbatcherrors"></a>
311309
# **ListBatchErrors**
312310
```csharp
313-
ListBatchErrorsResponseBody ListBatchErrors (string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default)
311+
ListBatchErrorsResponseBody ListBatchErrors (string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default)
314312

315-
ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default)
313+
ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default)
316314
```
317315

318316
Get Batch Errors
@@ -372,9 +370,9 @@ namespace Example
372370
<a id="listbatches"></a>
373371
# **ListBatches**
374372
```csharp
375-
ListBatchesResponseBody ListBatches (BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default)
373+
ListBatchesResponseBody ListBatches (BatchStatus status = null, BatchesSortBy sortBy = null, SortDir sortDir = null, string batchNumber = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default)
376374

377-
ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default)
375+
ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = null, BatchesSortBy sortBy = null, SortDir sortDir = null, string batchNumber = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default)
378376
```
379377

380378
List Batches
@@ -440,9 +438,9 @@ namespace Example
440438
<a id="processbatch"></a>
441439
# **ProcessBatch**
442440
```csharp
443-
string ProcessBatch (ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
441+
string ProcessBatch (ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
444442

445-
string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
443+
string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
446444
```
447445

448446
Process Batch ID Labels
@@ -500,9 +498,9 @@ namespace Example
500498
<a id="removefrombatch"></a>
501499
# **RemoveFromBatch**
502500
```csharp
503-
string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
501+
string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
504502

505-
string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
503+
string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
506504
```
507505

508506
Remove From Batch

‎docs/apis/CarrierAccountsApi.md‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
2-
31
# CarrierAccounts Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**ConnectCarrier**](CarrierAccountsApi.md#connectcarrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account |
8-
| [**DisconnectCarrier**](CarrierAccountsApi.md#disconnectcarrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier |
9-
| [**GetCarrierSettings**](CarrierAccountsApi.md#getcarriersettings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings |
10-
| [**UpdateCarrierSettings**](CarrierAccountsApi.md#updatecarriersettings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**ConnectCarrier**](CarrierAccountsApi.md#connectcarrier) | Connect a carrier account |
6+
| [**DisconnectCarrier**](CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier |
7+
| [**GetCarrierSettings**](CarrierAccountsApi.md#getcarriersettings) | Get carrier settings |
8+
| [**UpdateCarrierSettings**](CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings |
119

1210
<a id="connectcarrier"></a>
1311
# **ConnectCarrier**
1412
```csharp
15-
ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
13+
ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
1614

17-
ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
15+
ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
1816
```
1917

2018
Connect a carrier account
@@ -72,9 +70,9 @@ namespace Example
7270
<a id="disconnectcarrier"></a>
7371
# **DisconnectCarrier**
7472
```csharp
75-
string DisconnectCarrier (CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default)
73+
string DisconnectCarrier (CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)
7674

77-
string DisconnectCarrier (HttpClient methodClient, CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default)
75+
string DisconnectCarrier (HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)
7876
```
7977

8078
Disconnect a carrier
@@ -132,9 +130,9 @@ namespace Example
132130
<a id="getcarriersettings"></a>
133131
# **GetCarrierSettings**
134132
```csharp
135-
GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default)
133+
GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)
136134

137-
GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default)
135+
GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)
138136
```
139137

140138
Get carrier settings
@@ -192,9 +190,9 @@ namespace Example
192190
<a id="updatecarriersettings"></a>
193191
# **UpdateCarrierSettings**
194192
```csharp
195-
string UpdateCarrierSettings (CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default)
193+
string UpdateCarrierSettings (CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)
196194

197-
string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default)
195+
string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)
198196
```
199197

200198
Update carrier settings

‎docs/apis/CarriersApi.md‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
1-
2-
31
# Carriers Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**AddFundsToCarrier**](CarriersApi.md#addfundstocarrier) | **PUT** /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier |
8-
| [**DisconnectCarrierById**](CarriersApi.md#disconnectcarrierbyid) | **DELETE** /v1/carriers/{carrier_id} | Disconnect Carrier by ID |
9-
| [**GetCarrierById**](CarriersApi.md#getcarrierbyid) | **GET** /v1/carriers/{carrier_id} | Get Carrier By ID |
10-
| [**GetCarrierOptions**](CarriersApi.md#getcarrieroptions) | **GET** /v1/carriers/{carrier_id}/options | Get Carrier Options |
11-
| [**ListCarrierPackageTypes**](CarriersApi.md#listcarrierpackagetypes) | **GET** /v1/carriers/{carrier_id}/packages | List Carrier Package Types |
12-
| [**ListCarrierServices**](CarriersApi.md#listcarrierservices) | **GET** /v1/carriers/{carrier_id}/services | List Carrier Services |
13-
| [**ListCarriers**](CarriersApi.md#listcarriers) | **GET** /v1/carriers | List Carriers |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**AddFundsToCarrier**](CarriersApi.md#addfundstocarrier) | Add Funds To Carrier |
6+
| [**DisconnectCarrierById**](CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID |
7+
| [**GetCarrierById**](CarriersApi.md#getcarrierbyid) | Get Carrier By ID |
8+
| [**GetCarrierOptions**](CarriersApi.md#getcarrieroptions) | Get Carrier Options |
9+
| [**ListCarrierPackageTypes**](CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types |
10+
| [**ListCarrierServices**](CarriersApi.md#listcarrierservices) | List Carrier Services |
11+
| [**ListCarriers**](CarriersApi.md#listcarriers) | List Carriers |
1412

1513
<a id="addfundstocarrier"></a>
1614
# **AddFundsToCarrier**
1715
```csharp
18-
AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default)
16+
AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default)
1917

20-
AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default)
18+
AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default)
2119
```
2220

2321
Add Funds To Carrier
@@ -365,9 +363,9 @@ namespace Example
365363
<a id="listcarriers"></a>
366364
# **ListCarriers**
367365
```csharp
368-
GetCarriersResponseBody ListCarriers (, CancellationToken cancellationToken = default)
366+
GetCarriersResponseBody ListCarriers (CancellationToken cancellationToken = default)
369367

370-
GetCarriersResponseBody ListCarriers (HttpClient methodClient, , CancellationToken cancellationToken = default)
368+
GetCarriersResponseBody ListCarriers (HttpClient methodClient, CancellationToken cancellationToken = default)
371369
```
372370

373371
List Carriers

‎docs/apis/DownloadsApi.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
2-
31
# Downloads Methods
42

5-
| Method | HTTP request | Description |
6-
|--------|--------------|-------------|
7-
| [**DownloadFile**](DownloadsApi.md#downloadfile) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File |
3+
| Method | Description |
4+
|--------|-------------|
5+
| [**DownloadFile**](DownloadsApi.md#downloadfile) | Download File |
86

97
<a id="downloadfile"></a>
108
# **DownloadFile**
119
```csharp
12-
System.IO.Stream DownloadFile (string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default)
10+
System.IO.Stream DownloadFile (string subdir, string filename, string dir, int rotation = null, string download = null, CancellationToken cancellationToken = default)
1311

14-
System.IO.Stream DownloadFile (HttpClient methodClient, string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default)
12+
System.IO.Stream DownloadFile (HttpClient methodClient, string subdir, string filename, string dir, int rotation = null, string download = null, CancellationToken cancellationToken = default)
1513
```
1614

1715
Download File

0 commit comments

Comments
 (0)