Add legacy docs and remove commented code

ShipEngine · Jul 9, 2024 · 5176c5c · 5176c5c
1 parent 28b7661
commit 5176c5c
Show file tree

Hide file tree

Showing 241 changed files with 32 additions and 322 deletions.
diff --git a/README.md b/README.md
@@ -485,6 +485,22 @@ API | Method | HTTP request | Description
  - [Model.WeightUnit](docs/WeightUnit.md)
 
 
+
+## Legacy Methods
+
+These methods have been deprecated in favor of the methods listed above, but are still in the SDK.
+
+- [`CreateLabelFromRate`](./docs/legacy/CreateLabelFromRate.md) - When retrieving rates for shipments using the `GetRatesWithShipmentDetails` method, the returned information contains a `RateId` property that can be used to purchase a label without having to refill in the shipment information repeatedly.
+- [`CreateLabelFromShipmentDetails`](./docs/legacy/CreateLabelFromShipmentDetails.md) - Purchase and print a label for shipment.
+- [`GetRatesWithShipmentDetails`](./docs/legacy/GetRatesWithShipmentDetails.md) - Given some shipment details and rate options, this method returns a list of rate quotes.
+- [`ListCarriers`](./docs/legacy/ListCarriers.md) - Returns a list of carrier accounts that have been connected through
+  the [ShipEngine dashboard](https://www.shipengine.com/docs/carriers/setup/).
+- [`TrackUsingLabelId`](./docs/legacy/TrackUsingLabelId.md) - Track a package by its associated label ID.
+- [`TrackUsingCarrierCodeAndTrackingNumber`](./docs/legacy/TrackUsingCarrierCodeAndTrackingNumber.md) - Track a package for a given carrier and tracking number.
+- [`ValidateAddresses`](./docs/legacy/ValidateAddresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.
+- [`VoidLabelWithLabelId`](./docs/legacy/VoidLabelWithLabelId.md) - Void a label with its Label ID.
+- [`CreateManifests`](./docs/legacy/CreateManifest.md) - Create a shipment manifest.
+
 ## Contributing
 
 Contributions, enhancements, and bug-fixes are welcome! [Open an issue](https://github.com/ShipEngine/shipengine-dotnet/issues) on GitHub and [submit a pull request](https://github.com/ShipEngine/shipengine-dotnet/pulls).

diff --git a/README_old.md b/README_old.md
diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A ShipEngine account settings response body
 /// </summary>
-//[DataContract(Name = "account_settings")]
 public partial class AccountSettings
 {
 

diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A ShipEngine account images body
 /// </summary>
-//[DataContract(Name = "account_settings_images")]
 public partial class AccountSettingsImages
 {
     //    

diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An add funds to carrier request body
 /// </summary>
-//[DataContract(Name = "add_funds_to_carrier_request_body")]
 public partial class AddFundsToCarrierRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// The current balance of the requested carrier account
 /// </summary>
-//[DataContract(Name = "add_funds_to_carrier_response_body")]
 public partial class AddFundsToCarrierResponseBody
 {
 

diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An add funds to insurance request body
 /// </summary>
-//[DataContract(Name = "add_funds_to_insurance_request_body")]
 public partial class AddFundsToInsuranceRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Add funds to insurance response body
 /// </summary>
-//[DataContract(Name = "add_funds_to_insurance_response_body")]
 public partial class AddFundsToInsuranceResponseBody
 {
 

diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An add to batch request body
 /// </summary>
-//[DataContract(Name = "add_to_batch_request_body")]
 public partial class AddToBatchRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Any residential or business mailing address, anywhere in the world.  &gt; **Note:** Either &#x60;name&#x60; or &#x60;company_name&#x60; must be set. Both may be specified, if relevant. 
 /// </summary>
-//[DataContract(Name = "address")]
 public partial class Address
 {
 

diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Any residential or business mailing address, anywhere in the world. 
 /// </summary>
-//[DataContract(Name = "address_to_validate")]
 public partial class AddressToValidate
 {
 

diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An address validating shipment
 /// </summary>
-//[DataContract(Name = "address_validating_shipment")]
 public partial class AddressValidatingShipment
 {
 

diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An address validation result
 /// </summary>
-//[DataContract(Name = "address_validation_result")]
 public partial class AddressValidationResult
 {
 

diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Advanced shipment options
 /// </summary>
-//[DataContract(Name = "advanced_shipment_options")]
 public partial class AdvancedShipmentOptions
 {
 

diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Contact information for Dangerous goods
 /// </summary>
-//[DataContract(Name = "advanced_shipment_options_dangerous_goods_contact")]
 public partial class AdvancedShipmentOptionsDangerousGoodsContact
 {
 

diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Provide details for the Fedex freight service
 /// </summary>
-//[DataContract(Name = "advanced_shipment_options_fedex_freight")]
 public partial class AdvancedShipmentOptionsFedexFreight
 {
 

diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Additional information some carriers may provide by which to identify a given label in their system.  
 /// </summary>
-//[DataContract(Name = "alternative_identifier")]
 public partial class AlternativeIdentifier
 {
 

diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// AlternativeIdentifiers
 /// </summary>
-//[DataContract(Name = "alternative_identifiers")]
 public partial class AlternativeIdentifiers
 {
 

diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time. 
 /// </summary>
-//[DataContract(Name = "batch")]
 public partial class Batch
 {
 

diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A batch response error
 /// </summary>
-//[DataContract(Name = "batch_response_error")]
 public partial class BatchResponseError
 {
 

diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A bulk rate
 /// </summary>
-//[DataContract(Name = "bulk_rate")]
 public partial class BulkRate
 {
 

diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A rate shipment response body
 /// </summary>
-//[DataContract(Name = "calculate_rates_response_body")]
 public partial class CalculateRatesResponseBody
 {
 

diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A carrier object that represents a provider such as UPS, USPS, DHL, etc that has been tied to the current account. 
 /// </summary>
-//[DataContract(Name = "carrier")]
 public partial class Carrier
 {
 

diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Advanced options that are specific to the carrier
 /// </summary>
-//[DataContract(Name = "carrier_advanced_option")]
 public partial class CarrierAdvancedOption
 {
 

diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// Defer payment until package is delivered, instead of when it is ordered.
 /// </summary>
-//[DataContract(Name = "collect_on_delivery")]
 public partial class CollectOnDelivery
 {
 

diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An Access Worldwide account information request body
 /// </summary>
-//[DataContract(Name = "connect_access_worldwide_request_body")]
 public partial class ConnectAccessWorldwideRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An Amazon account information request body
 /// </summary>
-//[DataContract(Name = "connect_amazon_buy_shipping_request_body")]
 public partial class ConnectAmazonBuyShippingRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An Amazon Shipping UK account information request body
 /// </summary>
-//[DataContract(Name = "connect_amazon_shipping_uk")]
 public partial class ConnectAmazonShippingUk
 {
 

diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An APC account information request body
 /// </summary>
-//[DataContract(Name = "connect_apc_request_body")]
 public partial class ConnectApcRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An Asendia account information request body
 /// </summary>
-//[DataContract(Name = "connect_asendia_request_body")]
 public partial class ConnectAsendiaRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// An Australia Post account information request body
 /// </summary>
-//[DataContract(Name = "connect_australia_post_request_body")]
 public partial class ConnectAustraliaPostRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A Canada Post account information request body
 /// </summary>
-//[DataContract(Name = "connect_canada_post_request_body")]
 public partial class ConnectCanadaPostRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A connect account response body
 /// </summary>
-//[DataContract(Name = "connect_carrier_response_body")]
 public partial class ConnectCarrierResponseBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A DHL Ecommerce account information request body
 /// </summary>
-//[DataContract(Name = "connect_dhl_ecommerce_request_body")]
 public partial class ConnectDhlEcommerceRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A DHL Express AU account information request body
 /// </summary>
-//[DataContract(Name = "connect_dhl_express_au_request_body")]
 public partial class ConnectDhlExpressAuRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A DHL Express CA account information request body
 /// </summary>
-//[DataContract(Name = "connect_dhl_express_ca_request_body")]
 public partial class ConnectDhlExpressCaRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A DHL express account information request body
 /// </summary>
-//[DataContract(Name = "connect_dhl_express_request_body")]
 public partial class ConnectDhlExpressRequestBody
 {
 

diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs
@@ -25,7 +25,6 @@ namespace ShipEngineSDK.Model;
 /// <summary>
 /// A DHL Express UK account information request body
 /// </summary>
-//[DataContract(Name = "connect_dhl_express_uk_request_body")]
 public partial class ConnectDhlExpressUkRequestBody
 {