unstructured-transform-client 0.18.20 → 0.18.22

package/README.md

@@ -134,10 +134,13 @@ Polling with `client.jobs.get(job.body.id)` returns the same resource if you wou
 rather not hold a connection open.
 
 To scan jobs across every page, use the cursor-following async iterator.
-`list()` still returns one page when you need page boundaries.
+`list()` still returns one page when you need page boundaries; its `totalCount`
+is the number of matching jobs across all pages, or null/undefined when the
+service cannot count. Both take `status` and `operation` (`"parse"` or
+`"extract"`) filters. Jobs whose result has expired are not listed.
 
 ```ts
-for await (const job of client.jobs.iterate({ status: "completed" })) {
+for await (const job of client.jobs.iterate({ status: "completed", operation: "parse" })) {
   console.log(job.id, job.status);
 }
 ```

package/dist/_generated/apis/JobsApi.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
+import { type JobOperation } from '../models/JobOperation.js';
 import { type JobPage } from '../models/JobPage.js';
 import { type JobResult } from '../models/JobResult.js';
 import { type JobStatus } from '../models/JobStatus.js';
@@ -53,6 +54,10 @@ export interface JobsListRequest {
      * Return only jobs with this public status. completed_with_warnings maps to completed upstream and may include completed jobs without warnings.
      */
     status?: JobStatus;
+    /**
+     * Return only jobs created by this operation.
+     */
+    operation?: JobOperation;
 }
 /**
  *
@@ -105,12 +110,12 @@ export declare class JobsApi extends runtime.BaseAPI {
      */
     jobsListRequestOpts(requestParameters: JobsListRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter.
+     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter. Jobs whose result has expired are omitted.
      * List parse and extraction jobs
      */
     jobsListRaw(requestParameters: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobPage>>;
     /**
-     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter.
+     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter. Jobs whose result has expired are omitted.
      * List parse and extraction jobs
      */
     jobsList(requestParameters?: JobsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobPage>;

package/dist/_generated/apis/JobsApi.js

@@ -172,6 +172,9 @@ export class JobsApi extends runtime.BaseAPI {
         if (requestParameters['status'] != null) {
             queryParameters['status'] = requestParameters['status'];
         }
+        if (requestParameters['operation'] != null) {
+            queryParameters['operation'] = requestParameters['operation'];
+        }
         const headerParameters = {};
         if (this.configuration && this.configuration.apiKey) {
             headerParameters["unstructured-api-key"] = await this.configuration.apiKey("unstructured-api-key"); // ApiKeyAuth authentication
@@ -192,7 +195,7 @@ export class JobsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter.
+     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter. Jobs whose result has expired are omitted.
      * List parse and extraction jobs
      */
     async jobsListRaw(requestParameters, initOverrides) {
@@ -201,7 +204,7 @@ export class JobsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => JobPageFromJSON(jsonValue));
     }
     /**
-     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter.
+     * Returns this caller\'s visible jobs, newest first. Tenant scope comes from the credential; the request has no tenant parameter. Jobs whose result has expired are omitted.
      * List parse and extraction jobs
      */
     async jobsList(requestParameters = {}, initOverrides) {

package/dist/_generated/models/JobPage.d.ts

@@ -24,6 +24,10 @@ export interface JobPage {
      * Opaque cursor for the next page, or null at the end.
      */
     nextCursor: string | null;
+    /**
+     * Number of jobs matching every filter across all pages, or null when unknown.
+     */
+    totalCount?: number | null;
 }
 /**
  * Check if a given object implements the JobPage interface.

package/dist/_generated/models/JobPage.js

@@ -32,6 +32,7 @@ export function JobPageFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'jobs': (json['jobs'].map(JobSummaryFromJSON)),
         'nextCursor': json['next_cursor'],
+        'totalCount': json['total_count'] === undefined ? undefined : json['total_count'] === null ? null : json['total_count'],
     };
 }
 export function JobPageToJSON(json) {
@@ -44,5 +45,6 @@ export function JobPageToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'jobs': (value['jobs'].map(JobSummaryToJSON)),
         'next_cursor': value['nextCursor'],
+        'total_count': value['totalCount'],
     };
 }

package/dist/client.d.ts

@@ -21,7 +21,7 @@
  */
 import type { ParseRunProfileEnum } from "./_generated/apis/ParseApi.js";
 import { Configuration } from "./_generated/runtime.js";
-import type { JobPage, JobResult, JobStatus, OutputFormat, ParseResult, UploadResult } from "./_generated/models/index.js";
+import type { JobOperation, JobPage, JobResult, JobStatus, OutputFormat, ParseResult, UploadResult } from "./_generated/models/index.js";
 import { type FileInput } from "./files.js";
 import { type Outcome } from "./outcome.js";
 import { type RetryConfig } from "./retry.js";
@@ -112,6 +112,7 @@ export interface JobsListOptions {
     cursor?: string;
     limit?: number;
     status?: JobStatus;
+    operation?: JobOperation;
 }
 export interface JobsStreamOptions {
     signal?: AbortSignal;

package/dist/client.js

@@ -195,6 +195,7 @@ class JobsNamespace {
             cursor: options.cursor,
             limit: options.limit,
             status: options.status,
+            operation: options.operation,
         });
     }
     async *iterate(options = {}) {

package/dist/version.d.ts

@@ -7,4 +7,4 @@
  * runtime, because importing JSON differs across module systems and bundlers
  * and would make this module's behaviour depend on how it was built.
  */
-export declare const VERSION = "0.18.20";
+export declare const VERSION = "0.18.22";

package/dist/version.js

@@ -7,4 +7,4 @@
  * runtime, because importing JSON differs across module systems and bundlers
  * and would make this module's behaviour depend on how it was built.
  */
-export const VERSION = "0.18.20";
+export const VERSION = "0.18.22";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unstructured-transform-client",
-  "version": "0.18.20",
+  "version": "0.18.22",
   "description": "TypeScript client for the Unstructured Transform v2 API — one document in, structured output back.",
   "license": "MIT",
   "author": "Unstructured",