diff --git a/CHANGELOG.md b/CHANGELOG.md index c5997ed53..5b5d2e1c5 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/EasyPost/Models/API/Address.cs b/EasyPost/Models/API/Address.cs index 131e244ad..2aab17b9b 100644 --- a/EasyPost/Models/API/Address.cs +++ b/EasyPost/Models/API/Address.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Address /// - /// Class representing an EasyPost address. + /// Class representing an EasyPost address. /// public class Address : EasyPostObject, Parameters.IAddressParameter { diff --git a/EasyPost/Models/API/ApiKey.cs b/EasyPost/Models/API/ApiKey.cs index 17a0a2fed..bec334821 100644 --- a/EasyPost/Models/API/ApiKey.cs +++ b/EasyPost/Models/API/ApiKey.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost API key. + /// Class representing an EasyPost API key. /// public class ApiKey : EasyPostObject { diff --git a/EasyPost/Models/API/Batch.cs b/EasyPost/Models/API/Batch.cs index f83089d85..29a54bd9f 100644 --- a/EasyPost/Models/API/Batch.cs +++ b/EasyPost/Models/API/Batch.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Batch /// - /// Class representing an EasyPost batch. + /// Class representing an EasyPost batch. /// public class Batch : EasyPostObject, Parameters.IBatchParameter { diff --git a/EasyPost/Models/API/BatchShipment.cs b/EasyPost/Models/API/BatchShipment.cs index 6bc6c6d34..9547da2bf 100644 --- a/EasyPost/Models/API/BatchShipment.cs +++ b/EasyPost/Models/API/BatchShipment.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost batch shipment. + /// Class representing an EasyPost batch shipment. /// public class BatchShipment : EasyPostObject { diff --git a/EasyPost/Models/API/Beta/PaymentRefund.cs b/EasyPost/Models/API/Beta/PaymentRefund.cs index 951de9b06..423b24c3b 100644 --- a/EasyPost/Models/API/Beta/PaymentRefund.cs +++ b/EasyPost/Models/API/Beta/PaymentRefund.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API.Beta { /// - /// Class representing an EasyPost payment refund. + /// Class representing an EasyPost payment refund. /// public class PaymentRefund : EasyPostObject { diff --git a/EasyPost/Models/API/Beta/StatelessRate.cs b/EasyPost/Models/API/Beta/StatelessRate.cs index b4a57ffe8..6a1146b8d 100644 --- a/EasyPost/Models/API/Beta/StatelessRate.cs +++ b/EasyPost/Models/API/Beta/StatelessRate.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API.Beta { /// - /// Class representing an EasyPost stateless rate. + /// Class representing an EasyPost stateless rate. /// public class StatelessRate : EphemeralEasyPostObject { diff --git a/EasyPost/Models/API/Brand.cs b/EasyPost/Models/API/Brand.cs index 5ee400a0d..ae3c583c8 100644 --- a/EasyPost/Models/API/Brand.cs +++ b/EasyPost/Models/API/Brand.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost brand. + /// Class representing an EasyPost brand. /// public class Brand : EasyPostObject { diff --git a/EasyPost/Models/API/CarrierAccount.cs b/EasyPost/Models/API/CarrierAccount.cs index 598f4b596..c9a29ee23 100644 --- a/EasyPost/Models/API/CarrierAccount.cs +++ b/EasyPost/Models/API/CarrierAccount.cs @@ -7,7 +7,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.CarrierAccount /// - /// Class representing an EasyPost carrier account. + /// Class representing an EasyPost carrier account. /// public class CarrierAccount : EasyPostObject, Parameters.ICarrierAccountParameter { diff --git a/EasyPost/Models/API/CarrierDetail.cs b/EasyPost/Models/API/CarrierDetail.cs index 1646d3e6a..2dc41a7d1 100644 --- a/EasyPost/Models/API/CarrierDetail.cs +++ b/EasyPost/Models/API/CarrierDetail.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost 's carrier details. + /// Class representing an EasyPost 's carrier details. /// public class CarrierDetail : EasyPostObject { diff --git a/EasyPost/Models/API/CarrierFields.cs b/EasyPost/Models/API/CarrierFields.cs index b404529be..dc6f6ed19 100644 --- a/EasyPost/Models/API/CarrierFields.cs +++ b/EasyPost/Models/API/CarrierFields.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost 's credentials. + /// Class representing an EasyPost 's credentials. /// public class CarrierFields : EasyPostObject { diff --git a/EasyPost/Models/API/CarrierMetadata.cs b/EasyPost/Models/API/CarrierMetadata.cs index e577a18e5..a9cf0d7fd 100644 --- a/EasyPost/Models/API/CarrierMetadata.cs +++ b/EasyPost/Models/API/CarrierMetadata.cs @@ -7,7 +7,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Beta.CarrierMetadata /// - /// Class representing an EasyPost carrier metadata summary. + /// Class representing an EasyPost carrier metadata summary. /// public class CarrierMetadata : EphemeralEasyPostObject { diff --git a/EasyPost/Models/API/CarrierType.cs b/EasyPost/Models/API/CarrierType.cs index 98821a14a..ae78795f5 100644 --- a/EasyPost/Models/API/CarrierType.cs +++ b/EasyPost/Models/API/CarrierType.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost carrier type. + /// Class representing an EasyPost carrier type. /// public class CarrierType : EasyPostObject { diff --git a/EasyPost/Models/API/CustomsInfo.cs b/EasyPost/Models/API/CustomsInfo.cs index bd2b5a676..75b569537 100644 --- a/EasyPost/Models/API/CustomsInfo.cs +++ b/EasyPost/Models/API/CustomsInfo.cs @@ -6,7 +6,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.CustomInfo /// - /// Class representing an EasyPost customs info object. + /// Class representing an EasyPost customs info object. /// public class CustomsInfo : EasyPostObject, Parameters.ICustomsInfoParameter { diff --git a/EasyPost/Models/API/CustomsItem.cs b/EasyPost/Models/API/CustomsItem.cs index 24cea1f34..dce4fae6c 100644 --- a/EasyPost/Models/API/CustomsItem.cs +++ b/EasyPost/Models/API/CustomsItem.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.CustomsItem /// - /// Class representing an EasyPost customs item. + /// Class representing an EasyPost customs item. /// public class CustomsItem : EasyPostObject, Parameters.ICustomsItemParameter { diff --git a/EasyPost/Models/API/EndShipper.cs b/EasyPost/Models/API/EndShipper.cs index cf3ff1ff1..7f38ebf43 100644 --- a/EasyPost/Models/API/EndShipper.cs +++ b/EasyPost/Models/API/EndShipper.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.EndShipper /// - /// Class representing an EasyPost EndShipper. + /// Class representing an EasyPost EndShipper. /// public class EndShipper : EasyPostObject, Parameters.IEndShipperParameter { diff --git a/EasyPost/Models/API/Error.cs b/EasyPost/Models/API/Error.cs index c31e8dc60..f7bcc832f 100644 --- a/EasyPost/Models/API/Error.cs +++ b/EasyPost/Models/API/Error.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1716 /// - /// Represents an error returned by the EasyPost API. + /// Represents an error returned by the EasyPost API. /// 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. diff --git a/EasyPost/Models/API/Event.cs b/EasyPost/Models/API/Event.cs index c4ee6a354..3c1a1b153 100644 --- a/EasyPost/Models/API/Event.cs +++ b/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 /// - /// Class representing an EasyPost event. + /// Class representing an EasyPost event. /// public class Event : EasyPostObject { @@ -23,7 +23,7 @@ public class Event : EasyPostObject /// /// 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. /// [JsonProperty("description")] public string? Description { get; set; } diff --git a/EasyPost/Models/API/Fee.cs b/EasyPost/Models/API/Fee.cs index 2d21bf115..a5d14fe64 100644 --- a/EasyPost/Models/API/Fee.cs +++ b/EasyPost/Models/API/Fee.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost fee. + /// Class representing an EasyPost fee. /// public class Fee : EasyPostObject { diff --git a/EasyPost/Models/API/Form.cs b/EasyPost/Models/API/Form.cs index b33608d17..93d7def1f 100644 --- a/EasyPost/Models/API/Form.cs +++ b/EasyPost/Models/API/Form.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost form. + /// Class representing an EasyPost form. /// public class Form : EasyPostObject { diff --git a/EasyPost/Models/API/Insurance.cs b/EasyPost/Models/API/Insurance.cs index 749a69931..49d149724 100644 --- a/EasyPost/Models/API/Insurance.cs +++ b/EasyPost/Models/API/Insurance.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Insurance /// - /// Class representing an EasyPost insurance object. + /// Class representing an EasyPost insurance object. /// public class Insurance : EasyPostObject, Parameters.IInsuranceParameter { diff --git a/EasyPost/Models/API/Message.cs b/EasyPost/Models/API/Message.cs index 8c150d285..ca72c4871 100644 --- a/EasyPost/Models/API/Message.cs +++ b/EasyPost/Models/API/Message.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost or message. + /// Class representing an EasyPost or message. /// public class Message : EasyPostObject { diff --git a/EasyPost/Models/API/Options.cs b/EasyPost/Models/API/Options.cs index b4d8f4b27..f82054e00 100644 --- a/EasyPost/Models/API/Options.cs +++ b/EasyPost/Models/API/Options.cs @@ -7,7 +7,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost options set. + /// Class representing an EasyPost options set. /// public class Options : EasyPostObject { diff --git a/EasyPost/Models/API/Order.cs b/EasyPost/Models/API/Order.cs index bd244f631..59e51887f 100644 --- a/EasyPost/Models/API/Order.cs +++ b/EasyPost/Models/API/Order.cs @@ -7,7 +7,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Order /// - /// Class representing an EasyPost order. + /// Class representing an EasyPost order. /// public class Order : EasyPostObject, Parameters.IOrderParameter { diff --git a/EasyPost/Models/API/Parcel.cs b/EasyPost/Models/API/Parcel.cs index db09798d3..e06e2e193 100644 --- a/EasyPost/Models/API/Parcel.cs +++ b/EasyPost/Models/API/Parcel.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Parcel /// - /// Class representing an EasyPost parcel. + /// Class representing an EasyPost parcel. /// public class Parcel : EasyPostObject, Parameters.IParcelParameter { diff --git a/EasyPost/Models/API/Payload.cs b/EasyPost/Models/API/Payload.cs index 2156d7914..d4cb28fa8 100644 --- a/EasyPost/Models/API/Payload.cs +++ b/EasyPost/Models/API/Payload.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost event payload. + /// Class representing an EasyPost event payload. /// public class Payload : EasyPostObject { diff --git a/EasyPost/Models/API/PaymentMethodsSummary.cs b/EasyPost/Models/API/PaymentMethodsSummary.cs index 3748c5e5f..62e9bbe88 100644 --- a/EasyPost/Models/API/PaymentMethodsSummary.cs +++ b/EasyPost/Models/API/PaymentMethodsSummary.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Represents a summary of the primary and secondary payment methods on the user's account. + /// Represents a summary of the primary and secondary payment methods on the user's account. /// public class PaymentMethodsSummary : EasyPostObject { diff --git a/EasyPost/Models/API/Pickup.cs b/EasyPost/Models/API/Pickup.cs index 3b5375445..ef786db51 100644 --- a/EasyPost/Models/API/Pickup.cs +++ b/EasyPost/Models/API/Pickup.cs @@ -9,7 +9,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Pickup /// - /// Class representing an EasyPost pickup. + /// Class representing an EasyPost pickup. /// public class Pickup : EasyPostObject, Parameters.IPickupParameter { diff --git a/EasyPost/Models/API/PickupRate.cs b/EasyPost/Models/API/PickupRate.cs index 84bc70635..17e3e8e4f 100644 --- a/EasyPost/Models/API/PickupRate.cs +++ b/EasyPost/Models/API/PickupRate.cs @@ -3,7 +3,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost pickup rate. + /// Class representing an EasyPost pickup rate. /// public class PickupRate : Rate { diff --git a/EasyPost/Models/API/PostageLabel.cs b/EasyPost/Models/API/PostageLabel.cs index 76a803719..350cf6cfe 100644 --- a/EasyPost/Models/API/PostageLabel.cs +++ b/EasyPost/Models/API/PostageLabel.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost postage label. + /// Class representing an EasyPost postage label. /// public class PostageLabel : EasyPostObject { diff --git a/EasyPost/Models/API/Rate.cs b/EasyPost/Models/API/Rate.cs index cab518e75..5746e2af9 100644 --- a/EasyPost/Models/API/Rate.cs +++ b/EasyPost/Models/API/Rate.cs @@ -6,7 +6,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Beta.Rate /// - /// Class representing an EasyPost rate. + /// Class representing an EasyPost rate. /// public class Rate : EasyPostObject { diff --git a/EasyPost/Models/API/RateWithEstimatedDeliveryDate.cs b/EasyPost/Models/API/RateWithEstimatedDeliveryDate.cs index ff47735da..17eeb1329 100644 --- a/EasyPost/Models/API/RateWithEstimatedDeliveryDate.cs +++ b/EasyPost/Models/API/RateWithEstimatedDeliveryDate.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing a with an estimated delivery date. + /// Class representing a with an estimated delivery date. /// public class RateWithEstimatedDeliveryDate { diff --git a/EasyPost/Models/API/ReferralCustomer.cs b/EasyPost/Models/API/ReferralCustomer.cs index f9ab8e385..5f5cdd614 100644 --- a/EasyPost/Models/API/ReferralCustomer.cs +++ b/EasyPost/Models/API/ReferralCustomer.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.ReferralCustomer /// - /// Class representing an EasyPost referral customer. + /// Class representing an EasyPost referral customer. /// public class ReferralCustomer : EasyPostObject, Parameters.IReferralCustomerParameter { diff --git a/EasyPost/Models/API/Refund.cs b/EasyPost/Models/API/Refund.cs index 3b1b14378..b5321e8dd 100644 --- a/EasyPost/Models/API/Refund.cs +++ b/EasyPost/Models/API/Refund.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Refund /// - /// Class representing an EasyPost refund. + /// Class representing an EasyPost refund. /// public class Refund : EasyPostObject, Parameters.IRefundParameter { diff --git a/EasyPost/Models/API/Report.cs b/EasyPost/Models/API/Report.cs index dd4ea8d6c..33698707f 100644 --- a/EasyPost/Models/API/Report.cs +++ b/EasyPost/Models/API/Report.cs @@ -9,7 +9,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Report /// - /// Class representing an EasyPost report. + /// Class representing an EasyPost report. /// public class Report : EasyPostObject, Parameters.IReportParameter { diff --git a/EasyPost/Models/API/ScanForm.cs b/EasyPost/Models/API/ScanForm.cs index 7fe88e41a..0f8ddf5c0 100644 --- a/EasyPost/Models/API/ScanForm.cs +++ b/EasyPost/Models/API/ScanForm.cs @@ -8,7 +8,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.ScanForm /// - /// Class representing an EasyPost scan form. + /// Class representing an EasyPost scan form. /// public class ScanForm : EasyPostObject, Parameters.IScanFormParameter { diff --git a/EasyPost/Models/API/Shipment.cs b/EasyPost/Models/API/Shipment.cs index 2a85eb6fa..800ea17c2 100644 --- a/EasyPost/Models/API/Shipment.cs +++ b/EasyPost/Models/API/Shipment.cs @@ -9,7 +9,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Shipment /// - /// Class representing an EasyPost shipment. + /// Class representing an EasyPost shipment. /// public class Shipment : EasyPostObject, Parameters.IShipmentParameter { diff --git a/EasyPost/Models/API/SmartRate.cs b/EasyPost/Models/API/SmartRate.cs index baf021e8a..a5f927f2f 100644 --- a/EasyPost/Models/API/SmartRate.cs +++ b/EasyPost/Models/API/SmartRate.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost SmartRate. + /// Class representing an EasyPost SmartRate. /// public class SmartRate : EasyPostObject { diff --git a/EasyPost/Models/API/TaxIdentifier.cs b/EasyPost/Models/API/TaxIdentifier.cs index 4f827b671..2f61c8e44 100644 --- a/EasyPost/Models/API/TaxIdentifier.cs +++ b/EasyPost/Models/API/TaxIdentifier.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.TaxIdentifier /// - /// Class representing an EasyPost tax identifier. + /// Class representing an EasyPost tax identifier. /// public class TaxIdentifier : EasyPostObject, Parameters.ITaxIdentifierParameter { diff --git a/EasyPost/Models/API/TimeInTransit.cs b/EasyPost/Models/API/TimeInTransit.cs index 1df238a14..73039d30d 100644 --- a/EasyPost/Models/API/TimeInTransit.cs +++ b/EasyPost/Models/API/TimeInTransit.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost time in transit summary. + /// Class representing an EasyPost time in transit summary. /// public class TimeInTransit : EphemeralEasyPostObject { diff --git a/EasyPost/Models/API/Tracker.cs b/EasyPost/Models/API/Tracker.cs index 8d267b3fb..94b340b1f 100644 --- a/EasyPost/Models/API/Tracker.cs +++ b/EasyPost/Models/API/Tracker.cs @@ -9,7 +9,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Tracker /// - /// Class representing an EasyPost tracker. + /// Class representing an EasyPost tracker. /// public class Tracker : EasyPostObject, Parameters.ITrackerParameter { diff --git a/EasyPost/Models/API/TrackingDetail.cs b/EasyPost/Models/API/TrackingDetail.cs index cac53a234..aaf1059d5 100644 --- a/EasyPost/Models/API/TrackingDetail.cs +++ b/EasyPost/Models/API/TrackingDetail.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost tracker detail object. + /// Class representing an EasyPost tracker detail object. /// public class TrackingDetail : EasyPostObject { diff --git a/EasyPost/Models/API/TrackingLocation.cs b/EasyPost/Models/API/TrackingLocation.cs index 2c1f697bd..3abefedfb 100644 --- a/EasyPost/Models/API/TrackingLocation.cs +++ b/EasyPost/Models/API/TrackingLocation.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost tracking location. + /// Class representing an EasyPost tracking location. /// public class TrackingLocation : EasyPostObject { diff --git a/EasyPost/Models/API/User.cs b/EasyPost/Models/API/User.cs index 6b5e3786f..94793deae 100644 --- a/EasyPost/Models/API/User.cs +++ b/EasyPost/Models/API/User.cs @@ -6,7 +6,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.User /// - /// Class representing an EasyPost user. + /// Class representing an EasyPost user. /// public class User : EasyPostObject, Parameters.IUserParameter { diff --git a/EasyPost/Models/API/Verification.cs b/EasyPost/Models/API/Verification.cs index d921f3d39..a9076ce3b 100644 --- a/EasyPost/Models/API/Verification.cs +++ b/EasyPost/Models/API/Verification.cs @@ -5,7 +5,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost verification object. + /// Class representing an EasyPost verification object. /// public class Verification : EasyPostObject { diff --git a/EasyPost/Models/API/VerificationDetails.cs b/EasyPost/Models/API/VerificationDetails.cs index af993ef5a..facbd4962 100644 --- a/EasyPost/Models/API/VerificationDetails.cs +++ b/EasyPost/Models/API/VerificationDetails.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost verification details object. + /// Class representing an EasyPost verification details object. /// public class VerificationDetails : EasyPostObject { diff --git a/EasyPost/Models/API/Verifications.cs b/EasyPost/Models/API/Verifications.cs index 991d1acf2..5fe0d4126 100644 --- a/EasyPost/Models/API/Verifications.cs +++ b/EasyPost/Models/API/Verifications.cs @@ -4,7 +4,7 @@ namespace EasyPost.Models.API { /// - /// Class representing an EasyPost verifications object. + /// Class representing an EasyPost verifications object. /// public class Verifications : EasyPostObject { diff --git a/EasyPost/Models/API/Webhook.cs b/EasyPost/Models/API/Webhook.cs index fc915df32..08d78dfd9 100644 --- a/EasyPost/Models/API/Webhook.cs +++ b/EasyPost/Models/API/Webhook.cs @@ -6,7 +6,7 @@ namespace EasyPost.Models.API { #pragma warning disable CA1724 // Naming conflicts with Parameters.Webhook /// - /// Class representing an EasyPost webhook. + /// Class representing an EasyPost webhook. /// public class Webhook : EasyPostObject, Parameters.IWebhookParameter { diff --git a/EasyPost/Models/Shared/PaginatedCollection.cs b/EasyPost/Models/Shared/PaginatedCollection.cs index a2cf38db8..225359f56 100644 --- a/EasyPost/Models/Shared/PaginatedCollection.cs +++ b/EasyPost/Models/Shared/PaginatedCollection.cs @@ -7,7 +7,7 @@ namespace EasyPost.Models.Shared { /// - /// A paginated collection of s. + /// A paginated collection of s. /// /// The type of contained in the collection. public abstract class PaginatedCollection : _base.EasyPostObject where TEntries : _base.EasyPostObject diff --git a/EasyPost/Parameters/Address/All.cs b/EasyPost/Parameters/Address/All.cs index 0d74795b9..40de083c5 100644 --- a/EasyPost/Parameters/Address/All.cs +++ b/EasyPost/Parameters/Address/All.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.Address { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Address/Create.cs b/EasyPost/Parameters/Address/Create.cs index e09b7947e..d4cd56600 100644 --- a/EasyPost/Parameters/Address/Create.cs +++ b/EasyPost/Parameters/Address/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Address { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IAddressParameter diff --git a/EasyPost/Parameters/Batch/AddShipments.cs b/EasyPost/Parameters/Batch/AddShipments.cs index a9b9ff9ab..4066ede58 100644 --- a/EasyPost/Parameters/Batch/AddShipments.cs +++ b/EasyPost/Parameters/Batch/AddShipments.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class AddShipments : BaseParameters diff --git a/EasyPost/Parameters/Batch/All.cs b/EasyPost/Parameters/Batch/All.cs index b6f5a08c3..5cab723e9 100644 --- a/EasyPost/Parameters/Batch/All.cs +++ b/EasyPost/Parameters/Batch/All.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Batch/Create.cs b/EasyPost/Parameters/Batch/Create.cs index ace1c11eb..7e3babe37 100644 --- a/EasyPost/Parameters/Batch/Create.cs +++ b/EasyPost/Parameters/Batch/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IBatchParameter diff --git a/EasyPost/Parameters/Batch/GenerateLabel.cs b/EasyPost/Parameters/Batch/GenerateLabel.cs index ad93d0b06..1f3e8e467 100644 --- a/EasyPost/Parameters/Batch/GenerateLabel.cs +++ b/EasyPost/Parameters/Batch/GenerateLabel.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class GenerateLabel : BaseParameters diff --git a/EasyPost/Parameters/Batch/GenerateScanForm.cs b/EasyPost/Parameters/Batch/GenerateScanForm.cs index 22a7954db..88454081e 100644 --- a/EasyPost/Parameters/Batch/GenerateScanForm.cs +++ b/EasyPost/Parameters/Batch/GenerateScanForm.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class GenerateScanForm : BaseParameters diff --git a/EasyPost/Parameters/Batch/RemoveShipments.cs b/EasyPost/Parameters/Batch/RemoveShipments.cs index 4d1742c7e..7fe139a88 100644 --- a/EasyPost/Parameters/Batch/RemoveShipments.cs +++ b/EasyPost/Parameters/Batch/RemoveShipments.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Batch { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class RemoveShipments : BaseParameters diff --git a/EasyPost/Parameters/Beta/Rate/Retrieve.cs b/EasyPost/Parameters/Beta/Rate/Retrieve.cs index 2a819e7ec..973639ecf 100644 --- a/EasyPost/Parameters/Beta/Rate/Retrieve.cs +++ b/EasyPost/Parameters/Beta/Rate/Retrieve.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Beta.Rate { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Retrieve : BaseParameters diff --git a/EasyPost/Parameters/CarrierAccount/Create.cs b/EasyPost/Parameters/CarrierAccount/Create.cs index a4712825c..e3e5fb5b3 100644 --- a/EasyPost/Parameters/CarrierAccount/Create.cs +++ b/EasyPost/Parameters/CarrierAccount/Create.cs @@ -8,7 +8,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : ACreate diff --git a/EasyPost/Parameters/CarrierAccount/CreateFedEx.cs b/EasyPost/Parameters/CarrierAccount/CreateFedEx.cs index 0dcf80a2a..a659f0804 100644 --- a/EasyPost/Parameters/CarrierAccount/CreateFedEx.cs +++ b/EasyPost/Parameters/CarrierAccount/CreateFedEx.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateFedEx : ACreate diff --git a/EasyPost/Parameters/CarrierAccount/CreateUps.cs b/EasyPost/Parameters/CarrierAccount/CreateUps.cs index e5b9adc96..4a4ef8ad1 100644 --- a/EasyPost/Parameters/CarrierAccount/CreateUps.cs +++ b/EasyPost/Parameters/CarrierAccount/CreateUps.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateUps : ACreate diff --git a/EasyPost/Parameters/CarrierAccount/CreateUpsMailInnovations.cs b/EasyPost/Parameters/CarrierAccount/CreateUpsMailInnovations.cs index 1717e18f4..b4dfa1380 100644 --- a/EasyPost/Parameters/CarrierAccount/CreateUpsMailInnovations.cs +++ b/EasyPost/Parameters/CarrierAccount/CreateUpsMailInnovations.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateUpsMailInnovations : ACreate diff --git a/EasyPost/Parameters/CarrierAccount/CreateUpsSurePost.cs b/EasyPost/Parameters/CarrierAccount/CreateUpsSurePost.cs index 39a47706d..c1dbdb441 100644 --- a/EasyPost/Parameters/CarrierAccount/CreateUpsSurePost.cs +++ b/EasyPost/Parameters/CarrierAccount/CreateUpsSurePost.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateUpsSurePost : ACreate diff --git a/EasyPost/Parameters/CarrierAccount/Update.cs b/EasyPost/Parameters/CarrierAccount/Update.cs index 6a62aaca2..b374fcbb2 100644 --- a/EasyPost/Parameters/CarrierAccount/Update.cs +++ b/EasyPost/Parameters/CarrierAccount/Update.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Update : AUpdate diff --git a/EasyPost/Parameters/CarrierAccount/UpdateUps.cs b/EasyPost/Parameters/CarrierAccount/UpdateUps.cs index eab5bd277..74f3d8c8e 100644 --- a/EasyPost/Parameters/CarrierAccount/UpdateUps.cs +++ b/EasyPost/Parameters/CarrierAccount/UpdateUps.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class UpdateUps : AUpdate diff --git a/EasyPost/Parameters/CarrierAccount/UpdateUpsMailInnovations.cs b/EasyPost/Parameters/CarrierAccount/UpdateUpsMailInnovations.cs index 7cce29ee9..f7c0fbf23 100644 --- a/EasyPost/Parameters/CarrierAccount/UpdateUpsMailInnovations.cs +++ b/EasyPost/Parameters/CarrierAccount/UpdateUpsMailInnovations.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class UpdateUpsMailInnovations : AUpdate diff --git a/EasyPost/Parameters/CarrierAccount/UpdateUpsSurePost.cs b/EasyPost/Parameters/CarrierAccount/UpdateUpsSurePost.cs index 0de1671f1..382550ba1 100644 --- a/EasyPost/Parameters/CarrierAccount/UpdateUpsSurePost.cs +++ b/EasyPost/Parameters/CarrierAccount/UpdateUpsSurePost.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.CarrierAccount { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class UpdateUpsSurePost : AUpdate diff --git a/EasyPost/Parameters/CarrierMetadata/Retrieve.cs b/EasyPost/Parameters/CarrierMetadata/Retrieve.cs index c3027da4c..fa828a56a 100644 --- a/EasyPost/Parameters/CarrierMetadata/Retrieve.cs +++ b/EasyPost/Parameters/CarrierMetadata/Retrieve.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.CarrierMetadata { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Retrieve : BaseParameters diff --git a/EasyPost/Parameters/Claim/All.cs b/EasyPost/Parameters/Claim/All.cs index 74a5414cd..7564264c9 100644 --- a/EasyPost/Parameters/Claim/All.cs +++ b/EasyPost/Parameters/Claim/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Claim { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Claim/Create.cs b/EasyPost/Parameters/Claim/Create.cs index fecf83d72..8a1f5b8ca 100644 --- a/EasyPost/Parameters/Claim/Create.cs +++ b/EasyPost/Parameters/Claim/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Claim { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IClaimParameter diff --git a/EasyPost/Parameters/CustomsInfo/Create.cs b/EasyPost/Parameters/CustomsInfo/Create.cs index 06e42f3ef..fb4d1a0c5 100644 --- a/EasyPost/Parameters/CustomsInfo/Create.cs +++ b/EasyPost/Parameters/CustomsInfo/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.CustomsInfo { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, ICustomsInfoParameter diff --git a/EasyPost/Parameters/CustomsItem/Create.cs b/EasyPost/Parameters/CustomsItem/Create.cs index c2ca240f1..712336fef 100644 --- a/EasyPost/Parameters/CustomsItem/Create.cs +++ b/EasyPost/Parameters/CustomsItem/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.CustomsItem { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, ICustomsItemParameter diff --git a/EasyPost/Parameters/EndShipper/All.cs b/EasyPost/Parameters/EndShipper/All.cs index 9d969617f..0c731649a 100644 --- a/EasyPost/Parameters/EndShipper/All.cs +++ b/EasyPost/Parameters/EndShipper/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.EndShipper { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/EndShipper/Create.cs b/EasyPost/Parameters/EndShipper/Create.cs index cb1557093..fbbc15c36 100644 --- a/EasyPost/Parameters/EndShipper/Create.cs +++ b/EasyPost/Parameters/EndShipper/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.EndShipper { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IEndShipperParameter diff --git a/EasyPost/Parameters/EndShipper/Update.cs b/EasyPost/Parameters/EndShipper/Update.cs index fc9b37826..8789eaddc 100644 --- a/EasyPost/Parameters/EndShipper/Update.cs +++ b/EasyPost/Parameters/EndShipper/Update.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.EndShipper { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Update : BaseParameters diff --git a/EasyPost/Parameters/Event/All.cs b/EasyPost/Parameters/Event/All.cs index 4d46c4e16..fc4fcbcfa 100644 --- a/EasyPost/Parameters/Event/All.cs +++ b/EasyPost/Parameters/Event/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Event { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Insurance/All.cs b/EasyPost/Parameters/Insurance/All.cs index 8c94e5c35..55bc630e3 100644 --- a/EasyPost/Parameters/Insurance/All.cs +++ b/EasyPost/Parameters/Insurance/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Insurance { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Insurance/Create.cs b/EasyPost/Parameters/Insurance/Create.cs index 4f8f5220c..eec96c4fa 100644 --- a/EasyPost/Parameters/Insurance/Create.cs +++ b/EasyPost/Parameters/Insurance/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Insurance { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IInsuranceParameter diff --git a/EasyPost/Parameters/Order/Buy.cs b/EasyPost/Parameters/Order/Buy.cs index 51c3c2d93..a983010f8 100644 --- a/EasyPost/Parameters/Order/Buy.cs +++ b/EasyPost/Parameters/Order/Buy.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Order { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Buy : BaseParameters diff --git a/EasyPost/Parameters/Order/Create.cs b/EasyPost/Parameters/Order/Create.cs index eee9c585d..9063bffd4 100644 --- a/EasyPost/Parameters/Order/Create.cs +++ b/EasyPost/Parameters/Order/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Order { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IOrderParameter diff --git a/EasyPost/Parameters/Parcel/Create.cs b/EasyPost/Parameters/Parcel/Create.cs index 49e323781..434907f98 100644 --- a/EasyPost/Parameters/Parcel/Create.cs +++ b/EasyPost/Parameters/Parcel/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Parcel { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IParcelParameter diff --git a/EasyPost/Parameters/Pickup/All.cs b/EasyPost/Parameters/Pickup/All.cs index c999d0991..f9e8cab80 100644 --- a/EasyPost/Parameters/Pickup/All.cs +++ b/EasyPost/Parameters/Pickup/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Pickup { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Pickup/Buy.cs b/EasyPost/Parameters/Pickup/Buy.cs index f2a14638c..9b514fa82 100644 --- a/EasyPost/Parameters/Pickup/Buy.cs +++ b/EasyPost/Parameters/Pickup/Buy.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Pickup { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Buy : BaseParameters diff --git a/EasyPost/Parameters/Pickup/Create.cs b/EasyPost/Parameters/Pickup/Create.cs index 9bfe7d56a..f88d8cbc3 100644 --- a/EasyPost/Parameters/Pickup/Create.cs +++ b/EasyPost/Parameters/Pickup/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Pickup { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IPickupParameter diff --git a/EasyPost/Parameters/ReferralCustomer/AddPaymentMethod.cs b/EasyPost/Parameters/ReferralCustomer/AddPaymentMethod.cs index 79af1b0f5..f852e0b65 100644 --- a/EasyPost/Parameters/ReferralCustomer/AddPaymentMethod.cs +++ b/EasyPost/Parameters/ReferralCustomer/AddPaymentMethod.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.ReferralCustomer { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class AddPaymentMethod : BaseParameters diff --git a/EasyPost/Parameters/ReferralCustomer/All.cs b/EasyPost/Parameters/ReferralCustomer/All.cs index 41ce441b5..0c1a01ab0 100644 --- a/EasyPost/Parameters/ReferralCustomer/All.cs +++ b/EasyPost/Parameters/ReferralCustomer/All.cs @@ -7,7 +7,7 @@ namespace EasyPost.Parameters.ReferralCustomer { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/ReferralCustomer/CreateReferralCustomer.cs b/EasyPost/Parameters/ReferralCustomer/CreateReferralCustomer.cs index 30125811b..5ce0fdb1f 100644 --- a/EasyPost/Parameters/ReferralCustomer/CreateReferralCustomer.cs +++ b/EasyPost/Parameters/ReferralCustomer/CreateReferralCustomer.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.ReferralCustomer { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateReferralCustomer : BaseParameters, IReferralCustomerParameter diff --git a/EasyPost/Parameters/ReferralCustomer/RefundByAmount.cs b/EasyPost/Parameters/ReferralCustomer/RefundByAmount.cs index 6e8472d97..ef210b6e1 100644 --- a/EasyPost/Parameters/ReferralCustomer/RefundByAmount.cs +++ b/EasyPost/Parameters/ReferralCustomer/RefundByAmount.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.ReferralCustomer { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class RefundByAmount : BaseParameters diff --git a/EasyPost/Parameters/ReferralCustomer/RefundByPaymentLog.cs b/EasyPost/Parameters/ReferralCustomer/RefundByPaymentLog.cs index 1a729c630..b7c903c40 100644 --- a/EasyPost/Parameters/ReferralCustomer/RefundByPaymentLog.cs +++ b/EasyPost/Parameters/ReferralCustomer/RefundByPaymentLog.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.ReferralCustomer { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class RefundByPaymentLog : BaseParameters diff --git a/EasyPost/Parameters/Refund/All.cs b/EasyPost/Parameters/Refund/All.cs index 7ffcb6b32..feb1e100d 100644 --- a/EasyPost/Parameters/Refund/All.cs +++ b/EasyPost/Parameters/Refund/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Refund { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Refund/Create.cs b/EasyPost/Parameters/Refund/Create.cs index 08b4cca91..5665f7637 100644 --- a/EasyPost/Parameters/Refund/Create.cs +++ b/EasyPost/Parameters/Refund/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Refund { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IRefundParameter diff --git a/EasyPost/Parameters/Report/All.cs b/EasyPost/Parameters/Report/All.cs index ed8fe1bb4..e0d2c6180 100644 --- a/EasyPost/Parameters/Report/All.cs +++ b/EasyPost/Parameters/Report/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Report { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Report/Create.cs b/EasyPost/Parameters/Report/Create.cs index 8adeb7afb..07d9291b8 100644 --- a/EasyPost/Parameters/Report/Create.cs +++ b/EasyPost/Parameters/Report/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Report { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IReportParameter diff --git a/EasyPost/Parameters/ScanForm/All.cs b/EasyPost/Parameters/ScanForm/All.cs index 63a7c578f..b49533c1e 100644 --- a/EasyPost/Parameters/ScanForm/All.cs +++ b/EasyPost/Parameters/ScanForm/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.ScanForm { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/ScanForm/Create.cs b/EasyPost/Parameters/ScanForm/Create.cs index 0f44914be..6a36cac18 100644 --- a/EasyPost/Parameters/ScanForm/Create.cs +++ b/EasyPost/Parameters/ScanForm/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.ScanForm { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IScanFormParameter diff --git a/EasyPost/Parameters/Shipment/All.cs b/EasyPost/Parameters/Shipment/All.cs index 93fd734d8..7ba48822d 100644 --- a/EasyPost/Parameters/Shipment/All.cs +++ b/EasyPost/Parameters/Shipment/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Shipment/Buy.cs b/EasyPost/Parameters/Shipment/Buy.cs index d81477625..5b7b7798b 100644 --- a/EasyPost/Parameters/Shipment/Buy.cs +++ b/EasyPost/Parameters/Shipment/Buy.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Buy : BaseParameters diff --git a/EasyPost/Parameters/Shipment/Create.cs b/EasyPost/Parameters/Shipment/Create.cs index e7819bc2f..694eaf8d6 100644 --- a/EasyPost/Parameters/Shipment/Create.cs +++ b/EasyPost/Parameters/Shipment/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IShipmentParameter diff --git a/EasyPost/Parameters/Shipment/GenerateForm.cs b/EasyPost/Parameters/Shipment/GenerateForm.cs index 48da2feed..9dca329fd 100644 --- a/EasyPost/Parameters/Shipment/GenerateForm.cs +++ b/EasyPost/Parameters/Shipment/GenerateForm.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class GenerateForm : BaseParameters diff --git a/EasyPost/Parameters/Shipment/GenerateLabel.cs b/EasyPost/Parameters/Shipment/GenerateLabel.cs index 0c1bb91e4..a0c90c9e4 100644 --- a/EasyPost/Parameters/Shipment/GenerateLabel.cs +++ b/EasyPost/Parameters/Shipment/GenerateLabel.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class GenerateLabel : BaseParameters diff --git a/EasyPost/Parameters/Shipment/Insure.cs b/EasyPost/Parameters/Shipment/Insure.cs index d62eaf992..718aadb34 100644 --- a/EasyPost/Parameters/Shipment/Insure.cs +++ b/EasyPost/Parameters/Shipment/Insure.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Insure : BaseParameters diff --git a/EasyPost/Parameters/Shipment/RegenerateRates.cs b/EasyPost/Parameters/Shipment/RegenerateRates.cs index fa34dd473..d16697b26 100644 --- a/EasyPost/Parameters/Shipment/RegenerateRates.cs +++ b/EasyPost/Parameters/Shipment/RegenerateRates.cs @@ -3,7 +3,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class RegenerateRates : BaseParameters diff --git a/EasyPost/Parameters/Shipment/RetrieveEstimatedDeliveryDate.cs b/EasyPost/Parameters/Shipment/RetrieveEstimatedDeliveryDate.cs index 3eba40e40..77cb2b69b 100644 --- a/EasyPost/Parameters/Shipment/RetrieveEstimatedDeliveryDate.cs +++ b/EasyPost/Parameters/Shipment/RetrieveEstimatedDeliveryDate.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Shipment { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class RetrieveEstimatedDeliveryDate : BaseParameters diff --git a/EasyPost/Parameters/TaxIdentifier/Create.cs b/EasyPost/Parameters/TaxIdentifier/Create.cs index cb61dccb1..66734cdc1 100644 --- a/EasyPost/Parameters/TaxIdentifier/Create.cs +++ b/EasyPost/Parameters/TaxIdentifier/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.TaxIdentifier { /// - /// Parameters for property. + /// Parameters for property. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, ITaxIdentifierParameter diff --git a/EasyPost/Parameters/Tracker/All.cs b/EasyPost/Parameters/Tracker/All.cs index f14b0c2d5..8e7ba57ea 100644 --- a/EasyPost/Parameters/Tracker/All.cs +++ b/EasyPost/Parameters/Tracker/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Tracker { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Tracker/Create.cs b/EasyPost/Parameters/Tracker/Create.cs index f45e31391..038f0c89b 100644 --- a/EasyPost/Parameters/Tracker/Create.cs +++ b/EasyPost/Parameters/Tracker/Create.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.Tracker { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, ITrackerParameter diff --git a/EasyPost/Parameters/User/CreateChild.cs b/EasyPost/Parameters/User/CreateChild.cs index ecf930c8f..12c6568ce 100644 --- a/EasyPost/Parameters/User/CreateChild.cs +++ b/EasyPost/Parameters/User/CreateChild.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.User { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class CreateChild : BaseParameters, IUserParameter diff --git a/EasyPost/Parameters/User/Update.cs b/EasyPost/Parameters/User/Update.cs index 03ee085bb..3ebb5102b 100644 --- a/EasyPost/Parameters/User/Update.cs +++ b/EasyPost/Parameters/User/Update.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.User { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Update : BaseParameters diff --git a/EasyPost/Parameters/User/UpdateBrand.cs b/EasyPost/Parameters/User/UpdateBrand.cs index 158241139..52693ac26 100644 --- a/EasyPost/Parameters/User/UpdateBrand.cs +++ b/EasyPost/Parameters/User/UpdateBrand.cs @@ -4,7 +4,7 @@ namespace EasyPost.Parameters.User { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class UpdateBrand : BaseParameters diff --git a/EasyPost/Parameters/Webhook/All.cs b/EasyPost/Parameters/Webhook/All.cs index d95b73820..607ce95fd 100644 --- a/EasyPost/Parameters/Webhook/All.cs +++ b/EasyPost/Parameters/Webhook/All.cs @@ -6,7 +6,7 @@ namespace EasyPost.Parameters.Webhook { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class All : BaseAllParameters diff --git a/EasyPost/Parameters/Webhook/Create.cs b/EasyPost/Parameters/Webhook/Create.cs index df88c50d4..2e7627abd 100644 --- a/EasyPost/Parameters/Webhook/Create.cs +++ b/EasyPost/Parameters/Webhook/Create.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Webhook { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Create : BaseParameters, IWebhookParameter diff --git a/EasyPost/Parameters/Webhook/Update.cs b/EasyPost/Parameters/Webhook/Update.cs index e1bed1356..8178d962e 100644 --- a/EasyPost/Parameters/Webhook/Update.cs +++ b/EasyPost/Parameters/Webhook/Update.cs @@ -5,7 +5,7 @@ namespace EasyPost.Parameters.Webhook { /// - /// Parameters for API calls. + /// Parameters for API calls. /// [ExcludeFromCodeCoverage] public class Update : BaseParameters diff --git a/EasyPost/Services/AddressService.cs b/EasyPost/Services/AddressService.cs index 8aca30a84..553f7621d 100644 --- a/EasyPost/Services/AddressService.cs +++ b/EasyPost/Services/AddressService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of address-related functionality. + /// Class representing a set of address-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class AddressService : EasyPostService @@ -29,7 +29,7 @@ internal AddressService(EasyPostClient client) /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -63,7 +63,7 @@ public async Task
Create(Dictionary parameters, Cancell /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -77,7 +77,7 @@ public async Task
Create(Parameters.Address.Create parameters, Cancella /// /// Create and verify an in one API call. - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -87,7 +87,7 @@ public async Task
Create(Parameters.Address.Create parameters, Cancella /// /// Create and verify an in one API call. - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -101,7 +101,7 @@ public async Task
CreateAndVerify(Parameters.Address.Create parameters, /// /// List all objects. - /// Related API documentation. + /// Related API documentation. /// /// Dictionary containing parameters to filter the result list with. /// to use for the HTTP request. diff --git a/EasyPost/Services/ApiKeyService.cs b/EasyPost/Services/ApiKeyService.cs index ec77526ab..ce26e5e73 100644 --- a/EasyPost/Services/ApiKeyService.cs +++ b/EasyPost/Services/ApiKeyService.cs @@ -12,7 +12,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of API key-related functionality. + /// Class representing a set of API key-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class ApiKeyService : EasyPostService @@ -30,7 +30,7 @@ internal ApiKeyService(EasyPostClient client) /// /// Get a list of all s. - /// Related API documentation. + /// Related API documentation. /// /// to use for the HTTP request. /// A object. diff --git a/EasyPost/Services/BatchService.cs b/EasyPost/Services/BatchService.cs index 52df4ca9c..e17c723f8 100644 --- a/EasyPost/Services/BatchService.cs +++ b/EasyPost/Services/BatchService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of batch-related functionality. + /// Class representing a set of batch-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class BatchService : EasyPostService @@ -29,7 +29,7 @@ internal BatchService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task Create(Dictionary? parameters = null, C /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Batch.Create parameters, Cancellation /// /// List all objects. - /// Related API documentation. + /// Related API documentation. /// /// Dictionary containing parameters to filter the result list with. /// to use for the HTTP request. @@ -72,7 +72,7 @@ public async Task All(Dictionary? parameters = /// /// List all objects. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -89,7 +89,7 @@ public async Task All(Parameters.Batch.All parameters, Cancella /// /// Add s to a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to add s to. /// Parameters for the s to add. @@ -103,7 +103,7 @@ public async Task AddShipments(string id, Dictionary para /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -113,7 +113,7 @@ public async Task AddShipments(string id, Dictionary para /// /// Add s to a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to add s to. /// Parameters for the s to add. @@ -127,7 +127,7 @@ public async Task AddShipments(string id, Parameters.Batch.AddShipments p /// /// Add s to a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to add s to. /// List of s to add to the . @@ -142,7 +142,7 @@ public async Task AddShipments(string id, List shipmentsToAdd, /// /// Add s to a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to add s to. /// List of IDs of s to add to the . @@ -157,7 +157,7 @@ public async Task AddShipments(string id, IEnumerable shipmentIds /// /// Purchase all s within a . The must be "created" before purchasing. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase s from. /// to use for the HTTP request. @@ -170,7 +170,7 @@ public async Task Buy(string id, CancellationToken cancellationToken = de /// /// Asynchronously generate a containing all of the labels belonging to a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a label for. /// Format to generate the label in. Must be "pdf" or "zpl". @@ -185,7 +185,7 @@ public async Task GenerateLabel(string id, string fileFormat, Cancellatio /// /// Asynchronously generate a containing all of the labels belonging to this . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a label for. /// parameter set. @@ -199,7 +199,7 @@ public async Task GenerateLabel(string id, Parameters.Batch.GenerateLabel /// /// Asynchronously generate a for a . - /// Related API documentation. + /// Related API documentation. /// /// String representing a Batch. Starts with "batch_". /// Format to generate the label in. Valid formats: "pdf", "zpl" and "epl2". @@ -214,7 +214,7 @@ public async Task GenerateScanForm(string id, string fileFormat, Cancella /// /// Asynchronously generate a for this . - /// Related API documentation. + /// Related API documentation. /// /// String representing a Batch. Starts with "batch_". /// parameter set. @@ -228,7 +228,7 @@ public async Task GenerateScanForm(string id, Parameters.Batch.GenerateSc /// /// Remove s from a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to remove s from. /// Parameters for the s to remove. @@ -242,7 +242,7 @@ public async Task RemoveShipments(string id, Dictionary p /// /// Remove s from a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to remove s from. /// Parameters for the s to remove. @@ -256,7 +256,7 @@ public async Task RemoveShipments(string id, Parameters.Batch.RemoveShipm /// /// Remove s from a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to remove s from. /// List of s to remove from the . @@ -271,7 +271,7 @@ public async Task RemoveShipments(string id, List shipmentsToRe /// /// Remove s from a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to remove s from. /// List of IDs of s to remove from the . diff --git a/EasyPost/Services/Beta/RateService.cs b/EasyPost/Services/Beta/RateService.cs index b5f3be91b..0ddb253b2 100644 --- a/EasyPost/Services/Beta/RateService.cs +++ b/EasyPost/Services/Beta/RateService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services.Beta { /// - /// Class representing a set of rate-related beta functionality. + /// Class representing a set of rate-related beta functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class RateService : EasyPostService @@ -28,7 +28,7 @@ internal RateService(EasyPostClient client) /// /// Retrieve s for a . - /// Related API documentation. + /// Related API documentation. /// /// Data to retrieve the rates with. /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task> RetrieveStatelessRates(Dictionary /// Retrieve s for a . - /// Related API documentation. + /// Related API documentation. ///
/// Data to retrieve the rates with. /// to use for the HTTP request. diff --git a/EasyPost/Services/Beta/ReferralCustomerService.cs b/EasyPost/Services/Beta/ReferralCustomerService.cs index 751075d5f..acb3656b3 100644 --- a/EasyPost/Services/Beta/ReferralCustomerService.cs +++ b/EasyPost/Services/Beta/ReferralCustomerService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services.Beta { /// - /// Class representing a set of referral customer-related beta functionality. + /// Class representing a set of referral customer-related beta functionality. /// public class ReferralCustomerService : EasyPostService { @@ -30,7 +30,7 @@ public ReferralCustomerService(EasyPostClient client) /// Add a Stripe payment method to a /// This function should be called against a configured with the 's API key. /// This function will fail if called against a non-Referral Customer Client. - /// Related API documentation. + /// Related API documentation. /// /// Unique customer ID provided by Stripe. /// ID of the card or bank account provided by Stripe. @@ -63,7 +63,7 @@ public async Task AddPaymentMethod(string stripeCustomerId, strin /// Add a Stripe payment method to a /// This function should be called against a configured with the 's API key. /// This function will fail if called against a non-Referral Customer Client. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -78,7 +78,7 @@ public async Task AddPaymentMethod(Parameters.ReferralCustomer.Ad /// /// Refund a 's wallet by a specified amount. /// Refund will be issued to the user's original payment method. - /// Related API documentation. + /// Related API documentation. /// /// Amount in cents to refund the Referral Customer. /// to use for the HTTP request. @@ -97,7 +97,7 @@ public async Task RefundByAmount(int amount, CancellationToken ca /// /// Refund a 's wallet by a specified amount. /// Refund will be issued to the user's original payment method. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -111,7 +111,7 @@ public async Task RefundByAmount(Parameters.ReferralCustomer.Refu /// /// Refund a 's wallet for a specified payment log entry. /// Refund will be issued to the user's original payment method. - /// Related API documentation. + /// Related API documentation. /// /// Payment log ID to refund. /// to use for the HTTP request. @@ -130,7 +130,7 @@ public async Task RefundByPaymentLog(string paymentLogId, Cancell /// /// Refund a 's wallet for a specified payment log entry. /// Refund will be issued to the user's original payment method. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. diff --git a/EasyPost/Services/BillingService.cs b/EasyPost/Services/BillingService.cs index f4da1c51f..4ce0b4408 100644 --- a/EasyPost/Services/BillingService.cs +++ b/EasyPost/Services/BillingService.cs @@ -12,7 +12,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of billing-related functionality. + /// Class representing a set of billing-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class BillingService : EasyPostService @@ -30,7 +30,7 @@ internal BillingService(EasyPostClient client) /// /// Fund your wallet from a specific . - /// Related API documentation. + /// Related API documentation. /// /// Amount to fund. /// Which of payment method to use to fund the wallet. Defaults to . @@ -50,7 +50,7 @@ public async Task FundWallet(string amount, PaymentMethod.Priority? priority = n /// /// List all s for the user's account. - /// Related API documentation. + /// Related API documentation. /// /// to use for the HTTP request. /// A object. @@ -66,7 +66,7 @@ public async Task RetrievePaymentMethodsSummary(Cancellat /// /// Delete a from the user's account. - /// Related API documentation. + /// Related API documentation. /// /// Which of payment method to delete. /// to use for the HTTP request. diff --git a/EasyPost/Services/CarrierAccountService.cs b/EasyPost/Services/CarrierAccountService.cs index d0b16f74d..3f94f157e 100644 --- a/EasyPost/Services/CarrierAccountService.cs +++ b/EasyPost/Services/CarrierAccountService.cs @@ -12,7 +12,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of carrier account-related functionality. + /// Class representing a set of carrier account-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class CarrierAccountService : EasyPostService @@ -32,7 +32,7 @@ internal CarrierAccountService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -61,7 +61,7 @@ public async Task Create(Dictionary parameters, /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -94,7 +94,7 @@ public async Task Create(Parameters.CarrierAccount.ACreate param /// /// List all available s. - /// Related API documentation. + /// Related API documentation. /// /// to use for the HTTP request. /// A list of s. @@ -103,7 +103,7 @@ public async Task Create(Parameters.CarrierAccount.ACreate param /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// String representing a carrier account. Starts with "ca_". /// to use for the HTTP request. @@ -113,7 +113,7 @@ public async Task Create(Parameters.CarrierAccount.ACreate param /// /// Update a . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to update. /// Data to update with. @@ -141,7 +141,7 @@ public async Task Update(string id, Dictionary p /// /// Update a . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to update. /// Data to update with. @@ -172,7 +172,7 @@ public async Task Update(string id, Parameters.CarrierAccount.AU /// /// Delete a . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to delete. /// to use for the HTTP request. diff --git a/EasyPost/Services/CarrierMetadataService.cs b/EasyPost/Services/CarrierMetadataService.cs index 6bf7e1cff..40a6aa6bd 100644 --- a/EasyPost/Services/CarrierMetadataService.cs +++ b/EasyPost/Services/CarrierMetadataService.cs @@ -9,7 +9,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of carrier metadata-related beta functionality. + /// Class representing a set of carrier metadata-related beta functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class CarrierMetadataService : EasyPostService @@ -27,7 +27,7 @@ internal CarrierMetadataService(EasyPostClient client) /// /// Retrieve metadata about specific carrier(s). - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. diff --git a/EasyPost/Services/CarrierTypeService.cs b/EasyPost/Services/CarrierTypeService.cs index bea5c5ce6..e1ce91353 100644 --- a/EasyPost/Services/CarrierTypeService.cs +++ b/EasyPost/Services/CarrierTypeService.cs @@ -9,7 +9,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of carrier type-related functionality. + /// Class representing a set of carrier type-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class CarrierTypeService : EasyPostService @@ -27,7 +27,7 @@ internal CarrierTypeService(EasyPostClient client) /// /// Get all available s. - /// Related API documentation. + /// Related API documentation. /// /// to use for the HTTP request. /// A list of s. diff --git a/EasyPost/Services/CustomsInfoService.cs b/EasyPost/Services/CustomsInfoService.cs index b4f0e8200..1549d8a8e 100644 --- a/EasyPost/Services/CustomsInfoService.cs +++ b/EasyPost/Services/CustomsInfoService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of customs info-related functionality. + /// Class representing a set of customs info-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class CustomsInfoService : EasyPostService @@ -28,7 +28,7 @@ internal CustomsInfoService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task Create(Dictionary parameters, Can /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -56,7 +56,7 @@ public async Task Create(Parameters.CustomsInfo.Create parameters, /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/CustomsItemService.cs b/EasyPost/Services/CustomsItemService.cs index 5e5906d2c..009df5112 100644 --- a/EasyPost/Services/CustomsItemService.cs +++ b/EasyPost/Services/CustomsItemService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of customs item-related functionality. + /// Class representing a set of customs item-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class CustomsItemService : EasyPostService @@ -28,7 +28,7 @@ internal CustomsItemService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task Create(Dictionary parameters, Can /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -56,7 +56,7 @@ public async Task Create(Parameters.CustomsItem.Create parameters, /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/EndShipperService.cs b/EasyPost/Services/EndShipperService.cs index b37d25f73..c56d69186 100644 --- a/EasyPost/Services/EndShipperService.cs +++ b/EasyPost/Services/EndShipperService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of EndShipper-related functionality. + /// Class representing a set of EndShipper-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class EndShipperService : EasyPostService @@ -28,7 +28,7 @@ internal EndShipperService(EasyPostClient client) /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task Create(Dictionary parameters, Canc /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -56,7 +56,7 @@ public async Task Create(Parameters.EndShipper.Create parameters, Ca /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// A dictionary containing parameters to filter the list with. See for valid keys. /// to use for the HTTP request. @@ -71,7 +71,7 @@ public async Task All(Dictionary? paramete /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -88,7 +88,7 @@ public async Task All(Parameters.EndShipper.All parameters /// /// Retrieve an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -98,7 +98,7 @@ public async Task All(Parameters.EndShipper.All parameters /// /// Update an . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to update. /// Data to update with. @@ -114,7 +114,7 @@ public async Task Update(string id, Dictionary param /// /// Update an . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to update. /// Data to update with. diff --git a/EasyPost/Services/EventService.cs b/EasyPost/Services/EventService.cs index 134f97c43..033862a14 100644 --- a/EasyPost/Services/EventService.cs +++ b/EasyPost/Services/EventService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of event-related functionality. + /// Class representing a set of event-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class EventService : EasyPostService @@ -29,7 +29,7 @@ internal EventService(EasyPostClient client) /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Dictionary containing parameters to filter the results on. See for valid keys. /// to use for the HTTP request. @@ -44,7 +44,7 @@ public async Task All(Dictionary? parameters = /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -59,7 +59,7 @@ public async Task All(Parameters.Event.All parameters, Cancella /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -71,7 +71,7 @@ public async Task All(Parameters.Event.All parameters, Cancella /// /// Retrieve an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -81,7 +81,7 @@ public async Task All(Parameters.Event.All parameters, Cancella /// /// Retrieve all s for an . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to retrieve payloads for. /// to use for the HTTP request. @@ -90,7 +90,7 @@ public async Task All(Parameters.Event.All parameters, Cancella /// /// Retrieve a specific for an . - /// Related API documentation. + /// Related API documentation. /// /// ID of the to retrieve payload for. /// ID of the to retrieve. diff --git a/EasyPost/Services/InsuranceService.cs b/EasyPost/Services/InsuranceService.cs index 211b99310..2d4c8a70b 100644 --- a/EasyPost/Services/InsuranceService.cs +++ b/EasyPost/Services/InsuranceService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of insurance-related functionality. + /// Class representing a set of insurance-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class InsuranceService : EasyPostService @@ -29,7 +29,7 @@ internal InsuranceService(EasyPostClient client) /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task Create(Dictionary parameters, Cance /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Insurance.Create parameters, Canc /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s. /// to use for the HTTP request. @@ -72,7 +72,7 @@ public async Task All(Dictionary? parameter /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s. /// to use for the HTTP request. @@ -87,7 +87,7 @@ public async Task All(Parameters.Insurance.All parameters, /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -99,7 +99,7 @@ public async Task All(Parameters.Insurance.All parameters, /// /// Retrieve an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -109,7 +109,7 @@ public async Task All(Parameters.Insurance.All parameters, /// /// Refund an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to refund. /// to use for the HTTP request. diff --git a/EasyPost/Services/OrderService.cs b/EasyPost/Services/OrderService.cs index 543e77aa0..d937fb63b 100644 --- a/EasyPost/Services/OrderService.cs +++ b/EasyPost/Services/OrderService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of order-related functionality. + /// Class representing a set of order-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class OrderService : EasyPostService @@ -29,7 +29,7 @@ internal OrderService(EasyPostClient client) /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task Create(Dictionary parameters, Cancellat /// /// Create an . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Order.Create parameters, Cancellation /// /// Retrieve an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -67,7 +67,7 @@ public async Task Create(Parameters.Order.Create parameters, Cancellation /// /// Purchase the s within an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase. /// The carrier to purchase the s with. @@ -88,7 +88,7 @@ public async Task Buy(string id, string withCarrier, string withService, /// /// Purchase the s within an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase. /// The to purchase the s with. @@ -114,7 +114,7 @@ public async Task Buy(string id, Rate rate, CancellationToken cancellatio /// /// Purchase the s within an . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase. /// parameters set. diff --git a/EasyPost/Services/ParcelService.cs b/EasyPost/Services/ParcelService.cs index 9397b4002..8e259b205 100644 --- a/EasyPost/Services/ParcelService.cs +++ b/EasyPost/Services/ParcelService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of parcel-related functionality. + /// Class representing a set of parcel-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class ParcelService : EasyPostService @@ -28,7 +28,7 @@ internal ParcelService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task Create(Dictionary parameters, Cancella /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -56,7 +56,7 @@ public async Task Create(Parameters.Parcel.Create parameters, Cancellati /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/PickupService.cs b/EasyPost/Services/PickupService.cs index 1d7e8716e..4996a10f3 100644 --- a/EasyPost/Services/PickupService.cs +++ b/EasyPost/Services/PickupService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of pickup-related functionality. + /// Class representing a set of pickup-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class PickupService : EasyPostService @@ -29,7 +29,7 @@ internal PickupService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task Create(Dictionary parameters, Cancella /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Pickup.Create parameters, Cancellati /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -67,7 +67,7 @@ public async Task Create(Parameters.Pickup.Create parameters, Cancellati /// /// List all objects. - /// Related API documentation. + /// Related API documentation. /// /// The parameters to filter the list of objects by. /// to use for the HTTP request. @@ -82,7 +82,7 @@ public async Task All(Dictionary? parameters = /// /// List all objects. - /// Related API documentation. + /// Related API documentation. /// /// The parameters to filter the list of objects by. /// to use for the HTTP request. @@ -97,7 +97,7 @@ public async Task All(Parameters.Pickup.All parameters, Cancel /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -109,7 +109,7 @@ public async Task All(Parameters.Pickup.All parameters, Cancel /// /// Purchase a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase. /// The name of the carrier to purchase the with. @@ -130,7 +130,7 @@ public async Task Buy(string id, string withCarrier, string withService, /// /// Purchase a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase. /// The parameters to purchase the with. @@ -144,7 +144,7 @@ public async Task Buy(string id, Parameters.Pickup.Buy parameters, Cance /// /// Cancel a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to cancel. /// to use for the HTTP request. diff --git a/EasyPost/Services/RateService.cs b/EasyPost/Services/RateService.cs index caf6ad6d8..37d832921 100644 --- a/EasyPost/Services/RateService.cs +++ b/EasyPost/Services/RateService.cs @@ -8,7 +8,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of rate-related functionality. + /// Class representing a set of rate-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class RateService : EasyPostService diff --git a/EasyPost/Services/ReferralCustomerService.cs b/EasyPost/Services/ReferralCustomerService.cs index 5380cc28a..1ad2db078 100644 --- a/EasyPost/Services/ReferralCustomerService.cs +++ b/EasyPost/Services/ReferralCustomerService.cs @@ -17,7 +17,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of referral customer-related functionality. + /// Class representing a set of referral customer-related functionality. /// public class ReferralCustomerService : EasyPostService { @@ -35,7 +35,7 @@ internal ReferralCustomerService(EasyPostClient client) /// /// Create a for the account associated with the API key used. /// This function should be called against a configured with the white label partner's API key. - /// Referral Customer API documentation. + /// Referral Customer API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -50,7 +50,7 @@ public async Task CreateReferral(Dictionary pa /// /// Create a for the account associated with the API key used. /// This function should be called against a configured with the white label partner's API key. - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -65,7 +65,7 @@ public async Task CreateReferral(Parameters.ReferralCustomer.C /// /// List all s. /// This function should be called against a configured with the white label partner's API key. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s. /// to use for the HTTP request. @@ -81,7 +81,7 @@ public async Task All(Dictionary? pa /// /// List all s. /// This function should be called against a configured with the white label partner's API key. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s. /// to use for the HTTP request. @@ -96,7 +96,7 @@ public async Task All(Parameters.ReferralCustomer.Al /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -110,7 +110,7 @@ public async Task All(Parameters.ReferralCustomer.Al /// Add a credit card to a . /// This function should be called against a configured with the white label partner's API key. /// This function requires the target 's API key as a parameter. - /// Related API documentation. + /// Related API documentation. /// /// API key of the . /// Credit card number. @@ -147,7 +147,7 @@ public async Task AddCreditCardToUser(string referralApiKey, stri /// /// Update a 's email. /// This function should be called against a configured with the white label partner's API key. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update. /// The new email address for the . diff --git a/EasyPost/Services/RefundService.cs b/EasyPost/Services/RefundService.cs index 68ad83757..24658a2ea 100644 --- a/EasyPost/Services/RefundService.cs +++ b/EasyPost/Services/RefundService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of refund-related functionality. + /// Class representing a set of refund-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class RefundService : EasyPostService @@ -29,7 +29,7 @@ internal RefundService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task> Create(Dictionary parameters, Ca /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task> Create(Parameters.Refund.Create parameters, Canc /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. Refer to for more information. /// to use for the HTTP request. @@ -72,7 +72,7 @@ public async Task All(Dictionary? parameters = /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -87,7 +87,7 @@ public async Task All(Parameters.Refund.All parameters, Cancel /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -99,7 +99,7 @@ public async Task All(Parameters.Refund.All parameters, Cancel /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/ReportService.cs b/EasyPost/Services/ReportService.cs index d7d1cdc0b..bb2fa5066 100644 --- a/EasyPost/Services/ReportService.cs +++ b/EasyPost/Services/ReportService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of report-related functionality. + /// Class representing a set of report-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class ReportService : EasyPostService @@ -28,7 +28,7 @@ internal ReportService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Type of to create. /// Data to use to create the . @@ -39,7 +39,7 @@ internal ReportService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Report.Create parameters, Cancellati /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// The type of s to list. /// Parameters to filter the list of s on. @@ -76,7 +76,7 @@ public async Task All(string type, Dictionary? /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -96,7 +96,7 @@ public async Task All(Parameters.Report.All parameters, Cancel /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -109,7 +109,7 @@ public async Task All(Parameters.Report.All parameters, Cancel /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -121,7 +121,7 @@ public async Task All(Parameters.Report.All parameters, Cancel /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// Type of to retrieve. /// The ID of the to retrieve. diff --git a/EasyPost/Services/ScanFormService.cs b/EasyPost/Services/ScanFormService.cs index eca5d296a..979d17710 100644 --- a/EasyPost/Services/ScanFormService.cs +++ b/EasyPost/Services/ScanFormService.cs @@ -10,7 +10,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of scan form-related functionality. + /// Class representing a set of scan form-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class ScanFormService : EasyPostService @@ -28,7 +28,7 @@ internal ScanFormService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// s to create a for. /// to use for the HTTP request. @@ -42,7 +42,7 @@ public async Task Create(List shipments, CancellationToken c /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -56,7 +56,7 @@ public async Task Create(Parameters.ScanForm.Create parameters, Cancel /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -71,7 +71,7 @@ public async Task All(Dictionary? parameters /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -86,7 +86,7 @@ public async Task All(Parameters.ScanForm.All parameters, Ca /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -98,7 +98,7 @@ public async Task All(Parameters.ScanForm.All parameters, Ca /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/ShipmentService.cs b/EasyPost/Services/ShipmentService.cs index d06392697..f755cd262 100644 --- a/EasyPost/Services/ShipmentService.cs +++ b/EasyPost/Services/ShipmentService.cs @@ -11,7 +11,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of shipment-related functionality. + /// Class representing a set of shipment-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class ShipmentService : EasyPostService @@ -29,7 +29,7 @@ internal ShipmentService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -43,7 +43,7 @@ public async Task Create(Dictionary parameters, Cancel /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -57,7 +57,7 @@ public async Task Create(Parameters.Shipment.Create parameters, Cancel /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -72,7 +72,7 @@ public async Task All(Dictionary? parameters /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s on. /// to use for the HTTP request. @@ -87,7 +87,7 @@ public async Task All(Parameters.Shipment.All parameters, Ca /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -99,7 +99,7 @@ public async Task All(Parameters.Shipment.All parameters, Ca /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -109,7 +109,7 @@ public async Task All(Parameters.Shipment.All parameters, Ca /// /// Get the s for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to get rates for. /// to use for the HTTP request. @@ -122,7 +122,7 @@ public async Task> GetSmartRates(string id, CancellationToken ca /// /// Retrieve the estimated delivery date of each rate for a via the SmartRates API. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to get rates for. /// The planned shipment date. @@ -140,7 +140,7 @@ public async Task> RetrieveEstimatedDelivery /// /// Retrieve the estimated delivery date of each rate for a via the SmartRates API. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to get rates for. /// The parameters to include on the API call. @@ -154,6 +154,7 @@ public async Task> RetrieveEstimatedDelivery /// /// Retrieve a recommended ship date for a via the Precision Shipping API, based on a specific desired delivery date. + /// Related API documentation. /// /// The ID of the to get rate estimates for. /// The desired delivery date for the shipment. @@ -171,7 +172,7 @@ public async Task> RecommendShipDate(st /// /// Purchase a label for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase the label for. /// The ID of the to purchase the shipment with. @@ -203,7 +204,7 @@ public async Task Buy(string id, string? rateId, string? insuranceValu /// /// Purchase a label for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase the label for. /// The to purchase the with. @@ -224,7 +225,7 @@ public async Task Buy(string id, Rate rate, string? insuranceValue = n /// /// Purchase a label for this with the given . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to purchase the label for. /// parameters set. @@ -238,7 +239,7 @@ public async Task Buy(string id, Parameters.Shipment.Buy parameters, C /// /// Generate a for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a label for. /// Format to generate the in. Valid formats: "pdf", "zpl" and "epl2". @@ -254,7 +255,7 @@ public async Task GenerateLabel(string id, string fileFormat, Cancella /// /// Generate a for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a label for. /// parameter set. @@ -268,7 +269,7 @@ public async Task GenerateLabel(string id, Parameters.Shipment.Generat /// /// Generate a for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a form for. /// Parameters to generate the with. @@ -284,7 +285,7 @@ public async Task GenerateForm(string id, Dictionary p /// /// Generate a for a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to generate a form for. /// parameter set. @@ -298,7 +299,7 @@ public async Task GenerateForm(string id, Parameters.Shipment.Generate /// /// Insure a for the given amount. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to insure. /// The amount to insure the for. Currency is provided when creating a . @@ -314,7 +315,7 @@ public async Task Insure(string id, double amount, CancellationToken c /// /// Insure a for the given amount. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to insure. /// parameters set. @@ -328,7 +329,7 @@ public async Task Insure(string id, Parameters.Shipment.Insure paramet /// /// Send a refund request to the carrier a was purchased from. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to refund. /// to use for the HTTP request. @@ -341,6 +342,7 @@ public async Task Refund(string id, CancellationToken cancellationToke /// /// Refresh the s for a . + /// Related API documentation. /// /// The ID of the to refresh rates for. /// Optional dictionary of parameters for the API request. @@ -355,7 +357,8 @@ public async Task RegenerateRates(string id, Dictionary - /// Refresh the s for a . + /// Refresh the s for a . + /// Related API documentation. /// /// The ID of the to refresh rates for. /// parameter set. diff --git a/EasyPost/Services/TrackerService.cs b/EasyPost/Services/TrackerService.cs index b8d783023..1cf7618a1 100644 --- a/EasyPost/Services/TrackerService.cs +++ b/EasyPost/Services/TrackerService.cs @@ -12,7 +12,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of tracker-related functionality. + /// Class representing a set of tracker-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class TrackerService : EasyPostService @@ -30,7 +30,7 @@ internal TrackerService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Carrier for the . /// Tracking code for the . @@ -50,7 +50,7 @@ public async Task Create(string carrier, string trackingCode, Cancellat /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -92,7 +92,7 @@ public async Task CreateList(Parameters.Tracker.CreateList parameters, Cancellat /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// A dictionary of parameters to filter the list of s with. /// to use for the HTTP request. @@ -108,7 +108,7 @@ public async Task All(Dictionary? parameters /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// parameter set. /// to use for the HTTP request. @@ -123,7 +123,7 @@ public async Task All(Parameters.Tracker.All parameters, Canc /// /// Get the next page of a paginated . - /// Related API documentation. + /// Related API documentation. /// /// The to get the next page of. /// The size of the next page. @@ -135,7 +135,7 @@ public async Task All(Parameters.Tracker.All parameters, Canc /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. diff --git a/EasyPost/Services/UserService.cs b/EasyPost/Services/UserService.cs index 6e49e7fb1..42c10ae81 100644 --- a/EasyPost/Services/UserService.cs +++ b/EasyPost/Services/UserService.cs @@ -12,7 +12,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of user-related functionality. + /// Class representing a set of user-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class UserService : EasyPostService @@ -30,7 +30,7 @@ internal UserService(EasyPostClient client) /// /// Create a child for the current account. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to create the child with. /// to use for the HTTP request. @@ -44,7 +44,7 @@ public async Task CreateChild(Dictionary parameters, Cance /// /// Create a child for the current account. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to create the child with. /// to use for the HTTP request. @@ -84,7 +84,7 @@ public async Task Retrieve(string? id = null, CancellationToken cancellati /// /// List all Child objects. - /// Related API documentation. + /// Related API documentation. /// /// Dictionary containing parameters to filter the result list with. /// to use for the HTTP request. @@ -124,7 +124,7 @@ public async Task AllChildren(AllChildren parameters, Cance /// /// Update a 's . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update the of. /// Parameters to update the with. @@ -139,7 +139,7 @@ public async Task UpdateBrand(string id, Dictionary param /// /// Update a 's . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update the of. /// Parameters to update the with. @@ -153,7 +153,7 @@ public async Task UpdateBrand(string id, Parameters.User.UpdateBrand para /// /// Update a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update. /// Data to update with. @@ -167,7 +167,7 @@ public async Task Update(string id, Dictionary parameters, /// /// Update a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update. /// Data to update with. @@ -181,7 +181,7 @@ public async Task Update(string id, Parameters.User.Update parameters, Can /// /// Delete a child . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the child to delete. /// to use for the HTTP request. diff --git a/EasyPost/Services/WebhookService.cs b/EasyPost/Services/WebhookService.cs index 7e461b4a0..2a4bfb466 100644 --- a/EasyPost/Services/WebhookService.cs +++ b/EasyPost/Services/WebhookService.cs @@ -14,7 +14,7 @@ namespace EasyPost.Services { /// - /// Class representing a set of webhook-related functionality. + /// Class representing a set of webhook-related functionality. /// // ReSharper disable once ClassNeverInstantiated.Global public class WebhookService : EasyPostService @@ -32,7 +32,7 @@ internal WebhookService(EasyPostClient client) /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -46,7 +46,7 @@ public async Task Create(Dictionary parameters, Cancell /// /// Create a . - /// Related API documentation. + /// Related API documentation. /// /// Data to use to create the . /// to use for the HTTP request. @@ -60,7 +60,7 @@ public async Task Create(Parameters.Webhook.Create parameters, Cancella /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s returned. /// to use for the HTTP request. @@ -70,7 +70,7 @@ public async Task Create(Parameters.Webhook.Create parameters, Cancella /// /// List all s. - /// Related API documentation. + /// Related API documentation. /// /// Parameters to filter the list of s returned. /// to use for the HTTP request. @@ -80,7 +80,7 @@ public async Task Create(Parameters.Webhook.Create parameters, Cancella /// /// Retrieve a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to retrieve. /// to use for the HTTP request. @@ -90,7 +90,7 @@ public async Task Create(Parameters.Webhook.Create parameters, Cancella /// /// Enable a disabled or alter its secret. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update. /// Data to update with. @@ -104,7 +104,7 @@ public async Task Update(string id, Dictionary? paramet /// /// Enable a disabled or alter its secret. - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to update. /// Optional data to update with. @@ -118,7 +118,7 @@ public async Task Update(string id, Parameters.Webhook.Update? paramete /// /// Delete a . - /// Related API documentation. + /// Related API documentation. /// /// The ID of the to delete. /// to use for the HTTP request. @@ -128,7 +128,7 @@ public async Task Update(string id, Parameters.Webhook.Update? paramete /// /// Validate a received webhook's HMAC signature. - /// Related API documentation. + /// Related API documentation. /// /// Byte data of the received webhook request. /// Dictionary of headers from the received webhook request. diff --git a/README.md b/README.md index 165c20b50..0a74a992c 100644 --- a/README.md +++ b/README.md @@ -243,7 +243,7 @@ Client client = new(new ClientConfiguration(FakeApikey) ## Documentation -API documentation can be found at: . +API documentation can be found at: . Library documentation can be found on the web at: or locally on the [`gh-pages` branch](https://github.com/EasyPost/easypost-csharp/tree/gh-pages).