@nimble-way/nimble-js 0.5.1

package/resources/tasks.d.ts

@@ -0,0 +1,183 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Tasks extends APIResource {
+    /**
+     * Retrieve a paginated list of tasks for the authenticated account.
+     */
+    list(query?: TaskListParams | null | undefined, options?: RequestOptions): APIPromise<TaskListResponse>;
+    /**
+     * Retrieve the details of a specific task by its ID.
+     */
+    get(taskID: string, options?: RequestOptions): APIPromise<TaskGetResponse>;
+    /**
+     * Retrieve the results of a completed task.
+     */
+    results(taskID: string, options?: RequestOptions): APIPromise<TaskResultsResponse>;
+}
+/**
+ * Paginated list of tasks response.
+ */
+export interface TaskListResponse {
+    /**
+     * Array of task objects.
+     */
+    data: Array<TaskListResponse.Data>;
+    pagination: TaskListResponse.Pagination;
+}
+export declare namespace TaskListResponse {
+    interface Data {
+        /**
+         * Unique task identifier.
+         */
+        id: string;
+        _query: unknown;
+        /**
+         * Timestamp when the task was created.
+         */
+        created_at: string;
+        /**
+         * Original input data for the task.
+         */
+        input: unknown;
+        /**
+         * Current state of the task.
+         */
+        state: 'pending' | 'success' | 'error';
+        /**
+         * URL for checking the task status.
+         */
+        status_url: string;
+        /**
+         * Account name that owns the task.
+         */
+        account_name?: string;
+        api_type?: 'web' | 'serp' | 'ecommerce' | 'social';
+        /**
+         * Batch ID if this task is part of a batch.
+         */
+        batch_id?: string;
+        /**
+         * URL for downloading the task results.
+         */
+        download_url?: string;
+        /**
+         * Error message if the task failed.
+         */
+        error?: string;
+        /**
+         * Classification of the error type.
+         */
+        error_type?: string;
+        /**
+         * Timestamp when the task was last modified.
+         */
+        modified_at?: string;
+        /**
+         * Storage location of the output data.
+         */
+        output_url?: string;
+        /**
+         * HTTP status code from the task execution.
+         */
+        status_code?: number;
+    }
+    interface Pagination {
+        /**
+         * Whether there are more tasks available.
+         */
+        has_next: boolean;
+        /**
+         * Cursor to use for fetching the next page.
+         */
+        next_cursor: string | null;
+        /**
+         * Total number of tasks.
+         */
+        total: number;
+    }
+}
+/**
+ * Response containing task details.
+ */
+export interface TaskGetResponse {
+    task: TaskGetResponse.Task;
+}
+export declare namespace TaskGetResponse {
+    interface Task {
+        /**
+         * Unique task identifier.
+         */
+        id: string;
+        _query: unknown;
+        /**
+         * Timestamp when the task was created.
+         */
+        created_at: string;
+        /**
+         * Original input data for the task.
+         */
+        input: unknown;
+        /**
+         * Current state of the task.
+         */
+        state: 'pending' | 'success' | 'error';
+        /**
+         * URL for checking the task status.
+         */
+        status_url: string;
+        /**
+         * Account name that owns the task.
+         */
+        account_name?: string;
+        api_type?: 'web' | 'serp' | 'ecommerce' | 'social';
+        /**
+         * Batch ID if this task is part of a batch.
+         */
+        batch_id?: string;
+        /**
+         * URL for downloading the task results.
+         */
+        download_url?: string;
+        /**
+         * Error message if the task failed.
+         */
+        error?: string;
+        /**
+         * Classification of the error type.
+         */
+        error_type?: string;
+        /**
+         * Timestamp when the task was last modified.
+         */
+        modified_at?: string;
+        /**
+         * Storage location of the output data.
+         */
+        output_url?: string;
+        /**
+         * HTTP status code from the task execution.
+         */
+        status_code?: number;
+    }
+}
+/**
+ * The results of the completed task.
+ */
+export type TaskResultsResponse = {
+    [key: string]: unknown;
+};
+export interface TaskListParams {
+    /**
+     * Cursor for pagination. Use the next_cursor from the previous response.
+     */
+    cursor?: string;
+    /**
+     * Number of tasks to return per page.
+     */
+    limit?: number;
+}
+export declare namespace Tasks {
+    export { type TaskListResponse as TaskListResponse, type TaskGetResponse as TaskGetResponse, type TaskResultsResponse as TaskResultsResponse, type TaskListParams as TaskListParams, };
+}
+//# sourceMappingURL=tasks.d.ts.map

package/resources/tasks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/resources/tasks.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI1E;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGnF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAEnC,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;QAEvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEnD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;CAC5B;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;QAEvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEnD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7D,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/tasks.js

@@ -0,0 +1,28 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tasks = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Tasks extends resource_1.APIResource {
+    /**
+     * Retrieve a paginated list of tasks for the authenticated account.
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/tasks', { query, ...options });
+    }
+    /**
+     * Retrieve the details of a specific task by its ID.
+     */
+    get(taskID, options) {
+        return this._client.get((0, path_1.path) `/v1/tasks/${taskID}`, options);
+    }
+    /**
+     * Retrieve the results of a completed task.
+     */
+    results(taskID, options) {
+        return this._client.get((0, path_1.path) `/v1/tasks/${taskID}/results`, options);
+    }
+}
+exports.Tasks = Tasks;
+//# sourceMappingURL=tasks.js.map

package/resources/tasks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../src/resources/tasks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAxBD,sBAwBC"}

package/resources/tasks.mjs

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Tasks extends APIResource {
+    /**
+     * Retrieve a paginated list of tasks for the authenticated account.
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/tasks', { query, ...options });
+    }
+    /**
+     * Retrieve the details of a specific task by its ID.
+     */
+    get(taskID, options) {
+        return this._client.get(path `/v1/tasks/${taskID}`, options);
+    }
+    /**
+     * Retrieve the results of a completed task.
+     */
+    results(taskID, options) {
+        return this._client.get(path `/v1/tasks/${taskID}/results`, options);
+    }
+}
+//# sourceMappingURL=tasks.mjs.map

package/resources/tasks.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.mjs","sourceRoot":"","sources":["../src/resources/tasks.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}