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

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.11"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/communication-recipient-verification",
-  "version": "1.0.0-alpha.20241119.1",
+  "version": "1.0.0-alpha.20241203.1",
   "description": "Test",
   "sdk-type": "client",
   "main": "./dist/commonjs/index.js",

package/dist/communication-recipient-verification.d.ts

@@ -1,163 +0,0 @@
-import type { CommonClientOptions } from '@azure/core-client';
-import * as coreClient from '@azure/core-client';
-import type { KeyCredential } from '@azure/core-auth';
-import type { TokenCredential } from '@azure/core-auth';
-
-/** Model response returned for users. */
-export declare interface AcsVerification {
-    /** Immutable Id of the resource. */
-    immutableId?: string;
-    /** VerificationId of the number assigned to the verified recipient. */
-    verificationId?: string;
-    /** Status of the Verification (Pending or Verified). */
-    status?: string;
-    /** Subscription Id of the resource. */
-    subscriptionId?: string;
-    /** The phone number that was used to verify. */
-    identity?: string;
-    /** Verification Id for the 3rd party verification service. */
-    challengeId?: string;
-    /** Number of times the verification code has been sent. */
-    retries?: number;
-    /** Number of times the user has tried to validate the code. */
-    attempts?: number;
-}
-
-/** Optional parameters. */
-export declare interface AcsVerificationDeleteVerificationOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface AcsVerificationGetVerificationConstantsOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getVerificationConstants operation. */
-export declare type AcsVerificationGetVerificationConstantsResponse = VerificationConstantsResponse;
-
-/** Optional parameters. */
-export declare interface AcsVerificationGetVerificationsOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getVerifications operation. */
-export declare type AcsVerificationGetVerificationsResponse = AcsVerification[];
-
-export declare const AcsVerificationMapper: coreClient.CompositeMapper;
-
-/** Optional parameters. */
-export declare interface AcsVerificationRequestVerificationOptionalParams extends coreClient.OperationOptions {
-    /** The phone number that was used to verify. */
-    identity?: string;
-    /** Prefered verification channel. */
-    channel?: string;
-}
-
-/** Contains response data for the requestVerification operation. */
-export declare type AcsVerificationRequestVerificationResponse = VerificationResponse;
-
-/** Optional parameters. */
-export declare interface AcsVerificationVerifyIdentityOptionalParams extends coreClient.OperationOptions {
-    /** The verification code returned. */
-    verificationCode?: string;
-}
-
-/** Contains response data for the verifyIdentity operation. */
-export declare type AcsVerificationVerifyIdentityResponse = VerificationResponse;
-
-export declare const ConstantsMapper: coreClient.CompositeMapper;
-
-/**
- * Client class for interacting with Azure Communication Services Recipient Verification.
- */
-export declare class RecipientVerificationClient {
-    /**
-     * A reference to the auto-generated RecipientVerification HTTP client.
-     */
-    private readonly client;
-    /**
-     * Initializes a new instance of the RecipientVerificationClient class using a connection string.
-     *
-     * @param connectionString - Connection string to connect to an Azure Communication Service resource. (eg: endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret)
-     * @param options - Optional. Options to configure the HTTP pipeline.
-     */
-    constructor(connectionString: string, options?: RecipientVerificationClientOptions);
-    /**
-     * Initializes a new instance of the RecipientVerificationClient class using an Azure KeyCredential.
-     *
-     * @param endpoint - The endpoint of the service (eg: https://contoso.eastus.communications.azure.net)
-     * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
-     * @param options - Optional. Options to configure the HTTP pipeline.
-     */
-    constructor(endpoint: string, credential: KeyCredential, options?: RecipientVerificationClientOptions);
-    /**
-     * Initializes a new instance of the RecipientVerificationClient class using an Azure KeyCredential.
-     *
-     * @param endpoint - The endpoint of the service (eg: https://contoso.eastus.communications.azure.net)
-     * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
-     * @param options - Optional. Options to configure the HTTP pipeline.
-     */
-    constructor(endpoint: string, credential: TokenCredential, options?: RecipientVerificationClientOptions);
-    /**
-     * Returns list of verified/pending phone numbers.
-     *
-     * @param options - Additional request options.
-     */
-    getVerifications(options?: AcsVerificationGetVerificationsOptionalParams): Promise<AcsVerification[]>;
-    /**
-     * Removes a pending/verified number.
-     *
-     * @param verificationId - Id that is used to reference users phone number.
-     * @param options - Additional request options.
-     */
-    deleteVerification(verificationId: string, options?: AcsVerificationDeleteVerificationOptionalParams): Promise<void>;
-    /**
-     * Verifies a users phone number.
-     *
-     * @param verificationId - Id that is used to reference users phone number.
-     * @param options - Additional request options.
-     */
-    verifyIdentity(verificationId: string, options?: AcsVerificationVerifyIdentityOptionalParams): Promise<AcsVerificationVerifyIdentityResponse>;
-    /**
-     * Returns information about a resource in relation to recipient verification.
-     *
-     * @param options - Additional request options.
-     */
-    getVerificationConstants(options?: AcsVerificationGetVerificationConstantsOptionalParams): Promise<VerificationConstantsResponse>;
-    /**
-     * Sends a code to users phone number that will be used for verification.
-     *
-     * @param options - Additional request options.
-     */
-    requestVerification(options?: AcsVerificationRequestVerificationOptionalParams): Promise<AcsVerificationRequestVerificationResponse>;
-}
-
-/**
- * Client options used to configure the RecipientVerificationGeneratedClient API requests.
- */
-export declare interface RecipientVerificationClientOptions extends CommonClientOptions {
-}
-
-export declare const VerificationCodeRequestMapper: coreClient.CompositeMapper;
-
-/** Model verified recipients. */
-export declare interface VerificationConstantsResponse {
-    /** Max retries allowed for resource. */
-    maxRetriesAllowed?: number;
-    /** Max verified numbers allowed for resource. */
-    maxVerificationsAllowed?: number;
-    /** Current number of verified numbers for the resource. */
-    currentNumberOfVerifications?: number;
-}
-
-export declare const VerificationRequestMapper: coreClient.CompositeMapper;
-
-/** Model that contains the verification code. */
-export declare interface VerificationResponse {
-    /** VerificationId of the number assigned to the verified recipient. */
-    verificationId?: string;
-    /** Verification status of the number. */
-    isVerified?: boolean;
-}
-
-export declare const VerificationResponseMapper: coreClient.CompositeMapper;
-
-export { }