Skip to content

Commit

Permalink
Revert "- Add missing docstrings"
Browse files Browse the repository at this point in the history
This reverts commit 67a7f1a
  • Loading branch information
nwithan8 committed Oct 25, 2023
1 parent 06f5d4b commit c02049f
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 50 deletions.
13 changes: 1 addition & 12 deletions EasyPost/Hooks.cs
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
using System;
using System.Collections.Generic;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using EasyPost._base;

namespace EasyPost;

/// <summary>
/// Class representing a set of callbacks to use for introspecting API requests made by an <see cref="EasyPostClient"/>.
/// </summary>
public class Hooks
{
/// <summary>
Expand All @@ -23,10 +20,6 @@ public class Hooks
public EventHandler<OnRequestResponseReceivedEventArgs>? OnRequestResponseReceived { get; set; }
}

/// <summary>
/// Represents a set of <see cref="EventArgs"/> containing information about an in-flight HTTP request.
/// This set is passed into the <see cref="Hooks.OnRequestExecuting"/> event handler.
/// </summary>
public class OnRequestExecutingEventArgs : EventArgs
{
/// <summary>
Expand Down Expand Up @@ -78,10 +71,6 @@ internal OnRequestExecutingEventArgs(HttpRequestMessage request, int timestamp,
}
}

/// <summary>
/// Represents a set of <see cref="EventArgs"/> containing information about an HTTP response received by the client.
/// This set is passed into the <see cref="Hooks.OnRequestResponseReceived"/> event handler.
/// </summary>
public class OnRequestResponseReceivedEventArgs : EventArgs
{
/// <summary>
Expand Down
26 changes: 0 additions & 26 deletions EasyPost/Models/API/CarrierAccountType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,18 @@

namespace EasyPost.Models.API;

/// <summary>
/// Enums representing specific carrier account types.
/// </summary>
public class CarrierAccountType : ValueEnum
{
/// <summary>
/// Represents a FedEx carrier account.
/// </summary>
public static readonly CarrierAccountType FedEx = new CarrierAccountType(26, "FedexAccount");

/// <summary>
/// Represents a FedEx SmartPost carrier account.
/// </summary>
public static readonly CarrierAccountType FedExSmartPost = new CarrierAccountType(30, "FedexSmartpostAccount");

/// <summary>
/// Represents a UPS carrier account.
/// </summary>
public static readonly CarrierAccountType Ups = new CarrierAccountType(59, "UpsAccount");

/// <summary>
/// Constructor for CarrierAccountType enum.
/// </summary>
/// <param name="id">Internal ID of the enum. Must be unique among all enums of this specific type.</param>
/// <param name="name">Name of the carrier account type. Stored as the value associated with this enum.</param>
private CarrierAccountType(int id, string name)
: base(id, name)
{
}

/// <summary>
/// Gets the name of this <see cref="CarrierAccountType"/>.
/// </summary>
public string Name => (string)Value;

/// <summary>
/// Gets all <see cref="CarrierAccountType"/> enums.
/// </summary>
/// <returns></returns>
public static IEnumerable<CarrierAccountType> All() => GetAll<CarrierAccountType>();
}
12 changes: 0 additions & 12 deletions EasyPost/Parameters/IBaseParameters.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,9 @@

namespace EasyPost.Parameters;

/// <summary>
/// Base interface for all EasyPost API parameters.
/// </summary>
public interface IBaseParameters
{
/// <summary>
/// Convert this object to a <see cref="Dictionary{TKey,TValue}"/>.
/// </summary>
/// <returns></returns>
public Dictionary<string, object> ToDictionary();

/// <summary>
/// Convert this object to a sub-<see cref="Dictionary{TKey,TValue}"/> based on the parent parameter object type.
/// </summary>
/// <param name="parentParameterObjectType"></param>
/// <returns></returns>
public Dictionary<string, object> ToSubDictionary(Type parentParameterObjectType);
}

0 comments on commit c02049f

Please sign in to comment.