Merge branch 'main' into brtc-java-sdk

Author: smoghe-bw

api/openapi.yaml

@@ -4741,6 +4741,10 @@ paths:
                   $ref: "#/components/examples/lookupCompleteWithDniExample"
                 lookupCompleteExample:
                   $ref: "#/components/examples/lookupCompleteExample"
+                lookupCompleteWithRcsExample:
+                  $ref: "#/components/examples/lookupCompleteWithRcsExample"
+                lookupCompleteWithRcsErrorExample:
+                  $ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
                 lookupPartialExample:
                   $ref: "#/components/examples/lookupPartialExample"
                 lookupFailedExample:
@@ -4802,8 +4806,8 @@ paths:
           content:
             application/json:
               examples:
-                lookupInProgressExample:
-                  $ref: "#/components/examples/lookupInProgressExample"
+                lookupAcceptedExample:
+                  $ref: "#/components/examples/lookupAcceptedExample"
               schema:
                 $ref: "#/components/schemas/createAsyncBulkLookupResponse"
           description: Accepted
@@ -6821,25 +6825,31 @@ components:
         phoneNumbers:
         - "+19196104423"
         - "+19196104424"
-    lookupInProgressExample:
-      summary: Numbers Lookup In Progress
+    lookupAcceptedExample:
+      summary: Numbers Lookup Accepted
       value:
         links:
-        - href: href
-          rel: rel
+        - href: /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
+          rel: createdRequest
           method: GET
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: IN_PROGRESS
           results: []
         errors: []
+    lookupInProgressExample:
+      summary: Numbers Lookup In Progress
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: IN_PROGRESS
+          results: []
+        errors: []
     lookupFailedExample:
       summary: Numbers Lookup Failed
       value:
-        links:
-        - href: href
-          rel: rel
-          method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: FAILED
@@ -6857,10 +6867,7 @@ components:
     lookupPartialExample:
       summary: Numbers Lookup Partial Complete
       value:
-        links:
-        - href: href
-          rel: rel
-          method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: PARTIAL_COMPLETE
@@ -6888,10 +6895,7 @@ components:
     lookupCompleteExample:
       summary: Numbers Lookup Complete (without DNI)
       value:
-        links:
-        - href: href
-          rel: rel
-          method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: COMPLETE
@@ -6910,10 +6914,7 @@ components:
     lookupCompleteWithDniExample:
       summary: Numbers Lookup Complete (with DNI)
       value:
-        links:
-        - href: href
-          rel: rel
-          method: GET
+        links: []
         data:
           requestId: 20732adf-bf81-8b17-41b1-004223a05590
           status: COMPLETE
@@ -6951,6 +6952,58 @@ components:
             deactivationEvent: DEACTIVATED
             latestMessageDeliveryStatus: NOT_ENABLED
         errors: []
+    lookupCompleteWithRcsExample:
+      summary: Numbers Lookup Complete (with RCS)
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: COMPLETE
+          results:
+          - phoneNumber: "+10072904497"
+            lineType: MOBILE
+            messagingProvider: Verizon Wireless
+            voiceProvider: Verizon Wireless
+            countryCodeA3: USA
+            rcsEnabled: true
+          - phoneNumber: "+10072904498"
+            lineType: MOBILE
+            messagingProvider: T-Mobile USA
+            voiceProvider: T-Mobile USA
+            countryCodeA3: USA
+            rcsEnabled: false
+        errors: []
+    lookupCompleteWithRcsErrorExample:
+      summary: Numbers Lookup Complete (with RCS error)
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: COMPLETE
+          results:
+          - phoneNumber: "+10072904497"
+            lineType: MOBILE
+            messagingProvider: Verizon Wireless
+            voiceProvider: Verizon Wireless
+            countryCodeA3: USA
+          - phoneNumber: "+10072904498"
+            lineType: MOBILE
+            messagingProvider: T-Mobile USA
+            voiceProvider: T-Mobile USA
+            countryCodeA3: USA
+        errors:
+        - code: RCS_SERVICE_UNAVAILABLE
+          type: rcs-error
+          description: An exception was thrown during the async RCS service call.
+          meta:
+            phoneNumbers:
+            - "+10072904497"
+        - code: MISSING_FROM_RESPONSE
+          type: rcs-error
+          description: The phone number was absent from the RCS service response.
+          meta:
+            phoneNumbers:
+            - "+10072904498"
     badRequestExample:
       summary: Example Bad Request Error
       value:
@@ -8715,6 +8768,10 @@ components:
               $ref: "#/components/examples/lookupCompleteWithDniExample"
             lookupCompleteExample:
               $ref: "#/components/examples/lookupCompleteExample"
+            lookupCompleteWithRcsExample:
+              $ref: "#/components/examples/lookupCompleteWithRcsExample"
+            lookupCompleteWithRcsErrorExample:
+              $ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
             lookupPartialExample:
               $ref: "#/components/examples/lookupPartialExample"
             lookupFailedExample:
@@ -8726,8 +8783,8 @@ components:
       content:
         application/json:
           examples:
-            lookupInProgressExample:
-              $ref: "#/components/examples/lookupInProgressExample"
+            lookupAcceptedExample:
+              $ref: "#/components/examples/lookupAcceptedExample"
           schema:
             $ref: "#/components/schemas/createAsyncBulkLookupResponse"
       description: Accepted
@@ -14340,6 +14397,10 @@ components:
           type: string
         meta:
           $ref: "#/components/schemas/lookupErrorSchema_meta"
+      required:
+      - code
+      - description
+      - type
       type: object
     syncLookupRequest:
       properties:
@@ -14379,6 +14440,7 @@ components:
             phoneNumber: "+10072904498"
             countryCodeA3: USA
             initialMessageDeliveryStatusDate: 2025-06-20
+            rcsEnabled: true
             lineType: MOBILE
             deactivationReporter: deactivationReporter
             voiceProvider: Verizon Wireless
@@ -14390,6 +14452,7 @@ components:
             phoneNumber: "+10072904498"
             countryCodeA3: USA
             initialMessageDeliveryStatusDate: 2025-06-20
+            rcsEnabled: true
             lineType: MOBILE
             deactivationReporter: deactivationReporter
             voiceProvider: Verizon Wireless
@@ -14484,6 +14547,7 @@ components:
             phoneNumber: "+10072904498"
             countryCodeA3: USA
             initialMessageDeliveryStatusDate: 2025-06-20
+            rcsEnabled: true
             lineType: MOBILE
             deactivationReporter: deactivationReporter
             voiceProvider: Verizon Wireless
@@ -14495,6 +14559,7 @@ components:
             phoneNumber: "+10072904498"
             countryCodeA3: USA
             initialMessageDeliveryStatusDate: 2025-06-20
+            rcsEnabled: true
             lineType: MOBILE
             deactivationReporter: deactivationReporter
             voiceProvider: Verizon Wireless
@@ -14570,6 +14635,23 @@ components:
             $ref: "#/components/schemas/lookupErrorSchema"
           type: array
       type: object
+    rcsErrorEnum:
+      description: |-
+        [RCS-Only](#section/RCS-Only). Error encountered during RCS capability lookup. Appears as the `code` field in the top-level `errors` array.
+
+        **RCS service pass-through codes:**
+        - `REQUEST_FAILED`: The RCS service returned this error code.
+        - `UNKNOWN_CODE`: The RCS service returned this error code.
+        - `INVALID_DESTINATION_ADDRESS`: The RCS service returned this error code.
+        - `UNKNOWN_STATUS: <code>`: The RCS service returned an unrecognized status code, where `<code>` is the raw value.
+
+        **Service-level errors:**
+        - `MISSING_FROM_RESPONSE`: The phone number was absent from the RCS service response.
+        - `RCS_SERVICE_UNAVAILABLE`: An exception was thrown during the async RCS service call.
+        - `RCS_SERVICE_DISABLED`: RCS lookup is disabled in configuration.
+        - `EMPTY_RESPONSE`: The RCS service returned a null or empty response body.
+      example: RCS_SERVICE_UNAVAILABLE
+      type: string
     lookupResult:
       description: Carrier information results for the specified telephone number.
       example:
@@ -14580,6 +14662,7 @@ components:
         phoneNumber: "+10072904498"
         countryCodeA3: USA
         initialMessageDeliveryStatusDate: 2025-06-20
+        rcsEnabled: true
         lineType: MOBILE
         deactivationReporter: deactivationReporter
         voiceProvider: Verizon Wireless
@@ -14635,6 +14718,11 @@ components:
           example: 2025-06-21
           format: date
           type: string
+        rcsEnabled:
+          description: |
+            [RCS-Only](#section/RCS-Only). Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS.
+          example: true
+          type: boolean
       type: object
     accountId1:
       description: User's account ID.
@@ -16444,6 +16532,7 @@ components:
           phoneNumber: "+10072904498"
           countryCodeA3: USA
           initialMessageDeliveryStatusDate: 2025-06-20
+          rcsEnabled: true
           lineType: MOBILE
           deactivationReporter: deactivationReporter
           voiceProvider: Verizon Wireless
@@ -16455,6 +16544,7 @@ components:
           phoneNumber: "+10072904498"
           countryCodeA3: USA
           initialMessageDeliveryStatusDate: 2025-06-20
+          rcsEnabled: true
           lineType: MOBILE
           deactivationReporter: deactivationReporter
           voiceProvider: Verizon Wireless
@@ -16501,6 +16591,7 @@ components:
           phoneNumber: "+10072904498"
           countryCodeA3: USA
           initialMessageDeliveryStatusDate: 2025-06-20
+          rcsEnabled: true
           lineType: MOBILE
           deactivationReporter: deactivationReporter
           voiceProvider: Verizon Wireless
@@ -16512,6 +16603,7 @@ components:
           phoneNumber: "+10072904498"
           countryCodeA3: USA
           initialMessageDeliveryStatusDate: 2025-06-20
+          rcsEnabled: true
           lineType: MOBILE
           deactivationReporter: deactivationReporter
           voiceProvider: Verizon Wireless