Update the Number Lookup preview to include Number Format features

eng/versioning/version_client.txt

@@ -77,7 +77,7 @@ com.azure:azure-communication-identity;1.5.2;1.6.0-beta.1
 com.azure:azure-communication-jobrouter;1.1.1;1.2.0-beta.1
 com.azure:azure-communication-messages;1.0.0;1.1.0-beta.1
 com.azure:azure-communication-networktraversal;1.1.0-beta.2;1.1.0-beta.3
-com.azure:azure-communication-phonenumbers;1.1.10;1.2.0-beta.1
+com.azure:azure-communication-phonenumbers;1.1.10;1.2.0-beta.2
 com.azure:azure-communication-rooms;1.0.8;1.1.0-beta.2
 com.azure:azure-communication-sms;1.1.21;1.2.0-beta.1
 com.azure:azure-containers-containerregistry;1.2.5;1.3.0-beta.1

sdk/communication/azure-communication-phonenumbers/CHANGELOG.md

@@ -1,14 +1,11 @@
 # Release History
 
-## 1.2.0-beta.1 (Unreleased)
+## 1.2.0-beta.2 (2024-03-01)
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Add support for number lookup
+  - Format only can be returned for no cost
+  - Additional number details can be returned for a cost
 
 ## 1.1.9 (2023-12-04)
 
@@ -46,6 +43,12 @@
 - Upgraded `azure-core` from `1.42.0` to version `1.43.0`.
 - Upgraded `azure-communication-common` from `1.2.11` to version `1.2.12`.
 
+## 1.2.0-beta.1 (2023-09-07)
+
+### Features Added
+- Number Lookup API public preview
+- API version `2023-05-01-preview` is the default
+
 ## 1.1.5 (2023-08-18)
 
 ### Other Changes

sdk/communication/azure-communication-phonenumbers/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/communication/azure-communication-phonenumbers",
-  "Tag": "java/communication/azure-communication-phonenumbers_154a5685d1"
+  "Tag": "java/communication/azure-communication-phonenumbers_737e64b52b"
 }

sdk/communication/azure-communication-phonenumbers/pom.xml

@@ -16,7 +16,7 @@
   <groupId>com.azure</groupId>
   <artifactId>azure-communication-phonenumbers</artifactId>
   <packaging>jar</packaging>
-  <version>1.2.0-beta.1</version> <!-- {x-version-update;com.azure:azure-communication-phonenumbers;current} -->
+  <version>1.2.0-beta.2</version> <!-- {x-version-update;com.azure:azure-communication-phonenumbers;current} -->
 
   <name>Microsoft Azure client phone numbers library for communication</name>
   <description>

sdk/communication/azure-communication-phonenumbers/src/main/java/com/azure/communication/phonenumbers/PhoneNumbersAsyncClient.java

@@ -14,6 +14,9 @@
 import com.azure.communication.phonenumbers.implementation.models.PhoneNumbersReleasePhoneNumberResponse;
 import com.azure.communication.phonenumbers.implementation.models.PhoneNumberCapabilitiesRequest;
 import com.azure.communication.phonenumbers.implementation.models.PhoneNumbersUpdateCapabilitiesResponse;
+import com.azure.communication.phonenumbers.implementation.models.OperatorInformationRequest;
+import com.azure.communication.phonenumbers.models.OperatorInformationResult;
+import com.azure.communication.phonenumbers.models.OperatorInformationOptions;
 import com.azure.communication.phonenumbers.models.PhoneNumberAreaCode;
 import com.azure.communication.phonenumbers.models.PurchasedPhoneNumber;
 import com.azure.communication.phonenumbers.models.ReleasePhoneNumberResult;
@@ -45,6 +48,7 @@
 import reactor.core.publisher.Mono;
 
 import java.time.Duration;
+import java.util.List;
 import java.util.Objects;
 import java.util.function.BiFunction;
 import java.util.function.Function;
@@ -61,15 +65,15 @@
  *
  * <!-- src_embed com.azure.communication.phonenumbers.asyncclient.instantiation
  * -->
- * 
+ *
  * <pre>
  * PhoneNumbersAsyncClient phoneNumberAsyncClient = new PhoneNumbersClientBuilder&#40;&#41;
  *         .endpoint&#40;endpoint&#41;
  *         .credential&#40;keyCredential&#41;
  *         .httpClient&#40;httpClient&#41;
  *         .buildAsyncClient&#40;&#41;;
  * </pre>
- * 
+ *
  * <!-- end com.azure.communication.phonenumbers.asyncclient.instantiation -->
  *
  * @see PhoneNumbersClientBuilder
@@ -99,13 +103,13 @@ public final class PhoneNumbersAsyncClient {
      *
      * <!-- src_embed com.azure.communication.phonenumbers.asyncclient.getPurchased
      * -->
-     * 
+     *
      * <pre>
      * PurchasedPhoneNumber phoneNumber = phoneNumberAsyncClient.getPurchasedPhoneNumber&#40;&quot;+18001234567&quot;&#41;.block&#40;&#41;;
      * System.out.println&#40;&quot;Phone Number Value: &quot; + phoneNumber.getPhoneNumber&#40;&#41;&#41;;
      * System.out.println&#40;&quot;Phone Number Country Code: &quot; + phoneNumber.getCountryCode&#40;&#41;&#41;;
      * </pre>
-     * 
+     *
      * <!-- end com.azure.communication.phonenumbers.asyncclient.getPurchased -->
      *
      * @param phoneNumber The phone number id in E.164 format. The leading plus can
@@ -133,15 +137,15 @@ public Mono<PurchasedPhoneNumber> getPurchasedPhoneNumber(String phoneNumber) {
      *
      * <!-- src_embed
      * com.azure.communication.phonenumbers.asyncclient.getPurchasedWithResponse -->
-     * 
+     *
      * <pre>
      * Response&lt;PurchasedPhoneNumber&gt; response = phoneNumberAsyncClient
      *         .getPurchasedPhoneNumberWithResponse&#40;&quot;+18001234567&quot;&#41;.block&#40;&#41;;
      * PurchasedPhoneNumber phoneNumber = response.getValue&#40;&#41;;
      * System.out.println&#40;&quot;Phone Number Value: &quot; + phoneNumber.getPhoneNumber&#40;&#41;&#41;;
      * System.out.println&#40;&quot;Phone Number Country Code: &quot; + phoneNumber.getCountryCode&#40;&#41;&#41;;
      * </pre>
-     * 
+     *
      * <!-- end
      * com.azure.communication.phonenumbers.asyncclient.getPurchasedWithResponse -->
      *
@@ -170,14 +174,14 @@ public Mono<Response<PurchasedPhoneNumber>> getPurchasedPhoneNumberWithResponse(
      *
      * <!-- src_embed com.azure.communication.phonenumbers.asyncclient.listPurchased
      * -->
-     * 
+     *
      * <pre>
      * PagedFlux&lt;PurchasedPhoneNumber&gt; phoneNumbers = phoneNumberAsyncClient.listPurchasedPhoneNumbers&#40;&#41;;
      * PurchasedPhoneNumber phoneNumber = phoneNumbers.blockFirst&#40;&#41;;
      * System.out.println&#40;&quot;Phone Number Value: &quot; + phoneNumber.getPhoneNumber&#40;&#41;&#41;;
      * System.out.println&#40;&quot;Phone Number Country Code: &quot; + phoneNumber.getCountryCode&#40;&#41;&#41;;
      * </pre>
-     * 
+     *
      * <!-- end com.azure.communication.phonenumbers.asyncclient.listPurchased -->
      *
      * @return A {@link PagedFlux} of {@link PurchasedPhoneNumber} instances
@@ -201,7 +205,7 @@ public PagedFlux<PurchasedPhoneNumber> listPurchasedPhoneNumbers() {
      *
      * <!-- src_embed
      * com.azure.communication.phonenumbers.asyncclient.beginSearchAvailable -->
-     * 
+     *
      * <pre>
      * PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities&#40;&#41;
      *         .setCalling&#40;PhoneNumberCapabilityType.INBOUND&#41;
@@ -221,7 +225,7 @@ public PagedFlux<PurchasedPhoneNumber> listPurchasedPhoneNumbers() {
      *     System.out.println&#40;&quot;Phone number costs:&quot; + searchResult.getCost&#40;&#41;.getAmount&#40;&#41;&#41;;
      * &#125;
      * </pre>
-     * 
+     *
      * <!-- end
      * com.azure.communication.phonenumbers.asyncclient.beginSearchAvailable -->
      *
@@ -252,7 +256,7 @@ public PollerFlux<PhoneNumberOperation, PhoneNumberSearchResult> beginSearchAvai
      * <!-- src_embed
      * com.azure.communication.phonenumbers.asyncclient.beginSearchAvailableWithOptions
      * -->
-     * 
+     *
      * <pre>
      * PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities&#40;&#41;
      *         .setCalling&#40;PhoneNumberCapabilityType.INBOUND&#41;
@@ -272,7 +276,7 @@ public PollerFlux<PhoneNumberOperation, PhoneNumberSearchResult> beginSearchAvai
      *     System.out.println&#40;&quot;Phone number costs:&quot; + searchResult.getCost&#40;&#41;.getAmount&#40;&#41;&#41;;
      * &#125;
      * </pre>
-     * 
+     *
      * <!-- end
      * com.azure.communication.phonenumbers.asyncclient.beginSearchAvailableWithOptions
      * -->
@@ -406,13 +410,13 @@ private Function<PollingContext<PhoneNumberOperation>, Mono<PhoneNumberSearchRes
      *
      * <!-- src_embed com.azure.communication.phonenumbers.asyncclient.beginPurchase
      * -->
-     * 
+     *
      * <pre>
      * AsyncPollResponse&lt;PhoneNumberOperation, PurchasePhoneNumbersResult&gt; purchaseResponse = phoneNumberAsyncClient
      *         .beginPurchasePhoneNumbers&#40;searchId&#41;.blockFirst&#40;&#41;;
      * System.out.println&#40;&quot;Purchase phone numbers is complete: &quot; + purchaseResponse.getStatus&#40;&#41;&#41;;
      * </pre>
-     * 
+     *
      * <!-- end com.azure.communication.phonenumbers.asyncclient.beginPurchase -->
      *
      * @param searchId ID of the search.
@@ -472,13 +476,13 @@ private Function<PollingContext<PhoneNumberOperation>, Mono<PhoneNumberOperation
      *
      * <!-- src_embed com.azure.communication.phonenumbers.asyncclient.beginRelease
      * -->
-     * 
+     *
      * <pre>
      * AsyncPollResponse&lt;PhoneNumberOperation, ReleasePhoneNumberResult&gt; releaseResponse = phoneNumberAsyncClient
      *         .beginReleasePhoneNumber&#40;&quot;+18001234567&quot;&#41;.blockFirst&#40;&#41;;
      * System.out.println&#40;&quot;Release phone number is complete: &quot; + releaseResponse.getStatus&#40;&#41;&#41;;
      * </pre>
-     * 
+     *
      * <!-- end com.azure.communication.phonenumbers.asyncclient.beginRelease -->
      *
      * @param phoneNumber The phone number id in E.164 format. The leading plus can
@@ -534,7 +538,7 @@ private Function<PollingContext<PhoneNumberOperation>, Mono<PhoneNumberOperation
      *
      * <!-- src_embed
      * com.azure.communication.phonenumbers.asyncclient.beginUpdateCapabilities -->
-     * 
+     *
      * <pre>
      * PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities&#40;&#41;;
      * capabilities
@@ -551,7 +555,7 @@ private Function<PollingContext<PhoneNumberOperation>, Mono<PhoneNumberOperation
      *     System.out.println&#40;&quot;Phone Number SMS capabilities: &quot; + phoneNumber.getCapabilities&#40;&#41;.getSms&#40;&#41;&#41;;
      * &#125;
      * </pre>
-     * 
+     *
      * <!-- end
      * com.azure.communication.phonenumbers.asyncclient.beginUpdateCapabilities -->
      *
@@ -715,6 +719,40 @@ public PagedFlux<PhoneNumberOffering> listAvailableOfferings(String countryCode,
         }
     }
 
+    /**
+     * Searches for operator information for a given list of phone numbers.
+     *
+     * @param phoneNumbers The phone number(s) whose operator information should be searched.
+     *
+     * @return A {@link OperatorInformationResult} which contains the results of the search.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<OperatorInformationResult> searchOperatorInformation(List<String> phoneNumbers) {
+        OperatorInformationRequest request = new OperatorInformationRequest();
+        request.setPhoneNumbers(phoneNumbers);
+        request.setOptions(new OperatorInformationOptions().setIncludeAdditionalOperatorDetails(false));
+        return client.operatorInformationSearchAsync(request)
+                .onErrorMap(CommunicationErrorResponseException.class, e -> translateException(e));
+    }
+
+    /**
+     * Searches for operator information for a given list of phone numbers.
+     *
+     * @param phoneNumbers The phone number(s) whose operator information should be searched.
+     * @param requestOptions Modifies the search to include additional fields in the response.
+     *                  Please note: use of options will affect the cost of the search.
+     *
+     * @return A {@link OperatorInformationResult} which contains the results of the search.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<Response<OperatorInformationResult>> searchOperatorInformationWithResponse(List<String> phoneNumbers, OperatorInformationOptions requestOptions) {
+        OperatorInformationRequest request = new OperatorInformationRequest();
+        request.setPhoneNumbers(phoneNumbers);
+        request.setOptions(requestOptions);
+        return client.operatorInformationSearchWithResponseAsync(request)
+                .onErrorMap(CommunicationErrorResponseException.class, e -> translateException(e));
+    }
+
     private Mono<PhoneNumberOperation> getOperation(String operationId) {
         return client.getOperationAsync(operationId)
                 .onErrorMap(CommunicationErrorResponseException.class, e -> translateException(e))