@anyformat/sdk 1.0.0 → 1.2.0

package/dist/index.d.cts

@@ -2023,6 +2023,12 @@ type SplitPartition = {
      * Files
      */
     files: Array<FilePages>;
+    /**
+     * Id
+     *
+     * The partition's UUID. Pass it to `GET /v3/splits/{split_id}/pdf/` to download these pages as a PDF.
+     */
+    id: string;
     /**
      * Name
      *
@@ -2050,6 +2056,12 @@ type SplitResult = {
      * Per-file page lists, union of all partitions.
      */
     files: Array<FilePages>;
+    /**
+     * Id
+     *
+     * The split's UUID, for `GET /v3/splits/{split_id}/pdf/`. `null` when the splitter partitions this category, because the category is then several sub-documents and no single one of them: download each `partitions[].id` instead.
+     */
+    id?: string | null;
     /**
      * Name
      *
@@ -2875,6 +2887,17 @@ declare class Anyformat {
     iterRuns(workflowId: string, opts?: IterOptions): AsyncIterableIterator<RunSummaryV3>;
     /** Retrieve one run: lifecycle status plus results inline once `processed`. */
     getRun(runId: string): Promise<RunDetailV3>;
+    /**
+     * Download one split's pages as a PDF.
+     *
+     * Take `splitId` from a run's `results.splits[].id`, or from
+     * `results.splits[].partitions[].id` when the splitter partitions that
+     * category (the category's own `id` is then `null`, because it is several
+     * sub-documents and no single one of them).
+     *
+     * The document is built when you ask for it and never stored.
+     */
+    downloadSplitPdf(splitId: string): Promise<Blob>;
     /**
      * Parse a document with the platform's atomic parse operation (fast lite
      * parse). Returns the run id; poll `getParseMarkdown(runId)` for the parsed
@@ -2965,4 +2988,4 @@ declare class ExtractionCancelledError extends RunFailedError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3 };
+export { APIError, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3 };

package/dist/index.d.ts

@@ -2023,6 +2023,12 @@ type SplitPartition = {
      * Files
      */
     files: Array<FilePages>;
+    /**
+     * Id
+     *
+     * The partition's UUID. Pass it to `GET /v3/splits/{split_id}/pdf/` to download these pages as a PDF.
+     */
+    id: string;
     /**
      * Name
      *
@@ -2050,6 +2056,12 @@ type SplitResult = {
      * Per-file page lists, union of all partitions.
      */
     files: Array<FilePages>;
+    /**
+     * Id
+     *
+     * The split's UUID, for `GET /v3/splits/{split_id}/pdf/`. `null` when the splitter partitions this category, because the category is then several sub-documents and no single one of them: download each `partitions[].id` instead.
+     */
+    id?: string | null;
     /**
      * Name
      *
@@ -2875,6 +2887,17 @@ declare class Anyformat {
     iterRuns(workflowId: string, opts?: IterOptions): AsyncIterableIterator<RunSummaryV3>;
     /** Retrieve one run: lifecycle status plus results inline once `processed`. */
     getRun(runId: string): Promise<RunDetailV3>;
+    /**
+     * Download one split's pages as a PDF.
+     *
+     * Take `splitId` from a run's `results.splits[].id`, or from
+     * `results.splits[].partitions[].id` when the splitter partitions that
+     * category (the category's own `id` is then `null`, because it is several
+     * sub-documents and no single one of them).
+     *
+     * The document is built when you ask for it and never stored.
+     */
+    downloadSplitPdf(splitId: string): Promise<Blob>;
     /**
      * Parse a document with the platform's atomic parse operation (fast lite
      * parse). Returns the run id; poll `getParseMarkdown(runId)` for the parsed
@@ -2965,4 +2988,4 @@ declare class ExtractionCancelledError extends RunFailedError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3 };
+export { APIError, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3 };

package/dist/index.js

@@ -1,7 +1,7 @@
 // package.json
 var package_default = {
   name: "@anyformat/sdk",
-  version: "1.0.0",
+  version: "1.2.0",
   description: "TypeScript SDK for the AnyFormat API",
   license: "MIT",
   author: "Anyformat <info@anyformat.ai>",
@@ -1089,6 +1089,11 @@ var v3GetRun = (options) => (options.client ?? client).get({
   url: "/v3/runs/{run_id}/",
   ...options
 });
+var v3DownloadSplitPdf = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v3/splits/{split_id}/pdf/",
+  ...options
+});
 var v3ListWorkflows = (options) => (options?.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/v3/workflows/",
@@ -1742,6 +1747,21 @@ var Anyformat = class {
     if (res.error) throw toApiError(res.response?.status ?? 500, res.error, res.response?.headers);
     return res.data;
   }
+  /**
+   * Download one split's pages as a PDF.
+   *
+   * Take `splitId` from a run's `results.splits[].id`, or from
+   * `results.splits[].partitions[].id` when the splitter partitions that
+   * category (the category's own `id` is then `null`, because it is several
+   * sub-documents and no single one of them).
+   *
+   * The document is built when you ask for it and never stored.
+   */
+  async downloadSplitPdf(splitId) {
+    const res = await v3DownloadSplitPdf({ client: this._client, path: { split_id: splitId } });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error, res.response?.headers);
+    return res.data;
+  }
   /**
    * Parse a document with the platform's atomic parse operation (fast lite
    * parse). Returns the run id; poll `getParseMarkdown(runId)` for the parsed