@shi-corp/sdk-data-gateway
Version:
SDK client used to interface with the SHI Data Gateway service.
39 lines (38 loc) • 2.4 kB
TypeScript
import { type Tenant } from '../../../../models/update/shield/index.js';
import { type WithTenantItemRequestBuilder } from './item/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/Update/Shield/Tenant
*/
export interface TenantRequestBuilder extends BaseRequestBuilder<TenantRequestBuilder> {
/**
* Gets an item from the ApiSdk.Api.Update.Shield.Tenant.item collection
* @param tenantId The object ID of the tenant to operate against.
* @returns {WithTenantItemRequestBuilder}
*/
byTenantId(tenantId: Guid): WithTenantItemRequestBuilder;
/**
* Retrieves all tenant configurations present in the update service.This endpoint requires the `UpdateShield.ReadWrite.All` scope (permission). This endpoint is also only accessible form the `SHI Lab` tenant. End user access is restricted.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Tenant[]>}
*/
get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Tenant[] | undefined>;
/**
* Retrieves all tenant configurations present in the update service.This endpoint requires the `UpdateShield.ReadWrite.All` scope (permission). This endpoint is also only accessible form the `SHI Lab` tenant. End user access is restricted.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Uri template for the request builder.
*/
export declare const TenantRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Shield/Tenant";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const TenantRequestBuilderNavigationMetadata: Record<Exclude<keyof TenantRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const TenantRequestBuilderRequestsMetadata: RequestsMetadata;