@azure/arm-selfhelp 2.0.0-beta.1 → 2.0.0-beta.3

package/review/arm-selfhelp.api.md

@@ -19,7 +19,9 @@ export type AggregationType = string;
 // @public
 export interface AutomatedCheckResult {
     result?: string;
+    status?: string;
     type?: AutomatedCheckResultType;
+    version?: string;
 }
 
 // @public
@@ -51,6 +53,13 @@ export interface CheckNameAvailabilityResponse {
     reason?: string;
 }
 
+// @public
+export interface ClassificationService {
+    readonly displayName?: string;
+    resourceTypes?: string[];
+    readonly serviceId?: string;
+}
+
 // @public
 export type Confidence = string;
 
@@ -118,6 +127,19 @@ export interface DiagnosticsGetOptionalParams extends coreClient.OperationOption
 // @public
 export type DiagnosticsGetResponse = DiagnosticResource;
 
+// @public
+export interface DiscoveryNlpRequest {
+    additionalContext?: string;
+    issueSummary: string;
+    resourceId?: string;
+    serviceId?: string;
+}
+
+// @public
+export interface DiscoveryNlpResponse {
+    value?: SolutionNlpMetadataResource[];
+}
+
 // @public
 export interface DiscoveryResponse {
     nextLink?: string;
@@ -126,7 +148,7 @@ export interface DiscoveryResponse {
 
 // @public
 export interface DiscoverySolution {
-    list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
+    list(options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
 }
 
 // @public
@@ -145,6 +167,32 @@ export interface DiscoverySolutionListOptionalParams extends coreClient.Operatio
 // @public
 export type DiscoverySolutionListResponse = DiscoveryResponse;
 
+// @public
+export interface DiscoverySolutionNLPSubscriptionScope {
+    post(options?: DiscoverySolutionNLPSubscriptionScopePostOptionalParams): Promise<DiscoverySolutionNLPSubscriptionScopePostResponse>;
+}
+
+// @public
+export interface DiscoverySolutionNLPSubscriptionScopePostOptionalParams extends coreClient.OperationOptions {
+    discoverSolutionRequest?: DiscoveryNlpRequest;
+}
+
+// @public
+export type DiscoverySolutionNLPSubscriptionScopePostResponse = DiscoveryNlpResponse;
+
+// @public
+export interface DiscoverySolutionNLPTenantScope {
+    post(options?: DiscoverySolutionNLPTenantScopePostOptionalParams): Promise<DiscoverySolutionNLPTenantScopePostResponse>;
+}
+
+// @public
+export interface DiscoverySolutionNLPTenantScopePostOptionalParams extends coreClient.OperationOptions {
+    discoverSolutionRequest?: DiscoveryNlpRequest;
+}
+
+// @public
+export type DiscoverySolutionNLPTenantScopePostResponse = DiscoveryNlpResponse;
+
 // @public
 export interface ErrorAdditionalInfo {
     readonly info?: Record<string, unknown>;
@@ -195,6 +243,7 @@ export function getContinuationToken(page: unknown): string | undefined;
 export class HelpRP extends coreClient.ServiceClient {
     // (undocumented)
     $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: HelpRPOptionalParams);
     constructor(credentials: coreAuth.TokenCredential, options?: HelpRPOptionalParams);
     // (undocumented)
     apiVersion: string;
@@ -205,10 +254,20 @@ export class HelpRP extends coreClient.ServiceClient {
     // (undocumented)
     discoverySolution: DiscoverySolution;
     // (undocumented)
+    discoverySolutionNLPSubscriptionScope: DiscoverySolutionNLPSubscriptionScope;
+    // (undocumented)
+    discoverySolutionNLPTenantScope: DiscoverySolutionNLPTenantScope;
+    // (undocumented)
     operations: Operations;
     // (undocumented)
+    simplifiedSolutions: SimplifiedSolutions;
+    // (undocumented)
     solution: Solution;
     // (undocumented)
+    solutionSelfHelp: SolutionSelfHelp;
+    // (undocumented)
+    subscriptionId?: string;
+    // (undocumented)
     troubleshooters: Troubleshooters;
 }
 
@@ -272,6 +331,7 @@ export enum KnownDiagnosticProvisioningState {
     Canceled = "Canceled",
     Failed = "Failed",
     PartialComplete = "PartialComplete",
+    Running = "Running",
     Succeeded = "Succeeded"
 }
 
@@ -313,8 +373,10 @@ export enum KnownQuestionContentType {
 
 // @public
 export enum KnownQuestionType {
+    DateTimePicker = "DateTimePicker",
     Dropdown = "Dropdown",
     MultiLineInfoBox = "MultiLineInfoBox",
+    MultiSelect = "MultiSelect",
     RadioButton = "RadioButton",
     TextInput = "TextInput"
 }
@@ -329,13 +391,17 @@ export enum KnownResultType {
 export enum KnownSolutionProvisioningState {
     Canceled = "Canceled",
     Failed = "Failed",
+    PartialComplete = "PartialComplete",
+    Running = "Running",
     Succeeded = "Succeeded"
 }
 
 // @public
 export enum KnownSolutionType {
     Diagnostics = "Diagnostics",
-    Solutions = "Solutions"
+    SelfHelp = "SelfHelp",
+    Solutions = "Solutions",
+    Troubleshooters = "Troubleshooters"
 }
 
 // @public
@@ -360,10 +426,20 @@ export enum KnownTroubleshooterProvisioningState {
 export enum KnownType {
     AutomatedCheck = "AutomatedCheck",
     Decision = "Decision",
+    Input = "Input",
     Insight = "Insight",
     Solution = "Solution"
 }
 
+// @public
+export enum KnownValidationScope {
+    GuidFormat = "GuidFormat",
+    IpAddressFormat = "IpAddressFormat",
+    None = "None",
+    NumberOnlyFormat = "NumberOnlyFormat",
+    URLFormat = "URLFormat"
+}
+
 // @public
 export interface MetricsBasedChart {
     aggregationType?: AggregationType;
@@ -442,6 +518,13 @@ export interface ReplacementMaps {
     webResults?: WebResult[];
 }
 
+// @public
+export interface ReplacementMapsSelfHelp {
+    videoGroups?: VideoGroup[];
+    videos?: Video[];
+    webResults?: WebResult[];
+}
+
 // @public
 export interface Resource {
     readonly id?: string;
@@ -462,6 +545,7 @@ export interface ResponseValidationProperties {
     maxLength?: number;
     regex?: string;
     validationErrorMessage?: string;
+    validationScope?: ValidationScope;
 }
 
 // @public
@@ -491,6 +575,51 @@ export interface Section {
     title?: string;
 }
 
+// @public
+export interface SectionSelfHelp {
+    content?: string;
+    replacementMaps?: ReplacementMapsSelfHelp;
+    title?: string;
+}
+
+// @public
+export interface SimplifiedSolutions {
+    beginCreate(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<SimplifiedSolutionsCreateResponse>, SimplifiedSolutionsCreateResponse>>;
+    beginCreateAndWait(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsCreateOptionalParams): Promise<SimplifiedSolutionsCreateResponse>;
+    get(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsGetOptionalParams): Promise<SimplifiedSolutionsGetResponse>;
+}
+
+// @public
+export interface SimplifiedSolutionsCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    simplifiedSolutionsRequestBody?: SimplifiedSolutionsResource;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SimplifiedSolutionsCreateResponse = SimplifiedSolutionsResource;
+
+// @public
+export interface SimplifiedSolutionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SimplifiedSolutionsGetResponse = SimplifiedSolutionsResource;
+
+// @public
+export interface SimplifiedSolutionsResource extends ProxyResource {
+    readonly appendix?: {
+        [propertyName: string]: string;
+    };
+    readonly content?: string;
+    parameters?: {
+        [propertyName: string]: string;
+    };
+    readonly provisioningState?: SolutionProvisioningState;
+    solutionId?: string;
+    readonly title?: string;
+}
+
 // @public
 export interface Solution {
     beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
@@ -498,6 +627,7 @@ export interface Solution {
     beginUpdate(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionUpdateResponse>, SolutionUpdateResponse>>;
     beginUpdateAndWait(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SolutionUpdateResponse>;
     get(scope: string, solutionResourceName: string, options?: SolutionGetOptionalParams): Promise<SolutionGetResponse>;
+    warmUp(scope: string, solutionResourceName: string, options?: SolutionWarmUpOptionalParams): Promise<void>;
 }
 
 // @public
@@ -531,37 +661,58 @@ export interface SolutionMetadataResource extends ProxyResource {
 }
 
 // @public
-export interface SolutionPatchRequestBody {
-    properties?: SolutionResourceProperties;
+export interface SolutionNlpMetadataResource extends ProxyResource {
+    problemClassificationId?: string;
+    problemDescription?: string;
+    problemTitle?: string;
+    relatedServices?: ClassificationService[];
+    serviceId?: string;
+    solutions?: SolutionMetadataProperties[];
 }
 
 // @public
-export type SolutionProvisioningState = string;
+export interface SolutionPatchRequestBody {
+    readonly content?: string;
+    parameters?: {
+        [propertyName: string]: string;
+    };
+    readonly provisioningState?: SolutionProvisioningState;
+    readonly replacementMaps?: ReplacementMaps;
+    readonly sections?: Section[];
+    readonly solutionId?: string;
+    readonly title?: string;
+    triggerCriteria?: TriggerCriterion[];
+}
 
 // @public
-export interface SolutionResource {
-    readonly id?: string;
-    readonly name?: string;
-    properties?: SolutionResourceProperties;
-    readonly type?: string;
-}
+export type SolutionProvisioningState = string;
 
 // @public
-export interface SolutionResourceProperties {
-    content?: string;
+export interface SolutionResource extends ProxyResource {
+    readonly content?: string;
     parameters?: {
         [propertyName: string]: string;
     };
-    provisioningState?: SolutionProvisioningState;
-    replacementMaps?: ReplacementMaps;
-    sections?: Section[];
-    solutionId?: string;
-    title?: string;
+    readonly provisioningState?: SolutionProvisioningState;
+    readonly replacementMaps?: ReplacementMaps;
+    readonly sections?: Section[];
+    readonly solutionId?: string;
+    readonly title?: string;
     triggerCriteria?: TriggerCriterion[];
 }
 
+// @public
+export interface SolutionResourceSelfHelp extends ProxyResource {
+    readonly content?: string;
+    readonly replacementMaps?: ReplacementMapsSelfHelp;
+    readonly sections?: SectionSelfHelp[];
+    readonly solutionId?: string;
+    readonly title?: string;
+}
+
 // @public
 export interface SolutionsDiagnostic {
+    estimatedCompletionTime?: string;
     insights?: Insight[];
     replacementKey?: string;
     requiredParameters?: string[];
@@ -570,6 +721,18 @@ export interface SolutionsDiagnostic {
     statusDetails?: string;
 }
 
+// @public
+export interface SolutionSelfHelp {
+    get(solutionId: string, options?: SolutionSelfHelpGetOptionalParams): Promise<SolutionSelfHelpGetResponse>;
+}
+
+// @public
+export interface SolutionSelfHelpGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SolutionSelfHelpGetResponse = SolutionResourceSelfHelp;
+
 // @public
 export interface SolutionsTroubleshooters {
     solutionId?: string;
@@ -596,6 +759,18 @@ export interface SolutionUpdateOptionalParams extends coreClient.OperationOption
 // @public
 export type SolutionUpdateResponse = SolutionUpdateHeaders & SolutionResource;
 
+// @public
+export interface SolutionWarmUpOptionalParams extends coreClient.OperationOptions {
+    solutionWarmUpRequestBody?: SolutionWarmUpRequestBody;
+}
+
+// @public
+export interface SolutionWarmUpRequestBody {
+    parameters?: {
+        [propertyName: string]: string;
+    };
+}
+
 // @public
 export type Status = string;
 
@@ -622,7 +797,8 @@ export interface StepInput {
     questionContent?: string;
     questionContentType?: QuestionContentType;
     questionId?: string;
-    questionType?: string;
+    questionTitle?: string;
+    questionType?: QuestionType;
     recommendedOption?: string;
     responseHint?: string;
     // (undocumented)
@@ -734,6 +910,9 @@ export type TroubleshootersRestartResponse = TroubleshootersRestartHeaders & Res
 // @public
 export type Type = string;
 
+// @public
+export type ValidationScope = string;
+
 // @public
 export interface Video extends VideoGroupVideo {
     replacementKey?: string;

package/src/helpRP.ts

@@ -11,7 +11,7 @@ import * as coreRestPipeline from "@azure/core-rest-pipeline";
 import {
   PipelineRequest,
   PipelineResponse,
-  SendRequest
+  SendRequest,
 } from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
@@ -20,7 +20,11 @@ import {
   DiagnosticsImpl,
   DiscoverySolutionImpl,
   SolutionImpl,
-  TroubleshootersImpl
+  SimplifiedSolutionsImpl,
+  TroubleshootersImpl,
+  SolutionSelfHelpImpl,
+  DiscoverySolutionNLPTenantScopeImpl,
+  DiscoverySolutionNLPSubscriptionScopeImpl,
 } from "./operations";
 import {
   Operations,
@@ -28,37 +32,61 @@ import {
   Diagnostics,
   DiscoverySolution,
   Solution,
-  Troubleshooters
+  SimplifiedSolutions,
+  Troubleshooters,
+  SolutionSelfHelp,
+  DiscoverySolutionNLPTenantScope,
+  DiscoverySolutionNLPSubscriptionScope,
 } from "./operationsInterfaces";
 import { HelpRPOptionalParams } from "./models";
 
 export class HelpRP extends coreClient.ServiceClient {
   $host: string;
   apiVersion: string;
+  subscriptionId?: string;
 
   /**
    * Initializes a new instance of the HelpRP class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId The ID of the target subscription. The value must be an UUID.
    * @param options The parameter options
    */
   constructor(
     credentials: coreAuth.TokenCredential,
-    options?: HelpRPOptionalParams
+    subscriptionId: string,
+    options?: HelpRPOptionalParams,
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: HelpRPOptionalParams,
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionIdOrOptions?: HelpRPOptionalParams | string,
+    options?: HelpRPOptionalParams,
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
     }
 
+    let subscriptionId: string | undefined;
+
+    if (typeof subscriptionIdOrOptions === "string") {
+      subscriptionId = subscriptionIdOrOptions;
+    } else if (typeof subscriptionIdOrOptions === "object") {
+      options = subscriptionIdOrOptions;
+    }
+
     // Initializing default values for options
     if (!options) {
       options = {};
     }
     const defaults: HelpRPOptionalParams = {
       requestContentType: "application/json; charset=utf-8",
-      credential: credentials
+      credential: credentials,
     };
 
-    const packageDetails = `azsdk-js-arm-selfhelp/2.0.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-selfhelp/2.0.0-beta.3`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -68,20 +96,21 @@ export class HelpRP extends coreClient.ServiceClient {
       ...defaults,
       ...options,
       userAgentOptions: {
-        userAgentPrefix
+        userAgentPrefix,
       },
       endpoint:
-        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com",
     };
     super(optionsWithDefaults);
 
     let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
-      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] =
+        options.pipeline.getOrderedPolicies();
       bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
-          coreRestPipeline.bearerTokenAuthenticationPolicyName
+          coreRestPipeline.bearerTokenAuthenticationPolicyName,
       );
     }
     if (
@@ -91,7 +120,7 @@ export class HelpRP extends coreClient.ServiceClient {
       !bearerTokenAuthenticationPolicyFound
     ) {
       this.pipeline.removePolicy({
-        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName,
       });
       this.pipeline.addPolicy(
         coreRestPipeline.bearerTokenAuthenticationPolicy({
@@ -101,21 +130,29 @@ export class HelpRP extends coreClient.ServiceClient {
             `${optionsWithDefaults.endpoint}/.default`,
           challengeCallbacks: {
             authorizeRequestOnChallenge:
-              coreClient.authorizeRequestOnClaimChallenge
-          }
-        })
+              coreClient.authorizeRequestOnClaimChallenge,
+          },
+        }),
       );
     }
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2023-09-01-preview";
+    this.apiVersion = options.apiVersion || "2024-03-01-preview";
     this.operations = new OperationsImpl(this);
     this.checkNameAvailability = new CheckNameAvailabilityImpl(this);
     this.diagnostics = new DiagnosticsImpl(this);
     this.discoverySolution = new DiscoverySolutionImpl(this);
     this.solution = new SolutionImpl(this);
+    this.simplifiedSolutions = new SimplifiedSolutionsImpl(this);
     this.troubleshooters = new TroubleshootersImpl(this);
+    this.solutionSelfHelp = new SolutionSelfHelpImpl(this);
+    this.discoverySolutionNLPTenantScope =
+      new DiscoverySolutionNLPTenantScopeImpl(this);
+    this.discoverySolutionNLPSubscriptionScope =
+      new DiscoverySolutionNLPSubscriptionScopeImpl(this);
     this.addCustomApiVersionPolicy(options.apiVersion);
   }
 
@@ -128,7 +165,7 @@ export class HelpRP extends coreClient.ServiceClient {
       name: "CustomApiVersionPolicy",
       async sendRequest(
         request: PipelineRequest,
-        next: SendRequest
+        next: SendRequest,
       ): Promise<PipelineResponse> {
         const param = request.url.split("?");
         if (param.length > 1) {
@@ -142,7 +179,7 @@ export class HelpRP extends coreClient.ServiceClient {
           request.url = param[0] + "?" + newParams.join("&");
         }
         return next(request);
-      }
+      },
     };
     this.pipeline.addPolicy(apiVersionPolicy);
   }
@@ -152,5 +189,9 @@ export class HelpRP extends coreClient.ServiceClient {
   diagnostics: Diagnostics;
   discoverySolution: DiscoverySolution;
   solution: Solution;
+  simplifiedSolutions: SimplifiedSolutions;
   troubleshooters: Troubleshooters;
+  solutionSelfHelp: SolutionSelfHelp;
+  discoverySolutionNLPTenantScope: DiscoverySolutionNLPTenantScope;
+  discoverySolutionNLPSubscriptionScope: DiscoverySolutionNLPSubscriptionScope;
 }

package/src/lroImpl.ts

@@ -28,15 +28,15 @@ export function createLroSpec<T>(inputs: {
     sendInitialRequest: () => sendOperationFn(args, spec),
     sendPollRequest: (
       path: string,
-      options?: { abortSignal?: AbortSignalLike }
+      options?: { abortSignal?: AbortSignalLike },
     ) => {
       const { requestBody, ...restSpec } = spec;
       return sendOperationFn(args, {
         ...restSpec,
         httpMethod: "GET",
         path,
-        abortSignal: options?.abortSignal
+        abortSignal: options?.abortSignal,
       });
-    }
+    },
   };
 }