fix: all doc links in docstrings

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Next Release
+
+- Corrects all API documentation link references to point to their new locations
+
 ## v6.7.2 (2024-08-16)
 
 - Fix inclusion of `Verify` and `VerifyStrict` parameters when creating an Address as part of a larger object creation (e.g. Shipment, Order, etc.)
@@ -15,10 +19,10 @@
 ## v6.6.0 (2024-07-16)
 
 - Add new `SmartRate` service for interacting with the SmartRate API
-    - New `RecommendShipDateForShipment` function to recommend ship date for a shipment based on a desired delivery date.
-    - New `EstimateDeliveryDateForRoute` function to estimate delivery date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
-    - New `RecommendShipDateForRoute` function to to recommend ship date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
-    - New model classes as needed for JSON response to new API functions
+  - New `RecommendShipDateForShipment` function to recommend ship date for a shipment based on a desired delivery date.
+  - New `EstimateDeliveryDateForRoute` function to estimate delivery date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
+  - New `RecommendShipDateForRoute` function to to recommend ship date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
+  - New model classes as needed for JSON response to new API functions
 - Enforce one-or-other for `Shipment` and `Batch` parameters in `Pickup.Create` parameter set
 - Add internal parameter dependency utility
 

EasyPost/Models/API/Address.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Address
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#address-object">EasyPost address</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/addresses#address-object">EasyPost address</a>.
     /// </summary>
     public class Address : EasyPostObject, Parameters.IAddressParameter
     {

EasyPost/Models/API/ApiKey.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#api-key-object">EasyPost API key</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/api-keys#api-keys-object">EasyPost API key</a>.
     /// </summary>
     public class ApiKey : EasyPostObject
     {

EasyPost/Models/API/Batch.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Batch
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#batch-object">EasyPost batch</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/batches#batch-object">EasyPost batch</a>.
     /// </summary>
     public class Batch : EasyPostObject, Parameters.IBatchParameter
     {

EasyPost/Models/API/BatchShipment.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#batch-shipment-object">EasyPost batch shipment</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/batches#batchshipment-object">EasyPost batch shipment</a>.
     /// </summary>
     public class BatchShipment : EasyPostObject
     {

EasyPost/Models/API/Beta/PaymentRefund.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API.Beta
 {
     /// <summary>
-    ///     Class representing an EasyPost <see cref="Models.API.ReferralCustomer"/> <a href="https://www.easypost.com/docs/api#refund-a-referral-user">payment refund</a>.
+    ///     Class representing an EasyPost <see cref="Models.API.ReferralCustomer"/> <a href="https://docs.easypost.com/docs/users/referral-customers#refund-a-referralcustomer">payment refund</a>.
     /// </summary>
     public class PaymentRefund : EasyPostObject
     {

EasyPost/Models/API/Beta/StatelessRate.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API.Beta
 {
     /// <summary>
-    ///     Class representing an EasyPost <a href="https://www.easypost.com/docs/api#retrieve-rates-for-a-shipment">stateless rate</a>.
+    ///     Class representing an EasyPost <a href="https://docs.easypost.com/docs/shipments/rates#retrieve-rates-for-a-shipment">stateless rate</a>.
     /// </summary>
     public class StatelessRate : EphemeralEasyPostObject
     {

EasyPost/Models/API/Brand.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#child-user-object">EasyPost brand</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/users/brand#brand-object">EasyPost brand</a>.
     /// </summary>
     public class Brand : EasyPostObject
     {

EasyPost/Models/API/CarrierAccount.cs

@@ -7,7 +7,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.CarrierAccount
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#carrier-account-object">EasyPost carrier account</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/carrier-accounts#carrieraccount-object">EasyPost carrier account</a>.
     /// </summary>
     public class CarrierAccount : EasyPostObject, Parameters.ICarrierAccountParameter
     {

EasyPost/Models/API/CarrierDetail.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an EasyPost <see cref="Tracker"/>'s <a href="https://www.easypost.com/docs/api#carrier-detail-object">carrier details</a>.
+    ///     Class representing an EasyPost <see cref="Tracker"/>'s <a href="https://docs.easypost.com/docs/trackers#carrierdetail-object">carrier details</a>.
     /// </summary>
     public class CarrierDetail : EasyPostObject
     {

EasyPost/Models/API/CarrierFields.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an EasyPost <see cref="CarrierAccount"/>'s <a href="https://www.easypost.com/docs/api#carrier-account-fields-object">credentials</a>.
+    ///     Class representing an EasyPost <see cref="CarrierAccount"/>'s <a href="https://docs.easypost.com/docs/carrier-accounts#fields-object">credentials</a>.
     /// </summary>
     public class CarrierFields : EasyPostObject
     {

EasyPost/Models/API/CarrierMetadata.cs

@@ -7,7 +7,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Beta.CarrierMetadata
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#carriermetadata-object">EasyPost carrier metadata summary</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/carrier-metadata#carriermetadata-object">EasyPost carrier metadata summary</a>.
     /// </summary>
     public class CarrierMetadata : EphemeralEasyPostObject
     {

EasyPost/Models/API/CarrierType.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#carriertype-object">EasyPost carrier type</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/carrier-types#carriertype-object">EasyPost carrier type</a>.
     /// </summary>
     public class CarrierType : EasyPostObject
     {

EasyPost/Models/API/CustomsInfo.cs

@@ -6,7 +6,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.CustomInfo
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#customs-info-object">EasyPost customs info object</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/customs-infos#customsinfo-object">EasyPost customs info object</a>.
     /// </summary>
     public class CustomsInfo : EasyPostObject, Parameters.ICustomsInfoParameter
     {

EasyPost/Models/API/CustomsItem.cs

@@ -5,7 +5,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.CustomsItem
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#customs-item-object">EasyPost customs item</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/customs-items#customsitems-object">EasyPost customs item</a>.
     /// </summary>
     public class CustomsItem : EasyPostObject, Parameters.ICustomsItemParameter
     {

EasyPost/Models/API/EndShipper.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.EndShipper
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#endshipper-object">EasyPost EndShipper</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/endshippers#endshipper-object">EasyPost EndShipper</a>.
     /// </summary>
     public class EndShipper : EasyPostObject, Parameters.IEndShipperParameter
     {

EasyPost/Models/API/Error.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1716
     /// <summary>
-    ///     Represents an <a href="https://www.easypost.com/docs/api#error-object">error returned by the EasyPost API</a>.
+    ///     Represents an <a href="https://docs.easypost.com/docs/errors#error-object">error returned by the EasyPost API</a>.
     ///     These are typically informational about why a request failed (server-side validation issues, missing data, etc.).
     ///     This is different than the EasyPostError class, which represents exceptions in the EasyPost library,
     ///     such as bad HTTP status codes or local validation issues.

EasyPost/Models/API/Event.cs

@@ -9,7 +9,7 @@ namespace EasyPost.Models.API
 #pragma warning disable CA1716
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Event
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#event-object">EasyPost event</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/events#event-object">EasyPost event</a>.
     /// </summary>
     public class Event : EasyPostObject
     {
@@ -23,7 +23,7 @@ public class Event : EasyPostObject
 
         /// <summary>
         ///     The result type and event name.
-        ///     See https://www.easypost.com/docs/api#possible-event-types for a list of possible values.
+        ///     See https://docs.easypost.com/docs/events#possible-event-types for a list of possible values.
         /// </summary>
         [JsonProperty("description")]
         public string? Description { get; set; }

EasyPost/Models/API/Fee.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#fee-object">EasyPost fee</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/fees#fee-object">EasyPost fee</a>.
     /// </summary>
     public class Fee : EasyPostObject
     {

EasyPost/Models/API/Form.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#form-object">EasyPost form</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments/forms#form-object">EasyPost form</a>.
     /// </summary>
     public class Form : EasyPostObject
     {

EasyPost/Models/API/Insurance.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Insurance
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#insurance-object">EasyPost insurance object</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/insurance#insurance-object">EasyPost insurance object</a>.
     /// </summary>
     public class Insurance : EasyPostObject, Parameters.IInsuranceParameter
     {

EasyPost/Models/API/Message.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an EasyPost <see cref="Shipment"/> or <see cref="Pickup"/> <a href="https://www.easypost.com/docs/api#message-object">message</a>.
+    ///     Class representing an EasyPost <see cref="Shipment"/> or <see cref="Pickup"/> <a href="https://docs.easypost.com/docs/shipments/messages#message-object">message</a>.
     /// </summary>
     public class Message : EasyPostObject
     {

EasyPost/Models/API/Options.cs

@@ -7,7 +7,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#options-object">EasyPost options set</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments/options#options-object">EasyPost options set</a>.
     /// </summary>
     public class Options : EasyPostObject
     {
@@ -115,7 +115,7 @@
         public bool? ByDrone { get; set; }
 
         [JsonProperty("carrier_insurance_amount")]
         public string? CarrierInsuranceAmount { get; set; }
 
         /// <summary>
         ///     Assign an email address to receive carrier notifications.
@@ -167,16 +167,16 @@
         public string? CodMethod { get; set; }
 
         [JsonProperty("commercial_invoice_format")]
         public string? CommercialInvoiceFormat { get; set; }
 
         [JsonProperty("commercial_invoice_letterhead")]
         public string? CommercialInvoiceLetterhead { get; set; }
 
         [JsonProperty("commercial_invoice_signature")]
         public string? CommercialInvoiceSignature { get; set; }
 
         [JsonProperty("commercial_invoice_size")]
         public string? CommercialInvoiceSize { get; set; }
 
         /// <summary>
         ///     A description of the content of the shipment.
@@ -185,7 +185,7 @@
         public string? ContentDescription { get; set; }
 
         [JsonProperty("cost_center")]
         public string? CostCenter { get; set; }
 
         /// <summary>
         ///     Which currency this <see cref="Shipment"/> will show for rates if carrier allows.
@@ -194,10 +194,10 @@
         public string? Currency { get; set; }
 
         [JsonProperty("customs_broker_address_id")]
         public string? CustomsBrokerAddressId { get; set; }
 
         [JsonProperty("customs_include_shipping")]
         public string? CustomsIncludeShipping { get; set; }
 
         [JsonProperty("declared_value")]
         public double? DeclaredValue { get; set; }

EasyPost/Models/API/Order.cs

@@ -7,7 +7,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Order
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#order-object">EasyPost order</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/orders#order-object">EasyPost order</a>.
     /// </summary>
     public class Order : EasyPostObject, Parameters.IOrderParameter
     {

EasyPost/Models/API/Parcel.cs

@@ -5,7 +5,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Parcel
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#parcel-object">EasyPost parcel</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/parcels#parcel-object">EasyPost parcel</a>.
     /// </summary>
     public class Parcel : EasyPostObject, Parameters.IParcelParameter
     {

EasyPost/Models/API/Payload.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#payload-object">EasyPost event payload</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/events/payloads#payload-object">EasyPost event payload</a>.
     /// </summary>
     public class Payload : EasyPostObject
     {

EasyPost/Models/API/PaymentMethodsSummary.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Represents a <a href="https://www.easypost.com/docs/api#retrieve-payment-methods">summary of the primary and secondary payment methods on the user's account</a>.
+    ///     Represents a <a href="https://docs.easypost.com/docs/users/billing#retrieve-payment-methods">summary of the primary and secondary payment methods on the user's account</a>.
     /// </summary>
     public class PaymentMethodsSummary : EasyPostObject
     {

EasyPost/Models/API/Pickup.cs

@@ -9,7 +9,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Pickup
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#pickup-object">EasyPost pickup</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/pickups#pickup-object">EasyPost pickup</a>.
     /// </summary>
     public class Pickup : EasyPostObject, Parameters.IPickupParameter
     {

EasyPost/Models/API/PickupRate.cs

@@ -3,7 +3,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#pickup-rate-object">EasyPost pickup rate</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/pickups#pickuprate-object">EasyPost pickup rate</a>.
     /// </summary>
     public class PickupRate : Rate
     {

EasyPost/Models/API/PostageLabel.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#postage-label-object">EasyPost postage label</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments#postage-label-object">EasyPost postage label</a>.
     /// </summary>
     public class PostageLabel : EasyPostObject
     {

EasyPost/Models/API/Rate.cs

@@ -6,7 +6,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Beta.Rate
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#rate-object">EasyPost rate</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments/rates#rate-object">EasyPost rate</a>.
     /// </summary>
     public class Rate : EasyPostObject
     {

EasyPost/Models/API/RateWithEstimatedDeliveryDate.cs

@@ -4,7 +4,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing a <see cref="Rate"/> with an <a href="https://www.easypost.com/docs/api#retrieve-estimated-delivery-date-and-total-transit-days-across-all-rates-for-a-shipment">estimated delivery date</a>.
+    ///     Class representing a <see cref="Rate"/> with an <a href="https://docs.easypost.com/docs/shipments/shipping-smartrate#shipping-smartrate-1">estimated delivery date</a>.
     /// </summary>
     public class RateWithEstimatedDeliveryDate
     {

EasyPost/Models/API/ReferralCustomer.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.ReferralCustomer
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#referral-customers">EasyPost referral customer</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/users/referral-customers">EasyPost referral customer</a>.
     /// </summary>
     public class ReferralCustomer : EasyPostObject, Parameters.IReferralCustomerParameter
     {

EasyPost/Models/API/Refund.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Refund
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#refund-object">EasyPost refund</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/refunds#refund-object">EasyPost refund</a>.
     /// </summary>
     public class Refund : EasyPostObject, Parameters.IRefundParameter
     {

EasyPost/Models/API/Report.cs

@@ -9,7 +9,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Report
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#report-object">EasyPost report</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/reports#report-object">EasyPost report</a>.
     /// </summary>
     public class Report : EasyPostObject, Parameters.IReportParameter
     {

EasyPost/Models/API/ScanForm.cs

@@ -8,7 +8,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.ScanForm
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#scan-form-object">EasyPost scan form</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/scan-form#scanform-object">EasyPost scan form</a>.
     /// </summary>
     public class ScanForm : EasyPostObject, Parameters.IScanFormParameter
     {

EasyPost/Models/API/Shipment.cs

@@ -9,7 +9,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.Shipment
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#shipment-object">EasyPost shipment</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments#shipment-object">EasyPost shipment</a>.
     /// </summary>
     public class Shipment : EasyPostObject, Parameters.IShipmentParameter
     {

EasyPost/Models/API/SmartRate.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#smartrate">EasyPost SmartRate</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/smartrate">EasyPost SmartRate</a>.
     /// </summary>
     public class SmartRate : EasyPostObject
     {

EasyPost/Models/API/TaxIdentifier.cs

@@ -5,7 +5,7 @@ namespace EasyPost.Models.API
 {
 #pragma warning disable CA1724 // Naming conflicts with Parameters.TaxIdentifier
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#taxidentifier-object">EasyPost tax identifier</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments/tax-identifiers#taxidentifier-object">EasyPost tax identifier</a>.
     /// </summary>
     public class TaxIdentifier : EasyPostObject, Parameters.ITaxIdentifierParameter
     {

EasyPost/Models/API/TimeInTransit.cs

@@ -5,7 +5,7 @@
 namespace EasyPost.Models.API
 {
     /// <summary>
-    ///     Class representing an <a href="https://www.easypost.com/docs/api#time%20in%20transit-object">EasyPost time in transit summary</a>.
+    ///     Class representing an <a href="https://docs.easypost.com/docs/shipments/shipping-smartrate#time-in-transit-object">EasyPost time in transit summary</a>.
     /// </summary>
     public class TimeInTransit : EphemeralEasyPostObject
     {