/** * Reports service. * @version 4.1.1-beta-1 * @class ReportsApi */ export class ReportsApi { /** * Make the default {@link ApiClient} class available for developers to be able to extend it and bring * their own fetch methods into the SDK */ static get ApiClient(): typeof ApiClient; /** * Constructs a new ReportsApi. * @alias module:api/ReportsApi * @class * @param {module:ApiClient} [apiClient] Optional API client implementation to use, * default to {@link module:ApiClient#instance} if unspecified. */ constructor(apiClient?: any); apiClient: any; /** * Generate a report instance * Creates a report for the specified report configuration UUID. * @param { Required> & Partial } body specification * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateReportApiResponse } and HTTP response */ createReport(body: Required> & Partial, ...args: any): Promise; /** * Delete a report * Deletes the report associated with the given UUID. * @param { String } extId UUID of the report. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteReportApiResponse } and HTTP response */ deleteReportById(extId: string, ...args: any): Promise; /** * Download a report * Downloads a generated report by utilizing the given report type and UUID. * @param { String } reportExtId UUID of the report. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DownloadReportApiResponse } and HTTP response */ downloadReport(reportExtId: string, ...args: any): Promise; /** * Get a report * Fetches the report associated with the given UUID. * @param { String } extId UUID of the report. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetReportApiResponse } and HTTP response */ getReportById(extId: string, ...args: any): Promise; /** * Get the list of reports * Fetches a list of all the generated reports * @param {Object} opts Optional parameters defined for the operation * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. If both $page and $apply query parameters are present, $page will be applied on entities within the groups. * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. If both $limit and $apply query parameters are present, $limit will be applied on entities within the groups. Default value of limit with $apply will be 5. * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.
* For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. If both $filter and $apply query parameters are present, $filter will be applied on entities within the groups. * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. If both $orderby and $apply query parameters are present, $orderby will be applied on entities within the groups. * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. If both $select and $apply query parameters are present, $select will be applied on entities within the groups. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListReportsApiResponse } and HTTP response */ listReports(opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * Notify user with a report * Notifies the specified recipients by emailing the generated reports for the given UUID. * @param { Required> & Partial } body specification * @param { String } extId UUID of the report. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link NotifyReportApiResponse } and HTTP response */ notifyReport(extId: string, body: Required> & Partial, ...args: any): Promise; #private; } import Report from "../models/opsmgmt/v4/config/Report"; import CreateReportApiResponse from "../models/opsmgmt/v4/config/CreateReportApiResponse"; import DeleteReportApiResponse from "../models/opsmgmt/v4/config/DeleteReportApiResponse"; import DownloadReportApiResponse from "../models/opsmgmt/v4/content/DownloadReportApiResponse"; import GetReportApiResponse from "../models/opsmgmt/v4/config/GetReportApiResponse"; import ListReportsApiResponse from "../models/opsmgmt/v4/config/ListReportsApiResponse"; import ReportNotificationSpec from "../models/opsmgmt/v4/config/ReportNotificationSpec"; import NotifyReportApiResponse from "../models/opsmgmt/v4/config/NotifyReportApiResponse"; import { ApiClient } from "../ApiClient";