/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateReportRequestBody, ReportSchema, ReportsSchema, UpdateReportRequestBody } from '../models/index'; export interface CreateReportRequest { createReportRequestBody: CreateReportRequestBody; } export interface DeleteReportRequest { reportId: string; } export interface ListReportsRequest { filterStatus?: ListReportsFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ReportOptionsRequest { reportId: string; } export interface ShowReportRequest { reportId: string; } export interface UpdateReportRequest { reportId: string; updateReportRequestBody: UpdateReportRequestBody; } /** * */ export declare class ReportsApi extends runtime.BaseAPI { /** * Creates request options for createReport without sending the request */ createReportRequestOpts(requestParameters: CreateReportRequest): Promise; /** * Creates a new report in your account. ### Report\'s Attributes Here is a table that describes the attributes of the report object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `resourceId` | string | Identifier of the resource this report is associated with (job ID or tenant ID). **Required.** | | `resourceType` | string | Type of the resource (`tenants` or `jobs`). **Required.** | | `period` | string | Report period frequency (`DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`). | | `reportContent` | string | Merged analytics and AI analysis content. | | `settings` | string | Report configuration including email recipients and period preferences. | | `shortCode` | string | Optional short identifier for the report. | | `source` | string | Source of the report creation (e.g. scheduled, manual). | | `status` | string | Current status of the report (`active`, `inactive`, `pending`, `archived`, `failed`). | | `ttl` | string | Time-to-live value for automatic report expiration. | | `timestamps.created` | string | The date and time when the report was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the report was last modified (ISO 8601 format). | * Create Report */ createReportRaw(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new report in your account. ### Report\'s Attributes Here is a table that describes the attributes of the report object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `resourceId` | string | Identifier of the resource this report is associated with (job ID or tenant ID). **Required.** | | `resourceType` | string | Type of the resource (`tenants` or `jobs`). **Required.** | | `period` | string | Report period frequency (`DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`). | | `reportContent` | string | Merged analytics and AI analysis content. | | `settings` | string | Report configuration including email recipients and period preferences. | | `shortCode` | string | Optional short identifier for the report. | | `source` | string | Source of the report creation (e.g. scheduled, manual). | | `status` | string | Current status of the report (`active`, `inactive`, `pending`, `archived`, `failed`). | | `ttl` | string | Time-to-live value for automatic report expiration. | | `timestamps.created` | string | The date and time when the report was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the report was last modified (ISO 8601 format). | * Create Report */ createReport(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteReport without sending the request */ deleteReportRequestOpts(requestParameters: DeleteReportRequest): Promise; /** * This endpoint allows you to delete a specific report from your account. Once deleted, the report\'s information will be permanently removed and cannot be recovered. * Delete Report */ deleteReportRaw(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific report from your account. Once deleted, the report\'s information will be permanently removed and cannot be recovered. * Delete Report */ deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listReports without sending the request */ listReportsRequestOpts(requestParameters: ListReportsRequest): Promise; /** * Returns a collection of your account reports ## Overview Returns a collection of your account reports, sorted by the time they were inserted into the system in ascending order. ### Reports Endpoints Pagination The reports endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Reports */ listReportsRaw(requestParameters: ListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account reports ## Overview Returns a collection of your account reports, sorted by the time they were inserted into the system in ascending order. ### Reports Endpoints Pagination The reports endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Reports */ listReports(requestParameters?: ListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for reportOptions without sending the request */ reportOptionsRequestOpts(requestParameters: ReportOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Report Options */ reportOptionsRaw(requestParameters: ReportOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Report Options */ reportOptions(requestParameters: ReportOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for reportsOptions without sending the request */ reportsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Reports Options */ reportsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Reports Options */ reportsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showReport without sending the request */ showReportRequestOpts(requestParameters: ShowReportRequest): Promise; /** * This endpoint retrieves details of a specific report from your account. You can view information such as resourceId, resourceType, period, reportContent, status, and other relevant attributes of the report. * Show Report */ showReportRaw(requestParameters: ShowReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific report from your account. You can view information such as resourceId, resourceType, period, reportContent, status, and other relevant attributes of the report. * Show Report */ showReport(requestParameters: ShowReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateReport without sending the request */ updateReportRequestOpts(requestParameters: UpdateReportRequest): Promise; /** * This endpoint allows you to update details of a specific report in your account. You can modify information such as status, settings, and other relevant attributes of the report. Only the fields provided in the request will be updated. * Update Report */ updateReportRaw(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific report in your account. You can modify information such as status, settings, and other relevant attributes of the report. Only the fields provided in the request will be updated. * Update Report */ updateReport(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListReportsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListReportsFilterStatusEnum = typeof ListReportsFilterStatusEnum[keyof typeof ListReportsFilterStatusEnum]; //# sourceMappingURL=ReportsApi.d.ts.map