@azure/arm-support 1.1.1 → 2.0.0

package/src/operationsInterfaces/communications.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 { PollerLike, PollOperationState } from "@azure/core-lro";
+import {
+  CommunicationDetails,
+  CommunicationsListOptionalParams,
+  CheckNameAvailabilityInput,
+  CommunicationsCheckNameAvailabilityOptionalParams,
+  CommunicationsCheckNameAvailabilityResponse,
+  CommunicationsGetOptionalParams,
+  CommunicationsGetResponse,
+  CommunicationsCreateOptionalParams,
+  CommunicationsCreateResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Communications. */
+export interface Communications {
+  /**
+   * Lists all communications (attachments not included) for a support ticket. <br/></br> You can also
+   * filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter
+   * parameter. The only type of communication supported today is _Web_. Output will be a paged result
+   * with _nextLink_, using which you can retrieve the next set of Communication results.
+   * <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket was
+   * created more than 18 months ago, a request for data might cause an error.
+   * @param supportTicketName Support ticket name.
+   * @param options The options parameters.
+   */
+  list(
+    supportTicketName: string,
+    options?: CommunicationsListOptionalParams
+  ): PagedAsyncIterableIterator<CommunicationDetails>;
+  /**
+   * Check the availability of a resource name. This API should be used to check the uniqueness of the
+   * name for adding a new communication to the support ticket.
+   * @param supportTicketName Support ticket name.
+   * @param checkNameAvailabilityInput Input to check.
+   * @param options The options parameters.
+   */
+  checkNameAvailability(
+    supportTicketName: string,
+    checkNameAvailabilityInput: CheckNameAvailabilityInput,
+    options?: CommunicationsCheckNameAvailabilityOptionalParams
+  ): Promise<CommunicationsCheckNameAvailabilityResponse>;
+  /**
+   * Returns communication details for a support ticket.
+   * @param supportTicketName Support ticket name.
+   * @param communicationName Communication name.
+   * @param options The options parameters.
+   */
+  get(
+    supportTicketName: string,
+    communicationName: string,
+    options?: CommunicationsGetOptionalParams
+  ): Promise<CommunicationsGetResponse>;
+  /**
+   * Adds a new customer communication to an Azure support ticket.
+   * @param supportTicketName Support ticket name.
+   * @param communicationName Communication name.
+   * @param createCommunicationParameters Communication object.
+   * @param options The options parameters.
+   */
+  beginCreate(
+    supportTicketName: string,
+    communicationName: string,
+    createCommunicationParameters: CommunicationDetails,
+    options?: CommunicationsCreateOptionalParams
+  ): Promise<
+    PollerLike<
+      PollOperationState<CommunicationsCreateResponse>,
+      CommunicationsCreateResponse
+    >
+  >;
+  /**
+   * Adds a new customer communication to an Azure support ticket.
+   * @param supportTicketName Support ticket name.
+   * @param communicationName Communication name.
+   * @param createCommunicationParameters Communication object.
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    supportTicketName: string,
+    communicationName: string,
+    createCommunicationParameters: CommunicationDetails,
+    options?: CommunicationsCreateOptionalParams
+  ): Promise<CommunicationsCreateResponse>;
+}

package/src/operationsInterfaces/index.ts

@@ -0,0 +1,13 @@
+/*
+ * 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 "./services";
+export * from "./problemClassifications";
+export * from "./supportTickets";
+export * from "./communications";

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 {
+  /**
+   * This lists all the available Microsoft Support REST API operations.
+   * @param options The options parameters.
+   */
+  list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation>;
+}

package/src/operationsInterfaces/problemClassifications.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 {
+  ProblemClassification,
+  ProblemClassificationsListOptionalParams,
+  ProblemClassificationsGetOptionalParams,
+  ProblemClassificationsGetResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a ProblemClassifications. */
+export interface ProblemClassifications {
+  /**
+   * Lists all the problem classifications (categories) available for a specific Azure service. Always
+   * use the service and problem classifications obtained programmatically. This practice ensures that
+   * you always have the most recent set of service and problem classification Ids.
+   * @param serviceName Name of the Azure service for which the problem classifications need to be
+   *                    retrieved.
+   * @param options The options parameters.
+   */
+  list(
+    serviceName: string,
+    options?: ProblemClassificationsListOptionalParams
+  ): PagedAsyncIterableIterator<ProblemClassification>;
+  /**
+   * Get problem classification details for a specific Azure service.
+   * @param serviceName Name of the Azure service available for support.
+   * @param problemClassificationName Name of problem classification.
+   * @param options The options parameters.
+   */
+  get(
+    serviceName: string,
+    problemClassificationName: string,
+    options?: ProblemClassificationsGetOptionalParams
+  ): Promise<ProblemClassificationsGetResponse>;
+}

package/src/operationsInterfaces/services.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 {
+  Service,
+  ServicesListOptionalParams,
+  ServicesGetOptionalParams,
+  ServicesGetResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Services. */
+export interface Services {
+  /**
+   * Lists all the Azure services available for support ticket creation. For **Technical** issues, select
+   * the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down
+   * list on the Azure portal's [New support
+   * request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page.
+   * Always use the service and its corresponding problem classification(s) obtained programmatically for
+   * support ticket creation. This practice ensures that you always have the most recent set of service
+   * and problem classification Ids.
+   * @param options The options parameters.
+   */
+  list(
+    options?: ServicesListOptionalParams
+  ): PagedAsyncIterableIterator<Service>;
+  /**
+   * Gets a specific Azure service for support ticket creation.
+   * @param serviceName Name of the Azure service.
+   * @param options The options parameters.
+   */
+  get(
+    serviceName: string,
+    options?: ServicesGetOptionalParams
+  ): Promise<ServicesGetResponse>;
+}

package/src/operationsInterfaces/supportTickets.ts

@@ -0,0 +1,137 @@
+/*
+ * 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 { PollerLike, PollOperationState } from "@azure/core-lro";
+import {
+  SupportTicketDetails,
+  SupportTicketsListOptionalParams,
+  CheckNameAvailabilityInput,
+  SupportTicketsCheckNameAvailabilityOptionalParams,
+  SupportTicketsCheckNameAvailabilityResponse,
+  SupportTicketsGetOptionalParams,
+  SupportTicketsGetResponse,
+  UpdateSupportTicket,
+  SupportTicketsUpdateOptionalParams,
+  SupportTicketsUpdateResponse,
+  SupportTicketsCreateOptionalParams,
+  SupportTicketsCreateResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a SupportTickets. */
+export interface SupportTickets {
+  /**
+   * Lists all the support tickets for an Azure subscription. You can also filter the support tickets by
+   * _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with
+   * _nextLink_, using which you can retrieve the next set of support tickets. <br/><br/>Support ticket
+   * data is available for 18 months after ticket creation. If a ticket was created more than 18 months
+   * ago, a request for data might cause an error.
+   * @param options The options parameters.
+   */
+  list(
+    options?: SupportTicketsListOptionalParams
+  ): PagedAsyncIterableIterator<SupportTicketDetails>;
+  /**
+   * Check the availability of a resource name. This API should be used to check the uniqueness of the
+   * name for support ticket creation for the selected subscription.
+   * @param checkNameAvailabilityInput Input to check.
+   * @param options The options parameters.
+   */
+  checkNameAvailability(
+    checkNameAvailabilityInput: CheckNameAvailabilityInput,
+    options?: SupportTicketsCheckNameAvailabilityOptionalParams
+  ): Promise<SupportTicketsCheckNameAvailabilityResponse>;
+  /**
+   * Get ticket details for an Azure subscription. Support ticket data is available for 18 months after
+   * ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an
+   * error.
+   * @param supportTicketName Support ticket name.
+   * @param options The options parameters.
+   */
+  get(
+    supportTicketName: string,
+    options?: SupportTicketsGetOptionalParams
+  ): Promise<SupportTicketsGetResponse>;
+  /**
+   * This API allows you to update the severity level, ticket status, and your contact information in the
+   * support ticket.<br/><br/>Note: The severity levels cannot be changed if a support ticket is actively
+   * being worked upon by an Azure support engineer. In such a case, contact your support engineer to
+   * request severity update by adding a new communication using the Communications
+   * API.<br/><br/>Changing the ticket status to _closed_ is allowed only on an unassigned case. When an
+   * engineer is actively working on the ticket, send your ticket closure request by sending a note to
+   * your engineer.
+   * @param supportTicketName Support ticket name.
+   * @param updateSupportTicket UpdateSupportTicket object.
+   * @param options The options parameters.
+   */
+  update(
+    supportTicketName: string,
+    updateSupportTicket: UpdateSupportTicket,
+    options?: SupportTicketsUpdateOptionalParams
+  ): Promise<SupportTicketsUpdateResponse>;
+  /**
+   * Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and
+   * Subscription Management issues for the specified subscription. Learn the
+   * [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.<br/><br/>Always call
+   * the Services and ProblemClassifications API to get the most recent set of services and problem
+   * categories required for support ticket creation.<br/><br/>Adding attachments is not currently
+   * supported via the API. To add a file to an existing support ticket, visit the [Manage support
+   * ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest)
+   * page in the Azure portal, select the support ticket, and use the file upload control to add a new
+   * file.<br/><br/>Providing consent to share diagnostic information with Azure support is currently not
+   * supported via the API. The Azure support engineer working on your ticket will reach out to you for
+   * consent if your issue requires gathering diagnostic information from your Azure
+   * resources.<br/><br/>**Creating a support ticket for on-behalf-of**: Include
+   * _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per
+   * [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant).
+   * The primary token will be from the tenant for whom a support ticket is being raised against the
+   * subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from
+   * the Cloud solution provider (CSP) partner tenant.
+   * @param supportTicketName Support ticket name.
+   * @param createSupportTicketParameters Support ticket request payload.
+   * @param options The options parameters.
+   */
+  beginCreate(
+    supportTicketName: string,
+    createSupportTicketParameters: SupportTicketDetails,
+    options?: SupportTicketsCreateOptionalParams
+  ): Promise<
+    PollerLike<
+      PollOperationState<SupportTicketsCreateResponse>,
+      SupportTicketsCreateResponse
+    >
+  >;
+  /**
+   * Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and
+   * Subscription Management issues for the specified subscription. Learn the
+   * [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.<br/><br/>Always call
+   * the Services and ProblemClassifications API to get the most recent set of services and problem
+   * categories required for support ticket creation.<br/><br/>Adding attachments is not currently
+   * supported via the API. To add a file to an existing support ticket, visit the [Manage support
+   * ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest)
+   * page in the Azure portal, select the support ticket, and use the file upload control to add a new
+   * file.<br/><br/>Providing consent to share diagnostic information with Azure support is currently not
+   * supported via the API. The Azure support engineer working on your ticket will reach out to you for
+   * consent if your issue requires gathering diagnostic information from your Azure
+   * resources.<br/><br/>**Creating a support ticket for on-behalf-of**: Include
+   * _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per
+   * [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant).
+   * The primary token will be from the tenant for whom a support ticket is being raised against the
+   * subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from
+   * the Cloud solution provider (CSP) partner tenant.
+   * @param supportTicketName Support ticket name.
+   * @param createSupportTicketParameters Support ticket request payload.
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    supportTicketName: string,
+    createSupportTicketParameters: SupportTicketDetails,
+    options?: SupportTicketsCreateOptionalParams
+  ): Promise<SupportTicketsCreateResponse>;
+}

package/tsconfig.json

@@ -3,7 +3,7 @@
     "module": "es6",
     "moduleResolution": "node",
     "strict": true,
-    "target": "es5",
+    "target": "es6",
     "sourceMap": true,
     "declarationMap": true,
     "esModuleInterop": true,
@@ -11,9 +11,10 @@
     "forceConsistentCasingInFileNames": true,
     "lib": ["es6", "dom"],
     "declaration": true,
-    "outDir": "./esm",
-    "importHelpers": true
+    "outDir": "./dist-esm",
+    "importHelpers": true,
+    "paths": { "@azure/arm-support": ["./src/index"] }
   },
-  "include": ["./src/**/*.ts"],
+  "include": ["./src/**/*.ts", "./test/**/*.ts", "samples-dev/**/*.ts"],
   "exclude": ["node_modules"]
 }