@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
36 lines (35 loc) • 1.82 kB
TypeScript
import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
import { Configuration } from "../../datadog-api-client-common/configuration";
import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
import { ListSharedDashboardsResponse } from "../models/ListSharedDashboardsResponse";
export declare class DashboardSharingApiRequestFactory extends BaseAPIRequestFactory {
listSharedDashboardsByDashboardId(dashboardId: string, _options?: Configuration): Promise<RequestContext>;
}
export declare class DashboardSharingApiResponseProcessor {
/**
* Unwraps the actual response sent by the server from the response context and deserializes the response content
* to the expected objects
*
* @params response Response returned by the server for a request to listSharedDashboardsByDashboardId
* @throws ApiException if the response code was not in [200, 299]
*/
listSharedDashboardsByDashboardId(response: ResponseContext): Promise<ListSharedDashboardsResponse>;
}
export interface DashboardSharingApiListSharedDashboardsByDashboardIdRequest {
/**
* ID of the dashboard.
* @type string
*/
dashboardId: string;
}
export declare class DashboardSharingApi {
private requestFactory;
private responseProcessor;
private configuration;
constructor(configuration: Configuration, requestFactory?: DashboardSharingApiRequestFactory, responseProcessor?: DashboardSharingApiResponseProcessor);
/**
* Retrieve shared dashboards associated with the specified dashboard.
* @param param The request object
*/
listSharedDashboardsByDashboardId(param: DashboardSharingApiListSharedDashboardsByDashboardIdRequest, options?: Configuration): Promise<ListSharedDashboardsResponse>;
}