@azure/communication-sms 1.2.0-alpha.20241210.1 → 1.2.0-beta.2

package/dist/commonjs/optOutsClient.d.ts

@@ -0,0 +1,105 @@
+import type { SmsApiClient } from "./generated/src/smsApiClient.js";
+import type { OperationOptions } from "@azure/core-client";
+/**
+ * The result of Opt Out Check request.
+ */
+export interface OptOutCheckResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * Indicates if the recipient's phone number in opted out from receiving messages or not.
+     */
+    isOptedOut: boolean;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
+/**
+ * The result of Opt Out Add request.
+ */
+export interface OptOutAddResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
+/**
+ * The result of Opt Out Remove request.
+ */
+export interface OptOutRemoveResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
+/**
+ * Client options used to configure OptOuts Client API Check requests.
+ */
+export interface CheckOptions extends OperationOptions {
+}
+/**
+ * Client options used to configure OptOuts Client API Add requests.
+ */
+export interface AddOptions extends OperationOptions {
+}
+/**
+ * Client options used to configure OptOuts Client API Remove requests.
+ */
+export interface RemoveOptions extends OperationOptions {
+}
+/**
+ * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you
+ * to call Opt Out Management Api methods.
+ */
+export declare class OptOutsClient {
+    private readonly api;
+    constructor(api: SmsApiClient);
+    /**
+     * Removes phone numbers from the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    remove(from: string, to: string[], options?: RemoveOptions): Promise<OptOutRemoveResult[]>;
+    /**
+     * Adds phone numbers to the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    add(from: string, to: string[], options?: AddOptions): Promise<OptOutAddResult[]>;
+    /**
+     * Checks if phone numbers are in the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    check(from: string, to: string[], options?: CheckOptions): Promise<OptOutCheckResult[]>;
+}
+//# sourceMappingURL=optOutsClient.d.ts.map

package/dist/commonjs/optOutsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optOutsClient.d.ts","sourceRoot":"","sources":["../../src/optOutsClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAGpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;CAAG;AAEzD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,gBAAgB;CAAG;AAEvD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;CAAG;AAE1D;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;gBAEvB,GAAG,EAAE,YAAY;IAI7B;;;;;;OAMG;IACU,MAAM,CACjB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EAAE,EACZ,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAehC;;;;;;OAMG;IACU,GAAG,CACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EAAE,EACZ,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,eAAe,EAAE,CAAC;IAe7B;;;;;;OAMG;IACU,KAAK,CAChB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EAAE,EACZ,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,iBAAiB,EAAE,CAAC;CAkBhC"}

package/dist/commonjs/optOutsClient.js

@@ -0,0 +1,83 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptOutsClient = void 0;
+const tracing_js_1 = require("./generated/src/tracing.js");
+const smsUtils_js_1 = require("./utils/smsUtils.js");
+const extractOperationOptions_js_1 = require("./extractOperationOptions.js");
+/**
+ * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you
+ * to call Opt Out Management Api methods.
+ */
+class OptOutsClient {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * Removes phone numbers from the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    async remove(from, to, options = {}) {
+        const { operationOptions } = (0, extractOperationOptions_js_1.extractOperationOptions)(options);
+        return tracing_js_1.tracingClient.withSpan("OptOuts-Remove", operationOptions, async (updatedOptions) => {
+            const response = await this.api.optOuts.add((0, smsUtils_js_1.generateOptOutRequest)(from, to), updatedOptions);
+            return response.value.map((optOutResponseItem) => {
+                var _a;
+                return {
+                    to: optOutResponseItem.to,
+                    httpStatusCode: optOutResponseItem.httpStatusCode,
+                    errorMessage: (_a = optOutResponseItem.errorMessage) !== null && _a !== void 0 ? _a : "",
+                };
+            });
+        });
+    }
+    /**
+     * Adds phone numbers to the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    async add(from, to, options = {}) {
+        const { operationOptions } = (0, extractOperationOptions_js_1.extractOperationOptions)(options);
+        return tracing_js_1.tracingClient.withSpan("OptOuts-Add", operationOptions, async (updatedOptions) => {
+            const response = await this.api.optOuts.add((0, smsUtils_js_1.generateOptOutRequest)(from, to), updatedOptions);
+            return response.value.map((optOutResponseItem) => {
+                var _a;
+                return {
+                    to: optOutResponseItem.to,
+                    httpStatusCode: optOutResponseItem.httpStatusCode,
+                    errorMessage: (_a = optOutResponseItem.errorMessage) !== null && _a !== void 0 ? _a : "",
+                };
+            });
+        });
+    }
+    /**
+     * Checks if phone numbers are in the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    async check(from, to, options = {}) {
+        const { operationOptions } = (0, extractOperationOptions_js_1.extractOperationOptions)(options);
+        return tracing_js_1.tracingClient.withSpan("OptOuts-Check", operationOptions, async (updatedOptions) => {
+            const response = await this.api.optOuts.check((0, smsUtils_js_1.generateOptOutRequest)(from, to), updatedOptions);
+            return response.value.map((optOutResponseItem) => {
+                var _a, _b;
+                return {
+                    to: optOutResponseItem.to,
+                    isOptedOut: (_a = optOutResponseItem.isOptedOut) !== null && _a !== void 0 ? _a : false,
+                    httpStatusCode: optOutResponseItem.httpStatusCode,
+                    errorMessage: (_b = optOutResponseItem.errorMessage) !== null && _b !== void 0 ? _b : "",
+                };
+            });
+        });
+    }
+}
+exports.OptOutsClient = OptOutsClient;
+//# sourceMappingURL=optOutsClient.js.map

package/dist/commonjs/optOutsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optOutsClient.js","sourceRoot":"","sources":["../../src/optOutsClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,2DAA2D;AAG3D,qDAA4D;AAC5D,6EAAuE;AA4EvE;;;GAGG;AACH,MAAa,aAAa;IAGxB,YAAY,GAAiB;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,IAAY,EACZ,EAAY,EACZ,UAAyB,EAAE;QAE3B,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAA,oDAAuB,EAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,0BAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,mCAAqB,EAAC,IAAI,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;YAE7F,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,kBAAsC,EAAE,EAAE;;gBACnE,OAAO;oBACL,EAAE,EAAE,kBAAkB,CAAC,EAAE;oBACzB,cAAc,EAAE,kBAAkB,CAAC,cAAc;oBACjD,YAAY,EAAE,MAAA,kBAAkB,CAAC,YAAY,mCAAI,EAAE;iBACpD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,IAAY,EACZ,EAAY,EACZ,UAAsB,EAAE;QAExB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAA,oDAAuB,EAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,0BAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACtF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,mCAAqB,EAAC,IAAI,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;YAE7F,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,kBAAsC,EAAE,EAAE;;gBACnE,OAAO;oBACL,EAAE,EAAE,kBAAkB,CAAC,EAAE;oBACzB,cAAc,EAAE,kBAAkB,CAAC,cAAc;oBACjD,YAAY,EAAE,MAAA,kBAAkB,CAAC,YAAY,mCAAI,EAAE;iBACpD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,IAAY,EACZ,EAAY,EACZ,UAAwB,EAAE;QAE1B,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAA,oDAAuB,EAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,0BAAa,CAAC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACxF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAC3C,IAAA,mCAAqB,EAAC,IAAI,EAAE,EAAE,CAAC,EAC/B,cAAc,CACf,CAAC;YAEF,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,kBAAsC,EAAE,EAAE;;gBACnE,OAAO;oBACL,EAAE,EAAE,kBAAkB,CAAC,EAAE;oBACzB,UAAU,EAAE,MAAA,kBAAkB,CAAC,UAAU,mCAAI,KAAK;oBAClD,cAAc,EAAE,kBAAkB,CAAC,cAAc;oBACjD,YAAY,EAAE,MAAA,kBAAkB,CAAC,YAAY,mCAAI,EAAE;iBACpD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,sCAwFC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { tracingClient } from \"./generated/src/tracing.js\";\nimport type { OptOutResponseItem } from \"./generated/src/index.js\";\nimport type { SmsApiClient } from \"./generated/src/smsApiClient.js\";\nimport { generateOptOutRequest } from \"./utils/smsUtils.js\";\nimport { extractOperationOptions } from \"./extractOperationOptions.js\";\nimport type { OperationOptions } from \"@azure/core-client\";\n\n/**\n * The result of Opt Out Check request.\n */\nexport interface OptOutCheckResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * Indicates if the recipient's phone number in opted out from receiving messages or not.\n   */\n  isOptedOut: boolean;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * The result of Opt Out Add request.\n */\nexport interface OptOutAddResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * The result of Opt Out Remove request.\n */\nexport interface OptOutRemoveResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * Client options used to configure OptOuts Client API Check requests.\n */\nexport interface CheckOptions extends OperationOptions {}\n\n/**\n * Client options used to configure OptOuts Client API Add requests.\n */\nexport interface AddOptions extends OperationOptions {}\n\n/**\n * Client options used to configure OptOuts Client API Remove requests.\n */\nexport interface RemoveOptions extends OperationOptions {}\n\n/**\n * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you\n * to call Opt Out Management Api methods.\n */\nexport class OptOutsClient {\n  private readonly api: SmsApiClient;\n\n  constructor(api: SmsApiClient) {\n    this.api = api;\n  }\n\n  /**\n   * Removes phone numbers from the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  public async remove(\n    from: string,\n    to: string[],\n    options: RemoveOptions = {},\n  ): Promise<OptOutRemoveResult[]> {\n    const { operationOptions } = extractOperationOptions(options);\n    return tracingClient.withSpan(\"OptOuts-Remove\", operationOptions, async (updatedOptions) => {\n      const response = await this.api.optOuts.add(generateOptOutRequest(from, to), updatedOptions);\n\n      return response.value.map((optOutResponseItem: OptOutResponseItem) => {\n        return {\n          to: optOutResponseItem.to,\n          httpStatusCode: optOutResponseItem.httpStatusCode,\n          errorMessage: optOutResponseItem.errorMessage ?? \"\",\n        };\n      });\n    });\n  }\n\n  /**\n   * Adds phone numbers to the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  public async add(\n    from: string,\n    to: string[],\n    options: AddOptions = {},\n  ): Promise<OptOutAddResult[]> {\n    const { operationOptions } = extractOperationOptions(options);\n    return tracingClient.withSpan(\"OptOuts-Add\", operationOptions, async (updatedOptions) => {\n      const response = await this.api.optOuts.add(generateOptOutRequest(from, to), updatedOptions);\n\n      return response.value.map((optOutResponseItem: OptOutResponseItem) => {\n        return {\n          to: optOutResponseItem.to,\n          httpStatusCode: optOutResponseItem.httpStatusCode,\n          errorMessage: optOutResponseItem.errorMessage ?? \"\",\n        };\n      });\n    });\n  }\n\n  /**\n   * Checks if phone numbers are in the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  public async check(\n    from: string,\n    to: string[],\n    options: CheckOptions = {},\n  ): Promise<OptOutCheckResult[]> {\n    const { operationOptions } = extractOperationOptions(options);\n    return tracingClient.withSpan(\"OptOuts-Check\", operationOptions, async (updatedOptions) => {\n      const response = await this.api.optOuts.check(\n        generateOptOutRequest(from, to),\n        updatedOptions,\n      );\n\n      return response.value.map((optOutResponseItem: OptOutResponseItem) => {\n        return {\n          to: optOutResponseItem.to,\n          isOptedOut: optOutResponseItem.isOptedOut ?? false,\n          httpStatusCode: optOutResponseItem.httpStatusCode,\n          errorMessage: optOutResponseItem.errorMessage ?? \"\",\n        };\n      });\n    });\n  }\n}\n"]}

package/dist/commonjs/smsClient.d.ts

@@ -24,7 +24,7 @@ export interface SmsSendRequest {
     message: string;
 }
 /**
- * Options to configure Sms requests
+ * Options to configure Sms requests.
  */
 export interface SmsSendOptions extends OperationOptions {
     /**
@@ -40,6 +40,9 @@ export interface SmsSendOptions extends OperationOptions {
     /** Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. */
     deliveryReportTimeoutInSeconds?: number;
 }
+/**
+ * The result of Sms send request.
+ */
 export interface SmsSendResult {
     /**
      * The recipient's phone number in E.164 format.
@@ -62,12 +65,117 @@ export interface SmsSendResult {
      */
     errorMessage?: string;
 }
+/**
+ * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you
+ * to call Opt Out Management Api methods.
+ */
+export interface OptOutsClient {
+    /**
+     * Adds phone numbers to the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    add(from: string, to: string[], options?: AddOptions): Promise<OptOutAddResult[]>;
+    /**
+     * Checks if phone numbers are in the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    check(from: string, to: string[], options?: CheckOptions): Promise<OptOutCheckResult[]>;
+    /**
+     * Removes phone numbers from the optouts list.
+     *
+     * @param from - The sender's phone number
+     * @param to - The recipient's phone numbers
+     * @param options - Additional request options
+     */
+    remove(from: string, to: string[], options?: RemoveOptions): Promise<OptOutRemoveResult[]>;
+}
+/**
+ * Client options used to configure OptOuts Client API Add requests.
+ */
+export interface AddOptions extends OperationOptions {
+}
+/**
+ * Client options used to configure OptOuts Client API Check requests.
+ */
+export interface CheckOptions extends OperationOptions {
+}
+/**
+ * Client options used to configure OptOuts Client API Remove requests.
+ */
+export interface RemoveOptions extends OperationOptions {
+}
+/**
+ * The result of Opt Out Check request.
+ */
+export interface OptOutCheckResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * Indicates if the recipient's phone number in opted out from receiving messages or not.
+     */
+    isOptedOut: boolean;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
+/**
+ * The result of Opt Out Add request.
+ */
+export interface OptOutAddResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
+/**
+ * The result of Opt Out Remove request.
+ */
+export interface OptOutRemoveResult {
+    /**
+     * The recipient's phone number in E.164 format.
+     */
+    to: string;
+    /**
+     * HTTP Status code.
+     */
+    httpStatusCode: number;
+    /**
+     * Optional error message in case of 4xx/5xx/repeatable errors.
+     */
+    errorMessage?: string;
+}
 /**
  * A SmsClient represents a Client to the Azure Communication Sms service allowing you
  * to send SMS messages.
  */
 export declare class SmsClient {
     private readonly api;
+    /**
+     * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you
+     * to call Opt Out Management Api methods.
+     */
+    optOuts: OptOutsClient;
     /**
      * Initializes a new instance of the SmsClient class.
      * @param connectionString - Connection string to connect to an Azure Communication Service resource.

package/dist/commonjs/smsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"smsClient.d.ts","sourceRoot":"","sources":["../../src/smsClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAQhF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;CAAG;AAEhE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,EAAE,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kHAAkH;IAClH,8BAA8B,CAAC,EAAE,MAAM,CAAC;CACzC;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAUD;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IAEnC;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAEhE;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAEnF;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAwBrF;;;;;OAKG;IACU,IAAI,CACf,WAAW,EAAE,cAAc,EAC3B,OAAO,GAAE,cAAgD,GACxD,OAAO,CAAC,aAAa,EAAE,CAAC;CAU5B"}
+{"version":3,"file":"smsClient.d.ts","sourceRoot":"","sources":["../../src/smsClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAShF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;CAAG;AAEhE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,EAAE,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kHAAkH;IAClH,8BAA8B,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAClF;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACxF;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CAC5F;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,gBAAgB;CAAG;AAEvD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;CAAG;AAEzD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;CAAG;AAE1D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAUD;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC;;;OAGG;IACI,OAAO,EAAE,aAAa,CAAC;IAE9B;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAEhE;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAEnF;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAyBrF;;;;;OAKG;IACU,IAAI,CACf,WAAW,EAAE,cAAc,EAC3B,OAAO,GAAE,cAAgD,GACxD,OAAO,CAAC,aAAa,EAAE,CAAC;CAU5B"}

package/dist/commonjs/smsClient.js

@@ -11,6 +11,7 @@ const extractOperationOptions_js_1 = require("./extractOperationOptions.js");
 const smsUtils_js_1 = require("./utils/smsUtils.js");
 const logger_js_1 = require("./logger.js");
 const tracing_js_1 = require("./generated/src/tracing.js");
+const optOutsClient_js_1 = require("./optOutsClient.js");
 /**
  * Checks whether the type of a value is SmsClientOptions or not.
  *
@@ -33,6 +34,7 @@ class SmsClient {
         const authPolicy = (0, communication_common_1.createCommunicationAuthPolicy)(credential);
         this.api = new smsApiClient_js_1.SmsApiClient(url, internalPipelineOptions);
         this.api.pipeline.addPolicy(authPolicy);
+        this.optOuts = new optOutsClient_js_1.OptOutsClient(this.api);
     }
     /**
      * Sends an SMS from a phone number that is acquired by the authenticated account, to another phone number.

package/dist/commonjs/smsClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"smsClient.js","sourceRoot":"","sources":["../../src/smsClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,4CAA4C;;;AAE5C,sEAIqC;AAErC,gDAAqD;AAGrD,qEAA+D;AAC/D,6EAAuE;AACvE,qDAAiE;AACjE,2CAAqC;AACrC,2DAA2D;AAmE3D;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAAY,EAA+B,EAAE,CACvE,CAAC,CAAC,OAAO,IAAI,CAAC,IAAA,6BAAiB,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,sCAAe,EAAC,OAAO,CAAC,CAAC;AAExE;;;GAGG;AACH,MAAa,SAAS;IA2BpB,YACE,qBAA6B,EAC7B,mBAAwE,EACxE,eAAiC,EAAE;QAEnC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAA,2CAAoB,EAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;QAC7F,MAAM,OAAO,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC;QAE7F,MAAM,uBAAuB,mCACxB,OAAO,GACP;YACD,cAAc,EAAE;gBACd,MAAM,EAAE,kBAAM,CAAC,IAAI;aACpB;SACF,CACF,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,oDAA6B,EAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAY,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,WAA2B,EAC3B,UAA0B,EAAE,oBAAoB,EAAE,KAAK,EAAE;QAEzD,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAA,oDAAuB,EAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,0BAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CACtC,IAAA,wCAA0B,EAAC,WAAW,EAAE,WAAW,CAAC,EACpD,cAAc,CACf,CAAC;YACF,OAAO,QAAQ,CAAC,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApED,8BAoEC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/// <reference lib=\"esnext.asynciterable\" />\n\nimport {\n  createCommunicationAuthPolicy,\n  isKeyCredential,\n  parseClientArguments,\n} from \"@azure/communication-common\";\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport type { CommonClientOptions, OperationOptions } from \"@azure/core-client\";\nimport type { InternalPipelineOptions } from \"@azure/core-rest-pipeline\";\nimport { SmsApiClient } from \"./generated/src/smsApiClient.js\";\nimport { extractOperationOptions } from \"./extractOperationOptions.js\";\nimport { generateSendMessageRequest } from \"./utils/smsUtils.js\";\nimport { logger } from \"./logger.js\";\nimport { tracingClient } from \"./generated/src/tracing.js\";\n\n/**\n * Client options used to configure SMS Client API requests.\n */\nexport interface SmsClientOptions extends CommonClientOptions {}\n\n/**\n * Values used to configure Sms message\n */\nexport interface SmsSendRequest {\n  /**\n   * The sender's phone number in E.164 format that is owned by the authenticated account.\n   */\n  from: string;\n  /**\n   * The list of recipient's phone number in E.164 format.\n   */\n  to: string[];\n  /**\n   * The contents of the message that will be sent to the recipient. The allowable content is\n   * defined by RFC 5724.\n   */\n  message: string;\n}\n\n/**\n * Options to configure Sms requests\n */\nexport interface SmsSendOptions extends OperationOptions {\n  /**\n   * Enable this flag to receive a delivery report for this message on the Azure Resource\n   * EventGrid. Default value: false.\n   */\n  enableDeliveryReport?: boolean;\n  /**\n   * Use this field to provide metadata that will then be sent back in the corresponding Delivery\n   * Report.\n   */\n  tag?: string;\n  /** Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. */\n  deliveryReportTimeoutInSeconds?: number;\n}\n\nexport interface SmsSendResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * The identifier of the outgoing Sms message. Only present if message processed.\n   */\n  messageId?: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Indicates if the message is processed successfully or not.\n   */\n  successful: boolean;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * Checks whether the type of a value is SmsClientOptions or not.\n *\n * @param options - The value being checked.\n */\nconst isSmsClientOptions = (options: any): options is SmsClientOptions =>\n  !!options && !isTokenCredential(options) && !isKeyCredential(options);\n\n/**\n * A SmsClient represents a Client to the Azure Communication Sms service allowing you\n * to send SMS messages.\n */\nexport class SmsClient {\n  private readonly api: SmsApiClient;\n\n  /**\n   * Initializes a new instance of the SmsClient class.\n   * @param connectionString - Connection string to connect to an Azure Communication Service resource.\n   *                         Example: \"endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret\";\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(connectionString: string, options?: SmsClientOptions);\n\n  /**\n   * Initializes a new instance of the SmsClient class using an Azure KeyCredential.\n   * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).\n   * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(endpoint: string, credential: KeyCredential, options?: SmsClientOptions);\n\n  /**\n   * Initializes a new instance of the SmsClient class using a TokenCredential.\n   * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).\n   * @param credential - TokenCredential that is used to authenticate requests to the service.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(endpoint: string, credential: TokenCredential, options?: SmsClientOptions);\n\n  constructor(\n    connectionStringOrUrl: string,\n    credentialOrOptions?: KeyCredential | TokenCredential | SmsClientOptions,\n    maybeOptions: SmsClientOptions = {},\n  ) {\n    const { url, credential } = parseClientArguments(connectionStringOrUrl, credentialOrOptions);\n    const options = isSmsClientOptions(credentialOrOptions) ? credentialOrOptions : maybeOptions;\n\n    const internalPipelineOptions: InternalPipelineOptions = {\n      ...options,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n        },\n      },\n    };\n\n    const authPolicy = createCommunicationAuthPolicy(credential);\n    this.api = new SmsApiClient(url, internalPipelineOptions);\n    this.api.pipeline.addPolicy(authPolicy);\n  }\n\n  /**\n   * Sends an SMS from a phone number that is acquired by the authenticated account, to another phone number.\n   *\n   * @param sendRequest - Provides the sender's and recipient's phone numbers, and the contents of the message\n   * @param options - Additional request options\n   */\n  public async send(\n    sendRequest: SmsSendRequest,\n    options: SmsSendOptions = { enableDeliveryReport: false },\n  ): Promise<SmsSendResult[]> {\n    const { operationOptions, restOptions } = extractOperationOptions(options);\n    return tracingClient.withSpan(\"SmsClient-Send\", operationOptions, async (updatedOptions) => {\n      const response = await this.api.sms.send(\n        generateSendMessageRequest(sendRequest, restOptions),\n        updatedOptions,\n      );\n      return response.value;\n    });\n  }\n}\n"]}
+{"version":3,"file":"smsClient.js","sourceRoot":"","sources":["../../src/smsClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,4CAA4C;;;AAE5C,sEAIqC;AAErC,gDAAqD;AAGrD,qEAA+D;AAC/D,6EAAuE;AACvE,qDAAiE;AACjE,2CAAqC;AACrC,2DAA2D;AAC3D,yDAAwE;AA8KxE;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAAY,EAA+B,EAAE,CACvE,CAAC,CAAC,OAAO,IAAI,CAAC,IAAA,6BAAiB,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,sCAAe,EAAC,OAAO,CAAC,CAAC;AAExE;;;GAGG;AACH,MAAa,SAAS;IAgCpB,YACE,qBAA6B,EAC7B,mBAAwE,EACxE,eAAiC,EAAE;QAEnC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAA,2CAAoB,EAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;QAC7F,MAAM,OAAO,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC;QAE7F,MAAM,uBAAuB,mCACxB,OAAO,GACP;YACD,cAAc,EAAE;gBACd,MAAM,EAAE,kBAAM,CAAC,IAAI;aACpB;SACF,CACF,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,oDAA6B,EAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAY,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,gCAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,WAA2B,EAC3B,UAA0B,EAAE,oBAAoB,EAAE,KAAK,EAAE;QAEzD,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAA,oDAAuB,EAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,0BAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CACtC,IAAA,wCAA0B,EAAC,WAAW,EAAE,WAAW,CAAC,EACpD,cAAc,CACf,CAAC;YACF,OAAO,QAAQ,CAAC,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1ED,8BA0EC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/// <reference lib=\"esnext.asynciterable\" />\n\nimport {\n  createCommunicationAuthPolicy,\n  isKeyCredential,\n  parseClientArguments,\n} from \"@azure/communication-common\";\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport type { CommonClientOptions, OperationOptions } from \"@azure/core-client\";\nimport type { InternalPipelineOptions } from \"@azure/core-rest-pipeline\";\nimport { SmsApiClient } from \"./generated/src/smsApiClient.js\";\nimport { extractOperationOptions } from \"./extractOperationOptions.js\";\nimport { generateSendMessageRequest } from \"./utils/smsUtils.js\";\nimport { logger } from \"./logger.js\";\nimport { tracingClient } from \"./generated/src/tracing.js\";\nimport { OptOutsClient as OptOutsClientImpl } from \"./optOutsClient.js\";\n\n/**\n * Client options used to configure SMS Client API requests.\n */\nexport interface SmsClientOptions extends CommonClientOptions {}\n\n/**\n * Values used to configure Sms message\n */\nexport interface SmsSendRequest {\n  /**\n   * The sender's phone number in E.164 format that is owned by the authenticated account.\n   */\n  from: string;\n  /**\n   * The list of recipient's phone number in E.164 format.\n   */\n  to: string[];\n  /**\n   * The contents of the message that will be sent to the recipient. The allowable content is\n   * defined by RFC 5724.\n   */\n  message: string;\n}\n\n/**\n * Options to configure Sms requests.\n */\nexport interface SmsSendOptions extends OperationOptions {\n  /**\n   * Enable this flag to receive a delivery report for this message on the Azure Resource\n   * EventGrid. Default value: false.\n   */\n  enableDeliveryReport?: boolean;\n  /**\n   * Use this field to provide metadata that will then be sent back in the corresponding Delivery\n   * Report.\n   */\n  tag?: string;\n  /** Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. */\n  deliveryReportTimeoutInSeconds?: number;\n}\n\n/**\n * The result of Sms send request.\n */\nexport interface SmsSendResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * The identifier of the outgoing Sms message. Only present if message processed.\n   */\n  messageId?: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Indicates if the message is processed successfully or not.\n   */\n  successful: boolean;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you\n * to call Opt Out Management Api methods.\n */\nexport interface OptOutsClient {\n  /**\n   * Adds phone numbers to the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  add(from: string, to: string[], options?: AddOptions): Promise<OptOutAddResult[]>;\n  /**\n   * Checks if phone numbers are in the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  check(from: string, to: string[], options?: CheckOptions): Promise<OptOutCheckResult[]>;\n  /**\n   * Removes phone numbers from the optouts list.\n   *\n   * @param from - The sender's phone number\n   * @param to - The recipient's phone numbers\n   * @param options - Additional request options\n   */\n  remove(from: string, to: string[], options?: RemoveOptions): Promise<OptOutRemoveResult[]>;\n}\n\n/**\n * Client options used to configure OptOuts Client API Add requests.\n */\nexport interface AddOptions extends OperationOptions {}\n\n/**\n * Client options used to configure OptOuts Client API Check requests.\n */\nexport interface CheckOptions extends OperationOptions {}\n\n/**\n * Client options used to configure OptOuts Client API Remove requests.\n */\nexport interface RemoveOptions extends OperationOptions {}\n\n/**\n * The result of Opt Out Check request.\n */\nexport interface OptOutCheckResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * Indicates if the recipient's phone number in opted out from receiving messages or not.\n   */\n  isOptedOut: boolean;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * The result of Opt Out Add request.\n */\nexport interface OptOutAddResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * The result of Opt Out Remove request.\n */\nexport interface OptOutRemoveResult {\n  /**\n   * The recipient's phone number in E.164 format.\n   */\n  to: string;\n  /**\n   * HTTP Status code.\n   */\n  httpStatusCode: number;\n  /**\n   * Optional error message in case of 4xx/5xx/repeatable errors.\n   */\n  errorMessage?: string;\n}\n\n/**\n * Checks whether the type of a value is SmsClientOptions or not.\n *\n * @param options - The value being checked.\n */\nconst isSmsClientOptions = (options: any): options is SmsClientOptions =>\n  !!options && !isTokenCredential(options) && !isKeyCredential(options);\n\n/**\n * A SmsClient represents a Client to the Azure Communication Sms service allowing you\n * to send SMS messages.\n */\nexport class SmsClient {\n  private readonly api: SmsApiClient;\n  /**\n   * A OptOutsClient represents a Client to the Azure Communication Sms service allowing you\n   * to call Opt Out Management Api methods.\n   */\n  public optOuts: OptOutsClient;\n\n  /**\n   * Initializes a new instance of the SmsClient class.\n   * @param connectionString - Connection string to connect to an Azure Communication Service resource.\n   *                         Example: \"endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret\";\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(connectionString: string, options?: SmsClientOptions);\n\n  /**\n   * Initializes a new instance of the SmsClient class using an Azure KeyCredential.\n   * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).\n   * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(endpoint: string, credential: KeyCredential, options?: SmsClientOptions);\n\n  /**\n   * Initializes a new instance of the SmsClient class using a TokenCredential.\n   * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).\n   * @param credential - TokenCredential that is used to authenticate requests to the service.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  constructor(endpoint: string, credential: TokenCredential, options?: SmsClientOptions);\n\n  constructor(\n    connectionStringOrUrl: string,\n    credentialOrOptions?: KeyCredential | TokenCredential | SmsClientOptions,\n    maybeOptions: SmsClientOptions = {},\n  ) {\n    const { url, credential } = parseClientArguments(connectionStringOrUrl, credentialOrOptions);\n    const options = isSmsClientOptions(credentialOrOptions) ? credentialOrOptions : maybeOptions;\n\n    const internalPipelineOptions: InternalPipelineOptions = {\n      ...options,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n        },\n      },\n    };\n\n    const authPolicy = createCommunicationAuthPolicy(credential);\n    this.api = new SmsApiClient(url, internalPipelineOptions);\n    this.api.pipeline.addPolicy(authPolicy);\n    this.optOuts = new OptOutsClientImpl(this.api);\n  }\n\n  /**\n   * Sends an SMS from a phone number that is acquired by the authenticated account, to another phone number.\n   *\n   * @param sendRequest - Provides the sender's and recipient's phone numbers, and the contents of the message\n   * @param options - Additional request options\n   */\n  public async send(\n    sendRequest: SmsSendRequest,\n    options: SmsSendOptions = { enableDeliveryReport: false },\n  ): Promise<SmsSendResult[]> {\n    const { operationOptions, restOptions } = extractOperationOptions(options);\n    return tracingClient.withSpan(\"SmsClient-Send\", operationOptions, async (updatedOptions) => {\n      const response = await this.api.sms.send(\n        generateSendMessageRequest(sendRequest, restOptions),\n        updatedOptions,\n      );\n      return response.value;\n    });\n  }\n}\n"]}

package/dist/commonjs/utils/smsUtils.d.ts

@@ -1,4 +1,5 @@
-import type { SendMessageRequest } from "../generated/src/models/index.js";
+import type { SendMessageRequest, OptOutRequest } from "../generated/src/models/index.js";
 import type { SmsSendOptions, SmsSendRequest } from "../smsClient.js";
 export declare function generateSendMessageRequest(smsRequest: SmsSendRequest, options?: SmsSendOptions): SendMessageRequest;
+export declare function generateOptOutRequest(from: string, to: string[]): OptOutRequest;
 //# sourceMappingURL=smsUtils.d.ts.map

package/dist/commonjs/utils/smsUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"smsUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/smsUtils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAItE,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,cAAc,EAC1B,OAAO,GAAE,cAAmB,GAC3B,kBAAkB,CAuBpB"}
+{"version":3,"file":"smsUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/smsUtils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAC1F,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAItE,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,cAAc,EAC1B,OAAO,GAAE,cAAmB,GAC3B,kBAAkB,CAuBpB;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,aAAa,CAS/E"}

package/dist/commonjs/utils/smsUtils.js

@@ -3,6 +3,7 @@
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSendMessageRequest = generateSendMessageRequest;
+exports.generateOptOutRequest = generateOptOutRequest;
 const uuid_js_1 = require("./uuid.js");
 function generateSendMessageRequest(smsRequest, options = {}) {
     var _a, _b;
@@ -25,4 +26,14 @@ function generateSendMessageRequest(smsRequest, options = {}) {
         smsSendOptions: Object.assign({ enableDeliveryReport: (_b = options.enableDeliveryReport) !== null && _b !== void 0 ? _b : false }, (options.tag && { tag: options.tag })),
     };
 }
+function generateOptOutRequest(from, to) {
+    return {
+        from: from,
+        recipients: to.map((phoneNumberStr) => {
+            return {
+                to: phoneNumberStr,
+            };
+        }),
+    };
+}
 //# sourceMappingURL=smsUtils.js.map

package/dist/commonjs/utils/smsUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"smsUtils.js","sourceRoot":"","sources":["../../../src/utils/smsUtils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAOlC,gEA0BC;AA7BD,uCAAiC;AAGjC,SAAgB,0BAA0B,CACxC,UAA0B,EAC1B,UAA0B,EAAE;;IAE5B,MAAM,eAAe,GAAoB;QACvC,oBAAoB,EAAE,MAAA,OAAO,CAAC,oBAAoB,mCAAI,KAAK;KAC5D,CAAC;IACF,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,eAAe,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IACvC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,aAAa,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YAClD,OAAO;gBACL,EAAE,EAAE,cAAc;gBAClB,sBAAsB,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC1D,sBAAsB,EAAE,cAAI,CAAC,YAAY,EAAE;aAC5C,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,cAAc,kBACZ,oBAAoB,EAAE,MAAA,OAAO,CAAC,oBAAoB,mCAAI,KAAK,IACxD,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CACzC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { SendMessageRequest } from \"../generated/src/models/index.js\";\nimport type { SmsSendOptions, SmsSendRequest } from \"../smsClient.js\";\nimport { Uuid } from \"./uuid.js\";\nimport type { SmsSendOptions as InternalOptions } from \"../generated/src/models/index.js\";\n\nexport function generateSendMessageRequest(\n  smsRequest: SmsSendRequest,\n  options: SmsSendOptions = {},\n): SendMessageRequest {\n  const _smsSendOptions: InternalOptions = {\n    enableDeliveryReport: options.enableDeliveryReport ?? false,\n  };\n  if (options.tag) {\n    _smsSendOptions[\"tag\"] = options.tag;\n  }\n\n  return {\n    from: smsRequest.from,\n    smsRecipients: smsRequest.to.map((phoneNumberStr) => {\n      return {\n        to: phoneNumberStr,\n        repeatabilityFirstSent: new Date(Date.now()).toUTCString(),\n        repeatabilityRequestId: Uuid.generateUuid(),\n      };\n    }),\n    message: smsRequest.message,\n    smsSendOptions: {\n      enableDeliveryReport: options.enableDeliveryReport ?? false,\n      ...(options.tag && { tag: options.tag }),\n    },\n  };\n}\n"]}
+{"version":3,"file":"smsUtils.js","sourceRoot":"","sources":["../../../src/utils/smsUtils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAOlC,gEA0BC;AAED,sDASC;AAxCD,uCAAiC;AAGjC,SAAgB,0BAA0B,CACxC,UAA0B,EAC1B,UAA0B,EAAE;;IAE5B,MAAM,eAAe,GAAoB;QACvC,oBAAoB,EAAE,MAAA,OAAO,CAAC,oBAAoB,mCAAI,KAAK;KAC5D,CAAC;IACF,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,eAAe,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IACvC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,aAAa,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YAClD,OAAO;gBACL,EAAE,EAAE,cAAc;gBAClB,sBAAsB,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC1D,sBAAsB,EAAE,cAAI,CAAC,YAAY,EAAE;aAC5C,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,cAAc,kBACZ,oBAAoB,EAAE,MAAA,OAAO,CAAC,oBAAoB,mCAAI,KAAK,IACxD,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CACzC;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,qBAAqB,CAAC,IAAY,EAAE,EAAY;IAC9D,OAAO;QACL,IAAI,EAAE,IAAI;QACV,UAAU,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YACpC,OAAO;gBACL,EAAE,EAAE,cAAc;aACnB,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { SendMessageRequest, OptOutRequest } from \"../generated/src/models/index.js\";\nimport type { SmsSendOptions, SmsSendRequest } from \"../smsClient.js\";\nimport { Uuid } from \"./uuid.js\";\nimport type { SmsSendOptions as InternalOptions } from \"../generated/src/models/index.js\";\n\nexport function generateSendMessageRequest(\n  smsRequest: SmsSendRequest,\n  options: SmsSendOptions = {},\n): SendMessageRequest {\n  const _smsSendOptions: InternalOptions = {\n    enableDeliveryReport: options.enableDeliveryReport ?? false,\n  };\n  if (options.tag) {\n    _smsSendOptions[\"tag\"] = options.tag;\n  }\n\n  return {\n    from: smsRequest.from,\n    smsRecipients: smsRequest.to.map((phoneNumberStr) => {\n      return {\n        to: phoneNumberStr,\n        repeatabilityFirstSent: new Date(Date.now()).toUTCString(),\n        repeatabilityRequestId: Uuid.generateUuid(),\n      };\n    }),\n    message: smsRequest.message,\n    smsSendOptions: {\n      enableDeliveryReport: options.enableDeliveryReport ?? false,\n      ...(options.tag && { tag: options.tag }),\n    },\n  };\n}\n\nexport function generateOptOutRequest(from: string, to: string[]): OptOutRequest {\n  return {\n    from: from,\n    recipients: to.map((phoneNumberStr) => {\n      return {\n        to: phoneNumberStr,\n      };\n    }),\n  };\n}\n"]}

package/dist/esm/constants.js

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-export const SDK_VERSION = "1.2.0-beta.1";
+export const SDK_VERSION = "1.2.0-beta.2";
 //# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.2.0-beta.1\";\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.2.0-beta.2\";\n"]}

package/dist/esm/generated/src/models/index.d.ts

@@ -47,6 +47,30 @@ export interface SmsSendResponseItem {
     /** Optional error message in case of 4xx/5xx/repeatable errors. */
     errorMessage?: string;
 }
+/** An opt out request. */
+export interface OptOutRequest {
+    /** The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account. */
+    from: string;
+    recipients: OptOutRecipient[];
+}
+/** A single opt out recipient number. */
+export interface OptOutRecipient {
+    /** The recipient's phone number (in E.164 format). */
+    to: string;
+}
+/** Response for an opt out request. Validate the returned items in the response to see which recipients were successfully added or removed from the opt outs list. */
+export interface OptOutResponse {
+    value: OptOutResponseItem[];
+}
+export interface OptOutResponseItem {
+    /** The recipient phone number (in E.164 format). */
+    to: string;
+    httpStatusCode: number;
+    /** Optional flag specifying if number was Opted Out from receiving messages */
+    isOptedOut?: boolean;
+    /** Optional error message in case of 4xx/5xx errors. */
+    errorMessage?: string;
+}
 /** Known values of {@link SmsSendResponseItemRepeatabilityResult} that the service accepts. */
 export declare enum KnownSmsSendResponseItemRepeatabilityResult {
     /** Accepted */
@@ -69,6 +93,21 @@ export interface SmsSendOptionalParams extends coreClient.OperationOptions {
 /** Contains response data for the send operation. */
 export type SmsSendOperationResponse = SmsSendResponse;
 /** Optional parameters. */
+export interface OptOutsAddOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the add operation. */
+export type OptOutsAddResponse = OptOutResponse;
+/** Optional parameters. */
+export interface OptOutsRemoveOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the remove operation. */
+export type OptOutsRemoveResponse = OptOutResponse;
+/** Optional parameters. */
+export interface OptOutsCheckOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the check operation. */
+export type OptOutsCheckResponse = OptOutResponse;
+/** Optional parameters. */
 export interface SmsApiClientOptionalParams extends coreClient.ServiceClientOptions {
     /** Api Version */
     apiVersion?: string;

package/dist/esm/generated/src/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB;IACjC,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,uIAAuI;IACvI,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,oHAAoH;IACpH,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,kDAAkD;AAClD,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,ocAAoc;IACpc,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,8MAA8M;IAC9M,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,sGAAsG;IACtG,oBAAoB,EAAE,OAAO,CAAC;IAC9B,2GAA2G;IAC3G,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kHAAkH;IAClH,8BAA8B,CAAC,EAAE,MAAM,CAAC;CACzC;AAED,kEAAkE;AAClE,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B;AAED,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,uGAAuG;IACvG,mBAAmB,CAAC,EAAE,sCAAsC,CAAC;IAC7D,iEAAiE;IACjE,UAAU,EAAE,OAAO,CAAC;IACpB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+FAA+F;AAC/F,oBAAY,2CAA2C;IACrD,eAAe;IACf,QAAQ,aAAa;IACrB,eAAe;IACf,QAAQ,aAAa;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG,MAAM,CAAC;AAE5D,2BAA2B;AAC3B,MAAM,WAAW,qBAAsB,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAE7E,qDAAqD;AACrD,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;AAEvD,2BAA2B;AAC3B,MAAM,WAAW,0BACf,SAAQ,UAAU,CAAC,oBAAoB;IACvC,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB;IACjC,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,uIAAuI;IACvI,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,oHAAoH;IACpH,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,kDAAkD;AAClD,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,ocAAoc;IACpc,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,8MAA8M;IAC9M,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,sGAAsG;IACtG,oBAAoB,EAAE,OAAO,CAAC;IAC9B,2GAA2G;IAC3G,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kHAAkH;IAClH,8BAA8B,CAAC,EAAE,MAAM,CAAC;CACzC;AAED,kEAAkE;AAClE,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B;AAED,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,uGAAuG;IACvG,mBAAmB,CAAC,EAAE,sCAAsC,CAAC;IAC7D,iEAAiE;IACjE,UAAU,EAAE,OAAO,CAAC;IACpB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,0BAA0B;AAC1B,MAAM,WAAW,aAAa;IAC5B,mHAAmH;IACnH,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,sKAAsK;AACtK,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,kBAAkB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+FAA+F;AAC/F,oBAAY,2CAA2C;IACrD,eAAe;IACf,QAAQ,aAAa;IACrB,eAAe;IACf,QAAQ,aAAa;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG,MAAM,CAAC;AAE5D,2BAA2B;AAC3B,MAAM,WAAW,qBAAsB,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAE7E,qDAAqD;AACrD,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;AAEvD,2BAA2B;AAC3B,MAAM,WAAW,wBAAyB,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAEhF,oDAAoD;AACpD,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC;AAEhD,2BAA2B;AAC3B,MAAM,WAAW,2BACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAAC;AAEnD,2BAA2B;AAC3B,MAAM,WAAW,0BACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,sDAAsD;AACtD,MAAM,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAElD,2BAA2B;AAC3B,MAAM,WAAW,0BACf,SAAQ,UAAU,CAAC,oBAAoB;IACvC,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/esm/generated/src/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAyDH,+FAA+F;AAC/F,MAAM,CAAN,IAAY,2CAKX;AALD,WAAY,2CAA2C;IACrD,eAAe;IACf,oEAAqB,CAAA;IACrB,eAAe;IACf,oEAAqB,CAAA;AACvB,CAAC,EALW,2CAA2C,KAA3C,2CAA2C,QAKtD","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\n\n/** Represents the properties of a send message request. */\nexport interface SendMessageRequest {\n  /** The sender's phone number in E.164 format that is owned by the authenticated account. */\n  from: string;\n  /** The recipient's phone number in E.164 format. In this version, a minimum of 1 and upto 100 recipients in the list are supported. */\n  smsRecipients: SmsRecipient[];\n  /** The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724. */\n  message: string;\n  /** Optional configuration for sending SMS messages. */\n  smsSendOptions?: SmsSendOptions;\n}\n\n/** Recipient details for sending SMS messages. */\nexport interface SmsRecipient {\n  /** The recipient's phone number in E.164 format. */\n  to: string;\n  /** If specified, the client directs that the request is repeatable; that is, the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, 36-character hexadecimal case-insensitive encoding of a UUID (GUID), identifier for the request. */\n  repeatabilityRequestId?: string;\n  /** MUST be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created.eg- Tue, 26 Mar 2019 16:06:51 GMT */\n  repeatabilityFirstSent?: string;\n}\n\n/** Optional configuration for sending SMS messages. */\nexport interface SmsSendOptions {\n  /** Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid. */\n  enableDeliveryReport: boolean;\n  /** Use this field to provide metadata that will then be sent back in the corresponding Delivery Report. */\n  tag?: string;\n  /** Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. */\n  deliveryReportTimeoutInSeconds?: number;\n}\n\n/** Response for a successful or multi status send Sms request. */\nexport interface SmsSendResponse {\n  value: SmsSendResponseItem[];\n}\n\n/** Response for a single recipient. */\nexport interface SmsSendResponseItem {\n  /** The recipient's phone number in E.164 format. */\n  to: string;\n  /** The identifier of the outgoing Sms message. Only present if message processed. */\n  messageId?: string;\n  /** HTTP Status code. */\n  httpStatusCode: number;\n  /** The result of a repeatable request with one of the case-insensitive values accepted or rejected. */\n  repeatabilityResult?: SmsSendResponseItemRepeatabilityResult;\n  /** Indicates if the message is processed successfully or not. */\n  successful: boolean;\n  /** Optional error message in case of 4xx/5xx/repeatable errors. */\n  errorMessage?: string;\n}\n\n/** Known values of {@link SmsSendResponseItemRepeatabilityResult} that the service accepts. */\nexport enum KnownSmsSendResponseItemRepeatabilityResult {\n  /** Accepted */\n  Accepted = \"accepted\",\n  /** Rejected */\n  Rejected = \"rejected\",\n}\n\n/**\n * Defines values for SmsSendResponseItemRepeatabilityResult. \\\n * {@link KnownSmsSendResponseItemRepeatabilityResult} can be used interchangeably with SmsSendResponseItemRepeatabilityResult,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **accepted** \\\n * **rejected**\n */\nexport type SmsSendResponseItemRepeatabilityResult = string;\n\n/** Optional parameters. */\nexport interface SmsSendOptionalParams extends coreClient.OperationOptions {}\n\n/** Contains response data for the send operation. */\nexport type SmsSendOperationResponse = SmsSendResponse;\n\n/** Optional parameters. */\nexport interface SmsApiClientOptionalParams\n  extends coreClient.ServiceClientOptions {\n  /** Api Version */\n  apiVersion?: string;\n  /** Overrides client endpoint. */\n  endpoint?: string;\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAqFH,+FAA+F;AAC/F,MAAM,CAAN,IAAY,2CAKX;AALD,WAAY,2CAA2C;IACrD,eAAe;IACf,oEAAqB,CAAA;IACrB,eAAe;IACf,oEAAqB,CAAA;AACvB,CAAC,EALW,2CAA2C,KAA3C,2CAA2C,QAKtD","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\n\n/** Represents the properties of a send message request. */\nexport interface SendMessageRequest {\n  /** The sender's phone number in E.164 format that is owned by the authenticated account. */\n  from: string;\n  /** The recipient's phone number in E.164 format. In this version, a minimum of 1 and upto 100 recipients in the list are supported. */\n  smsRecipients: SmsRecipient[];\n  /** The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724. */\n  message: string;\n  /** Optional configuration for sending SMS messages. */\n  smsSendOptions?: SmsSendOptions;\n}\n\n/** Recipient details for sending SMS messages. */\nexport interface SmsRecipient {\n  /** The recipient's phone number in E.164 format. */\n  to: string;\n  /** If specified, the client directs that the request is repeatable; that is, the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, 36-character hexadecimal case-insensitive encoding of a UUID (GUID), identifier for the request. */\n  repeatabilityRequestId?: string;\n  /** MUST be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created.eg- Tue, 26 Mar 2019 16:06:51 GMT */\n  repeatabilityFirstSent?: string;\n}\n\n/** Optional configuration for sending SMS messages. */\nexport interface SmsSendOptions {\n  /** Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid. */\n  enableDeliveryReport: boolean;\n  /** Use this field to provide metadata that will then be sent back in the corresponding Delivery Report. */\n  tag?: string;\n  /** Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. */\n  deliveryReportTimeoutInSeconds?: number;\n}\n\n/** Response for a successful or multi status send Sms request. */\nexport interface SmsSendResponse {\n  value: SmsSendResponseItem[];\n}\n\n/** Response for a single recipient. */\nexport interface SmsSendResponseItem {\n  /** The recipient's phone number in E.164 format. */\n  to: string;\n  /** The identifier of the outgoing Sms message. Only present if message processed. */\n  messageId?: string;\n  /** HTTP Status code. */\n  httpStatusCode: number;\n  /** The result of a repeatable request with one of the case-insensitive values accepted or rejected. */\n  repeatabilityResult?: SmsSendResponseItemRepeatabilityResult;\n  /** Indicates if the message is processed successfully or not. */\n  successful: boolean;\n  /** Optional error message in case of 4xx/5xx/repeatable errors. */\n  errorMessage?: string;\n}\n\n/** An opt out request. */\nexport interface OptOutRequest {\n  /** The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account. */\n  from: string;\n  recipients: OptOutRecipient[];\n}\n\n/** A single opt out recipient number. */\nexport interface OptOutRecipient {\n  /** The recipient's phone number (in E.164 format). */\n  to: string;\n}\n\n/** Response for an opt out request. Validate the returned items in the response to see which recipients were successfully added or removed from the opt outs list. */\nexport interface OptOutResponse {\n  value: OptOutResponseItem[];\n}\n\nexport interface OptOutResponseItem {\n  /** The recipient phone number (in E.164 format). */\n  to: string;\n  httpStatusCode: number;\n  /** Optional flag specifying if number was Opted Out from receiving messages */\n  isOptedOut?: boolean;\n  /** Optional error message in case of 4xx/5xx errors. */\n  errorMessage?: string;\n}\n\n/** Known values of {@link SmsSendResponseItemRepeatabilityResult} that the service accepts. */\nexport enum KnownSmsSendResponseItemRepeatabilityResult {\n  /** Accepted */\n  Accepted = \"accepted\",\n  /** Rejected */\n  Rejected = \"rejected\",\n}\n\n/**\n * Defines values for SmsSendResponseItemRepeatabilityResult. \\\n * {@link KnownSmsSendResponseItemRepeatabilityResult} can be used interchangeably with SmsSendResponseItemRepeatabilityResult,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **accepted** \\\n * **rejected**\n */\nexport type SmsSendResponseItemRepeatabilityResult = string;\n\n/** Optional parameters. */\nexport interface SmsSendOptionalParams extends coreClient.OperationOptions {}\n\n/** Contains response data for the send operation. */\nexport type SmsSendOperationResponse = SmsSendResponse;\n\n/** Optional parameters. */\nexport interface OptOutsAddOptionalParams extends coreClient.OperationOptions {}\n\n/** Contains response data for the add operation. */\nexport type OptOutsAddResponse = OptOutResponse;\n\n/** Optional parameters. */\nexport interface OptOutsRemoveOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the remove operation. */\nexport type OptOutsRemoveResponse = OptOutResponse;\n\n/** Optional parameters. */\nexport interface OptOutsCheckOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the check operation. */\nexport type OptOutsCheckResponse = OptOutResponse;\n\n/** Optional parameters. */\nexport interface SmsApiClientOptionalParams\n  extends coreClient.ServiceClientOptions {\n  /** Api Version */\n  apiVersion?: string;\n  /** Overrides client endpoint. */\n  endpoint?: string;\n}\n"]}

package/dist/esm/generated/src/models/mappers.d.ts

@@ -4,4 +4,8 @@ export declare const SmsRecipient: coreClient.CompositeMapper;
 export declare const SmsSendOptions: coreClient.CompositeMapper;
 export declare const SmsSendResponse: coreClient.CompositeMapper;
 export declare const SmsSendResponseItem: coreClient.CompositeMapper;
+export declare const OptOutRequest: coreClient.CompositeMapper;
+export declare const OptOutRecipient: coreClient.CompositeMapper;
+export declare const OptOutResponse: coreClient.CompositeMapper;
+export declare const OptOutResponseItem: coreClient.CompositeMapper;
 //# sourceMappingURL=mappers.d.ts.map

package/dist/esm/generated/src/models/mappers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/mappers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,eA4C3C,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eA0BrC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,UAAU,CAAC,eA8BvC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,eAoBxC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eA8C5C,CAAC"}
+{"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/mappers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,eA4C3C,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eA0BrC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,UAAU,CAAC,eA8BvC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,eAoBxC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eA8C5C,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,eAkCtC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,eAiBxC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,UAAU,CAAC,eAoBvC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,eAoC3C,CAAC"}