Skip to content

Commit

Permalink
Fix some of the API doc gen
Browse files Browse the repository at this point in the history
  • Loading branch information
@AndrewBenzSW
AndrewBenzSW committed Feb 5, 2025
1 parent d9aa7e0 commit 01a24dd
Show file tree
Hide file tree
Showing 21 changed files with 223 additions and 266 deletions.
5 changes: 1 addition & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ The only configuration requirement is an [API key](https://www.shipengine.com/do
using ShipEngineSDK;

var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__");

var carriers = await shipengine.ListCarriers(CancellationToken.Default);
```


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



## Legacy Methods

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

2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)**
2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)**

3. **Install dependencies**<br>
`dotnet restore`
Expand Down
30 changes: 14 additions & 16 deletions docs/apis/AccountApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@


# Account Methods

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

<a id="createaccountimage"></a>
# **CreateAccountImage**
Expand Down Expand Up @@ -188,9 +186,9 @@ namespace Example
<a id="listaccountimages"></a>
# **ListAccountImages**
```csharp
ListAccountSettingsImagesResponseBody ListAccountImages (, CancellationToken cancellationToken = default)
ListAccountSettingsImagesResponseBody ListAccountImages (CancellationToken cancellationToken = default)

ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, , CancellationToken cancellationToken = default)
ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, CancellationToken cancellationToken = default)
```

List Account Images
Expand Down Expand Up @@ -244,9 +242,9 @@ namespace Example
<a id="listaccountsettings"></a>
# **ListAccountSettings**
```csharp
GetAccountSettingsResponseBody ListAccountSettings (, CancellationToken cancellationToken = default)
GetAccountSettingsResponseBody ListAccountSettings (CancellationToken cancellationToken = default)

GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, , CancellationToken cancellationToken = default)
GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, CancellationToken cancellationToken = default)
```

List Account Settings
Expand Down Expand Up @@ -300,9 +298,9 @@ namespace Example
<a id="updateaccountsettingsimagesbyid"></a>
# **UpdateAccountSettingsImagesById**
```csharp
string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default)
string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)

string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default)
string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)
```

Update Account Image By ID
Expand Down
10 changes: 4 additions & 6 deletions docs/apis/AddressesApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@


# Addresses Methods

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

<a id="parseaddress"></a>
# **ParseAddress**
Expand Down
46 changes: 22 additions & 24 deletions docs/apis/BatchesApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@


# Batches Methods

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

<a id="addtobatch"></a>
# **AddToBatch**
```csharp
string AddToBatch (AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string AddToBatch (AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default)

string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
```

Add to a Batch
Expand Down Expand Up @@ -310,9 +308,9 @@ namespace Example
<a id="listbatcherrors"></a>
# **ListBatchErrors**
```csharp
ListBatchErrorsResponseBody ListBatchErrors (string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default)
ListBatchErrorsResponseBody ListBatchErrors (string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default)

ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default)
ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default)
```

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

ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default)
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)
```

List Batches
Expand Down Expand Up @@ -440,9 +438,9 @@ namespace Example
<a id="processbatch"></a>
# **ProcessBatch**
```csharp
string ProcessBatch (ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string ProcessBatch (ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default)

string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
```

Process Batch ID Labels
Expand Down Expand Up @@ -500,9 +498,9 @@ namespace Example
<a id="removefrombatch"></a>
# **RemoveFromBatch**
```csharp
string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default)

string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default)
string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default)
```

Remove From Batch
Expand Down
30 changes: 14 additions & 16 deletions docs/apis/CarrierAccountsApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@


# CarrierAccounts Methods

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

<a id="connectcarrier"></a>
# **ConnectCarrier**
```csharp
ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)

ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)
```

Connect a carrier account
Expand Down Expand Up @@ -72,9 +70,9 @@ namespace Example
<a id="disconnectcarrier"></a>
# **DisconnectCarrier**
```csharp
string DisconnectCarrier (CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default)
string DisconnectCarrier (CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)

string DisconnectCarrier (HttpClient methodClient, CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default)
string DisconnectCarrier (HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)
```

Disconnect a carrier
Expand Down Expand Up @@ -132,9 +130,9 @@ namespace Example
<a id="getcarriersettings"></a>
# **GetCarrierSettings**
```csharp
GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default)
GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)

GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default)
GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)
```

Get carrier settings
Expand Down Expand Up @@ -192,9 +190,9 @@ namespace Example
<a id="updatecarriersettings"></a>
# **UpdateCarrierSettings**
```csharp
string UpdateCarrierSettings (CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default)
string UpdateCarrierSettings (CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)

string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default)
string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)
```

Update carrier settings
Expand Down
28 changes: 13 additions & 15 deletions docs/apis/CarriersApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@


# Carriers Methods

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

<a id="addfundstocarrier"></a>
# **AddFundsToCarrier**
```csharp
AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default)
AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default)

AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default)
AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default)
```

Add Funds To Carrier
Expand Down Expand Up @@ -365,9 +363,9 @@ namespace Example
<a id="listcarriers"></a>
# **ListCarriers**
```csharp
GetCarriersResponseBody ListCarriers (, CancellationToken cancellationToken = default)
GetCarriersResponseBody ListCarriers (CancellationToken cancellationToken = default)

GetCarriersResponseBody ListCarriers (HttpClient methodClient, , CancellationToken cancellationToken = default)
GetCarriersResponseBody ListCarriers (HttpClient methodClient, CancellationToken cancellationToken = default)
```

List Carriers
Expand Down
12 changes: 5 additions & 7 deletions docs/apis/DownloadsApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@


# Downloads Methods

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

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

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

Download File
Expand Down
Loading

0 comments on commit 01a24dd

Please sign in to comment.