import { LabelFormat } from './LabelFormat';
import { TPrintCustomCode } from './PrintCustomCode';

/**
 * Shipments can have a variety of additional options which you can specify when creating a shipment.
 * The Options object can be populated with the keys below.
 *
 * @see https://docs.easypost.com/docs/shipments/options#options-object
 */
export declare interface IOptions {
  /**
   * Setting this option to true, will add an additional handling charge.
   * An Additional Handling charge may be applied to the following:
   *  - Any article that is encased in an outside shipping container made of metal or wood.
   *  - Any item, such as a barrel, drum, pail or tire, that is not fully encased in a corrugated cardboard shipping container.
   *  - Any package with the longest side exceeding 60 inches or its second longest side exceeding 30 inches.
   *  - Any package with an actual weight greater than 70 pounds.
   */
  additional_handling?: boolean | null;

  /**
   * Setting this option to "0", will allow the minimum amount of address information to pass the validation check.
   * Only for USPS postage.
   */
  address_validation_level?: string | null;

  /**
   * Set this option to true if your shipment contains alcohol.
   *  - UPS - only supported for US Domestic shipments
   *  - FedEx - only supported for US Domestic shipments
   *  - Canada Post - Requires adult signature 19 years or older. If you want adult signature 18 years or older, instead use delivery_confirmation: ADULT_SIGNATURE
   */
  alcohol?: boolean | null;

  /**
   * Setting this option to true will indicate to the carrier to prefer delivery by drone, if the carrier supports drone delivery.
   */
  by_drone?: boolean | null;

  /**
   * Setting this to true will add a charge to reduce carbon emissions.
   */
  carbon_neutral?: boolean | null;

  /**
   * Adding an amount will have the carrier collect the specified amount from the recipient.
   */
  cod_amount?: string | null;

  /**
   * Method for payment. "CASH", "CHECK", "MONEY_ORDER"
   */
  cod_method?: 'CASH' | 'CHECK' | 'MONEY_ORDER' | null;

  /**
   * The ID of the Address to which the COD payment should be returned.
   * Defaults to the origin address.
   * Only available on FedEx shipments.
   */
  cod_address_id?: string | null;

  /**
   * A description of the content of the shipment.
   */
  content_description?: string | null;

  /**
   * Which currency this shipment will show for rates if carrier allows.
   */
  currency?: string | null;

  /**
   * If you want to request a signature, you can pass "ADULT_SIGNATURE" or "SIGNATURE".
   * You may also request "NO_SIGNATURE" to leave the package at the door.
   *  - All - some options may be limited for international shipments
   *  - FedEx - "INDIRECT_SIGNATURE" is also an option
   *  - USPS - additional options
   *    - "ADULT_SIGNATURE_RESTRICTED"
   *    - "SIGNATURE_RESTRICTED"
   *  - Canada Post - "DO_NOT_SAFE_DROP" - Tells the carrier to not hide the package ("safe drop").
   *  - GSO - "STANDARD_SIGNATURE".
   *  - DHL Express - option mapping
   *    - "SIGNATURE" - DHL Express Direct Signature
   *    - "NO_SIGNATURE" - DHL Express Signature Release
   */
  delivery_confirmation?:
    | 'ADULT_SIGNATURE'
    | 'SIGNATURE'
    | 'NO_SIGNATURE'
    | 'INDIRECT_SIGNATURE'
    | 'ADULT_SIGNATURE_RESTRICTED'
    | 'SIGNATURE_RESTRICTED'
    | null;

  /**
   * Method the customer will use to transfer the package to the carrier.
   * "REGULAR_PICKUP", "SCHEDULED_PICKUP", "RETAIL_LOCATION", "STATION" or "DROP_BOX".
   * Supported carriers and their corresponding carrier dropoff codes:
   *  - FedEx
   *    - "REGULAR_PICKUP" - "REGULAR_PICKUP" (default)
   *    - "SCHEDULED_PICKUP" - "REQUEST_COURIER"
   *    - "RETAIL_LOCATION" - "BUSINESS_SERVICE_CENTER"
   *    - "STATION" - "STATION"
   *    - "DROP_BOX" - "DROP_BOX"
   */
  dropoff_type?:
    | 'REGULAR_PICKUP'
    | 'SCHEDULED_PICKUP'
    | 'RETAIL_LOCATION'
    | 'STATION'
    | 'DROP_BOX'
    | 'REQUEST_COURIER'
    | 'BUSINESS_SERVICE_CENTER'
    | null;

  /**
   * Package contents contain dry ice.
   *  - UPS - Need dry_ice_weight to be set
   *  - UPS MailInnovations - Need dry_ice_weight to be set
   *  - FedEx - Need dry_ice_weight to be set
   */
  dry_ice?: boolean | null;

  /**
   * If the dry ice is for medical use, set this option to true.
   *  - UPS - Need dry_ice_weight to be set
   *  - UPS MailInnovations - Need dry_ice_weight to be set
   */
  dry_ice_medical?: boolean | null;

  /**
   * Weight of the dry ice in ounces.
   *  - UPS - Need dry_ice to be set
   *  - UPS MailInnovations - Need dry_ice to be set
   *  - FedEx - Need dry_ice to be set
   */
  dry_ice_weight?: string | null;

  /**
   * Setting duty_payment type to bill the correct account for purchasing postage.
   * This option is only available with FedEx and UPS.
   *  - type - (string) Supported values are "THIRD_PARTY", and "RECEIVER".
   *  - account - (string) Setting account number.
   *  - country - (string) Setting country code that the account is based in.
   *  - postal_code - (string) Setting postal code that the account is based in.
   */
  duty_payment: object | null;

  /**
   * Possible values "ADDRESS_SERVICE_REQUESTED", "FORWARDING_SERVICE_REQUESTED", "CHANGE_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED", "LEAVE_IF_NO_RESPONSE"
   */
  endorsement?:
    | 'ADDRESS_SERVICE_REQUESTED'
    | 'FORWARDING_SERVICE_REQUESTED'
    | 'CHANGE_SERVICE_REQUESTED'
    | 'RETURN_SERVICE_REQUESTED'
    | 'LEAVE_IF_NO_RESPONSE'
    | null;

  /**
   * Specify the responsible EndShipper for the shipment by passing in an EndShipper ID.
   */
  end_shipper_id: string | null;

  /**
   * Additional cost to be added to the invoice of this shipment.
   * Only applies to UPS currently.
   */
  freight_charge?: number | null;

  /**
   * This is to designate special instructions for the carrier like "Do not drop!".
   */
  handling_instructions?: string | null;

  /**
   * Dangerous goods indicator.
   * Possible values are "PRIMARY_CONTAINED", "PRIMARY_PACKED", "PRIMARY", "SECONDARY_CONTAINED", "SECONDARY_PACKED", "SECONDARY", "ORMD", "LIMITED_QUANTITY", "LITHIUM".
   * Applies to USPS, FedEx and DHL eCommerce.
   */
  hazmat?:
    | 'PRIMARY_CONTAINED'
    | 'PRIMARY_PACKED'
    | 'PRIMARY'
    | 'SECONDARY_CONTAINED'
    | 'SECONDARY_PACKED'
    | 'SECONDARY'
    | 'ORMD'
    | 'LIMITED_QUANTITY'
    | 'LITHIUM'
    | null;

  /**
   * Package will wait at carrier facility for pickup.
   */
  hold_for_pickup?: boolean | null;

  /**
   * Incoterm negotiated for shipment.
   * Supported values are "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP", "FAS", "FOB", "CFR", and "CIF".
   * Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules
   */
  incoterm?:
    | 'EXW'
    | 'FCA'
    | 'CPT'
    | 'CIP'
    | 'DAT'
    | 'DAP'
    | 'DDP'
    | 'FAS'
    | 'FOB'
    | 'CFR'
    | 'CIF'
    | null;

  /**
   * This will print an invoice number on the postage label.
   */
  invoice_number?: string | null;

  /**
   * Set the date that will appear on the postage label.
   * Accepts ISO 8601 formatted string including time zone offset.
   * EasyPost stores all dates as UTC time.
   */
  label_date?: string | null;

  /**
   * Supported label formats include "PNG", "PDF", "ZPL", and "EPL2".
   * "PNG" is the only format that allows for conversion.
   *
   * @see https://docs.easypost.com/docs/shipments#converting-the-label-format-of-a-shipment
   */
  label_format?: LabelFormat | null;

  /**
   * Whether or not the parcel can be processed by the carriers equipment.
   */
  machinable?: boolean | null;

  /**
   * Setting payment type to bill the correct account for purchasing postage.
   */
  payment: {
    /**
     * Supported values are "SENDER", "THIRD_PARTY", "RECEIVER", "COLLECT". Defaults to SENDER.
     */
    type?: 'SENDER' | 'THIRD_PARTY' | 'RECEIVER' | 'COLLECT' | null;

    /**
     * Setting account number.
     * Required for RECEIVER and THIRD_PARTY.
     */
    account?: string | null;

    /**
     * Setting country code that the account is based in.
     * Required for THIRD_PARTY.
     */
    country?: string | null;

    /**
     * Setting postal code that the account is based in.
     * Required for RECEIVER and THIRD_PARTY.
     */
    postal_code?: string | null;
  };

  /**
   * The earliest a package should be picked up. Supported carriers vary.
   */
  pickup_min_datetime: string | null;

  /**
   * The latest a package should be picked up. Supported carriers vary.
   */
  pickup_man_datetime: string | null;

  /**
   * You can optionally print custom messages on labels.
   * The locations of these fields show up on different spots on the carrier's labels.
   */
  print_custom_1?: string | null;

  /**
   * An additional message on the label. Same restrictions as print_custom_1
   */
  print_custom_2?: string | null;

  /**
   * An additional message on the label. Same restrictions as print_custom_1
   */
  print_custom_3?: string | null;

  /**
   * Create a barcode for this custom reference if supported by carrier.
   */
  print_custom_1_barcode?: boolean | null;

  /**
   * Create a barcode for this custom reference if supported by carrier.
   */
  print_custom_2_barcode?: boolean | null;

  /**
   * Create a barcode for this custom reference if supported by carrier.
   */
  print_custom_3_barcode?: boolean | null;

  /**
   * Specify the type of print_custom_1.
   */
  print_custom_1_code?: TPrintCustomCode | null;

  /**
   * Specify the type of print_custom_2.
   */
  print_custom_2_code?: TPrintCustomCode | null;

  /**
   * Specify the type of print_custom_3.
   */
  print_custom_3_code?: TPrintCustomCode | null;

  /**
   * Set this value to true for delivery on Saturday.
   * When setting the saturday_delivery option, you will only get rates for services that are eligible for saturday delivery.
   * If no services are available for saturday delivery, then you will not be returned any rates.
   * You may need to create 2 shipments, one with the saturday_delivery option set on one without to get all your eligible rates.
   */
  saturday_delivery?: boolean | null;

  /**
   * This option allows you to request restrictive rates from USPS.
   * Can set to 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL'.
   */
  special_rates_eligibility?: 'USPS.MEDIAMAIL' | 'USPS.LIBRARYMAIL' | null;

  /**
   * You can use this to override the hub ID you have on your account.
   */
  smartpost_hub?: string | null;

  /**
   * The manifest ID is used to group SmartPost packages onto a manifest for each trailer.
   */
  smartpost_manifest?: string | null;

  /**
   * A reference ID for aggregating DHL eCommerce billing data.
   */
  billing_ref?: string | null;

  /**
   * Certified Mail provides the sender with a mailing receipt and, upon request, electronic verification that an article was delivered or that a delivery attempt was made.
   */
  certified_mail?: boolean | null;

  /**
   * Registered Mail is the most secure service that the USPS offers.
   * It incorporates a system of receipts to monitor the movement of the mail from the point of acceptance to delivery
   */
  registered_mail?: boolean | null;

  /**
   * The value of the package contents
   */
  registered_mail_amount?: number | null;

  /**
   * An electronic return receipt may be purchased at the time of mailing and provides a shipper with evidence of delivery (to whom the mail was delivered and date of delivery), and information about the recipient's actual delivery address.
   * Only applies to the USPS.
   */
  return_receipt?: boolean | null;
}