import { APIResource } from "../../core/resource.mjs"; import * as AvailableFiltersAPI from "./available-filters.mjs"; import { AvailableFilterRetrieveResponse, AvailableFilters } from "./available-filters.mjs"; import { APIPromise } from "../../core/api-promise.mjs"; import { RequestOptions } from "../../internal/request-options.mjs"; /** * Report data for company */ export declare class Reports extends APIResource { availableFilters: AvailableFiltersAPI.AvailableFilters; /** * Retrieve a specific report by its ID * * @example HTTP * Representative request and response shapes. * ``` * GET /reports/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "2025-01-01T00:00:00Z", * "updated_at": "2025-01-01T00:00:00Z", * "name": "string", * "output_fields": [ * { * "field_id": "string", * "field_name": "string" * } * ], * "saved_filters": [ * { * "field_id": "string", * "field_name": "string", * "operator": "string", * "value": null * } * ] * } * ``` */ retrieve(id: string, options?: RequestOptions): APIPromise; } /** * A report definition including its output fields and saved filters */ export interface ReportRetrieveResponse { /** * Unique identifier of the report */ id: string; /** * Record creation date */ created_at: string; /** * Display name of the report */ name: string; /** * Attributes (columns) in the report output, with field_id and field_name */ output_fields: Array; /** * Filters currently saved on the report */ saved_filters: Array; /** * Record update date */ updated_at: string; } export declare namespace ReportRetrieveResponse { /** * An attribute (column) in the report output */ interface OutputField { /** * Stable field identifier */ field_id: string; /** * Human-readable display name of the output field */ field_name: string; } /** * A filter currently saved on the report */ interface SavedFilter { /** * Stable field identifier the filter applies to */ field_id: string; /** * Human-readable display name of the filtered field */ field_name: string; /** * Filter operator applied to the field */ operator: string; /** * Filter value; shape depends on the operator */ value?: unknown; } } export declare namespace Reports { export { type ReportRetrieveResponse as ReportRetrieveResponse }; export { AvailableFilters as AvailableFilters, type AvailableFilterRetrieveResponse as AvailableFilterRetrieveResponse, }; } //# sourceMappingURL=reports.d.mts.map