@azure-tools/communication-recipient-verification 1.0.0-alpha.20241119.1 → 1.0.0-alpha.20241122.8

package/dist/index.js

@@ -0,0 +1,661 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var coreAuth = require('@azure/core-auth');
+var communicationCommon = require('@azure/communication-common');
+var coreTracing = require('@azure/core-tracing');
+var logger$1 = require('@azure/logger');
+var coreClient = require('@azure/core-client');
+var coreRestPipeline = require('@azure/core-rest-pipeline');
+
+function _interopNamespaceDefault(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__*/_interopNamespaceDefault(coreClient);
+var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespaceDefault(coreRestPipeline);
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+const AcsVerification = {
+    type: {
+        name: "Composite",
+        className: "AcsVerification",
+        modelProperties: {
+            immutableId: {
+                serializedName: "ImmutableId",
+                type: {
+                    name: "String"
+                }
+            },
+            verificationId: {
+                serializedName: "VerificationId",
+                type: {
+                    name: "String"
+                }
+            },
+            status: {
+                serializedName: "Status",
+                type: {
+                    name: "String"
+                }
+            },
+            subscriptionId: {
+                serializedName: "SubscriptionId",
+                type: {
+                    name: "String"
+                }
+            },
+            identity: {
+                serializedName: "Identity",
+                type: {
+                    name: "String"
+                }
+            },
+            challengeId: {
+                serializedName: "ChallengeId",
+                type: {
+                    name: "String"
+                }
+            },
+            retries: {
+                serializedName: "Retries",
+                type: {
+                    name: "Number"
+                }
+            },
+            attempts: {
+                serializedName: "Attempts",
+                type: {
+                    name: "Number"
+                }
+            }
+        }
+    }
+};
+const CommunicationErrorResponse = {
+    type: {
+        name: "Composite",
+        className: "CommunicationErrorResponse",
+        modelProperties: {
+            error: {
+                serializedName: "error",
+                type: {
+                    name: "Composite",
+                    className: "CommunicationError"
+                }
+            }
+        }
+    }
+};
+const CommunicationError = {
+    type: {
+        name: "Composite",
+        className: "CommunicationError",
+        modelProperties: {
+            code: {
+                serializedName: "code",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            message: {
+                serializedName: "message",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            target: {
+                serializedName: "target",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            details: {
+                serializedName: "details",
+                readOnly: true,
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "CommunicationError"
+                        }
+                    }
+                }
+            },
+            innerError: {
+                serializedName: "innererror",
+                type: {
+                    name: "Composite",
+                    className: "CommunicationError"
+                }
+            }
+        }
+    }
+};
+const VerificationRequest = {
+    type: {
+        name: "Composite",
+        className: "VerificationRequest",
+        modelProperties: {
+            identity: {
+                serializedName: "Identity",
+                type: {
+                    name: "String"
+                }
+            },
+            channel: {
+                serializedName: "Channel",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const VerificationResponse = {
+    type: {
+        name: "Composite",
+        className: "VerificationResponse",
+        modelProperties: {
+            verificationId: {
+                serializedName: "VerificationId",
+                type: {
+                    name: "String"
+                }
+            },
+            isVerified: {
+                serializedName: "IsVerified",
+                type: {
+                    name: "Boolean"
+                }
+            }
+        }
+    }
+};
+const VerificationCodeRequest = {
+    type: {
+        name: "Composite",
+        className: "VerificationCodeRequest",
+        modelProperties: {
+            verificationCode: {
+                serializedName: "VerificationCode",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const VerificationConstantsResponse = {
+    type: {
+        name: "Composite",
+        className: "VerificationConstantsResponse",
+        modelProperties: {
+            maxRetriesAllowed: {
+                serializedName: "MaxRetriesAllowed",
+                type: {
+                    name: "Number"
+                }
+            },
+            maxVerificationsAllowed: {
+                serializedName: "MaxVerificationsAllowed",
+                type: {
+                    name: "Number"
+                }
+            },
+            currentNumberOfVerifications: {
+                serializedName: "CurrentNumberOfVerifications",
+                type: {
+                    name: "Number"
+                }
+            }
+        }
+    }
+};
+
+var Mappers = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    AcsVerification: AcsVerification,
+    CommunicationError: CommunicationError,
+    CommunicationErrorResponse: CommunicationErrorResponse,
+    VerificationCodeRequest: VerificationCodeRequest,
+    VerificationConstantsResponse: VerificationConstantsResponse,
+    VerificationRequest: VerificationRequest,
+    VerificationResponse: VerificationResponse
+});
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+const tracingClient = coreTracing.createTracingClient({
+    namespace: "Microsoft.Communication",
+    packageName: "@azure/communication-recipient-verification",
+    packageVersion: "1.0.0-beta.1"
+});
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+const accept = {
+    parameterPath: "accept",
+    mapper: {
+        defaultValue: "application/json",
+        isConstant: true,
+        serializedName: "Accept",
+        type: {
+            name: "String"
+        }
+    }
+};
+const endpoint = {
+    parameterPath: "endpoint",
+    mapper: {
+        serializedName: "endpoint",
+        required: true,
+        type: {
+            name: "String"
+        }
+    },
+    skipEncoding: true
+};
+const apiVersion = {
+    parameterPath: "apiVersion",
+    mapper: {
+        defaultValue: "2022-11-15",
+        isConstant: true,
+        serializedName: "api-version",
+        type: {
+            name: "String"
+        }
+    }
+};
+const contentType = {
+    parameterPath: ["options", "contentType"],
+    mapper: {
+        defaultValue: "application/json",
+        isConstant: true,
+        serializedName: "Content-Type",
+        type: {
+            name: "String"
+        }
+    }
+};
+const verificationId = {
+    parameterPath: "verificationId",
+    mapper: {
+        serializedName: "verificationId",
+        required: true,
+        type: {
+            name: "Uuid"
+        }
+    }
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+/** Class containing AcsVerificationOperations operations. */
+class AcsVerificationOperationsImpl {
+    /**
+     * Initialize a new instance of the class AcsVerificationOperations class.
+     * @param client Reference to the service client
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Gets the array of verified phone numbers for the current resource.
+     * @param options The options parameters.
+     */
+    async getVerifications(options) {
+        return tracingClient.withSpan("RecipientVerificationClient.getVerifications", options !== null && options !== void 0 ? options : {}, async (options) => {
+            return this.client.sendOperationRequest({ options }, getVerificationsOperationSpec);
+        });
+    }
+    /**
+     * Request the identity for the verification.
+     * @param options The options parameters.
+     */
+    async requestVerification(options) {
+        return tracingClient.withSpan("RecipientVerificationClient.requestVerification", options !== null && options !== void 0 ? options : {}, async (options) => {
+            return this.client.sendOperationRequest({ options }, requestVerificationOperationSpec);
+        });
+    }
+    /**
+     * Verify that the user received the correct verification code.
+     * @param verificationId Verification Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async verifyIdentity(verificationId, options) {
+        return tracingClient.withSpan("RecipientVerificationClient.verifyIdentity", options !== null && options !== void 0 ? options : {}, async (options) => {
+            return this.client.sendOperationRequest({ verificationId, options }, verifyIdentityOperationSpec);
+        });
+    }
+    /**
+     * Deleting a verification.
+     * @param verificationId Verification Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async deleteVerification(verificationId, options) {
+        return tracingClient.withSpan("RecipientVerificationClient.deleteVerification", options !== null && options !== void 0 ? options : {}, async (options) => {
+            return this.client.sendOperationRequest({ verificationId, options }, deleteVerificationOperationSpec);
+        });
+    }
+    /**
+     * Getting all the constants for the resource.
+     * @param options The options parameters.
+     */
+    async getVerificationConstants(options) {
+        return tracingClient.withSpan("RecipientVerificationClient.getVerificationConstants", options !== null && options !== void 0 ? options : {}, async (options) => {
+            return this.client.sendOperationRequest({ options }, getVerificationConstantsOperationSpec);
+        });
+    }
+}
+// Operation Specifications
+const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const getVerificationsOperationSpec = {
+    path: "/verifications",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: {
+                type: {
+                    name: "Sequence",
+                    element: { type: { name: "Composite", className: "AcsVerification" } }
+                }
+            }
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [endpoint],
+    headerParameters: [accept],
+    serializer
+};
+const requestVerificationOperationSpec = {
+    path: "/verifications",
+    httpMethod: "POST",
+    responses: {
+        200: {
+            bodyMapper: VerificationResponse
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    requestBody: {
+        parameterPath: {
+            identity: ["options", "identity"],
+            channel: ["options", "channel"]
+        },
+        mapper: VerificationRequest
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [endpoint],
+    headerParameters: [accept, contentType],
+    mediaType: "json",
+    serializer
+};
+const verifyIdentityOperationSpec = {
+    path: "/verifications/{verificationId}/check",
+    httpMethod: "POST",
+    responses: {
+        200: {
+            bodyMapper: VerificationResponse
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    requestBody: {
+        parameterPath: { verificationCode: ["options", "verificationCode"] },
+        mapper: VerificationCodeRequest
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [endpoint, verificationId],
+    headerParameters: [accept, contentType],
+    mediaType: "json",
+    serializer
+};
+const deleteVerificationOperationSpec = {
+    path: "/verifications/{verificationId}/",
+    httpMethod: "DELETE",
+    responses: {
+        200: {},
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [endpoint, verificationId],
+    headerParameters: [accept],
+    serializer
+};
+const getVerificationConstantsOperationSpec = {
+    path: "/verifications/configuration",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: VerificationConstantsResponse
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [endpoint],
+    headerParameters: [accept],
+    serializer
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+let RecipientVerificationClient$1 = class RecipientVerificationClient extends coreClient__namespace.ServiceClient {
+    /**
+     * Initializes a new instance of the RecipientVerificationClient class.
+     * @param endpoint The communication resource, for example https://resourcename.communication.azure.com
+     * @param options The parameter options
+     */
+    constructor(endpoint, options) {
+        var _a, _b;
+        if (endpoint === undefined) {
+            throw new Error("'endpoint' cannot be null");
+        }
+        // Initializing default values for options
+        if (!options) {
+            options = {};
+        }
+        const defaults = {
+            requestContentType: "application/json; charset=utf-8"
+        };
+        const packageDetails = `azsdk-js-communication-recipient-verification/1.0.0-beta.1`;
+        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: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "{endpoint}" });
+        super(optionsWithDefaults);
+        if ((options === null || options === void 0 ? void 0 : options.pipeline) && options.pipeline.getOrderedPolicies().length > 0) {
+            const pipelinePolicies = options.pipeline.getOrderedPolicies();
+            const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
+                coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName);
+            if (!bearerTokenAuthenticationPolicyFound) {
+                this.pipeline.removePolicy({
+                    name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
+                });
+                this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
+                    scopes: `${optionsWithDefaults.baseUri}/.default`,
+                    challengeCallbacks: {
+                        authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
+                    }
+                }));
+            }
+        }
+        // Parameter assignments
+        this.endpoint = endpoint;
+        // Assigning values to Constant parameters
+        this.apiVersion = options.apiVersion || "2022-11-15";
+        this.acsVerificationOperations = new AcsVerificationOperationsImpl(this);
+        this.addCustomApiVersionPolicy(options.apiVersion);
+    }
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    addCustomApiVersionPolicy(apiVersion) {
+        if (!apiVersion) {
+            return;
+        }
+        const apiVersionPolicy = {
+            name: "CustomApiVersionPolicy",
+            async sendRequest(request, next) {
+                const param = request.url.split("?");
+                if (param.length > 1) {
+                    const newParams = param[1].split("&").map((item) => {
+                        if (item.indexOf("api-version") > -1) {
+                            return "api-version=" + apiVersion;
+                        }
+                        else {
+                            return item;
+                        }
+                    });
+                    request.url = param[0] + "?" + newParams.join("&");
+                }
+                return next(request);
+            }
+        };
+        this.pipeline.addPolicy(apiVersionPolicy);
+    }
+};
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * The \@azure\/logger configuration for this package.
+ */
+const logger = logger$1.createClientLogger("communication-verified-recipients");
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/// <reference lib="esnext.asynciterable" />
+const isRecipientVerificationClientOptions = (options) => options && !communicationCommon.isKeyCredential(options) && !coreAuth.isTokenCredential(options);
+/**
+ * Client class for interacting with Azure Communication Services Recipient Verification.
+ */
+class RecipientVerificationClient {
+    constructor(connectionStringOrUrl, credentialOrOptions, maybeOptions = {}) {
+        const { url, credential } = communicationCommon.parseClientArguments(connectionStringOrUrl, credentialOrOptions);
+        const options = isRecipientVerificationClientOptions(credentialOrOptions)
+            ? credentialOrOptions
+            : maybeOptions;
+        const internalPipelineOptions = Object.assign(Object.assign({}, options), {
+            loggingOptions: {
+                logger: logger.info,
+            },
+        });
+        this.client = new RecipientVerificationClient$1(url, internalPipelineOptions);
+        const authPolicy = communicationCommon.createCommunicationAuthPolicy(credential);
+        this.client.pipeline.addPolicy(authPolicy);
+    }
+    /**
+     * Returns list of verified/pending phone numbers.
+     *
+     * @param options - Additional request options.
+     */
+    getVerifications(options = {}) {
+        return tracingClient.withSpan("RecipientVerification.getVerifications", options, (updatedOptions) => {
+            return this.client.acsVerificationOperations.getVerifications(updatedOptions);
+        });
+    }
+    /**
+     * Removes a pending/verified number.
+     *
+     * @param verificationId - Id that is used to reference users phone number.
+     * @param options - Additional request options.
+     */
+    deleteVerification(verificationId, options = {}) {
+        return tracingClient.withSpan("RecipientVerification.deleteVerification", options, (updatedOptions) => {
+            return this.client.acsVerificationOperations.deleteVerification(verificationId, updatedOptions);
+        });
+    }
+    /**
+     * Verifies a users phone number.
+     *
+     * @param verificationId - Id that is used to reference users phone number.
+     * @param options - Additional request options.
+     */
+    verifyIdentity(verificationId, options = {}) {
+        return tracingClient.withSpan("RecipientVerification.verifyIdentity", options, (updatedOptions) => {
+            return this.client.acsVerificationOperations.verifyIdentity(verificationId, updatedOptions);
+        });
+    }
+    /**
+     * Returns information about a resource in relation to recipient verification.
+     *
+     * @param options - Additional request options.
+     */
+    getVerificationConstants(options = {}) {
+        return tracingClient.withSpan("RecipientVerification.getVerificationConstants", options, (updatedOptions) => {
+            return this.client.acsVerificationOperations.getVerificationConstants(updatedOptions);
+        });
+    }
+    /**
+     * Sends a code to users phone number that will be used for verification.
+     *
+     * @param options - Additional request options.
+     */
+    requestVerification(options = {}) {
+        return tracingClient.withSpan("RecipientVerification.requestVerification", options, (updatedOptions) => {
+            return this.client.acsVerificationOperations.requestVerification(updatedOptions);
+        });
+    }
+}
+
+exports.AcsVerificationMapper = AcsVerification;
+exports.ConstantsMapper = VerificationConstantsResponse;
+exports.RecipientVerificationClient = RecipientVerificationClient;
+exports.VerificationCodeRequestMapper = VerificationCodeRequest;
+exports.VerificationRequestMapper = VerificationRequest;
+exports.VerificationResponseMapper = VerificationResponse;
+//# sourceMappingURL=index.js.map