@azure/communication-phone-numbers 1.3.0-alpha.20230820.1 → 1.3.0-beta.2

package/dist-esm/src/utils/constants.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/communication-phone-numbers",
-  "version": "1.3.0-alpha.20230820.1",
+  "version": "1.3.0-beta.2",
   "description": "SDK for Azure Communication service which facilitates phone number management.",
   "sdk-type": "client",
   "main": "dist/index.js",
@@ -19,7 +19,6 @@
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "generate:client": "autorest --typescript ./swagger/README.md && rushx format",
-    "generate:siproutingclient": "autorest --typescript ./swagger/README-SipRouting.md && rushx format",
     "integration-test:browser": "dev-tool run test:browser",
     "integration-test:node": "dev-tool run test:node-js-input -- --timeout 5000000 'dist-esm/test/**/*.spec.js'",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
@@ -32,8 +31,7 @@
     "test:watch": "npm run test -- --watch --reporter min",
     "unit-test:browser": "dev-tool run test:browser",
     "unit-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 --exclude 'test/**/browser/*.spec.ts' 'test/**/*.spec.ts'",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "unit-test-case": "dev-tool run test:node-ts-input -- --timeout 1200000 "
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
   },
   "files": [
     "dist/",
@@ -50,7 +48,7 @@
   "author": "Microsoft Corporation",
   "license": "MIT",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-phone-numbers/",
   "repository": "github:Azure/azure-sdk-for-js",
@@ -80,12 +78,12 @@
     "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-credential": "^1.0.0",
     "@azure-tools/test-recorder": "^3.0.0",
-    "@azure/identity": "^2.0.1",
+    "@azure/identity": "^3.3.0",
     "@microsoft/api-extractor": "^7.31.1",
     "@types/chai": "^4.1.6",
-    "@types/mocha": "^7.0.2",
-    "@types/sinon": "^9.0.4",
-    "@types/node": "^14.0.0",
+    "@types/mocha": "^10.0.0",
+    "@types/sinon": "^17.0.0",
+    "@types/node": "^18.0.0",
     "@types/uuid": "^8.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
@@ -102,12 +100,14 @@
     "karma-sourcemap-loader": "^0.3.8",
     "karma": "^6.2.0",
     "mocha-junit-reporter": "^2.0.0",
-    "mocha": "^7.1.1",
-    "nyc": "^15.0.0",
+    "mocha": "^10.0.0",
+    "c8": "^8.0.0",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
-    "sinon": "^9.0.2",
-    "typescript": "~5.0.0"
+    "sinon": "^17.0.0",
+    "typescript": "~5.2.0",
+    "ts-node": "^10.0.0",
+    "esm": "^3.2.18"
   },
   "//metadata": {
     "constantPaths": [
@@ -148,7 +148,8 @@
     },
     "skip": [
       "purchasePhoneNumber.js",
-      "releasePhoneNumber.js"
+      "releasePhoneNumber.js",
+      "manageSipRoutingConfiguration.js"
     ]
   }
 }

package/types/communication-phone-numbers.d.ts

@@ -9,9 +9,6 @@ import { PollerLike } from '@azure/core-lro';
 import { PollOperationState } from '@azure/core-lro';
 import { TokenCredential } from '@azure/core-auth';
 
-/** Defines values for ActivityStatus. */
-export declare type ActivityStatus = "unknown" | "active" | "inactive";
-
 /**
  * Additional options for the purchase phone number operation.
  */
@@ -41,19 +38,6 @@ export declare interface BeginUpdatePhoneNumberCapabilitiesOptions extends Opera
  */
 export declare type GetPurchasedPhoneNumberOptions = OperationOptions;
 
-/**
- * Additional options that can be passed to get SIP trunk.
- */
-export declare interface GetSipTrunkOptions extends OperationOptions {
-    /**
-     * Sets the optional parameter to retrieve SBC properties.
-     */
-    includeHealth?: boolean;
-}
-
-/** Defines values for InactiveReason. */
-export declare type InactiveReason = "noRecentCalls" | "noRecentPings" | "noRecentCallsAndPings";
-
 /**
  * Additional options that can be passed to the available countries request.
  */
@@ -87,12 +71,6 @@ export declare interface ListOfferingsOptions extends OperationOptions {
 export declare interface ListPurchasedPhoneNumbersOptions extends OperationOptions {
 }
 
-/**
- * Additional options that can be passed to list SIP trunks.
- */
-export declare interface ListSipDomainsOptions extends OperationOptions {
-}
-
 /**
  * Additional options that can be passed to list SIP routes.
  */
@@ -102,7 +80,7 @@ export declare interface ListSipRoutesOptions extends OperationOptions {
 /**
  * Additional options that can be passed to list SIP trunks.
  */
-export declare interface ListSipTrunksOptions extends GetSipTrunkOptions {
+export declare interface ListSipTrunksOptions extends OperationOptions {
 }
 
 /**
@@ -111,6 +89,44 @@ export declare interface ListSipTrunksOptions extends GetSipTrunkOptions {
 export declare interface ListTollFreeAreaCodesOptions extends Omit<PhoneNumbersListAreaCodesOptionalParams, "assignmentType" | "locality" | "administrativeDivision"> {
 }
 
+/** Represents metadata describing the operator of a phone number */
+export declare interface OperatorDetails {
+    /** Name of the phone operator */
+    name?: string;
+    /** Mobile Network Code */
+    mobileNetworkCode?: string;
+    /** Mobile Country Code */
+    mobileCountryCode?: string;
+}
+
+/** Represents metadata about a phone number that is controlled/provided by that phone number's operator. */
+export declare interface OperatorInformation {
+    /** E.164 formatted string representation of the phone number */
+    phoneNumber?: string;
+    /** National format of the phone number */
+    nationalFormat?: string;
+    /** International format of the phone number */
+    internationalFormat?: string;
+    /** Type of service associated with the phone number */
+    numberType?: OperatorNumberType;
+    /** ISO 3166-1 two character ('alpha-2') code associated with the phone number. */
+    isoCountryCode?: string;
+    /** Represents metadata describing the operator of a phone number */
+    operatorDetails?: OperatorDetails;
+}
+
+/** Represents a search result containing operator information associated with the requested phone numbers */
+export declare interface OperatorInformationResult {
+    /**
+     * Results of a search.
+     * This array will have one entry per requested phone number which will contain the relevant operator information.
+     */
+    values?: OperatorInformation[];
+}
+
+/** Defines values for OperatorNumberType. */
+export declare type OperatorNumberType = "unknown" | "other" | "geographic" | "mobile";
+
 /** Represents an administrative division. e.g. state or province. */
 export declare interface PhoneNumberAdministrativeDivision {
     /** Represents the localized name of the administrative division of the locality. e.g. state or province localized name. */
@@ -404,6 +420,13 @@ export declare class PhoneNumbersClient {
      * @param options - The optional parameters.
      */
     listAvailableOfferings(countryCode: string, options?: ListOfferingsOptions): PagedAsyncIterableIterator<PhoneNumberOffering>;
+    /**
+     * Search for operator information about specified phone numbers.
+     *
+     * @param phoneNumbers - The phone numbers to search.
+     * @param options - Additional request options.
+     */
+    searchOperatorInformation(phoneNumbers: string[], options?: SearchOperatorInformationOptions): Promise<OperatorInformationResult>;
 }
 
 /**
@@ -446,15 +469,22 @@ export declare interface PhoneNumberSearchResult {
     cost: PhoneNumberCost;
     /** The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z. */
     searchExpiresBy: Date;
+    /** The error code of the search. */
+    errorCode?: number;
+    /** Mapping Error Messages to Codes */
+    error?: PhoneNumberSearchResultError;
 }
 
+/** Defines values for PhoneNumberSearchResultError. */
+export declare type PhoneNumberSearchResultError = "NoError" | "UnknownErrorCode" | "OutOfStock" | "AuthorizationDenied" | "MissingAddress" | "InvalidAddress" | "InvalidOfferModel" | "NotEnoughLicenses" | "NoWallet" | "NotEnoughCredit" | "NumbersPartiallyAcquired" | "AllNumbersNotAcquired" | "ReservationExpired" | "PurchaseFailed" | "BillingUnavailable" | "ProvisioningFailed" | "UnknownSearchError";
+
 /** Optional parameters. */
 export declare interface PhoneNumbersListAreaCodesOptionalParams extends coreClient.OperationOptions {
     /** An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. */
     skip?: number;
     /** An optional parameter for how many entries to return, for pagination purposes. The default value is 100. */
     maxPageSize?: number;
-    /** Filter by assignmentType, e.g. User, Application. */
+    /** Filter by assignmentType, e.g. Person, Application. */
     assignmentType?: PhoneNumberAssignmentType;
     /** The name of locality or town in which to search for the area code. This is required if the number type is Geographic. */
     locality?: string;
@@ -467,9 +497,6 @@ export declare interface PhoneNumbersListAreaCodesOptionalParams extends coreCli
 /** Defines values for PhoneNumberType. */
 export declare type PhoneNumberType = "geographic" | "tollFree";
 
-/** Defines values for PingStatus. */
-export declare type PingStatus = "unknown" | "ok" | "expired" | "error";
-
 /** Represents a purchased phone number. */
 export declare interface PurchasedPhoneNumber {
     /** The id of the phone number, e.g. 11234567890. */
@@ -514,17 +541,10 @@ export declare interface SearchAvailablePhoneNumbersRequest extends PhoneNumberS
 }
 
 /**
- * Represents a SIP domain for routing calls. See RFC 4904.
+ * Additional options for the search operator information request.
  */
-export declare interface SipDomain {
-    /**
-     * Gets or sets domain uri.
-     */
-    domainName: string;
-    /**
-     * Gets or sets enabled flag
-     */
-    enabled: boolean;
+export declare interface SearchOperatorInformationOptions extends OperationOptions {
+    formatOnly: boolean;
 }
 
 /**
@@ -567,35 +587,12 @@ export declare class SipRoutingClient {
      * @param fqdn - The trunk's FQDN.
      * @param options - The options parameters.
      */
-    getTrunk(fqdn: string, options?: GetSipTrunkOptions): Promise<SipTrunk>;
-    /**
-     * Gets the SIP domains.
-     * @param options - The options parameters.
-     */
-    listDomains(options?: ListSipDomainsOptions): PagedAsyncIterableIterator<SipDomain>;
-    /**
-     * Gets the SIP domain.
-     * @param domainName - The domain's name (ex: contoso.com).
-     * @param options - The options parameters.
-     */
-    getDomain(domainName: string, options?: OperationOptions): Promise<SipDomain>;
+    getTrunk(fqdn: string, options?: OperationOptions): Promise<SipTrunk>;
     /**
      * Lists the SIP trunk routes.
      * @param options - The options parameters.
      */
     listRoutes(options?: ListSipRoutesOptions): PagedAsyncIterableIterator<SipTrunkRoute>;
-    /**
-     * Sets the SIP domains.
-     * @param domains - The SIP domains to be set.
-     * @param options - The options parameters.
-     */
-    setDomains(domains: SipDomain[], options?: OperationOptions): Promise<SipDomain[]>;
-    /**
-     * Sets the SIP domain.
-     * @param domain - The SIP domain to be set.
-     * @param options - The options parameters.
-     */
-    setDomain(domain: SipDomain, options?: OperationOptions): Promise<SipDomain>;
     /**
      * Sets the SIP trunks.
      * @param trunks - The SIP trunks to be set.
@@ -620,21 +617,11 @@ export declare class SipRoutingClient {
      * @param options - The options parameters.
      */
     deleteTrunk(fqdn: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Deletes the SIP domain.
-     * @param domainName - The domain's name (ex: contoso.com).
-     * @param options - The options parameters.
-     */
-    deleteDomain(domainName: string, options?: OperationOptions): Promise<void>;
-    matchNumberToRoutes(phoneNumber: string, options: SipRoutingTestRoutesWithNumberOperationParams): Promise<SipTrunkRoute[]>;
     private getRoutesInternal;
     private getTrunksInternal;
-    private getDomainsInternal;
     private listRoutesPagingAll;
     private listTrunksPagingAll;
-    private listDomainsPagingAll;
     private listTrunksPagingPage;
-    private listDomainsPagingPage;
     private listRoutesPagingPage;
 }
 
@@ -667,25 +654,6 @@ export declare interface SipRoutingError {
     readonly innerError?: SipRoutingError;
 }
 
-export declare interface SipRoutingTestRoutesWithNumberOperationParams extends OperationOptions {
-    /**
-     * Validated Domains.
-     * Map key is domain.
-     */
-    domains?: {
-        [propertyName: string]: SipDomain;
-    };
-    /**
-     * SIP trunks for routing calls.
-     * Map key is trunk's FQDN (1-249 characters).
-     */
-    trunks?: {
-        [propertyName: string]: SipTrunk;
-    };
-    /** Trunk routes for routing calls. */
-    routes?: SipTrunkRoute[];
-}
-
 /**
  * Represents a SIP trunk for routing calls. See RFC 4904.
  */
@@ -698,38 +666,6 @@ export declare interface SipTrunk {
      * Gets or sets SIP signaling port of the trunk.
      */
     sipSignalingPort: number;
-    /**
-     * Gets or sets enabled property of the trunk.
-     */
-    enabled?: boolean;
-    /**
-     * Represents health state of a SIP trunk for routing calls.
-     */
-    readonly health?: SipTrunkHealth;
-}
-
-/** The activity status of Trunk. */
-export declare interface SipTrunkActivity {
-    /** The activity status of Trunk. */
-    status: ActivityStatus;
-    /** The reason activity status of Trunk is inactive. */
-    inactiveReason?: InactiveReason;
-}
-
-/** Represents health state of a SIP trunk for routing calls. */
-export declare interface SipTrunkHealth {
-    /** The status of the TLS connections of the Trunk. */
-    tls: SipTrunkTls;
-    /** The status of SIP OPTIONS message sent by Trunk. */
-    ping: SipTrunkPing;
-    /** The activity status of Trunk. */
-    activity: SipTrunkActivity;
-}
-
-/** The status of SIP OPTIONS message sent by Trunk. */
-export declare interface SipTrunkPing {
-    /** The status of SIP OPTIONS message sent by Trunk. */
-    status: PingStatus;
 }
 
 /** Represents a trunk route for routing calls. */
@@ -748,13 +684,4 @@ export declare interface SipTrunkRoute {
     trunks?: string[];
 }
 
-/** The status of the TLS connections of the Trunk. */
-export declare interface SipTrunkTls {
-    /** The status of the TLS connections of the Trunk. */
-    status: TlsStatus;
-}
-
-/** Defines values for TlsStatus. */
-export declare type TlsStatus = "unknown" | "ok" | "certExpiring" | "certExpired";
-
 export { }