@azure/arm-selfhelp 1.0.1-alpha.20231016.1 → 2.0.0-beta.1

package/package.json

@@ -3,17 +3,17 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for HelpRP.",
-  "version": "1.0.1-alpha.20231016.1",
+  "version": "2.0.0-beta.1",
   "engines": {
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@azure/core-lro": "^2.5.3",
+    "@azure/core-lro": "^2.5.4",
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-paging": "^1.2.0",
     "@azure/core-client": "^1.7.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-rest-pipeline": "^1.8.0",
+    "@azure/core-rest-pipeline": "^1.12.0",
     "tslib": "^2.2.0"
   },
   "keywords": [
@@ -30,9 +30,9 @@
   "devDependencies": {
     "@microsoft/api-extractor": "^7.31.1",
     "mkdirp": "^2.1.2",
-    "typescript": "~5.0.0",
+    "typescript": "~5.2.0",
     "uglify-js": "^3.4.9",
-    "rimraf": "^3.0.0",
+    "rimraf": "^5.0.0",
     "dotenv": "^16.0.0",
     "@azure/identity": "^3.3.0",
     "@azure-tools/test-recorder": "^3.0.0",
@@ -42,7 +42,7 @@
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
     "@types/node": "^16.0.0",
-    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/dev-tool": "^1.0.0",
     "ts-node": "^10.0.0"
   },
   "repository": {
@@ -77,7 +77,7 @@
     "extract-api": "api-extractor run --local",
     "lint": "echo skipped",
     "audit": "echo skipped",
-    "clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+    "clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
     "build:node": "echo skipped",
     "build:browser": "echo skipped",
     "build:test": "echo skipped",

package/review/arm-selfhelp.api.md

@@ -13,6 +13,31 @@ import { SimplePollerLike } from '@azure/core-lro';
 // @public
 export type ActionType = string;
 
+// @public
+export type AggregationType = string;
+
+// @public
+export interface AutomatedCheckResult {
+    result?: string;
+    type?: AutomatedCheckResultType;
+}
+
+// @public
+export type AutomatedCheckResultType = string;
+
+// @public
+export interface CheckNameAvailability {
+    post(scope: string, options?: CheckNameAvailabilityPostOptionalParams): Promise<CheckNameAvailabilityPostResponse>;
+}
+
+// @public
+export interface CheckNameAvailabilityPostOptionalParams extends coreClient.OperationOptions {
+    checkNameAvailabilityRequest?: CheckNameAvailabilityRequest;
+}
+
+// @public
+export type CheckNameAvailabilityPostResponse = CheckNameAvailabilityResponse;
+
 // @public
 export interface CheckNameAvailabilityRequest {
     name?: string;
@@ -26,6 +51,16 @@ export interface CheckNameAvailabilityResponse {
     reason?: string;
 }
 
+// @public
+export type Confidence = string;
+
+// @public
+export interface ContinueRequestBody {
+    // (undocumented)
+    responses?: TroubleshooterResponse[];
+    stepId?: string;
+}
+
 // @public
 export type CreatedByType = string;
 
@@ -45,6 +80,9 @@ export interface DiagnosticInvocation {
     solutionId?: string;
 }
 
+// @public
+export type DiagnosticProvisioningState = string;
+
 // @public
 export interface DiagnosticResource extends ProxyResource {
     readonly acceptedAt?: string;
@@ -53,25 +91,16 @@ export interface DiagnosticResource extends ProxyResource {
         [propertyName: string]: string;
     };
     insights?: DiagnosticInvocation[];
-    readonly provisioningState?: ProvisioningState;
+    readonly provisioningState?: DiagnosticProvisioningState;
 }
 
 // @public
 export interface Diagnostics {
     beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
     beginCreateAndWait(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<DiagnosticsCreateResponse>;
-    checkNameAvailability(scope: string, options?: DiagnosticsCheckNameAvailabilityOptionalParams): Promise<DiagnosticsCheckNameAvailabilityResponse>;
     get(scope: string, diagnosticsResourceName: string, options?: DiagnosticsGetOptionalParams): Promise<DiagnosticsGetResponse>;
 }
 
-// @public
-export interface DiagnosticsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
-    checkNameAvailabilityRequest?: CheckNameAvailabilityRequest;
-}
-
-// @public
-export type DiagnosticsCheckNameAvailabilityResponse = CheckNameAvailabilityResponse;
-
 // @public
 export interface DiagnosticsCreateOptionalParams extends coreClient.OperationOptions {
     diagnosticResourceRequest?: DiagnosticResource;
@@ -144,6 +173,21 @@ export interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+// @public
+export type ExecutionStatus = string;
+
+// @public
+export interface Filter {
+    name?: string;
+    operator?: string;
+    values?: string;
+}
+
+// @public
+export interface FilterGroup {
+    filter?: Filter[];
+}
+
 // @public
 export function getContinuationToken(page: unknown): string | undefined;
 
@@ -155,11 +199,17 @@ export class HelpRP extends coreClient.ServiceClient {
     // (undocumented)
     apiVersion: string;
     // (undocumented)
+    checkNameAvailability: CheckNameAvailability;
+    // (undocumented)
     diagnostics: Diagnostics;
     // (undocumented)
     discoverySolution: DiscoverySolution;
     // (undocumented)
     operations: Operations;
+    // (undocumented)
+    solution: Solution;
+    // (undocumented)
+    troubleshooters: Troubleshooters;
 }
 
 // @public
@@ -185,6 +235,30 @@ export enum KnownActionType {
     Internal = "Internal"
 }
 
+// @public
+export enum KnownAggregationType {
+    Avg = "Avg",
+    Count = "Count",
+    Max = "Max",
+    Min = "Min",
+    Sum = "Sum"
+}
+
+// @public
+export enum KnownAutomatedCheckResultType {
+    Error = "Error",
+    Information = "Information",
+    Success = "Success",
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownConfidence {
+    High = "High",
+    Low = "Low",
+    Medium = "Medium"
+}
+
 // @public
 export enum KnownCreatedByType {
     Application = "Application",
@@ -193,6 +267,22 @@ export enum KnownCreatedByType {
     User = "User"
 }
 
+// @public
+export enum KnownDiagnosticProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    PartialComplete = "PartialComplete",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownExecutionStatus {
+    Failed = "Failed",
+    Running = "Running",
+    Success = "Success",
+    Warning = "Warning"
+}
+
 // @public
 export enum KnownImportanceLevel {
     Critical = "Critical",
@@ -200,6 +290,13 @@ export enum KnownImportanceLevel {
     Warning = "Warning"
 }
 
+// @public
+export enum KnownName {
+    ProblemClassificationId = "ProblemClassificationId",
+    ReplacementKey = "ReplacementKey",
+    SolutionId = "SolutionId"
+}
+
 // @public
 export enum KnownOrigin {
     System = "system",
@@ -208,13 +305,39 @@ export enum KnownOrigin {
 }
 
 // @public
-export enum KnownProvisioningState {
+export enum KnownQuestionContentType {
+    Html = "Html",
+    Markdown = "Markdown",
+    Text = "Text"
+}
+
+// @public
+export enum KnownQuestionType {
+    Dropdown = "Dropdown",
+    MultiLineInfoBox = "MultiLineInfoBox",
+    RadioButton = "RadioButton",
+    TextInput = "TextInput"
+}
+
+// @public
+export enum KnownResultType {
+    Community = "Community",
+    Documentation = "Documentation"
+}
+
+// @public
+export enum KnownSolutionProvisioningState {
     Canceled = "Canceled",
     Failed = "Failed",
-    PartialComplete = "PartialComplete",
     Succeeded = "Succeeded"
 }
 
+// @public
+export enum KnownSolutionType {
+    Diagnostics = "Diagnostics",
+    Solutions = "Solutions"
+}
+
 // @public
 export enum KnownStatus {
     Failed = "Failed",
@@ -224,6 +347,36 @@ export enum KnownStatus {
     Timeout = "Timeout"
 }
 
+// @public
+export enum KnownTroubleshooterProvisioningState {
+    AutoContinue = "AutoContinue",
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Running = "Running",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownType {
+    AutomatedCheck = "AutomatedCheck",
+    Decision = "Decision",
+    Insight = "Insight",
+    Solution = "Solution"
+}
+
+// @public
+export interface MetricsBasedChart {
+    aggregationType?: AggregationType;
+    filterGroup?: FilterGroup;
+    name?: string;
+    replacementKey?: string;
+    timeSpanDuration?: string;
+    title?: string;
+}
+
+// @public
+export type Name = string;
+
 // @public
 export interface Operation {
     readonly actionType?: ActionType;
@@ -270,10 +423,23 @@ export type OperationsListResponse = OperationListResult;
 export type Origin = string;
 
 // @public
-export type ProvisioningState = string;
+export interface ProxyResource extends Resource {
+}
 
 // @public
-export interface ProxyResource extends Resource {
+export type QuestionContentType = string;
+
+// @public
+export type QuestionType = string;
+
+// @public
+export interface ReplacementMaps {
+    diagnostics?: SolutionsDiagnostic[];
+    metricsBasedCharts?: MetricsBasedChart[];
+    troubleshooters?: SolutionsTroubleshooters[];
+    videoGroups?: VideoGroup[];
+    videos?: Video[];
+    webResults?: WebResult[];
 }
 
 // @public
@@ -284,17 +450,187 @@ export interface Resource {
     readonly type?: string;
 }
 
+// @public
+export interface ResponseOption {
+    key?: string;
+    value?: string;
+}
+
+// @public
+export interface ResponseValidationProperties {
+    isRequired?: boolean;
+    maxLength?: number;
+    regex?: string;
+    validationErrorMessage?: string;
+}
+
+// @public
+export interface RestartTroubleshooterResponse {
+    readonly troubleshooterResourceName?: string;
+}
+
+// @public
+export type ResultType = string;
+
+// @public
+export interface SearchResult {
+    confidence?: Confidence;
+    content?: string;
+    link?: string;
+    rank?: number;
+    resultType?: ResultType;
+    solutionId?: string;
+    source?: string;
+    title?: string;
+}
+
+// @public
+export interface Section {
+    content?: string;
+    replacementMaps?: ReplacementMaps;
+    title?: string;
+}
+
+// @public
+export interface Solution {
+    beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
+    beginCreateAndWait(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SolutionCreateResponse>;
+    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>;
+}
+
+// @public
+export interface SolutionCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    solutionRequestBody?: SolutionResource;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SolutionCreateResponse = SolutionResource;
+
+// @public
+export interface SolutionGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SolutionGetResponse = SolutionResource;
+
+// @public
+export interface SolutionMetadataProperties {
+    readonly description?: string;
+    readonly requiredInputs?: string[];
+    solutionId?: string;
+    readonly solutionType?: SolutionType;
+}
+
 // @public
 export interface SolutionMetadataResource extends ProxyResource {
-    description?: string;
-    requiredParameterSets?: string[][];
+    solutions?: SolutionMetadataProperties[];
+}
+
+// @public
+export interface SolutionPatchRequestBody {
+    properties?: SolutionResourceProperties;
+}
+
+// @public
+export type SolutionProvisioningState = string;
+
+// @public
+export interface SolutionResource {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: SolutionResourceProperties;
+    readonly type?: string;
+}
+
+// @public
+export interface SolutionResourceProperties {
+    content?: string;
+    parameters?: {
+        [propertyName: string]: string;
+    };
+    provisioningState?: SolutionProvisioningState;
+    replacementMaps?: ReplacementMaps;
+    sections?: Section[];
+    solutionId?: string;
+    title?: string;
+    triggerCriteria?: TriggerCriterion[];
+}
+
+// @public
+export interface SolutionsDiagnostic {
+    insights?: Insight[];
+    replacementKey?: string;
+    requiredParameters?: string[];
+    solutionId?: string;
+    status?: Status;
+    statusDetails?: string;
+}
+
+// @public
+export interface SolutionsTroubleshooters {
     solutionId?: string;
-    solutionType?: string;
+    summary?: string;
+    title?: string;
 }
 
+// @public
+export type SolutionType = string;
+
+// @public
+export interface SolutionUpdateHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface SolutionUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    solutionPatchRequestBody?: SolutionPatchRequestBody;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SolutionUpdateResponse = SolutionUpdateHeaders & SolutionResource;
+
 // @public
 export type Status = string;
 
+// @public
+export interface Step {
+    automatedCheckResults?: AutomatedCheckResult;
+    description?: string;
+    error?: ErrorDetail;
+    executionStatus?: ExecutionStatus;
+    executionStatusDescription?: string;
+    guidance?: string;
+    id?: string;
+    // (undocumented)
+    inputs?: StepInput[];
+    // (undocumented)
+    insights?: Insight[];
+    isLastStep?: boolean;
+    title?: string;
+    type?: Type;
+}
+
+// @public
+export interface StepInput {
+    questionContent?: string;
+    questionContentType?: QuestionContentType;
+    questionId?: string;
+    questionType?: string;
+    recommendedOption?: string;
+    responseHint?: string;
+    // (undocumented)
+    responseOptions?: ResponseOption[];
+    responseValidationProperties?: ResponseValidationProperties;
+    selectedOptionValue?: string;
+}
+
 // @public
 export interface SystemData {
     createdAt?: Date;
@@ -305,6 +641,122 @@ export interface SystemData {
     lastModifiedByType?: CreatedByType;
 }
 
+// @public
+export interface TriggerCriterion {
+    name?: Name;
+    value?: string;
+}
+
+// @public
+export type TroubleshooterProvisioningState = string;
+
+// @public
+export interface TroubleshooterResource extends ProxyResource {
+    parameters?: {
+        [propertyName: string]: string;
+    };
+    readonly provisioningState?: TroubleshooterProvisioningState;
+    solutionId?: string;
+    readonly steps?: Step[];
+}
+
+// @public
+export interface TroubleshooterResponse {
+    questionId?: string;
+    questionType?: QuestionType;
+    response?: string;
+}
+
+// @public
+export interface Troubleshooters {
+    continue(scope: string, troubleshooterName: string, options?: TroubleshootersContinueOptionalParams): Promise<TroubleshootersContinueResponse>;
+    create(scope: string, troubleshooterName: string, options?: TroubleshootersCreateOptionalParams): Promise<TroubleshootersCreateResponse>;
+    end(scope: string, troubleshooterName: string, options?: TroubleshootersEndOptionalParams): Promise<TroubleshootersEndResponse>;
+    get(scope: string, troubleshooterName: string, options?: TroubleshootersGetOptionalParams): Promise<TroubleshootersGetResponse>;
+    restart(scope: string, troubleshooterName: string, options?: TroubleshootersRestartOptionalParams): Promise<TroubleshootersRestartResponse>;
+}
+
+// @public
+export interface TroubleshootersContinueHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface TroubleshootersContinueOptionalParams extends coreClient.OperationOptions {
+    continueRequestBody?: ContinueRequestBody;
+}
+
+// @public
+export type TroubleshootersContinueResponse = TroubleshootersContinueHeaders;
+
+// @public
+export interface TroubleshootersCreateOptionalParams extends coreClient.OperationOptions {
+    createTroubleshooterRequestBody?: TroubleshooterResource;
+}
+
+// @public
+export type TroubleshootersCreateResponse = TroubleshooterResource;
+
+// @public
+export interface TroubleshootersEndHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface TroubleshootersEndOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TroubleshootersEndResponse = TroubleshootersEndHeaders;
+
+// @public
+export interface TroubleshootersGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TroubleshootersGetResponse = TroubleshooterResource;
+
+// @public
+export interface TroubleshootersRestartHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface TroubleshootersRestartOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TroubleshootersRestartResponse = TroubleshootersRestartHeaders & RestartTroubleshooterResponse;
+
+// @public
+export type Type = string;
+
+// @public
+export interface Video extends VideoGroupVideo {
+    replacementKey?: string;
+}
+
+// @public
+export interface VideoGroup {
+    replacementKey?: string;
+    videos?: VideoGroupVideo[];
+}
+
+// @public
+export interface VideoGroupVideo {
+    src?: string;
+    title?: string;
+}
+
+// @public
+export interface WebResult {
+    replacementKey?: string;
+    searchResults?: SearchResult[];
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/src/helpRP.ts

@@ -16,13 +16,19 @@ import {
 import * as coreAuth from "@azure/core-auth";
 import {
   OperationsImpl,
+  CheckNameAvailabilityImpl,
   DiagnosticsImpl,
-  DiscoverySolutionImpl
+  DiscoverySolutionImpl,
+  SolutionImpl,
+  TroubleshootersImpl
 } from "./operations";
 import {
   Operations,
+  CheckNameAvailability,
   Diagnostics,
-  DiscoverySolution
+  DiscoverySolution,
+  Solution,
+  Troubleshooters
 } from "./operationsInterfaces";
 import { HelpRPOptionalParams } from "./models";
 
@@ -52,7 +58,7 @@ export class HelpRP extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-selfhelp/1.0.1`;
+    const packageDetails = `azsdk-js-arm-selfhelp/2.0.0-beta.1`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -103,10 +109,13 @@ export class HelpRP extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2023-06-01";
+    this.apiVersion = options.apiVersion || "2023-09-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.troubleshooters = new TroubleshootersImpl(this);
     this.addCustomApiVersionPolicy(options.apiVersion);
   }
 
@@ -139,6 +148,9 @@ export class HelpRP extends coreClient.ServiceClient {
   }
 
   operations: Operations;
+  checkNameAvailability: CheckNameAvailability;
   diagnostics: Diagnostics;
   discoverySolution: DiscoverySolution;
+  solution: Solution;
+  troubleshooters: Troubleshooters;
 }