Show / Hide Table of Contents

Class Retrieve

Parameters for API calls.

Inheritance
System.Object
BaseParameters<CarrierMetadata>
Retrieve
Implements
IBaseParameters
Inherited Members
BaseParameters<CarrierMetadata>.MatchFunction
BaseParameters<CarrierMetadata>.Matches(CarrierMetadata)
BaseParameters<CarrierMetadata>.ToSubDictionary(Type)
Namespace: EasyPost.Parameters.CarrierMetadata
Assembly: EasyPost.dll
Syntax
public class Retrieve : BaseParameters<CarrierMetadata>, IBaseParameters

Properties

| Improve this Doc View Source

Carriers

A list of carrier names to retrieve metadata for.

Declaration
public List<string>? Carriers { get; set; }
Property Value
Type Description
System.Nullable<List<System.String>>
| Improve this Doc View Source

Types

A list of CarrierMetadataTypes to retrieve.

Declaration
public List<CarrierMetadataType>? Types { get; set; }
Property Value
Type Description
System.Nullable<List<CarrierMetadataType>>

Methods

| Improve this Doc View Source

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.CarrierMetadata>.ToDictionary()

Implements

IBaseParameters
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX