@azure/arm-selfhelp 1.0.0-alpha.20230428.1

package/src/operations/operations.ts

@@ -0,0 +1,149 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
+import { Operations } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { HelpRP } from "../helpRP";
+import {
+  Operation,
+  OperationsListNextOptionalParams,
+  OperationsListOptionalParams,
+  OperationsListResponse,
+  OperationsListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing Operations operations. */
+export class OperationsImpl implements Operations {
+  private readonly client: HelpRP;
+
+  /**
+   * Initialize a new instance of the class Operations class.
+   * @param client Reference to the service client
+   */
+  constructor(client: HelpRP) {
+    this.client = client;
+  }
+
+  /**
+   * Returns list of operations.
+   * @param options The options parameters.
+   */
+  public list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation> {
+    const iter = this.listPagingAll(options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(options, settings);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    options?: OperationsListOptionalParams,
+    settings?: PageSettings
+  ): AsyncIterableIterator<Operation[]> {
+    let result: OperationsListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+    while (continuationToken) {
+      result = await this._listNext(continuationToken, options);
+      continuationToken = result.nextLink;
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+  }
+
+  private async *listPagingAll(
+    options?: OperationsListOptionalParams
+  ): AsyncIterableIterator<Operation> {
+    for await (const page of this.listPagingPage(options)) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Returns list of operations.
+   * @param options The options parameters.
+   */
+  private _list(
+    options?: OperationsListOptionalParams
+  ): Promise<OperationsListResponse> {
+    return this.client.sendOperationRequest({ options }, listOperationSpec);
+  }
+
+  /**
+   * ListNext
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    nextLink: string,
+    options?: OperationsListNextOptionalParams
+  ): Promise<OperationsListNextResponse> {
+    return this.client.sendOperationRequest(
+      { nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/providers/Microsoft.Help/operations",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.OperationListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.OperationListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  urlParameters: [Parameters.$host, Parameters.nextLink],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operationsInterfaces/diagnostics.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
+import {
+  DiagnosticsCheckNameAvailabilityOptionalParams,
+  DiagnosticsCheckNameAvailabilityResponse,
+  DiagnosticsCreateOptionalParams,
+  DiagnosticsCreateResponse,
+  DiagnosticsGetOptionalParams,
+  DiagnosticsGetResponse
+} from "../models";
+
+/** Interface representing a Diagnostics. */
+export interface Diagnostics {
+  /**
+   * This API is used to check the uniqueness of a resource name used for a diagnostic check.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param options The options parameters.
+   */
+  checkNameAvailability(
+    scope: string,
+    options?: DiagnosticsCheckNameAvailabilityOptionalParams
+  ): Promise<DiagnosticsCheckNameAvailabilityResponse>;
+  /**
+   * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+   * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+   * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+   * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+   * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  beginCreate(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsCreateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DiagnosticsCreateResponse>,
+      DiagnosticsCreateResponse
+    >
+  >;
+  /**
+   * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+   * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+   * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+   * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+   * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsCreateOptionalParams
+  ): Promise<DiagnosticsCreateResponse>;
+  /**
+   * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  get(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsGetOptionalParams
+  ): Promise<DiagnosticsGetResponse>;
+}

package/src/operationsInterfaces/discoverySolution.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  SolutionMetadataResource,
+  DiscoverySolutionListOptionalParams
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a DiscoverySolution. */
+export interface DiscoverySolution {
+  /**
+   * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
+   * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
+   * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
+   * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
+   * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
+   * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
+   * ‘additionalParameters’ as an input to Diagnostics API.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param options The options parameters.
+   */
+  list(
+    scope: string,
+    options?: DiscoverySolutionListOptionalParams
+  ): PagedAsyncIterableIterator<SolutionMetadataResource>;
+}

package/src/operationsInterfaces/index.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export * from "./operations";
+export * from "./diagnostics";
+export * from "./discoverySolution";

package/src/operationsInterfaces/operations.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { Operation, OperationsListOptionalParams } from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Operations. */
+export interface Operations {
+  /**
+   * Returns list of operations.
+   * @param options The options parameters.
+   */
+  list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation>;
+}

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export function getContinuationToken(page: unknown): string | undefined {
+  if (typeof page !== "object" || page === null) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "module": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "target": "es6",
+    "sourceMap": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    "declaration": true,
+    "outDir": "./dist-esm",
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-selfhelp": [
+        "./src/index"
+      ]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}