@azure-tools/communication-short-codes 1.0.0-beta.1 → 1.0.0-beta.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+## 1.0.0-beta.2 (2022-03-31)
+### Features Added
+- Migrated from using `@azure/core-http` to `@azure/core-rest-pipeline` for the handling of HTTP requests. See [Azure Core v1 vs v2](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/documentation/core2.md) for more on the difference and benefits of the move.
+
+### Breaking Changes
+- `ShortCodesClient.submitUSProgramBrief` no longer returns the generic `RestResponse` type, and instead returns the more specific `USProgramBrief`. Because of this, the `_response` property is no longer exposed in the returned object. However, in the operation options, it can take a callback (`onResponse`) to access the HTTP response. See https://github.com/Azure/autorest.typescript/wiki/%60core-http%60-dependency-migration-to-%60core-client%60-%60core-rest-pipeline%60#change-to-the-_response-property
+
 ## 1.0.0-beta.1 (2021-11-05)
 
 The first preview of the Azure Communication Short Codes Client has the following features:

package/dist/index.js

@@ -4,14 +4,30 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var communicationCommon = require('@azure/communication-common');
 var coreAuth = require('@azure/core-auth');
-var coreHttp = require('@azure/core-http');
-var logger$1 = require('@azure/logger');
 var coreTracing = require('@azure/core-tracing');
+var logger$1 = require('@azure/logger');
+var coreClient = require('@azure/core-client');
 var tslib = require('tslib');
 
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const SDK_VERSION = "1.0.0-beta.1";
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -28,7 +44,7 @@ const logger = logger$1.createClientLogger("communication-short-codes");
  */
 const createSpan = coreTracing.createSpanFunction({
     packagePrefix: "Azure.Communication",
-    namespace: "Microsoft.Communication"
+    namespace: "Microsoft.Communication",
 });
 
 /*
@@ -78,8 +94,7 @@ const ShortCode = {
             numberType: {
                 serializedName: "numberType",
                 type: {
-                    name: "Enum",
-                    allowedValues: ["shortCode", "alphaId"]
+                    name: "String"
                 }
             },
             countryCode: {
@@ -187,15 +202,7 @@ const USProgramBrief = {
             status: {
                 serializedName: "status",
                 type: {
-                    name: "Enum",
-                    allowedValues: [
-                        "submitted",
-                        "approved",
-                        "submitNewVanityNumbers",
-                        "updateProgramBrief",
-                        "draft",
-                        "denied"
-                    ]
+                    name: "String"
                 }
             },
             number: {
@@ -314,8 +321,7 @@ const ShortCodeCost = {
                 serializedName: "billingFrequency",
                 required: true,
                 type: {
-                    name: "Enum",
-                    allowedValues: ["monthly", "once"]
+                    name: "String"
                 }
             }
         }
@@ -346,8 +352,7 @@ const ProgramDetails = {
             numberType: {
                 serializedName: "numberType",
                 type: {
-                    name: "Enum",
-                    allowedValues: ["shortCode", "alphaId"]
+                    name: "String"
                 }
             },
             isPoliticalCampaign: {
@@ -524,8 +529,7 @@ const MessageDetails = {
             recurrence: {
                 serializedName: "recurrence",
                 type: {
-                    name: "Enum",
-                    allowedValues: ["subscription", "transaction"]
+                    name: "String"
                 }
             },
             helpMessage: {
@@ -561,8 +565,7 @@ const MessageDetails = {
             directionality: {
                 serializedName: "directionality",
                 type: {
-                    name: "Enum",
-                    allowedValues: ["oneWay", "twoWay"]
+                    name: "String"
                 }
             },
             useCases: {
@@ -588,50 +591,7 @@ const UseCase = {
             contentCategory: {
                 serializedName: "contentCategory",
                 type: {
-                    name: "Enum",
-                    allowedValues: [
-                        "ringTones",
-                        "smsChat",
-                        "video",
-                        "loyaltyProgramPointsPrizes",
-                        "gifting",
-                        "inApplicationBilling",
-                        "textToScreen",
-                        "games",
-                        "audioChat",
-                        "mmsPictures",
-                        "sweepstakesContestAuction",
-                        "financialBanking",
-                        "premiumWap",
-                        "queryService",
-                        "wallpaperScreensaver",
-                        "voting",
-                        "application",
-                        "mobileGivingDonations",
-                        "coupons",
-                        "loyaltyProgram",
-                        "noPointsPrizes",
-                        "informationalAlerts",
-                        "microBilling",
-                        "trivia",
-                        "entertainmentAlerts",
-                        "accountNotification",
-                        "ageGatedContent",
-                        "conversationalMessaging",
-                        "deliveryNotification",
-                        "education",
-                        "emergencyAlerts",
-                        "fraudAlerts",
-                        "loanArrangement",
-                        "onBehalfOfCarrier",
-                        "political",
-                        "promotionalMarketing",
-                        "publicServiceAnnouncements",
-                        "securityAlerts",
-                        "socialMedia",
-                        "twoFactorAuthentication",
-                        "other"
-                    ]
+                    name: "String"
                 }
             },
             examples: {
@@ -677,8 +637,7 @@ const MessageExample = {
             direction: {
                 serializedName: "direction",
                 type: {
-                    name: "Enum",
-                    allowedValues: ["toUser", "fromUser"]
+                    name: "String"
                 }
             },
             text: {
@@ -830,6 +789,7 @@ const endpoint = {
 const skip = {
     parameterPath: ["options", "skip"],
     mapper: {
+        defaultValue: 0,
         serializedName: "skip",
         type: {
             name: "Number"
@@ -901,10 +861,11 @@ const nextLink = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-/** Class representing a ShortCodes. */
-class ShortCodes$1 {
+/// <reference lib="esnext.asynciterable" />
+/** Class containing ShortCodesOperations operations. */
+class ShortCodesOperationsImpl {
     /**
-     * Initialize a new instance of the class ShortCodes class.
+     * Initialize a new instance of the class ShortCodesOperations class.
      * @param client Reference to the service client
      */
     constructor(client) {
@@ -1011,10 +972,7 @@ class ShortCodes$1 {
      * @param options The options parameters.
      */
     _getShortCodes(options) {
-        const operationArguments = {
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, getShortCodesOperationSpec);
+        return this.client.sendOperationRequest({ options }, getShortCodesOperationSpec);
     }
     /**
      * Creates or updates a US Program Brief.
@@ -1022,11 +980,7 @@ class ShortCodes$1 {
      * @param options The options parameters.
      */
     upsertUSProgramBrief(programBriefId, options) {
-        const operationArguments = {
-            programBriefId,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, upsertUSProgramBriefOperationSpec);
+        return this.client.sendOperationRequest({ programBriefId, options }, upsertUSProgramBriefOperationSpec);
     }
     /**
      * Deletes a US Program Brief.
@@ -1034,43 +988,30 @@ class ShortCodes$1 {
      * @param options The options parameters.
      */
     deleteUSProgramBrief(programBriefId, options) {
-        const operationArguments = {
-            programBriefId,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, deleteUSProgramBriefOperationSpec);
+        return this.client.sendOperationRequest({ programBriefId, options }, deleteUSProgramBriefOperationSpec);
     }
     /**
-     * @param programBriefId
+     * Get a US Program Brief by id.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
      * @param options The options parameters.
      */
     getUSProgramBrief(programBriefId, options) {
-        const operationArguments = {
-            programBriefId,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, getUSProgramBriefOperationSpec);
+        return this.client.sendOperationRequest({ programBriefId, options }, getUSProgramBriefOperationSpec);
     }
     /**
-     * @param programBriefId
+     * Submits a US Program Brief for review.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
      * @param options The options parameters.
      */
     submitUSProgramBrief(programBriefId, options) {
-        const operationArguments = {
-            programBriefId,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, submitUSProgramBriefOperationSpec);
+        return this.client.sendOperationRequest({ programBriefId, options }, submitUSProgramBriefOperationSpec);
     }
     /**
      * Gets the list of US Program Briefs for the current resource.
      * @param options The options parameters.
      */
     _getUSProgramBriefs(options) {
-        const operationArguments = {
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, getUSProgramBriefsOperationSpec);
+        return this.client.sendOperationRequest({ options }, getUSProgramBriefsOperationSpec);
     }
     /**
      * GetShortCodesNext
@@ -1078,11 +1019,7 @@ class ShortCodes$1 {
      * @param options The options parameters.
      */
     _getShortCodesNext(nextLink, options) {
-        const operationArguments = {
-            nextLink,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, getShortCodesNextOperationSpec);
+        return this.client.sendOperationRequest({ nextLink, options }, getShortCodesNextOperationSpec);
     }
     /**
      * GetUSProgramBriefsNext
@@ -1090,15 +1027,11 @@ class ShortCodes$1 {
      * @param options The options parameters.
      */
     _getUSProgramBriefsNext(nextLink, options) {
-        const operationArguments = {
-            nextLink,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.client.sendOperationRequest(operationArguments, getUSProgramBriefsNextOperationSpec);
+        return this.client.sendOperationRequest({ nextLink, options }, getUSProgramBriefsNextOperationSpec);
     }
 }
 // Operation Specifications
-const serializer = new coreHttp.Serializer(Mappers, /* isXml */ false);
+const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const getShortCodesOperationSpec = {
     path: "/shortCodes",
     httpMethod: "GET",
@@ -1238,9 +1171,7 @@ const getUSProgramBriefsNextOperationSpec = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-const packageName = "azure-communication-short-codes";
-const packageVersion = "1.0.0-beta.1";
-class ShortCodesClientContext extends coreHttp.ServiceClient {
+class ShortCodesClientContext extends coreClient__namespace.ServiceClient {
     /**
      * Initializes a new instance of the ShortCodesClientContext class.
      * @param endpoint The communication resource, for example https://resourcename.communication.azure.com
@@ -1254,13 +1185,17 @@ class ShortCodesClientContext extends coreHttp.ServiceClient {
         if (!options) {
             options = {};
         }
-        if (!options.userAgent) {
-            const defaultUserAgent = coreHttp.getDefaultUserAgentValue();
-            options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
-        }
-        super(undefined, options);
-        this.requestContentType = "application/json; charset=utf-8";
-        this.baseUri = options.endpoint || "{endpoint}";
+        const defaults = {
+            requestContentType: "application/json; charset=utf-8"
+        };
+        const packageDetails = `azsdk-js-communication-short-codes/1.0.0-beta.2`;
+        const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+            ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+            : `${packageDetails}`;
+        const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
+                userAgentPrefix
+            }, baseUri: options.endpoint || "{endpoint}" });
+        super(optionsWithDefaults);
         // Parameter assignments
         this.endpoint = endpoint;
         // Assigning values to Constant parameters
@@ -1275,7 +1210,7 @@ class ShortCodesClientContext extends coreHttp.ServiceClient {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class ShortCodesClient extends ShortCodesClientContext {
+class ShortCodesClient$1 extends ShortCodesClientContext {
     /**
      * Initializes a new instance of the ShortCodesClient class.
      * @param endpoint The communication resource, for example https://resourcename.communication.azure.com
@@ -1283,46 +1218,36 @@ class ShortCodesClient extends ShortCodesClientContext {
      */
     constructor(endpoint, options) {
         super(endpoint, options);
-        this.shortCodes = new ShortCodes$1(this);
+        this.shortCodesOperations = new ShortCodesOperationsImpl(this);
     }
 }
 
 // Copyright (c) Microsoft Corporation.
 const isShortCodesClientOptions = (options) => options && !communicationCommon.isKeyCredential(options) && !coreAuth.isTokenCredential(options);
-class ShortCodesClient$1 {
+class ShortCodesClient {
     constructor(connectionStringOrUrl, credentialOrOptions, maybeOptions = {}) {
         const { url, credential } = communicationCommon.parseClientArguments(connectionStringOrUrl, credentialOrOptions);
         const options = isShortCodesClientOptions(credentialOrOptions)
             ? credentialOrOptions
             : maybeOptions;
-        const libInfo = `azsdk-js-communication-short-codes/${SDK_VERSION}`;
-        if (!options.userAgentOptions) {
-            options.userAgentOptions = {};
-        }
-        if (options.userAgentOptions.userAgentPrefix) {
-            options.userAgentOptions.userAgentPrefix = `${options.userAgentOptions.userAgentPrefix} ${libInfo}`;
-        }
-        else {
-            options.userAgentOptions.userAgentPrefix = libInfo;
-        }
         const internalPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
-                logger: logger.info
-            }
+                logger: logger.info,
+            },
         });
+        this.client = new ShortCodesClient$1(url, internalPipelineOptions);
         const authPolicy = communicationCommon.createCommunicationAuthPolicy(credential);
-        const pipeline = coreHttp.createPipelineFromOptions(internalPipelineOptions, authPolicy);
-        this.client = new ShortCodesClient(url, pipeline).shortCodes;
+        this.client.pipeline.addPolicy(authPolicy);
     }
     listShortCodes(options = {}) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-listShortCodes", options);
         try {
-            return this.client.listShortCodes(updatedOptions);
+            return this.client.shortCodesOperations.listShortCodes(updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1333,12 +1258,12 @@ class ShortCodesClient$1 {
     async upsertUSProgramBrief(programBriefId, options = {}) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-upsertUSProgramBrief", options);
         try {
-            return await this.client.upsertUSProgramBrief(programBriefId, updatedOptions);
+            return await this.client.shortCodesOperations.upsertUSProgramBrief(programBriefId, updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1349,12 +1274,12 @@ class ShortCodesClient$1 {
     async deleteUSProgramBrief(programBriefId, options) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-deleteUSProgramBrief", options);
         try {
-            return await this.client.deleteUSProgramBrief(programBriefId, updatedOptions);
+            return await this.client.shortCodesOperations.deleteUSProgramBrief(programBriefId, updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1365,12 +1290,12 @@ class ShortCodesClient$1 {
     async getUSProgramBrief(programBriefId, options) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-getUSProgramBrief", options);
         try {
-            return await this.client.getUSProgramBrief(programBriefId, updatedOptions);
+            return await this.client.shortCodesOperations.getUSProgramBrief(programBriefId, updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1381,12 +1306,12 @@ class ShortCodesClient$1 {
     listUSProgramBriefs(options = {}) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-listUSProgramBriefs", options);
         try {
-            return this.client.listUSProgramBriefs(updatedOptions);
+            return this.client.shortCodesOperations.listUSProgramBriefs(updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1397,12 +1322,12 @@ class ShortCodesClient$1 {
     async submitUSProgramBrief(programBriefId, options) {
         const { span, updatedOptions } = createSpan("ShortCodesClient-submitUSProgramBrief", options);
         try {
-            return await this.client.submitUSProgramBrief(programBriefId, updatedOptions);
+            return await this.client.shortCodesOperations.submitUSProgramBrief(programBriefId, updatedOptions);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -1412,5 +1337,5 @@ class ShortCodesClient$1 {
     }
 }
 
-exports.ShortCodesClient = ShortCodesClient$1;
+exports.ShortCodesClient = ShortCodesClient;
 //# sourceMappingURL=index.js.map