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

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

import { type RecordData } from '../../../models/tenantDetails/index.js';
import { type AdditionalDataHolder, type BaseRequestBuilder, type Guid, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {WithTenantPatchRequestBody}
 */
export declare function createWithTenantPatchRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * The deserialization information for the current model
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoWithTenantPatchRequestBody(withTenantPatchRequestBody?: Partial<WithTenantPatchRequestBody> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * Serializes information the current object
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeWithTenantPatchRequestBody(writer: SerializationWriter, withTenantPatchRequestBody?: Partial<WithTenantPatchRequestBody> | undefined | null): void;
/**
 * Builds and executes requests for operations under /Api/Tenant/{tenantId}
 */
export interface WithTenantItemRequestBuilder extends BaseRequestBuilder<WithTenantItemRequestBuilder> {
    /**
     * Retrieves details of a specific tenant record. 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<WithTenantItemRequestBuilderGetQueryParameters> | undefined): Promise<RecordData | undefined>;
    /**
     * Update tenant record using provided information. Payload could contain any combination of existing properties. To remove a parent, set the parentId to be the same as the tenant ID value. This endpoint requires the `Tenant.ReadWrite.All` scopes (permissions).
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<RecordData>}
     */
    patch(body: WithTenantPatchRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<RecordData | undefined>;
    /**
     * Retrieves details of a specific tenant record. 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<WithTenantItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update tenant record using provided information. Payload could contain any combination of existing properties. To remove a parent, set the parentId to be the same as the tenant ID value. This endpoint requires the `Tenant.ReadWrite.All` scopes (permissions).
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: WithTenantPatchRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieves details of a specific tenant record. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).
 */
export interface WithTenantItemRequestBuilderGetQueryParameters {
    /**
     * The object ID of the parent value to operate against.
     */
    parentId?: Guid;
}
export interface WithTenantPatchRequestBody extends AdditionalDataHolder, Parsable {
    /**
     * Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
     */
    additionalData?: Record<string, unknown>;
    /**
     * List of object IDs that are allowed to access this record and related data.
     */
    authorizedPrincipalList?: Guid[] | null;
    /**
     * Human readable name for the tenant record
     */
    displayName?: string | null;
    /**
     * The object ID of the tenant that is considered a parent to this record
     */
    parentId?: Guid | null;
}
/**
 * Uri template for the request builder.
 */
export declare const WithTenantItemRequestBuilderUriTemplate = "{+baseurl}/Api/Tenant/{tenantId}{?parentId*}";
/**
 * Metadata for all the requests in the request builder.
 */
export declare const WithTenantItemRequestBuilderRequestsMetadata: RequestsMetadata;