@nimble-way/nimble-js 0.18.0 → 0.20.0

package/src/resources/fast-serp.ts

@@ -1,5 +1,465 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
 
-export class FastSerp extends APIResource {}
+export class FastSerp extends APIResource {
+  /**
+   * Fast SERP
+   *
+   * @example
+   * ```ts
+   * const response = await client.fastSerp.run({
+   *   search_engine: 'google_search',
+   * });
+   * ```
+   */
+  run(body: FastSerpRunParams, options?: RequestOptions): APIPromise<FastSerpRunResponse> {
+    return this._client.post('/v1/fast-serp', { body, ...options });
+  }
+}
+
+export interface FastSerpRunResponse {
+  data: FastSerpRunResponse.Data;
+
+  metadata: FastSerpRunResponse.Metadata;
+
+  /**
+   * The status of the task.
+   */
+  status: 'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked';
+
+  /**
+   * Unique identifier for the task.
+   */
+  task_id: string;
+
+  /**
+   * The final URL.
+   */
+  url: string;
+
+  debug?: FastSerpRunResponse.Debug;
+
+  /**
+   * Pagination information if applicable.
+   */
+  pagination?: FastSerpRunResponse.NextPageParams | Array<FastSerpRunResponse.UnionMember1>;
+
+  /**
+   * The HTTP status code of the task.
+   */
+  status_code?: number;
+
+  /**
+   * List of warnings generated during the task.
+   */
+  warnings?: Array<string>;
+}
+
+export namespace FastSerpRunResponse {
+  export interface Data {
+    /**
+     * Browser actions execution results. Present only when browser_actions were
+     * specified in the request.
+     */
+    browser_actions?: Data.BrowserActions;
+
+    /**
+     * The cookies collected from browser actions during the task.
+     */
+    cookies?: Array<unknown>;
+
+    /**
+     * The evaluation results from browser actions during the task.
+     */
+    eval?: Array<unknown>;
+
+    /**
+     * The http requests from browser actions made during the task.
+     */
+    fetch?: Array<unknown>;
+
+    /**
+     * The headers received during the task.
+     */
+    headers?: { [key: string]: string };
+
+    /**
+     * The HTML content of the page.
+     */
+    html?: string;
+
+    /**
+     * List of all unique URLs found on the page.
+     */
+    links?: Array<string>;
+
+    /**
+     * The Markdown version of the HTML content.
+     */
+    markdown?: string;
+
+    /**
+     * The network capture data collected during the task.
+     */
+    network_capture?: Array<Data.NetworkCapture>;
+
+    /**
+     * Individual HTML content of each pagination page, before merging.
+     */
+    pages_html?: Array<string>;
+
+    /**
+     * The parsing results extracted from the HTML & network content.
+     */
+    parsing?: Data.ParsingSuccessResult | Data.ParsingErrorResult | { [key: string]: unknown };
+
+    /**
+     * The list of redirects that occurred during the task.
+     */
+    redirects?: Array<Data.Redirect>;
+
+    /**
+     * Screenshots taken during the task, from browser actions, or the screenshot
+     * format.
+     */
+    screenshots?: Array<unknown>;
+  }
+
+  export namespace Data {
+    /**
+     * Browser actions execution results. Present only when browser_actions were
+     * specified in the request.
+     */
+    export interface BrowserActions {
+      results: Array<BrowserActions.Result>;
+
+      success: boolean;
+
+      total_duration: number;
+    }
+
+    export namespace BrowserActions {
+      export interface Result {
+        duration: number;
+
+        name:
+          | 'goto'
+          | 'wait'
+          | 'wait_for_element'
+          | 'wait_for_navigation'
+          | 'click'
+          | 'fill'
+          | 'press'
+          | 'scroll'
+          | 'auto_scroll'
+          | 'screenshot'
+          | 'get_cookies'
+          | 'eval'
+          | 'fetch';
+
+        status: 'no-run' | 'in-progress' | 'done' | 'error' | 'skipped';
+
+        error?: string;
+
+        result?: unknown;
+      }
+    }
+
+    export interface NetworkCapture {
+      filter: NetworkCapture.Filter;
+
+      results: Array<NetworkCapture.Result>;
+
+      errorMessage?: string;
+    }
+
+    export namespace NetworkCapture {
+      export interface Filter {
+        validation: boolean;
+
+        wait_for_requests_count: number;
+
+        method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+
+        /**
+         * Resource type for network capture filtering
+         */
+        resource_type?:
+          | 'document'
+          | 'stylesheet'
+          | 'image'
+          | 'media'
+          | 'font'
+          | 'script'
+          | 'texttrack'
+          | 'xhr'
+          | 'fetch'
+          | 'prefetch'
+          | 'eventsource'
+          | 'websocket'
+          | 'manifest'
+          | 'signedexchange'
+          | 'ping'
+          | 'cspviolationreport'
+          | 'preflight'
+          | 'other'
+          | 'fedcm'
+          | Array<
+              | 'document'
+              | 'stylesheet'
+              | 'image'
+              | 'media'
+              | 'font'
+              | 'script'
+              | 'texttrack'
+              | 'xhr'
+              | 'fetch'
+              | 'prefetch'
+              | 'eventsource'
+              | 'websocket'
+              | 'manifest'
+              | 'signedexchange'
+              | 'ping'
+              | 'cspviolationreport'
+              | 'preflight'
+              | 'other'
+              | 'fedcm'
+            >;
+
+        status_code?: number | Array<number>;
+
+        url?: Filter.URL;
+
+        wait_for_requests_count_timeout?: number;
+      }
+
+      export namespace Filter {
+        export interface URL {
+          type: 'exact' | 'contains';
+
+          value: string;
+        }
+      }
+
+      export interface Result {
+        request: Result.Request;
+
+        response: Result.Response;
+      }
+
+      export namespace Result {
+        export interface Request {
+          headers: { [key: string]: string };
+
+          method: string;
+
+          /**
+           * Resource type for network capture filtering
+           */
+          resource_type:
+            | 'document'
+            | 'stylesheet'
+            | 'image'
+            | 'media'
+            | 'font'
+            | 'script'
+            | 'texttrack'
+            | 'xhr'
+            | 'fetch'
+            | 'prefetch'
+            | 'eventsource'
+            | 'websocket'
+            | 'manifest'
+            | 'signedexchange'
+            | 'ping'
+            | 'cspviolationreport'
+            | 'preflight'
+            | 'other'
+            | 'fedcm';
+
+          url: string;
+
+          body?: string;
+        }
+
+        export interface Response {
+          body: string;
+
+          headers: { [key: string]: string };
+
+          serialization: 'none' | 'base64';
+
+          status: number;
+
+          status_text: string;
+        }
+      }
+    }
+
+    export interface ParsingSuccessResult {
+      entities: { [key: string]: unknown };
+
+      status: 'success';
+    }
+
+    export interface ParsingErrorResult {
+      error: string;
+
+      status: 'error';
+    }
+
+    export interface Redirect {
+      status_code: number;
+
+      url: string;
+    }
+  }
+
+  export interface Metadata {
+    /**
+     * The name of the agent used for the query.
+     */
+    agent?: string;
+
+    /**
+     * The driver used for the task.
+     */
+    driver?: string;
+
+    /**
+     * The localization identifier for the query.
+     */
+    localization_id?: string;
+
+    /**
+     * The duration in milliseconds of the query processing.
+     */
+    query_duration?: number;
+
+    /**
+     * The time when the query was received.
+     */
+    query_time?: string;
+
+    /**
+     * Additional response parameters.
+     */
+    response_parameters?: unknown;
+
+    /**
+     * A tag associated with the query.
+     */
+    tag?: string;
+  }
+
+  export interface Debug {
+    /**
+     * Performance metrics collected during the task.
+     */
+    performance_metrics?: { [key: string]: number };
+
+    /**
+     * Total bytes used by the proxy during the task.
+     */
+    proxy_total_bytes_usage?: number;
+
+    /**
+     * The transformed output after applying any transformations.
+     */
+    transformed_output?: unknown;
+
+    /**
+     * The userbrowser instance using during the task.
+     */
+    userbrowser?: unknown;
+  }
+
+  export interface NextPageParams {
+    next_page_params: { [key: string]: unknown };
+  }
+
+  export interface UnionMember1 {
+    next_page_params: { [key: string]: unknown };
+  }
+}
+
+export interface FastSerpRunParams {
+  /**
+   * The search engine to query.
+   */
+  search_engine:
+    | 'google_search'
+    | 'google_sge'
+    | 'google_aio'
+    | 'google_maps_search'
+    | 'google_maps_reviews'
+    | 'google_maps_place'
+    | 'google_news'
+    | 'google_images'
+    | 'bing_search'
+    | 'yandex_search';
+
+  /**
+   * ISO Alpha-2 country code used to access the target search engine (e.g. US, DE,
+   * GB).
+   */
+  country?: string;
+
+  /**
+   * Device type used for the search request.
+   */
+  device?: 'desktop' | 'mobile';
+
+  /**
+   * Top-level domain for the search engine (e.g. "com", "co.uk", "de").
+   */
+  domain?: string;
+
+  /**
+   * Locale used for the search request.
+   */
+  locale?: string;
+
+  /**
+   * Geo-location for the search (canonical Google location name).
+   */
+  location?: string;
+
+  /**
+   * Number of results to return (1–100).
+   */
+  num_results?: number;
+
+  /**
+   * The result page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * When true, the SERP response is parsed into structured JSON.
+   */
+  parse?: boolean;
+
+  /**
+   * The search keyword or phrase to query.
+   */
+  query?: string;
+
+  /**
+   * Whether to render the page in a browser before extracting.
+   */
+  render?: boolean;
+
+  /**
+   * When true, disables Google result filtering (filter=0) so omitted/duplicate and
+   * highly similar pages are also returned. Applies to Google search engines.
+   */
+  show_hidden_results?: boolean;
+}
+
+export declare namespace FastSerp {
+  export { type FastSerpRunResponse as FastSerpRunResponse, type FastSerpRunParams as FastSerpRunParams };
+}

package/src/resources/index.ts

@@ -31,7 +31,7 @@ export {
   type DomainKnowledgeGetDriverResponse,
   type DomainKnowledgeGetDriverParams,
 } from './domain-knowledge';
-export { FastSerp } from './fast-serp';
+export { FastSerp, type FastSerpRunResponse, type FastSerpRunParams } from './fast-serp';
 export {
   Jobs,
   type JobCreateResponse,

package/src/resources/jobs/jobs.ts

@@ -13,6 +13,8 @@ export class Jobs extends APIResource {
 
   /**
    * Create Job
+   *
+   * @deprecated
    */
   create(body: JobCreateParams, options?: RequestOptions): APIPromise<JobCreateResponse> {
     return this._client.post('/v1/jobs', { body, ...options });
@@ -20,6 +22,8 @@ export class Jobs extends APIResource {
 
   /**
    * Update Job
+   *
+   * @deprecated
    */
   update(jobID: string, body: JobUpdateParams, options?: RequestOptions): APIPromise<JobUpdateResponse> {
     return this._client.patch(path`/v1/jobs/${jobID}`, { body, ...options });
@@ -27,6 +31,8 @@ export class Jobs extends APIResource {
 
   /**
    * List Jobs
+   *
+   * @deprecated
    */
   list(query: JobListParams | null | undefined = {}, options?: RequestOptions): APIPromise<JobListResponse> {
     return this._client.get('/v1/jobs', { query, ...options });
@@ -34,6 +40,8 @@ export class Jobs extends APIResource {
 
   /**
    * Delete Job
+   *
+   * @deprecated
    */
   delete(jobID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/jobs/${jobID}`, {
@@ -44,6 +52,8 @@ export class Jobs extends APIResource {
 
   /**
    * Get Job
+   *
+   * @deprecated
    */
   get(jobID: string, options?: RequestOptions): APIPromise<JobGetResponse> {
     return this._client.get(path`/v1/jobs/${jobID}`, options);
@@ -51,6 +61,8 @@ export class Jobs extends APIResource {
 
   /**
    * Trigger Run
+   *
+   * @deprecated
    */
   run(jobID: string, options?: RequestOptions): APIPromise<JobRunResponse> {
     return this._client.post(path`/v1/jobs/${jobID}/runs`, options);
@@ -81,6 +93,9 @@ export interface JobCreateResponse {
    */
   created_at?: string | null;
 
+  /**
+   * Free-text description of the job.
+   */
   description?: string | null;
 
   /**
@@ -202,6 +217,9 @@ export interface JobUpdateResponse {
    */
   created_at?: string | null;
 
+  /**
+   * Free-text description of the job.
+   */
   description?: string | null;
 
   /**
@@ -309,19 +327,19 @@ export interface JobListResponse {
   items: Array<JobListResponse.Item>;
 
   /**
-   * Current page number.
+   * Total number of jobs matching the query.
    */
-  page: number;
+  total: number;
 
   /**
-   * Number of items per page.
+   * Current page number.
    */
-  per_page: number;
+  page?: number;
 
   /**
-   * Total number of jobs matching the query.
+   * Number of items per page.
    */
-  total: number;
+  per_page?: number;
 }
 
 export namespace JobListResponse {
@@ -349,6 +367,9 @@ export namespace JobListResponse {
      */
     created_at?: string | null;
 
+    /**
+     * Free-text description of the job.
+     */
     description?: string | null;
 
     /**
@@ -479,6 +500,9 @@ export interface JobGetResponse {
    */
   created_at?: string | null;
 
+  /**
+   * Free-text description of the job.
+   */
   description?: string | null;
 
   /**
@@ -637,6 +661,9 @@ export interface JobCreateParams {
    */
   name: string;
 
+  /**
+   * Free-text description of the job.
+   */
   description?: string | null;
 
   /**
@@ -720,6 +747,9 @@ export namespace JobCreateParams {
 }
 
 export interface JobUpdateParams {
+  /**
+   * New description.
+   */
   description?: string | null;
 
   /**

package/src/resources/jobs/runs/artifacts.ts

@@ -8,6 +8,8 @@ import { path } from '../../../internal/utils/path';
 export class Artifacts extends APIResource {
   /**
    * List Run Artifacts
+   *
+   * @deprecated
    */
   list(runID: string, options?: RequestOptions): APIPromise<ArtifactListResponse> {
     return this._client.get(path`/v1/jobs/runs/${runID}/artifacts`, options);
@@ -15,9 +17,11 @@ export class Artifacts extends APIResource {
 
   /**
    * Get Run Artifact Download URL
+   *
+   * @deprecated
    */
   downloadURL(
-    artifactID: string,
+    artifactID: number,
     params: ArtifactDownloadURLParams,
     options?: RequestOptions,
   ): APIPromise<ArtifactDownloadURLResponse> {
@@ -27,9 +31,11 @@ export class Artifacts extends APIResource {
 
   /**
    * Get Run Artifact
+   *
+   * @deprecated
    */
   get(
-    artifactID: string,
+    artifactID: number,
     params: ArtifactGetParams,
     options?: RequestOptions,
   ): APIPromise<ArtifactGetResponse> {
@@ -39,9 +45,11 @@ export class Artifacts extends APIResource {
 
   /**
    * Preview Run Artifact
+   *
+   * @deprecated
    */
   preview(
-    artifactID: string,
+    artifactID: number,
     params: ArtifactPreviewParams,
     options?: RequestOptions,
   ): APIPromise<ArtifactPreviewResponse> {
@@ -63,11 +71,6 @@ export interface ArtifactListResponse {
 export namespace ArtifactListResponse {
   /**
    * A file produced by a run.
-   *
-   * Intentional subset of the bakery Artifact: `data_format` and `s3_path` are
-   * hidden from SDK consumers — internal storage details, not part of the public
-   * contract. Use the download-url endpoint to fetch the file. Bakery emits `id` as
-   * an int (crawlit native); the SDK contract is a string.
    */
   export interface Item {
     /**
@@ -80,6 +83,9 @@ export namespace ArtifactListResponse {
      */
     created_at: string;
 
+    /**
+     * Human-readable artifact description.
+     */
     description: string;
 
     /**
@@ -106,11 +112,6 @@ export interface ArtifactDownloadURLResponse {
 
 /**
  * A file produced by a run.
- *
- * Intentional subset of the bakery Artifact: `data_format` and `s3_path` are
- * hidden from SDK consumers — internal storage details, not part of the public
- * contract. Use the download-url endpoint to fetch the file. Bakery emits `id` as
- * an int (crawlit native); the SDK contract is a string.
  */
 export interface ArtifactGetResponse {
   /**
@@ -123,6 +124,9 @@ export interface ArtifactGetResponse {
    */
   created_at: string;
 
+  /**
+   * Human-readable artifact description.
+   */
   description: string;
 
   /**