ERP/TradeManageNew/APIClients/FedexApi/Models/RatesAndTransitTimes/RequestedShipment.cs

namespace TradeManageNew.APIClients.FedexApi.Models.RatesAndTransitTimes
{
    /// <summary>
    /// This is shipment data for which a rate quote (or rate-shipping comparison) is requested.
    /// </summary>
    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0))")]
    public partial class RequestedShipment
    {
        /// <summary>
        /// The descriptive data for the physical shipper location from which the shipment originates.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("shipper", Required = Newtonsoft.Json.Required.Always)]
        [System.ComponentModel.DataAnnotations.Required]
        public RateParty Shipper { get; set; } = new RateParty();

        /// <summary>
        /// Indicate the descriptive data for the recipient location to which the shipment is to be received.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("recipient", Required = Newtonsoft.Json.Required.Always)]
        [System.ComponentModel.DataAnnotations.Required]
        public RateParty Recipient { get; set; } = new RateParty();

        /// <summary>
        /// Indicate the FedEx service type used for this shipment. The results will be filtered by the service type value indicated. If no serviceType is indicated then all the applicable services and corresponding rates will be returned.&lt;br&gt;Example: STANDARD_OVERNIGHT&lt;br&gt;&lt;a onclick='loadDocReference("servicetypes")'&gt;Click here to see Service Types&lt;/a&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("serviceType", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
        public RequestedRateServiceType? ServiceType { get; set; }

        /// <summary>
        /// Indicate the currency the caller requests to have used in all returned monetary values (when a choice is possible). Used in conjunction with the rateRequestType data element. This element is used to pull Preferred rates.&lt;br&gt;Example: USD&lt;br&gt;&lt;a onclick='loadDocReference("currencycodes")'&gt; Click here to see Currency Codes&lt;/a&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("preferredCurrency", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public string PreferredCurrency { get; set; }

        /// <summary>
        /// Indicate the type of rates to be returned.&lt;br&gt;Following are values:&lt;ul&gt;&lt;li&gt;LIST - Returns FedEx published list rates in addition to account-specific rates (if applicable).&lt;/li&gt;&lt;li&gt;PREFERRED - Returns rates in the preferred currency specified in the element preferredCurrency.&lt;/li&gt;&lt;li&gt;ACCOUNT - Returns account specific rates (Default).&lt;/li&gt;&lt;li&gt;INCENTIVE - This is one-time discount for incentivising the customer. For more information, contact your FedEx representative.&lt;/li&gt;&lt;/ul&gt;Examples: ["LIST","PREFERRED"]
        /// </summary>
        [Newtonsoft.Json.JsonProperty("rateRequestType", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore, ItemConverterType = typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
        public System.Collections.Generic.ICollection<RateRequestType> RateRequestType { get; set; }

        /// <summary>
        ///  This is shipment date. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone.&lt;br&gt;Required Format is YYYY-MM-DD&lt;br&gt; Example: 2019-09-05
        /// </summary>
        [Newtonsoft.Json.JsonProperty("shipDateStamp", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public string ShipDateStamp { get; set; }

        /// <summary>
        /// Indicate the pickup type method by which the shipment to be tendered to FedEx.&lt;br&gt;&lt;a onclick='loadDocReference("pickuptypes")'&gt;Click here for more information on Pickup Types.&lt;/a&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("pickupType", Required = Newtonsoft.Json.Required.Always)]
        [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)]
        [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
        public RequestedShipmentPickupType PickupType { get; set; }

        /// <summary>
        /// These are one or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics of all packages in the shipment.&lt;ul&gt;&lt;li&gt;At least one instance containing the weight for at least one package is required for EXPRESS and GROUND shipments.&lt;/li&gt;&lt;li&gt;Not used for FREIGHT.&lt;/li&gt;&lt;li&gt;Single piece requests will have one RequestedPackageLineItem.&lt;/li&gt;&lt;li&gt;Multiple piece requests will have multiple RequestedPackageLineItems.&lt;/li&gt;&lt;li&gt;Maximum occurrences is 99.&lt;/li&gt;&lt;/ul&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("requestedPackageLineItems", Required = Newtonsoft.Json.Required.Always)]
        [System.ComponentModel.DataAnnotations.Required]
        public System.Collections.Generic.ICollection<RequestedPackageLineItem> RequestedPackageLineItems { get; set; } = new System.Collections.ObjectModel.Collection<RequestedPackageLineItem>();

        /// <summary>
        /// Indicate whether or not its a document Shipment.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("documentShipment", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public bool? DocumentShipment { get; set; }

        /// <summary>
        /// contains the detail used to calculate a variable handling charge, a potentially non-fixed handling surcharge. Based on if there is a percent value, or a fixed amount, the charge can either be fixed or percents based.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("variableHandlingChargeDetail", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public VariableHandlingChargeDetail VariableHandlingChargeDetail { get; set; }

        /// <summary>
        /// This is the Packaging type associated with this rate. For Ground/SmartPost,it  will always be YOUR_PACKAGING. For domestic Express, the packaging may have been bumped so it may not match the value specified on the request. For International Express the packaging may be bumped and not mapped.&lt;br&gt;&lt;a onclick='loadDocReference("packagetypes")'&gt;Click here to see Package Types&lt;/a&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("packagingType", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
        public RequestedRatePackageType? PackagingType { get; set; }

        /// <summary>
        /// Indicate the total number of packages in the shipment. &lt;br&gt;The Maximum number of packages in a rate request is 100.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalPackageCount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public int? TotalPackageCount { get; set; }

        /// <summary>
        /// Specify the total weight of the shipment. &lt;br&gt;This is only applies to International shipments and should be used on the first package of a multiple piece shipment. This value contains 1 explicit decimal position.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalWeight", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public double? TotalWeight { get; set; }

        [Newtonsoft.Json.JsonProperty("shipmentSpecialServices", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public RequestedShipmentSpecialServicesRequested ShipmentSpecialServices { get; set; }

        [Newtonsoft.Json.JsonProperty("customsClearanceDetail", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public RequestedShipmentCustomsClearanceDetail CustomsClearanceDetail { get; set; }

        [Newtonsoft.Json.JsonProperty("serviceTypeDetail", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public ServiceTypeDetailVO ServiceTypeDetail { get; set; }

        [Newtonsoft.Json.JsonProperty("smartPostInfoDetail", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public RequestedShipmentSmartPostInfoDetail SmartPostInfoDetail { get; set; }

        private System.Collections.Generic.IDictionary<string, object> _additionalProperties;

        [Newtonsoft.Json.JsonExtensionData]
        public System.Collections.Generic.IDictionary<string, object> AdditionalProperties
        {
            get { return _additionalProperties ?? (_additionalProperties = new System.Collections.Generic.Dictionary<string, object>()); }
            set { _additionalProperties = value; }
        }

    }
}