postgrid-node 0.1.0-alpha.1

package/resources/reports/reports.mjs

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
+import * as ExportsAPI from "./exports.mjs";
+import { Exports, } from "./exports.mjs";
+import * as SamplesAPI from "./samples.mjs";
+import { Samples, } from "./samples.mjs";
+import { List } from "../../pagination.mjs";
+export class Reports extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.samples = new SamplesAPI.Samples(this._client);
+        this.exports = new ExportsAPI.Exports(this._client);
+    }
+    /**
+     * Create a new saved report definition. Saved reports are SQL queries that can be
+     * executed later to generate full exports or samples.
+     *
+     * If you just want to do ad-hoc queries, you should use the `/reports/samples`
+     * endpoint.
+     */
+    create(body, options) {
+        return this._client.post('/reports/', { body, ...options });
+    }
+    /**
+     * Retrieve the details of a specific saved report by its ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(`/reports/${id}`, options);
+    }
+    /**
+     * Update an existing saved report definition. You can change the query,
+     * description, or metadata.
+     */
+    update(id, body, options) {
+        return this._client.post(`/reports/${id}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/reports/', ReportListResponsesList, { query, ...options });
+    }
+    /**
+     * Delete a saved report definition. This action cannot be undone. Associated
+     * exports are not automatically deleted.
+     */
+    delete(id, options) {
+        return this._client.delete(`/reports/${id}`, options);
+    }
+}
+export class ReportListResponsesList extends List {
+}
+Reports.ReportListResponsesList = ReportListResponsesList;
+Reports.Samples = Samples;
+Reports.Exports = Exports;
+//# sourceMappingURL=reports.mjs.map

package/resources/reports/reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,UAAU;OACf,EAKL,OAAO,GACR;OACM,KAAK,UAAU;OACf,EAKL,OAAO,GACR;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyDrE,CAAC;IAvDC;;;;;;OAMG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAUD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,IAAwB;CAAG;AAkPxE,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/resources/reports/samples.d.ts

@@ -0,0 +1,81 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+export declare class Samples extends APIResource {
+    /**
+     * Run an ad-hoc SQL query against your data lake and get a sample of the results.
+     * This is useful for quickly testing queries without saving them as a report. The
+     * query execution time and result size are limited.
+     */
+    run(body: SampleRunParams, options?: Core.RequestOptions): Core.APIPromise<SampleRunResponse>;
+    /**
+     * Run the query associated with a saved report and get a sample of the results.
+     * This allows getting up to 1000 rows of resutls but the runtime of the query is
+     * limited to 30 seconds. If you need more rows or longer runtime, you should
+     * create an export from this report.
+     */
+    sample(id: string, body: SampleSampleParams, options?: Core.RequestOptions): Core.APIPromise<SampleSampleResponse>;
+}
+/**
+ * Represents the result of a report sample query.
+ */
+export interface SampleRunResponse {
+    /**
+     * Unique identifier for the sample query result.
+     */
+    id: string;
+    /**
+     * The actual data records returned by the sample query.
+     */
+    records: Array<Record<string, unknown>>;
+    /**
+     * The ID of the report this sample was generated from, or null for ad-hoc samples.
+     */
+    report: string | null;
+}
+/**
+ * Represents the result of a report sample query.
+ */
+export interface SampleSampleResponse {
+    /**
+     * Unique identifier for the sample query result.
+     */
+    id: string;
+    /**
+     * The actual data records returned by the sample query.
+     */
+    records: Array<Record<string, unknown>>;
+    /**
+     * The ID of the report this sample was generated from, or null for ad-hoc samples.
+     */
+    report: string | null;
+}
+export interface SampleRunParams {
+    /**
+     * The SQL query to execute for the sample.
+     */
+    sqlQuery: string;
+    /**
+     * Maximum number of rows to return in the sample.
+     */
+    limit?: number;
+    /**
+     * Optional parameters to bind to the SQL query (e.g., for placeholders like ? or
+     * $1).
+     */
+    params?: Array<string>;
+}
+export interface SampleSampleParams {
+    /**
+     * Maximum number of rows to return in the sample.
+     */
+    limit?: number;
+    /**
+     * Optional parameters to bind to the SQL query (e.g., for placeholders like ? or
+     * $1).
+     */
+    params?: Array<string>;
+}
+export declare namespace Samples {
+    export { type SampleRunResponse as SampleRunResponse, type SampleSampleResponse as SampleSampleResponse, type SampleRunParams as SampleRunParams, type SampleSampleParams as SampleSampleParams, };
+}
+//# sourceMappingURL=samples.d.ts.map

package/resources/reports/samples.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples.d.ts","sourceRoot":"","sources":["../../src/resources/reports/samples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAI7F;;;;;OAKG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/reports/samples.js

@@ -0,0 +1,26 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Samples = void 0;
+const resource_1 = require("../../resource.js");
+class Samples extends resource_1.APIResource {
+    /**
+     * Run an ad-hoc SQL query against your data lake and get a sample of the results.
+     * This is useful for quickly testing queries without saving them as a report. The
+     * query execution time and result size are limited.
+     */
+    run(body, options) {
+        return this._client.post('/reports/samples', { body, ...options });
+    }
+    /**
+     * Run the query associated with a saved report and get a sample of the results.
+     * This allows getting up to 1000 rows of resutls but the runtime of the query is
+     * limited to 30 seconds. If you need more rows or longer runtime, you should
+     * create an export from this report.
+     */
+    sample(id, body, options) {
+        return this._client.post(`/reports/${id}/samples`, { body, ...options });
+    }
+}
+exports.Samples = Samples;
+//# sourceMappingURL=samples.js.map

package/resources/reports/samples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples.js","sourceRoot":"","sources":["../../src/resources/reports/samples.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;OAIG;IACH,GAAG,CAAC,IAAqB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAvBD,0BAuBC"}

package/resources/reports/samples.mjs

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+export class Samples extends APIResource {
+    /**
+     * Run an ad-hoc SQL query against your data lake and get a sample of the results.
+     * This is useful for quickly testing queries without saving them as a report. The
+     * query execution time and result size are limited.
+     */
+    run(body, options) {
+        return this._client.post('/reports/samples', { body, ...options });
+    }
+    /**
+     * Run the query associated with a saved report and get a sample of the results.
+     * This allows getting up to 1000 rows of resutls but the runtime of the query is
+     * limited to 30 seconds. If you need more rows or longer runtime, you should
+     * create an export from this report.
+     */
+    sample(id, body, options) {
+        return this._client.post(`/reports/${id}/samples`, { body, ...options });
+    }
+}
+//# sourceMappingURL=samples.mjs.map

package/resources/reports/samples.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples.mjs","sourceRoot":"","sources":["../../src/resources/reports/samples.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,GAAG,CAAC,IAAqB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}