Class Retrieve

Parameters for API calls.

Inheritance

System.Object

BaseParameters<StatelessRate>

Retrieve

Implements

IBaseParameters

Inherited Members

BaseParameters<StatelessRate>.MatchFunction

BaseParameters<StatelessRate>.Matches(StatelessRate)

BaseParameters<StatelessRate>.ToSubDictionary(Type)

Namespace: EasyPost.Parameters.Beta.Rate

Assembly: EasyPost.dll

Syntax

public class Retrieve : BaseParameters<StatelessRate>, IBaseParameters

Properties

CarrierAccounts

List of CarrierAccounts to use to retrieve StatelessRates. The provided CarrierAccounts must exist prior to making the API call.

Declaration

public List<CarrierAccount>? CarrierAccounts { get; set; }

Property Value

Type	Description
System.Nullable<List<CarrierAccount>>

FromAddress

List of Addresses (or Create parameters) to use to retrieve StatelessRates.

Declaration

public IAddressParameter FromAddress { get; set; }

Property Value

Type	Description
IAddressParameter

Options

Additional Options to use to retrieve StatelessRates.

Declaration

public Options Options { get; set; }

Property Value

Type	Description
Options

Parcel

Parcel (or Create parameters) to use to retrieve StatelessRates.

Declaration

public IParcelParameter Parcel { get; set; }

Property Value

Type	Description
IParcelParameter

Reference

Reference name to use to retrieve StatelessRates.

Declaration

public string? Reference { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Service

Service name to use to retrieve StatelessRates.

Declaration

public string? Service { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ToAddress

List of Addresses (or Create parameters) to use to retrieve StatelessRates.

Declaration

public IAddressParameter ToAddress { get; set; }

Property Value

Type	Description
IAddressParameter

Methods

ToDictionary()

Override the default ToDictionary() method to handle the unique serialization requirements for this parameter set.

Declaration

public override Dictionary<string, object> ToDictionary()

Returns

Type	Description
Dictionary<System.String, System.Object>	A .

Overrides

EasyPost.Parameters.BaseParameters<EasyPost.Models.API.Beta.StatelessRate>.ToDictionary()

Implements

IBaseParameters