import { IDatedObject, IObjectWithId } from '../base';
import { IPickup } from '../Pickup';
import { IScanForm } from '../ScanForm';
import { LabelFormat } from '../Shipment';
import { IBatchCreateParameters } from './BatchCreateParameters';
import { IBatchListParameters } from './BatchListParameters';
import { IBatchShipment } from './BatchShipment';
import { TBatchState } from './BatchState';
import { TBatchStatuses } from './BatchStatuses';

/**
 * The Batch object allows you to perform operations on multiple Shipments at once.
 * This includes scheduling a Pickup, creating a ScanForm and consolidating labels.
 * Operations performed on Batches are asynchronous and take advantage of our webhook infrastructure.
 *
 * @see https://docs.easypost.com/docs/batches#batch-object
 */
export declare interface IBatch extends IObjectWithId<'Batch'>, IDatedObject {
  /**
   * An optional field that may be used in place of ID in some API endpoints
   */
  reference?: string | null;

  /**
   * The overall state. Possible values are "creating", "creation_failed", "created", "purchasing", "purchase_failed", "purchased", "label_generating", and "label_generated"
   */
  state: TBatchState;

  /**
   * The number of shipments added
   */
  num_shipments: number;

  /**
   * An array of batch shipments
   */
  shipments: IBatchShipment[];

  /**
   * A map of BatchShipment statuses to the count of BatchShipments with that status. Valid statuses are "postage_purchased", "postage_purchase_failed", "queued_for_purchase", and "creation_failed"
   */
  status: TBatchStatuses;

  /**
   * The label image url
   */
  label_url?: string | null;

  /**
   * The created ScanForm
   */
  scan_form: IScanForm;

  /**
   * The created Pickup
   */
  pickup: IPickup;
}

export declare class Batch implements IBatch {
  public constructor(input: IBatchCreateParameters);

  id: string;
  mode: 'test' | 'production';
  object: 'Batch';
  reference?: string | null;
  state: TBatchState;
  num_shipments: number;
  shipments: IBatchShipment[];
  status: TBatchStatuses;
  label_url?: string | null;
  scan_form: IScanForm;
  pickup: IPickup;
  created_at: string;
  updated_at: string;

  /**
   * A Batch can be created with or without Shipments.
   * When created with Shipments the initial state will be creating.
   * Once the state changes to created a webhook Event will be sent.
   * When created with no Shipments the initial state will be created and webhook will be sent.
   *
   * @see https://docs.easypost.com/docs/batches#create-a-batch
   *
   * @param {Object} params The parameters to create an {@link Batch} with.
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static create(params: Object): Promise<Batch>;

  /**
   * A Batch can be retrieved by its id.
   *
   * @see https://docs.easypost.com/docs/batches#retrieve-batch
   *
   * @param batchId Unique, begins with "batch_"
   *
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static retrieve(batchId: string): Promise<Batch>;

  /**
   * Shipments can be added to a Batch throughout its life cycle.
   * Just remember that the state change of a Batch is asynchronous and will fire a webhook Event when the state change is completed.
   *
   * @see https://docs.easypost.com/docs/batches#add-shipments-to-a-batch
   *
   * @param id Unique, begins with "batch_"
   * @param shipments An array of shipments
   *
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static addShipments(id: string, shipments: IBatchCreateParameters['shipments']): Promise<Batch>;

  /**
   * There could be times when a Shipment needs to be removed from the Batch during its life cycle.
   * Removing a Shipment does not remove it from the consolidated label or ScanForm.
   *
   * @see https://docs.easypost.com/docs/batches#remove-shipments-from-a-batch
   *
   * @param id Unique, begins with "batch_"
   * @param shipments An array of shipments
   *
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static removeShipments(
    id: string,
    shipments: IBatchCreateParameters['shipments'],
  ): Promise<Batch>;

  /**
   * One of the advantages of processing Shipments in batches is the ability to consolidate the PostageLabel into one file.
   * This can only be done once for each batch and all Shipments must have a status of postage_purchased.
   *
   * Available label formats are 'pdf', 'zpl' or 'epl2' format.
   * Like converting a PostageLabel format, if this process will change the format of the labels they must have been created as PNGs.
   *
   * @see https://docs.easypost.com/docs/batches#batch-labels
   *
   * @param id Unique, begins with "batch_"
   * @param labelFormat The format of label
   *
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static generateLabel(id: string, labelFormat: LabelFormat): Promise<Batch>;

  /**
   * See [Scan Form](https://docs.easypost.com/docs/scan-form) rules and [Object Definition](https://docs.easypost.com/docs/scan-form-object).
   *
   * @see https://docs.easypost.com/docs/batches#manifesting-scan-form
   *
   * @param id Unique, begins with "batch_"
   *
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static createScanForm(id: string): Promise<Batch>;

  /**
   * Once you have added all of your Shipments to a Batch, issue a buy request to enqueue a background job to purchase the shipments and generate all necessary labels.
   * Purchasing may take anywhere from a few seconds to an hour, depending on the size of the batch, the carrier, and Internet weather.
   *
   * @see https://docs.easypost.com/docs/batches#buy-a-batch
   *
   * @param id Unique, begins with "batch_"
   * @returns {Promise<Batch>} The {@link Batch}.
   */
  static buy(id: string): Promise<Batch>;

  /**
   * The Batch List is a paginated list of all Batch objects associated with the given API Key.
   * See the Pagination section of our docs for more details on retrieving all records when
   * multiple pages are available.
   *
   * @see https://docs.easypost.com/docs/batches#retrieve-all-batches
   *
   * @param {Object} params - The parameters to use for the request.
   * @returns {Object} - An object containing a list of {@link Batch batches} and pagination information.
   */
  static all(params?: IBatchListParameters): Promise<{ batches: Batch[]; has_more: boolean }>;
}