Class BaseParameters<TMatchInputType>

Base class for all parameters used in functions.

Inheritance

System.Object

BaseParameters<TMatchInputType>

Create

BaseAllParameters<TMatchInputType>

AddShipments

Create

GenerateLabel

GenerateScanForm

RemoveShipments

Retrieve

ACreate

AUpdate

Retrieve

Create

Create

Create

Create

Update

Create

Buy

CreateAndBuy

GetPromise

Buy

Create

Create

Buy

Create

AddPaymentMethod

CreateReferralCustomer

RefundByAmount

RefundByPaymentLog

Create

Create

Create

Buy

Create

GenerateForm

GenerateLabel

Insure

RegenerateRates

RetrieveEstimatedDeliveryDate

EstimateDeliveryDateForZipPair

RecommendShipDateForZipPair

Create

Create

CreateChild

Update

UpdateBrand

Create

Update

Implements

IBaseParameters

Namespace: EasyPost.Parameters

Assembly: EasyPost.dll

Syntax

public abstract class BaseParameters<TMatchInputType> : object, IBaseParameters where TMatchInputType : EphemeralEasyPostObject

Type Parameters

Name	Description
TMatchInputType	The type of EphemeralEasyPostObject that will be compared against in the MatchFunction.

Constructors

BaseParameters()

Initializes a new instance of the BaseParameters<TMatchInputType> class for a new set of request parameters.

Declaration

protected BaseParameters()

Properties

MatchFunction

A function to determine if a given object matches this parameter set. Defaults to always returning false, but can be overridden by child classes and end-users.

Declaration

public Func<TMatchInputType, bool> MatchFunction { get; set; }

Property Value

Type	Description
Func<TMatchInputType, System.Boolean>

Methods

Matches(TMatchInputType)

Execute the match function on a given object.

Declaration

public bool Matches(TMatchInputType obj)

Parameters

Type	Name	Description
TMatchInputType	obj	The EasyPostObject to compare this parameter set against.

Returns

Type	Description
System.Boolean	The result of the MatchFunction.

ToDictionary()

Convert this parameter object to a dictionary for an HTTP request.

Declaration

public virtual Dictionary<string, object> ToDictionary()

Returns

Type	Description
Dictionary<System.String, System.Object>	of parameters.

ToSubDictionary(Type)

Convert this parameters object to a sub-dictionary, for use in a parent parameter object's dictionary.

Declaration

public virtual Dictionary<string, object> ToSubDictionary(Type parentParameterObjectType)

Parameters

Type	Name	Description
Type	parentParameterObjectType	The type of the parent parameter object in which this dictionary will be embedded.

Returns

Type	Description
Dictionary<System.String, System.Object>	of parameters.

Implements

IBaseParameters