Hierarchy

  • APIResource
    • Batches

Constructors

Methods

Constructors

  • Parameters

    Returns Batches

Methods

  • Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

    Parameters

    • batchID: string
    • Optionaloptions: RequestOptions

    Returns APIPromise<Batch>

  • Creates and executes a batch from an uploaded file of requests

    Parameters

    Returns APIPromise<Batch>

  • List your organization's batches.

    Parameters

    Returns PagePromise<BatchesPage, Batch>

  • Retrieves a batch.

    Parameters

    • batchID: string
    • Optionaloptions: RequestOptions

    Returns APIPromise<Batch>