@azure/communication-sms
Version:
SDK for Azure Communication SMS service which facilitates the sending of SMS messages.
83 lines • 3.8 kB
JavaScript
;
// 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.remove((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