Skip to content

Commit 0fa4249

Browse files
committed
feat: changing version and fixing documentation
1 parent 441f0ab commit 0fa4249

19 files changed

+40
-40
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Fixed handling of No Content responses
224224

225225
- Marked v2 methods as obsolete
226226

227-
## 3.0.1
227+
## 3.1.0
228228

229229
### Added
230230

ShipEngineSDK/ShipEngineSDK.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<PackageId>ShipEngine</PackageId>
55
<PackageTags>sdk;rest;api;shipping;rates;label;tracking;cost;address;validation;normalization;fedex;ups;usps;</PackageTags>
66

7-
<Version>3.0.1</Version>
7+
<Version>3.1.0</Version>
88
<Authors>ShipEngine</Authors>
99
<Company>ShipEngine</Company>
1010
<Summary>The official ShipEngine C# SDK for .NET</Summary>

docs/apis/AccountApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ namespace Example
5858
| Name | Type | Description | Notes |
5959
|------|------|-------------|-------|
6060
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
61-
| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs/\models/CreateAccountSettingsImageRequestBody.md) | | |
61+
| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs//models/CreateAccountSettingsImageRequestBody.md) | | |
6262
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6363

6464
### Return type
@@ -335,7 +335,7 @@ namespace Example
335335
| Name | Type | Description | Notes |
336336
|------|------|-------------|-------|
337337
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
338-
| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs/\models/UpdateAccountSettingsImageRequestBody.md) | | |
338+
| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs//models/UpdateAccountSettingsImageRequestBody.md) | | |
339339
| **labelImageId** | **string** | Label Image Id | |
340340
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
341341

docs/apis/AddressesApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ namespace Example
5454
| Name | Type | Description | Notes |
5555
|------|------|-------------|-------|
5656
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
57-
| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs/\models/ParseAddressRequestBody.md) | The only required field is &#x60;text&#x60;, which is the text to be parsed. You can optionally also provide an &#x60;address&#x60; containing already-known values. For example, you may already know the recipient&#39;s name, city, and country, and only want to parse the street address into separate lines. | |
57+
| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs//models/ParseAddressRequestBody.md) | The only required field is &#x60;text&#x60;, which is the text to be parsed. You can optionally also provide an &#x60;address&#x60; containing already-known values. For example, you may already know the recipient&#39;s name, city, and country, and only want to parse the street address into separate lines. | |
5858
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
5959

6060
### Return type
@@ -110,7 +110,7 @@ namespace Example
110110
| Name | Type | Description | Notes |
111111
|------|------|-------------|-------|
112112
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
113-
| **addressToValidate** | [**List&lt;AddressToValidate&gt;**](../../docs/\models/AddressToValidate.md) | | |
113+
| **addressToValidate** | [**List&lt;AddressToValidate&gt;**](../../docs//models/AddressToValidate.md) | | |
114114
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
115115

116116
### Return type

docs/apis/BatchesApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ namespace Example
6363
| Name | Type | Description | Notes |
6464
|------|------|-------------|-------|
6565
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
66-
| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs/\models/AddToBatchRequestBody.md) | | |
66+
| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs//models/AddToBatchRequestBody.md) | | |
6767
| **batchId** | **string** | Batch ID | |
6868
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6969

@@ -120,7 +120,7 @@ namespace Example
120120
| Name | Type | Description | Notes |
121121
|------|------|-------------|-------|
122122
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
123-
| **createBatchRequest** | [**CreateBatchRequest**](../../docs/\models/CreateBatchRequest.md) | | |
123+
| **createBatchRequest** | [**CreateBatchRequest**](../../docs//models/CreateBatchRequest.md) | | |
124124
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
125125

126126
### Return type
@@ -471,7 +471,7 @@ namespace Example
471471
| Name | Type | Description | Notes |
472472
|------|------|-------------|-------|
473473
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
474-
| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs/\models/ProcessBatchRequestBody.md) | | |
474+
| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs//models/ProcessBatchRequestBody.md) | | |
475475
| **batchId** | **string** | Batch ID | |
476476
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
477477

@@ -529,7 +529,7 @@ namespace Example
529529
| Name | Type | Description | Notes |
530530
|------|------|-------------|-------|
531531
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
532-
| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs/\models/RemoveFromBatchRequestBody.md) | | |
532+
| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs//models/RemoveFromBatchRequestBody.md) | | |
533533
| **batchId** | **string** | Batch ID | |
534534
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
535535

docs/apis/CarrierAccountsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ namespace Example
5858
|------|------|-------------|-------|
5959
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
6060
| **carrierName** | **CarrierName** | The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. | |
61-
| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs/\models/ConnectCarrierRequestBody.md) | | |
61+
| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs//models/ConnectCarrierRequestBody.md) | | |
6262
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6363

6464
### Return type
@@ -233,7 +233,7 @@ namespace Example
233233
|------|------|-------------|-------|
234234
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
235235
| **carrierName** | **CarrierNameWithSettings** | The carrier name, such as &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. | |
236-
| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs/\models/UpdateCarrierSettingsRequestBody.md) | | |
236+
| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs//models/UpdateCarrierSettingsRequestBody.md) | | |
237237
| **carrierId** | **string** | Carrier ID | |
238238
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
239239

docs/apis/CarriersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ namespace Example
6060
| Name | Type | Description | Notes |
6161
|------|------|-------------|-------|
6262
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
63-
| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs/\models/AddFundsToCarrierRequestBody.md) | | |
63+
| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs//models/AddFundsToCarrierRequestBody.md) | | |
6464
| **carrierId** | **string** | Carrier ID | |
6565
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6666

docs/apis/InsuranceApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ namespace Example
5656
| Name | Type | Description | Notes |
5757
|------|------|-------------|-------|
5858
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
59-
| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs/\models/AddFundsToInsuranceRequestBody.md) | | |
59+
| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs//models/AddFundsToInsuranceRequestBody.md) | | |
6060
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6161

6262
### Return type
@@ -112,7 +112,7 @@ namespace Example
112112
| Name | Type | Description | Notes |
113113
|------|------|-------------|-------|
114114
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
115-
| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs/\models/ConnectInsurerRequestBody.md) | | |
115+
| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs//models/ConnectInsurerRequestBody.md) | | |
116116
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
117117

118118
### Return type

docs/apis/LabelsApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ namespace Example
6262
| Name | Type | Description | Notes |
6363
|------|------|-------------|-------|
6464
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
65-
| **createCombinedLabelDocumentRequestBody** | [**CreateCombinedLabelDocumentRequestBody**](../../docs/\models/CreateCombinedLabelDocumentRequestBody.md) | | |
65+
| **createCombinedLabelDocumentRequestBody** | [**CreateCombinedLabelDocumentRequestBody**](../../docs//models/CreateCombinedLabelDocumentRequestBody.md) | | |
6666
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6767

6868
### Return type
@@ -118,7 +118,7 @@ namespace Example
118118
| Name | Type | Description | Notes |
119119
|------|------|-------------|-------|
120120
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
121-
| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs/\models/CreateLabelRequestBody.md) | | |
121+
| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs//models/CreateLabelRequestBody.md) | | |
122122
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
123123

124124
### Return type
@@ -175,7 +175,7 @@ namespace Example
175175
| Name | Type | Description | Notes |
176176
|------|------|-------------|-------|
177177
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
178-
| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs/\models/CreateLabelFromRateRequestBody.md) | | |
178+
| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs//models/CreateLabelFromRateRequestBody.md) | | |
179179
| **rateId** | **string** | Rate ID | |
180180
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
181181

@@ -233,7 +233,7 @@ namespace Example
233233
| Name | Type | Description | Notes |
234234
|------|------|-------------|-------|
235235
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
236-
| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs/\models/CreateLabelFromShipmentRequestBody.md) | | |
236+
| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs//models/CreateLabelFromShipmentRequestBody.md) | | |
237237
| **shipmentId** | **string** | Shipment ID | |
238238
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
239239

@@ -291,7 +291,7 @@ namespace Example
291291
| Name | Type | Description | Notes |
292292
|------|------|-------------|-------|
293293
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
294-
| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs/\models/CreateReturnLabelRequestBody.md) | | |
294+
| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs//models/CreateReturnLabelRequestBody.md) | | |
295295
| **labelId** | **string** | Label ID | |
296296
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
297297

docs/apis/ManifestsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ namespace Example
5656
| Name | Type | Description | Notes |
5757
|------|------|-------------|-------|
5858
| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | |
59-
| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs/\models/CreateManifestRequestBody.md) | | |
59+
| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs//models/CreateManifestRequestBody.md) | | |
6060
| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | |
6161

6262
### Return type
@@ -236,7 +236,7 @@ namespace Example
236236
| **shipDateEnd** | **DateTimeOffset** | ship date end range | [optional] |
237237
| **createdAtStart** | **DateTimeOffset** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] |
238238
| **createdAtEnd** | **DateTimeOffset** | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) | [optional] |
239-
| **labelIds** | [**List&lt;string&gt;**](../../docs/\models/string.md) | | [optional] |
239+
| **labelIds** | [**List&lt;string&gt;**](../../docs//models/string.md) | | [optional] |
240240
| **warehouseId** | **string** | Warehouse ID | [optional] |
241241
| **carrierId** | **string** | Carrier ID | [optional] |
242242
| **page** | **int** | Return a specific page of results. Defaults to the first page. If set to a number that&#39;s greater than the number of pages of results, an empty page is returned. | [optional] [default to 1] |

0 commit comments

Comments
 (0)