postgrid-node 0.1.0-alpha.1

package/src/resources/reports/exports.ts

@@ -0,0 +1,272 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Exports extends APIResource {
+  /**
+   * Create a new export job for a saved report. This runs the report's query
+   * asynchronously and generates a downloadable CSV file with the full results. Your
+   * queries can run for up to 13 minutes the resulting file can be up to 100mb
+   * large.
+   */
+  create(
+    reportId: string,
+    body: ExportCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ExportCreateResponse> {
+    return this._client.post(`/reports/${reportId}/exports`, { body, ...options });
+  }
+
+  /**
+   * Retrieve the status and details of a specific report export job. Check the
+   * `outputURL` property for the download link once generation is complete.
+   */
+  retrieve(
+    reportId: string,
+    exportId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ExportRetrieveResponse> {
+    return this._client.get(`/reports/${reportId}/exports/${exportId}`, options);
+  }
+
+  /**
+   * Delete a completed or failed report export job and its associated output file
+   * (if any). This action cannot be undone. You cannot delete an export that is
+   * still generating.
+   */
+  delete(
+    reportId: string,
+    exportId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ExportDeleteResponse> {
+    return this._client.delete(`/reports/${reportId}/exports/${exportId}`, options);
+  }
+}
+
+/**
+ * Represents a report export job and its results.
+ */
+export interface ExportCreateResponse {
+  /**
+   * Unique identifier for the report export.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the export was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the export is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report_export`.
+   */
+  object: 'report_export';
+
+  /**
+   * Details of the report this export was generated from.
+   */
+  report: ExportCreateResponse.Report;
+
+  /**
+   * Timestamp when the export was last updated (e.g., finished generation).
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the export.
+   */
+  description?: string;
+
+  /**
+   * If export generation failed, this contains the error message.
+   */
+  failureMessage?: string;
+
+  /**
+   * Optional key-value metadata associated with the export.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * A signed URL to download the exported data (CSV format). Available when
+   * generation is complete and successful.
+   */
+  outputURL?: string;
+
+  /**
+   * Optional parameters to bind to the SQL query of the associated report.
+   */
+  params?: Array<string>;
+
+  /**
+   * The number of rows in the exported data.
+   */
+  rowCount?: number;
+
+  /**
+   * The size of the generated export file in bytes.
+   */
+  sizeInBytes?: number;
+
+  /**
+   * If the output was truncated, indicates the byte limit reached.
+   */
+  truncatedToBytes?: number;
+}
+
+export namespace ExportCreateResponse {
+  /**
+   * Details of the report this export was generated from.
+   */
+  export interface Report {
+    /**
+     * The ID of the report.
+     */
+    id: string;
+
+    /**
+     * The SQL query used for this export (snapshotted at creation time).
+     */
+    sqlQuery: string;
+  }
+}
+
+/**
+ * Represents a report export job and its results.
+ */
+export interface ExportRetrieveResponse {
+  /**
+   * Unique identifier for the report export.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the export was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the export is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report_export`.
+   */
+  object: 'report_export';
+
+  /**
+   * Details of the report this export was generated from.
+   */
+  report: ExportRetrieveResponse.Report;
+
+  /**
+   * Timestamp when the export was last updated (e.g., finished generation).
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the export.
+   */
+  description?: string;
+
+  /**
+   * If export generation failed, this contains the error message.
+   */
+  failureMessage?: string;
+
+  /**
+   * Optional key-value metadata associated with the export.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * A signed URL to download the exported data (CSV format). Available when
+   * generation is complete and successful.
+   */
+  outputURL?: string;
+
+  /**
+   * Optional parameters to bind to the SQL query of the associated report.
+   */
+  params?: Array<string>;
+
+  /**
+   * The number of rows in the exported data.
+   */
+  rowCount?: number;
+
+  /**
+   * The size of the generated export file in bytes.
+   */
+  sizeInBytes?: number;
+
+  /**
+   * If the output was truncated, indicates the byte limit reached.
+   */
+  truncatedToBytes?: number;
+}
+
+export namespace ExportRetrieveResponse {
+  /**
+   * Details of the report this export was generated from.
+   */
+  export interface Report {
+    /**
+     * The ID of the report.
+     */
+    id: string;
+
+    /**
+     * The SQL query used for this export (snapshotted at creation time).
+     */
+    sqlQuery: string;
+  }
+}
+
+/**
+ * Generic response for delete operations.
+ */
+export interface ExportDeleteResponse {
+  /**
+   * The ID of the deleted resource.
+   */
+  id: string;
+
+  /**
+   * Indicates the resource was successfully deleted.
+   */
+  deleted: true;
+}
+
+export interface ExportCreateParams {
+  /**
+   * An optional user-friendly description for the export.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the export.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * Optional parameters to bind to the SQL query of the associated report.
+   */
+  params?: Array<string>;
+}
+
+export declare namespace Exports {
+  export {
+    type ExportCreateResponse as ExportCreateResponse,
+    type ExportRetrieveResponse as ExportRetrieveResponse,
+    type ExportDeleteResponse as ExportDeleteResponse,
+    type ExportCreateParams as ExportCreateParams,
+  };
+}

package/src/resources/reports/index.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Exports,
+  type ExportCreateResponse,
+  type ExportRetrieveResponse,
+  type ExportDeleteResponse,
+  type ExportCreateParams,
+} from './exports';
+export {
+  ReportListResponsesList,
+  Reports,
+  type ReportCreateResponse,
+  type ReportRetrieveResponse,
+  type ReportUpdateResponse,
+  type ReportListResponse,
+  type ReportDeleteResponse,
+  type ReportCreateParams,
+  type ReportUpdateParams,
+  type ReportListParams,
+} from './reports';
+export {
+  Samples,
+  type SampleRunResponse,
+  type SampleSampleResponse,
+  type SampleRunParams,
+  type SampleSampleParams,
+} from './samples';

package/src/resources/reports/reports.ts

@@ -0,0 +1,359 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as ExportsAPI from './exports';
+import {
+  ExportCreateParams,
+  ExportCreateResponse,
+  ExportDeleteResponse,
+  ExportRetrieveResponse,
+  Exports,
+} from './exports';
+import * as SamplesAPI from './samples';
+import {
+  SampleRunParams,
+  SampleRunResponse,
+  SampleSampleParams,
+  SampleSampleResponse,
+  Samples,
+} from './samples';
+import { List, type ListParams } from '../../pagination';
+
+export class Reports extends APIResource {
+  samples: SamplesAPI.Samples = new SamplesAPI.Samples(this._client);
+  exports: ExportsAPI.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: ReportCreateParams, options?: Core.RequestOptions): Core.APIPromise<ReportCreateResponse> {
+    return this._client.post('/reports/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the details of a specific saved report by its ID.
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ReportRetrieveResponse> {
+    return this._client.get(`/reports/${id}`, options);
+  }
+
+  /**
+   * Update an existing saved report definition. You can change the query,
+   * description, or metadata.
+   */
+  update(
+    id: string,
+    body: ReportUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ReportUpdateResponse> {
+    return this._client.post(`/reports/${id}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of saved reports for your organization.
+   */
+  list(
+    query?: ReportListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ReportListResponsesList, ReportListResponse>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ReportListResponsesList, ReportListResponse>;
+  list(
+    query: ReportListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ReportListResponsesList, ReportListResponse> {
+    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: string, options?: Core.RequestOptions): Core.APIPromise<ReportDeleteResponse> {
+    return this._client.delete(`/reports/${id}`, options);
+  }
+}
+
+export class ReportListResponsesList extends List<ReportListResponse> {}
+
+/**
+ * Represents a saved Report definition.
+ */
+export interface ReportCreateResponse {
+  /**
+   * Unique identifier for the report.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the report was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the report is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report`.
+   */
+  object: 'report';
+
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery: string;
+
+  /**
+   * Timestamp when the report was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the report.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the report.
+   */
+  metadata?: Record<string, string>;
+}
+
+/**
+ * Represents a saved Report definition.
+ */
+export interface ReportRetrieveResponse {
+  /**
+   * Unique identifier for the report.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the report was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the report is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report`.
+   */
+  object: 'report';
+
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery: string;
+
+  /**
+   * Timestamp when the report was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the report.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the report.
+   */
+  metadata?: Record<string, string>;
+}
+
+/**
+ * Represents a saved Report definition.
+ */
+export interface ReportUpdateResponse {
+  /**
+   * Unique identifier for the report.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the report was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the report is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report`.
+   */
+  object: 'report';
+
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery: string;
+
+  /**
+   * Timestamp when the report was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the report.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the report.
+   */
+  metadata?: Record<string, string>;
+}
+
+/**
+ * Represents a saved Report definition.
+ */
+export interface ReportListResponse {
+  /**
+   * Unique identifier for the report.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the report was created.
+   */
+  createdAt: string;
+
+  /**
+   * Indicates if the report is associated with the live or test environment.
+   */
+  live: boolean;
+
+  /**
+   * Always `report`.
+   */
+  object: 'report';
+
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery: string;
+
+  /**
+   * Timestamp when the report was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional user-friendly description for the report.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the report.
+   */
+  metadata?: Record<string, string>;
+}
+
+/**
+ * Generic response for delete operations.
+ */
+export interface ReportDeleteResponse {
+  /**
+   * The ID of the deleted resource.
+   */
+  id: string;
+
+  /**
+   * Indicates the resource was successfully deleted.
+   */
+  deleted: true;
+}
+
+export interface ReportCreateParams {
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery: string;
+
+  /**
+   * An optional user-friendly description for the report.
+   */
+  description?: string;
+
+  /**
+   * Optional key-value metadata associated with the report.
+   */
+  metadata?: Record<string, string>;
+}
+
+export interface ReportUpdateParams {
+  /**
+   * An optional user-friendly description for the report. Set to null to remove.
+   */
+  description?: string | null;
+
+  /**
+   * Optional key-value metadata associated with the report. Set to null to remove.
+   */
+  metadata?: Record<string, string> | null;
+
+  /**
+   * The SQL query defining the report.
+   */
+  sqlQuery?: string;
+}
+
+export interface ReportListParams extends ListParams {
+  /**
+   * You can supply any string to help narrow down the list of resources. For
+   * example, if you pass `"New York"` (quoted), it will return resources that have
+   * that string present somewhere in their response. Alternatively, you can supply a
+   * structured search query. See the documentation on `StructuredSearchQuery` for
+   * more details.
+   */
+  search?: string;
+}
+
+Reports.ReportListResponsesList = ReportListResponsesList;
+Reports.Samples = Samples;
+Reports.Exports = Exports;
+
+export declare namespace Reports {
+  export {
+    type ReportCreateResponse as ReportCreateResponse,
+    type ReportRetrieveResponse as ReportRetrieveResponse,
+    type ReportUpdateResponse as ReportUpdateResponse,
+    type ReportListResponse as ReportListResponse,
+    type ReportDeleteResponse as ReportDeleteResponse,
+    ReportListResponsesList as ReportListResponsesList,
+    type ReportCreateParams as ReportCreateParams,
+    type ReportUpdateParams as ReportUpdateParams,
+    type ReportListParams as ReportListParams,
+  };
+
+  export {
+    Samples as Samples,
+    type SampleRunResponse as SampleRunResponse,
+    type SampleSampleResponse as SampleSampleResponse,
+    type SampleRunParams as SampleRunParams,
+    type SampleSampleParams as SampleSampleParams,
+  };
+
+  export {
+    Exports as Exports,
+    type ExportCreateResponse as ExportCreateResponse,
+    type ExportRetrieveResponse as ExportRetrieveResponse,
+    type ExportDeleteResponse as ExportDeleteResponse,
+    type ExportCreateParams as ExportCreateParams,
+  };
+}