@shi-corp/sdk-data-gateway/bin/sdk/api/licenseReport/correlation/index.d.ts

SDK client used to interface with the SHI Data Gateway service.

import { type CorrelationRecord } from '../../../models/licenseReport/index.js';
import { type WithCorrelationItemRequestBuilder } from './item/index.js';
import { type TenantRequestBuilder } from './tenant/index.js';
import { type BaseRequestBuilder, type Guid, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Builds and executes requests for operations under /Api/LicenseReport/Correlation
 */
export interface CorrelationRequestBuilder extends BaseRequestBuilder<CorrelationRequestBuilder> {
    /**
     * The Tenant property
     */
    get tenant(): TenantRequestBuilder;
    /**
     * Gets an item from the ApiSdk.Api.LicenseReport.Correlation.item collection
     * @param correlationId The object ID of the correlation identifier for the specified record.
     * @returns {WithCorrelationItemRequestBuilder}
     */
    byCorrelationId(correlationId: Guid): WithCorrelationItemRequestBuilder;
    /**
     * Retrieves the list of correlation records for the authenticated tenant. Can use filters targeting creation date to limit results. Correlation records store the metadata for a specific license report.This endpoint requires the `LicenseReport.Read`,  `LicenseReport.Read.All`, `LicenseReport.ReadWrite`, or `LicenseReport.ReadWrite.All` scope (permission).
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<CorrelationRecord[]>}
     */
    get(requestConfiguration?: RequestConfiguration<CorrelationRequestBuilderGetQueryParameters> | undefined): Promise<CorrelationRecord[] | undefined>;
    /**
     * Retrieves the list of correlation records for the authenticated tenant. Can use filters targeting creation date to limit results. Correlation records store the metadata for a specific license report.This endpoint requires the `LicenseReport.Read`,  `LicenseReport.Read.All`, `LicenseReport.ReadWrite`, or `LicenseReport.ReadWrite.All` scope (permission).
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<CorrelationRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
 * Retrieves the list of correlation records for the authenticated tenant. Can use filters targeting creation date to limit results. Correlation records store the metadata for a specific license report.This endpoint requires the `LicenseReport.Read`,  `LicenseReport.Read.All`, `LicenseReport.ReadWrite`, or `LicenseReport.ReadWrite.All` scope (permission).
 */
export interface CorrelationRequestBuilderGetQueryParameters {
    /**
     * Date string to narrow records selection to those created before or on that date.
     */
    dateEnd?: Date;
    /**
     * Date string to narrow records selection to those created on or after that date.
     */
    dateStart?: Date;
}
/**
 * Uri template for the request builder.
 */
export declare const CorrelationRequestBuilderUriTemplate = "{+baseurl}/Api/LicenseReport/Correlation{?dateEnd*,dateStart*}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const CorrelationRequestBuilderNavigationMetadata: Record<Exclude<keyof CorrelationRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const CorrelationRequestBuilderRequestsMetadata: RequestsMetadata;