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

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

import { type Channel } from '../../../../../models/update/shield/index.js';
import { type RingRequestBuilder } from './ring/index.js';
import { type VersionRequestBuilder } from './version/index.js';
import { type AdditionalDataHolder, type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, 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 {WithChannelNamePatchRequestBody}
 */
export declare function createWithChannelNamePatchRequestBodyFromDiscriminatorValue(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 deserializeIntoWithChannelNamePatchRequestBody(withChannelNamePatchRequestBody?: Partial<WithChannelNamePatchRequestBody> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * Serializes information the current object
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeWithChannelNamePatchRequestBody(writer: SerializationWriter, withChannelNamePatchRequestBody?: Partial<WithChannelNamePatchRequestBody> | undefined | null): void;
/**
 * Builds and executes requests for operations under /Api/Update/Shield/Channel/{channelName}
 */
export interface WithChannelNameItemRequestBuilder extends BaseRequestBuilder<WithChannelNameItemRequestBuilder> {
    /**
     * The Ring property
     */
    get ring(): RingRequestBuilder;
    /**
     * The Version property
     */
    get version(): VersionRequestBuilder;
    /**
     * Deletes the specified channel configuration and associated rings.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 channel 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<Channel>}
     */
    get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Channel | undefined>;
    /**
     * Updates (or adds when missing) the specified channel 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<Channel>}
     */
    patch(body: WithChannelNamePatchRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Channel | undefined>;
    /**
     * Deletes the specified channel configuration and associated rings.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 channel 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) the specified channel 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: WithChannelNamePatchRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
export interface WithChannelNamePatchRequestBody 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 ring should be operating off of the latest version number provided by the channel (`true`) or the previous (`false`).
     */
    latest?: boolean | null;
    /**
     * Ring number that this configuration belongs to.
     */
    number?: number | null;
}
/**
 * Uri template for the request builder.
 */
export declare const WithChannelNameItemRequestBuilderUriTemplate = "{+baseurl}/Api/Update/Shield/Channel/{channelName}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const WithChannelNameItemRequestBuilderNavigationMetadata: Record<Exclude<keyof WithChannelNameItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const WithChannelNameItemRequestBuilderRequestsMetadata: RequestsMetadata;