import { IDatedObject, IObjectWithId } from '../base';
import { DeepPartial } from '../utils';
import { IParcelCreateParameters } from './ParcelCreateParameters';

/**
 * Parcel objects represent the physical container being shipped.
 * Dimensions can be supplied either as length, width, and height dimensions, or a predefined_package string.
 * Only weight is required, but since many carriers charge different rates for packages with large dimensions, we strongly recommend including all dimensions if available.
 *
 * Weights are in OUNCES (OZ) and go to one decimal point.
 * Dimensions are in INCHES (IN) and go to one decimal point.
 *
 * @see https://docs.easypost.com/docs/parcels#parcel-object
 */
export declare interface IParcel extends IObjectWithId<'Parcel'>, IDatedObject {
  /**
   * Required if width and/or height are present
   * float (inches)
   */
  length?: number | null;

  /**
   * Required if width and/or height are present
   * float (inches)
   */
  width?: number | null;

  /**
   * Required if width and/or height are present
   * float (inches)
   */
  height?: number | null;

  /**
   * Always required
   * float (oz)
   */
  weight: number;

  /**
   * Optional, one of our predefined_packages
   */
  predefined_package?: string | null;
}

export declare class Parcel implements IParcel {
  public constructor(input: DeepPartial<IParcelCreateParameters>);

  id: string;
  mode: 'test' | 'production';
  object: 'Parcel';
  length?: number | null;
  width?: number | null;
  height?: number | null;
  predefined_package?: string | null;
  weight: number;
  created_at: string;
  updated_at: string;

  /**
   * Include the `weight`, and either a `predefined_package` or `length`, `width` and `height` if applicable.
   *
   * @see https://docs.easypost.com/docs/parcels#create-a-parcel
   *
   * @param {Object} params The parameters to create an {@link Parcel} with.
   * @returns {Promise<Parcel>} The created and verified {@link Parcel}.
   */
  static create(params: Object): Promise<Parcel>;

  /**
   * Get a Parcel by its id.
   * In general you should not need to use this in your automated solution.
   * A Parcel's id can be inlined into the creation call to other objects.
   * This allows you to only create one Parcel for each package you will be using.
   *
   * @see https://docs.easypost.com/docs/parcels#retrieve-a-parcel
   *
   * @param parcelId Unique, begins with "prcl_"
   * @returns {Promise<Parcel>} The retrieved {@link Parcel}.
   */
  static retrieve(parcelId: string): Promise<Parcel>;
}