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

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

import { type RecordData } from '../../models/tenantDetails/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/Tenant
 */
export interface TenantRequestBuilder extends BaseRequestBuilder<TenantRequestBuilder> {
    /**
     * Gets an item from the ApiSdk.Api.Tenant.item collection
     * @param tenantId The object ID of the tenant to operate against.
     * @returns {WithTenantItemRequestBuilder}
     */
    byTenantId(tenantId: Guid): WithTenantItemRequestBuilder;
    /**
     * Retrieves the list of tenant records. Can use filter by parent ID limit the results. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<RecordData[]>}
     */
    get(requestConfiguration?: RequestConfiguration<TenantRequestBuilderGetQueryParameters> | undefined): Promise<RecordData[] | undefined>;
    /**
     * Retrieves the list of tenant records. Can use filter by parent ID limit the results. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<TenantRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
 * Retrieves the list of tenant records. Can use filter by parent ID limit the results. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).
 */
export interface TenantRequestBuilderGetQueryParameters {
    /**
     * The object ID of the parent value to operate against.
     */
    parentId?: Guid;
}
/**
 * Uri template for the request builder.
 */
export declare const TenantRequestBuilderUriTemplate = "{+baseurl}/Api/Tenant{?parentId*}";
/**
 * 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;