Number lookup ga (#37719)

GA implementation of the number lookup feature.  This commit should cover the vast majority of the work needed, and is updated to incorporate feedback from the stewardship board.  These changes are going into a branch to wait until we're ready to do our final bug bashing and eventually merging and shipping the feature.

----------

* Implementation of Number Lookup feature for public preview in communication-phonenumbers (#35674)

* implementation of number lookup in java SDK

* fix readme to remove debug logging

* fix autorest generation swagger mismatch issue

* update autorest generation and yaml directives

* update service version

* fix public/private type generation, update changelog

* fix checkstyle issues

* update test recordings

* update test base to redact phonenumbers in operatorInformation response, update test recordings

* update changelog

* update date format for changelog

* Increment package versions for communication releases (#36670)

* fix imports in test file

* update auto-generated files

* implement ga updates

* removing edits to version_client.txt

* fix build errors

* attempt to fix versioning issue

* update based on SDK review

---------

Co-authored-by: Azure SDK Bot <[email protected]>

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

@@ -1,14 +1,18 @@
 # Release History
 
-## 1.2.0-beta.1 (Unreleased)
+## 1.2.0 (2024-03-01)
 
 ### Features Added
+- Add support for number lookup
+  - Format only can be returned for no cost
+  - Additional number details can be returned for a cost
 
-### Breaking Changes
+## 1.2.0-beta.1 (2023-09-07)
 
-### Bugs Fixed
+### Features Added
+- Number Lookup API public preview
+- API version `2023-05-01-preview` is the default
 
-### Other Changes
 
 ## 1.1.9 (2023-12-04)
 

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_04198d656b"
 }

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</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.implementation.models.OperatorInformationRequestOptions;
+import com.azure.communication.phonenumbers.models.OperatorInformationResult;
 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,36 @@ 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) {
+        return this.searchOperatorInformation(phoneNumbers, false);
+    }
+
+    /**
+     * Searches for operator information for a given list of phone numbers.
+     *
+     * @param phoneNumbers The phone number(s) whose operator information should be searched.
+     * @param includeAdditionalPhoneAndOperatorDetails Modifies the search to include additional fields in the response.
+     *                  Please note: use of this option 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, boolean includeAdditionalPhoneAndOperatorDetails) {
+        OperatorInformationRequest request = new OperatorInformationRequest();
+        request.setPhoneNumbers(phoneNumbers);
+        request.setOptions(new OperatorInformationRequestOptions().setIncludeAdditionalPhoneAndOperatorDetails(includeAdditionalPhoneAndOperatorDetails));
+        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))