@shi-corp/sdk-data-gateway
Version:
SDK client used to interface with the SHI Data Gateway service.
51 lines (50 loc) • 3.33 kB
TypeScript
import { type Shield } from '../../../models/telemetry/index.js';
import { type TenantRequestBuilder } from './tenant/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Builds and executes requests for operations under /Api/Telemetry/Shield
*/
export interface ShieldRequestBuilder extends BaseRequestBuilder<ShieldRequestBuilder> {
/**
* The Tenant property
*/
get tenant(): TenantRequestBuilder;
/**
* Retrieves the telemetry records that have been reported for the authenticated tenant. Data is not guaranteed to be retrieved in any specific order.This endpoint requires the `Telemetry.Shield.Read`, `Telemetry.Shield.Read.All`, `Telemetry.Shield.ReadWrite`, or `Telemetry.Shield.ReadWrite.All` scope (permission).
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Shield[]>}
*/
get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Shield[] | undefined>;
/**
* Submits the telemetry report for SHIELD.This endpoint requires the `Telemetry.Shield.ReadWrite`, or `Telemetry.Shield.ReadWrite.All` scope (permission).
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Shield>}
*/
post(body: Shield, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Shield | undefined>;
/**
* Retrieves the telemetry records that have been reported for the authenticated tenant. Data is not guaranteed to be retrieved in any specific order.This endpoint requires the `Telemetry.Shield.Read`, `Telemetry.Shield.Read.All`, `Telemetry.Shield.ReadWrite`, or `Telemetry.Shield.ReadWrite.All` scope (permission).
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* Submits the telemetry report for SHIELD.This endpoint requires the `Telemetry.Shield.ReadWrite`, or `Telemetry.Shield.ReadWrite.All` scope (permission).
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: Shield, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Uri template for the request builder.
*/
export declare const ShieldRequestBuilderUriTemplate = "{+baseurl}/Api/Telemetry/Shield";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ShieldRequestBuilderNavigationMetadata: Record<Exclude<keyof ShieldRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ShieldRequestBuilderRequestsMetadata: RequestsMetadata;