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

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

import { type Tenant } from '../../../../../models/update/shield/index.js';
import { type AdditionalDataHolder, type BaseRequestBuilder, 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/Update/Shield/Tenant/{tenantId}
 */
export interface WithTenantItemRequestBuilder extends BaseRequestBuilder<WithTenantItemRequestBuilder> {
    /**
     * Deletes configuration for the specific tenant.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.
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Retrieves configuration for the specific tenant from 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>;
    /**
     * Updates (or adds when missing) tenant configuration.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 body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Tenant>}
     */
    patch(body: WithTenantPatchRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Tenant | undefined>;
    /**
     * Deletes configuration for the specific tenant.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}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Retrieves configuration for the specific tenant from 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;
    /**
     * Updates (or adds when missing) tenant configuration.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 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;
}
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>;
    /**
     * Flag that indicates if the current tenant is allowed to request alpha builds (`true`) or not (`false`).
     */
    alphaEnabled?: boolean | null;
    /**
     * Name of the deploy channel.
     */
    channel?: string | null;
    /**
     * Ring number that the client is a member of for the current chanel.
     */
    ring?: number | null;
}
/**
 * Uri template for the request builder.
 */
export declare const WithTenantItemRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Shield/Tenant/{tenantId}";
/**
 * Metadata for all the requests in the request builder.
 */
export declare const WithTenantItemRequestBuilderRequestsMetadata: RequestsMetadata;