@scrapyio/sdk 0.1.0

package/dist/generated/schema.d.ts

@@ -0,0 +1,762 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/tools": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List public tools */
+        get: operations["listTools"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/tools/{publisher}/{slug}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a public tool */
+        get: operations["getTool"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List runs for the authenticated user */
+        get: operations["listRuns"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/runs/{runId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a run */
+        get: operations["getRun"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/runs/{runId}/dataset/items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List dataset items for a run (JSON) or export in another format */
+        get: operations["listRunDatasetItems"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/schedules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List schedules for the authenticated user */
+        get: operations["listSchedules"];
+        put?: never;
+        /** Create a schedule */
+        post: operations["createSchedule"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/schedules/{scheduleId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a schedule */
+        get: operations["getSchedule"];
+        put?: never;
+        post?: never;
+        /** Soft-delete a schedule */
+        delete: operations["deleteSchedule"];
+        options?: never;
+        head?: never;
+        /** Update schedule (exactly one of isActive or notificationsEnabled) */
+        patch: operations["updateSchedule"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * @description Platform error type.
+         *     Active: unauthorized, validation_error, not_found, insufficient_credits, conflict.
+         *     Reserved (defined, not currently emitted by Platform handlers): forbidden, rate_limit_exceeded.
+         *     Fallback: internal_error.
+         * @enum {string}
+         */
+        ErrorType: "unauthorized" | "forbidden" | "not_found" | "validation_error" | "insufficient_credits" | "conflict" | "rate_limit_exceeded" | "internal_error";
+        Error: {
+            type: components["schemas"]["ErrorType"];
+            message: string;
+            /** @description Always present. Example `https://docs.scrapy.io/errors/not-found`. */
+            doc_url: string;
+        };
+        ErrorResponse: {
+            error: components["schemas"]["Error"];
+        };
+        /** @description Opaque JSON object (dynamic tool schemas / dataset rows). */
+        JsonObject: {
+            [key: string]: unknown;
+        };
+        ToolExecution: {
+            /**
+             * Format: uri
+             * @description Sync publisher execution URL (`…/v1/api`).
+             */
+            apiUrl: string;
+            /**
+             * Format: uri
+             * @description Async publisher execution URL (`…/v1/scraper`).
+             */
+            scraperUrl: string;
+        };
+        ToolDeveloper: {
+            slug: string;
+            name: string;
+            avatarUrl?: string | null;
+        };
+        ToolSummary: {
+            publisher: string;
+            slug: string;
+            shortId?: string | null;
+            name: string;
+            description?: string | null;
+            pricePerResult: number;
+            features: ("Scraper" | "API")[];
+            categories: string[];
+            rating: number;
+            reviewCount: number;
+            iconUrl?: string | null;
+            lastModifiedAt: string;
+            developer: components["schemas"]["ToolDeveloper"];
+            execution: components["schemas"]["ToolExecution"];
+        };
+        Tool: components["schemas"]["ToolSummary"] & {
+            /** @description Dynamic tool input form/schema. Not a closed per-tool TypeScript type. */
+            inputSchema: components["schemas"]["JsonObject"];
+            /** @description Optional dataset views / extracted paths. */
+            datasetSchema?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /** @enum {string} */
+        RunKind: "api_sync" | "async_batch";
+        /**
+         * @description Public run status. DB `completed` is mapped to `succeeded` by the Platform API.
+         * @enum {string}
+         */
+        RunStatus: "queued" | "running" | "succeeded" | "failed" | "cancelled" | "partial";
+        Run: {
+            /** Format: uuid */
+            id: string;
+            kind: components["schemas"]["RunKind"];
+            status: components["schemas"]["RunStatus"];
+            /** Format: uuid */
+            toolId: string;
+            publisher?: string | null;
+            toolSlug?: string | null;
+            runName?: string | null;
+            totalItems?: number | null;
+            processedItems?: number | null;
+            completedItems?: number | null;
+            failedItems?: number | null;
+            billedAmount?: number | null;
+            estimatedCost?: number | null;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            completedAt?: string | null;
+        };
+        /** @enum {string} */
+        ScheduleFrequency: "one-time" | "repeatedly";
+        /** @enum {string} */
+        RepeatFrequency: "every_10_mins" | "hourly" | "daily" | "weekly" | "monthly";
+        Schedule: {
+            /** Format: uuid */
+            id: string;
+            publisher?: string | null;
+            slug?: string | null;
+            toolName?: string | null;
+            runName: string;
+            timezone: string;
+            frequency: string;
+            /** @description YYYY-MM-DD */
+            date: string;
+            /** @description HH:MM */
+            time: string;
+            /** @description Null for one-time schedules. Enum when present - every_10_mins, hourly, daily, weekly, monthly. */
+            repeatFrequency?: string | null;
+            inputsCount: number;
+            isActive: boolean;
+            notificationsEnabled: boolean;
+            /** Format: date-time */
+            createdAt: string;
+        };
+        CreateScheduleRequest: {
+            publisher: string;
+            slug: string;
+            runName: string;
+            timezone: string;
+            frequency: components["schemas"]["ScheduleFrequency"];
+            /** @description YYYY-MM-DD */
+            date: string;
+            /** @description HH:MM */
+            time: string;
+            /** @description Required when frequency is repeatedly. */
+            repeatFrequency?: components["schemas"]["RepeatFrequency"];
+            inputs: string[];
+        };
+        /** @description Exactly one of isActive or notificationsEnabled must be supplied. */
+        UpdateScheduleRequest: {
+            isActive?: boolean;
+            notificationsEnabled?: boolean;
+        };
+        DeleteOk: {
+            /** @enum {boolean} */
+            ok: true;
+        };
+        DatasetItem: components["schemas"]["JsonObject"];
+        ToolSummaryCollectionResponse: {
+            data: {
+                items: components["schemas"]["ToolSummary"][];
+                total: number;
+                offset: number;
+                limit: number;
+            };
+        };
+        ToolResponse: {
+            data: components["schemas"]["Tool"];
+        };
+        RunCollectionResponse: {
+            data: {
+                items: components["schemas"]["Run"][];
+                total: number;
+                offset: number;
+                limit: number;
+            };
+        };
+        RunResponse: {
+            data: components["schemas"]["Run"];
+        };
+        DatasetItemsCollectionResponse: {
+            data: {
+                items: components["schemas"]["DatasetItem"][];
+                total: number;
+                offset: number;
+                limit: number;
+            };
+        };
+        ScheduleCollectionResponse: {
+            data: {
+                items: components["schemas"]["Schedule"][];
+                total: number;
+                offset: number;
+                limit: number;
+            };
+        };
+        ScheduleResponse: {
+            data: components["schemas"]["Schedule"];
+        };
+        DeleteScheduleResponse: {
+            data: components["schemas"]["DeleteOk"];
+        };
+    };
+    responses: {
+        /** @description Missing or invalid API key. */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /**
+                 * @example {
+                 *       "error": {
+                 *         "type": "unauthorized",
+                 *         "message": "Authentication token was not provided",
+                 *         "doc_url": "https://docs.scrapy.io/errors/unauthorized"
+                 *       }
+                 *     }
+                 */
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Invalid request parameters or body. */
+        ValidationError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Resource not found (or not owned by the authenticated account). */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Not enough credits to create the schedule. */
+        InsufficientCredits: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Idempotency key conflict (request already in progress). */
+        Conflict: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+    };
+    parameters: {
+        /** @description Zero-based offset. Default 0. */
+        OffsetParam: number;
+        /** @description Page size. Default 20, maximum 100. */
+        LimitParam: number;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    listTools: {
+        parameters: {
+            query?: {
+                /** @description Search over name/slug/description/categories. */
+                q?: string;
+                /** @description Comma-separated category tokens. */
+                social?: string;
+                /** @description Comma-separated category tokens. */
+                leads?: string;
+                /** @description Comma-separated category tokens. */
+                searchSeo?: string;
+                /** @description Comma-separated category tokens. */
+                ecommerce?: string;
+                /** @description Comma-separated; `api` and/or `scraper`. */
+                feature?: string;
+                sort?: string;
+                /** @description Zero-based offset. Default 0. */
+                offset?: components["parameters"]["OffsetParam"];
+                /** @description Page size. Default 20, maximum 100. */
+                limit?: components["parameters"]["LimitParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tool collection */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "data": {
+                     *         "items": [
+                     *           {
+                     *             "publisher": "datadoping",
+                     *             "slug": "instagram-profile-scraper",
+                     *             "shortId": "abc123",
+                     *             "name": "Instagram Profile Scraper",
+                     *             "description": "Extract public Instagram profile data",
+                     *             "pricePerResult": 0.01,
+                     *             "features": [
+                     *               "API",
+                     *               "Scraper"
+                     *             ],
+                     *             "categories": [
+                     *               "Instagram"
+                     *             ],
+                     *             "rating": 4.8,
+                     *             "reviewCount": 12,
+                     *             "iconUrl": null,
+                     *             "lastModifiedAt": "2026-01-01T00:00:00.000Z",
+                     *             "developer": {
+                     *               "slug": "datadoping",
+                     *               "name": "Data Doping",
+                     *               "avatarUrl": null
+                     *             },
+                     *             "execution": {
+                     *               "apiUrl": "https://datadoping.p.scrapy.io/instagram-profile-scraper/v1/api",
+                     *               "scraperUrl": "https://datadoping.p.scrapy.io/instagram-profile-scraper/v1/scraper"
+                     *             }
+                     *           }
+                     *         ],
+                     *         "total": 42,
+                     *         "offset": 0,
+                     *         "limit": 20
+                     *       }
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ToolSummaryCollectionResponse"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    getTool: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                publisher: string;
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tool detail including inputSchema and datasetSchema */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ToolResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    listRuns: {
+        parameters: {
+            query?: {
+                /** @description `api_sync` or alias `api`; `async_batch` or alias `scraper`. */
+                kind?: string;
+                toolId?: string;
+                /** @description Public status filter. `succeeded` maps to DB `completed` server-side. */
+                status?: string;
+                /** @description Zero-based offset. Default 0. */
+                offset?: components["parameters"]["OffsetParam"];
+                /** @description Page size. Default 20, maximum 100. */
+                limit?: components["parameters"]["LimitParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Run collection */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunCollectionResponse"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    getRun: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Run */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    listRunDatasetItems: {
+        parameters: {
+            query?: {
+                /** @description Zero-based offset. Default 0. */
+                offset?: components["parameters"]["OffsetParam"];
+                /** @description Page size. Default 20, maximum 100. */
+                limit?: components["parameters"]["LimitParam"];
+                format?: string;
+                /** @description Comma-separated fields to include. */
+                fields?: string;
+                /** @description Alias for fields. */
+                columns?: string;
+                /** @description Comma-separated fields to omit. */
+                omit?: string;
+                /** @description If true/1/yes, drop keys starting with `#`. */
+                clean?: string;
+                /** @description If true/1/yes, reverse row order. */
+                desc?: string;
+                includeSerial?: string;
+                skipHeaderRow?: string;
+                feedTitle?: string;
+                /** @description Controls Content-Disposition for non-JSON exports. */
+                attachment?: string;
+                /** @description Comma-separated row `type` filter. */
+                types?: string;
+                /** @description Comma-separated row `category` filter. */
+                categories?: string;
+            };
+            header?: never;
+            path: {
+                runId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /**
+             * @description When `format` is omitted or `json`: Platform collection envelope.
+             *     Otherwise: raw export body (not wrapped in `{ data: ... }`).
+             */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatasetItemsCollectionResponse"];
+                    "application/x-ndjson": string;
+                    "text/csv": string;
+                    "application/xml": string;
+                    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": string;
+                    "text/html": string;
+                    "application/rss+xml": string;
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    listSchedules: {
+        parameters: {
+            query?: {
+                /** @description Zero-based offset. Default 0. */
+                offset?: components["parameters"]["OffsetParam"];
+                /** @description Page size. Default 20, maximum 100. */
+                limit?: components["parameters"]["LimitParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Schedule collection */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduleCollectionResponse"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+        };
+    };
+    createSchedule: {
+        parameters: {
+            query?: never;
+            header?: {
+                "Idempotency-Key"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                /**
+                 * @example {
+                 *       "publisher": "datadoping",
+                 *       "slug": "instagram-profile-scraper",
+                 *       "runName": "nightly-ig",
+                 *       "timezone": "America/New_York",
+                 *       "frequency": "repeatedly",
+                 *       "date": "2026-09-15",
+                 *       "time": "09:00",
+                 *       "repeatFrequency": "daily",
+                 *       "inputs": [
+                 *         "nasa",
+                 *         "spacex"
+                 *       ]
+                 *     }
+                 */
+                "application/json": components["schemas"]["CreateScheduleRequest"];
+            };
+        };
+        responses: {
+            /** @description Created (or idempotent replay of a completed create) */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduleResponse"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            402: components["responses"]["InsufficientCredits"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    getSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                scheduleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Schedule */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduleResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    deleteSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                scheduleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Deleted */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "data": {
+                     *         "ok": true
+                     *       }
+                     *     }
+                     */
+                    "application/json": components["schemas"]["DeleteScheduleResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    updateSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                scheduleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateScheduleRequest"];
+            };
+        };
+        responses: {
+            /** @description Updated schedule */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ScheduleResponse"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+}
+//# sourceMappingURL=schema.d.ts.map