bandwidth-sdk 16.2.2 → 17.0.0

data/bandwidth.yml

@@ -1328,62 +1328,66 @@ paths:
         '500':
           $ref: '#/components/responses/mfaInternalServerError'
     servers: *ref_2
-  /accounts/{accountId}/tnlookup:
+  /accounts/{accountId}/phoneNumberLookup:
     post:
-      deprecated: true
-      summary: Create Lookup
-      description: Create a Phone Number Lookup Request.
-      operationId: createLookup
+      summary: Create Synchronous Number Lookup
+      description: >-
+        Creates a synchronous phone number lookup request. Maximum of 100
+        telephone numbers per request.
+      operationId: createSyncLookup
       tags:
         - Phone Number Lookup
       parameters:
-        - $ref: '#/components/parameters/accountId'
+        - $ref: '#/components/parameters/accountId1'
       requestBody:
-        $ref: '#/components/requestBodies/createLookupRequest'
+        $ref: '#/components/requestBodies/createSyncLookupRequest'
       responses:
-        '202':
-          $ref: '#/components/responses/createLookupResponse'
-        '400':
-          $ref: '#/components/responses/tnLookupBadRequestError'
-        '401':
-          $ref: '#/components/responses/tnLookupUnauthorizedError'
-        '403':
-          $ref: '#/components/responses/tnLookupForbiddenError'
-        '415':
-          $ref: '#/components/responses/tnLookupMediaTypeError'
-        '429':
-          $ref: '#/components/responses/tnLookupTooManyRequestsError'
-        '500':
-          $ref: '#/components/responses/tnLookupInternalServerError'
+        '200':
+          $ref: '#/components/responses/createSyncLookupResponse'
+        default:
+          $ref: '#/components/responses/tnLookupDefaultResponse'
     servers: &ref_3
-      - url: https://numbers.bandwidth.com/api/v1
+      - url: https://api.bandwidth.com/v2
         description: Production
-  /accounts/{accountId}/tnlookup/{requestId}:
+  /accounts/{accountId}/phoneNumberLookup/bulk:
+    post:
+      summary: Create Asynchronous Bulk Number Lookup
+      description: >-
+        Creates an asynchronous bulk phone number lookup request. Maximum of
+        15,000 telephone numbers per request. Use the [Get Asynchronous Bulk
+        Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup)
+        endpoint to check the status of the request and view the results.
+      operationId: createAsyncBulkLookup
+      tags:
+        - Phone Number Lookup
+      parameters:
+        - $ref: '#/components/parameters/accountId1'
+      requestBody:
+        $ref: '#/components/requestBodies/createAsyncBulkLookupRequest'
+      responses:
+        '202':
+          $ref: '#/components/responses/createAsyncBulkLookupResponse'
+        default:
+          $ref: '#/components/responses/tnLookupDefaultResponse'
+    servers: *ref_3
+  /accounts/{accountId}/phoneNumberLookup/bulk/{requestId}:
     get:
-      deprecated: true
-      summary: Get Lookup Request Status
-      description: Get an existing Phone Number Lookup Request.
-      operationId: getLookupStatus
+      summary: Get Asynchronous Bulk Number Lookup
+      description: >-
+        Get an existing [Asynchronous Bulk Number
+        Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use
+        this endpoint to check the status of the request and view the results.
+      operationId: getAsyncBulkLookup
       tags:
         - Phone Number Lookup
       parameters:
-        - $ref: '#/components/parameters/accountId'
+        - $ref: '#/components/parameters/accountId1'
         - $ref: '#/components/parameters/requestId'
       responses:
         '200':
-          $ref: '#/components/responses/getLookupResponse'
-        '400':
-          $ref: '#/components/responses/tnLookupBadRequestError'
-        '401':
-          $ref: '#/components/responses/tnLookupUnauthorizedError'
-        '403':
-          $ref: '#/components/responses/tnLookupForbiddenError'
-        '404':
-          $ref: '#/components/responses/tnLookupNotFoundError'
-        '429':
-          $ref: '#/components/responses/tnLookupTooManyRequestsError'
-        '500':
-          $ref: '#/components/responses/tnLookupInternalServerError'
+          $ref: '#/components/responses/getAsyncBulkLookupResponse'
+        default:
+          $ref: '#/components/responses/tnLookupDefaultResponse'
     servers: *ref_3
   /accounts/{accountId}/tollFreeVerification:
     post:
@@ -5368,112 +5372,291 @@ components:
             The message containing the reason behind the request being
             forbidden.
           example: Missing Authentication Token
-    lookupStatusEnum:
+    completedLookupStatusEnum:
+      type: string
+      enum:
+        - COMPLETE
+        - PARTIAL_COMPLETE
+        - FAILED
+      example: COMPLETE
+    inProgressLookupStatusEnum:
       type: string
-      description: >-
-        The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or
-        FAILED).
       enum:
         - IN_PROGRESS
         - COMPLETE
         - PARTIAL_COMPLETE
         - FAILED
       example: COMPLETE
-    lookupRequest:
+    deactivationEventEnum:
+      type: string
+      description: >
+        [DNI-Only](#section/DNI-Only).
+
+        `DEACTIVATED` if the carrier reported a deactivation event for this
+        phone number.
+      enum:
+        - DEACTIVATED
+    latestMessageDeliveryStatusEnum:
+      type: string
+      description: >-
+        [DNI-Only](#section/DNI-Only). The current delivery status of the phone
+        number.
+
+        - ACTIVE: A message was successfully sent to the number (delivery code
+        0).
+
+        - DEACTIVATED: A message was not delivered to a number (delivery code
+        720)
+
+        - UNKNOWN: Bandwidth cannot find an delivery status entry for the
+        number.
+      enum:
+        - ACTIVE
+        - DEACTIVATED
+        - UNKNOWN
+    lineTypeEnum:
+      type: string
+      enum:
+        - FIXED
+        - VOIP-FIXED
+        - MOBILE
+        - VOIP
+      example: MOBILE
+    requestId:
+      type: string
+      format: uuid
+      description: The phone number lookup request ID from Bandwidth.
+      example: 004223a0-8b17-41b1-bf81-20732adf5590
+    linkSchema:
+      title: Link
       type: object
-      description: Create phone number lookup request.
       properties:
-        tns:
+        href:
+          type: string
+          description: URI of the link.
+          example: /relative/uri
+        rel:
+          type: string
+          description: Specifies the relationship between this link and the resource.
+          example: aRelatedResource
+        method:
+          type: string
+          description: HTTP method to be used.
+          example: GET
+    lookupErrorSchema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Validation error code
+          example: NO-MATCH
+        description:
+          type: string
+          description: Description of validation error
+          example: Example error description
+        type:
+          type: string
+          description: Type of validation error
+          example: NumberInventory
+        meta:
+          type: object
+          properties:
+            phoneNumbers:
+              type: array
+              items:
+                type: string
+                description: Phone number experiencing the error.
+              example:
+                - '+13992077164'
+                - '+19196104424'
+            message:
+              type: string
+              description: Message describing the error
+              example: Invalid TNs
+            code:
+              type: integer
+              description: Error code associated with the message
+              example: 1001
+    syncLookupRequest:
+      type: object
+      properties:
+        phoneNumbers:
+          description: Telephone numbers in E.164 format.
           type: array
+          minimum: 1
+          maximum: 100
           items:
             type: string
+            pattern: ^\+[1-9]\d{1,14}$
       required:
-        - tns
-    createLookupResponse:
+        - phoneNumbers
+    asyncLookupRequest:
       type: object
-      description: >-
-        The request has been accepted for processing but not yet finished and in
-        a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED).
       properties:
-        requestId:
-          type: string
-          description: The phone number lookup request ID from Bandwidth.
-        status:
-          $ref: '#/components/schemas/lookupStatusEnum'
-    lookupStatus:
+        phoneNumbers:
+          description: Telephone numbers in E.164 format.
+          type: array
+          minimum: 1
+          maximum: 15000
+          items:
+            type: string
+            pattern: ^\+[1-9]\d{1,14}$
+      required:
+        - phoneNumbers
+    createSyncLookupResponse:
       type: object
-      description: >-
-        If requestId exists, the result for that request is returned. See the
-        Examples for details on the various responses that you can receive.
-        Generally, if you see a Response Code of 0 in a result for a TN,
-        information will be available for it.  Any other Response Code will
-        indicate no information was available for the TN.
       properties:
-        requestId:
-          type: string
-          description: The requestId.
-          example: 004223a0-8b17-41b1-bf81-20732adf5590
-        status:
-          $ref: '#/components/schemas/lookupStatusEnum'
-        result:
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/linkSchema'
+          example: []
+        data:
+          type: object
+          description: The phone number lookup response data
+          properties:
+            requestId:
+              $ref: '#/components/schemas/requestId'
+            status:
+              $ref: '#/components/schemas/completedLookupStatusEnum'
+            results:
+              type: array
+              description: >-
+                The carrier information results for the specified telephone
+                numbers.
+              items:
+                $ref: '#/components/schemas/lookupResult'
+        errors:
           type: array
-          description: The carrier information results for the specified telephone number.
           items:
-            $ref: '#/components/schemas/lookupResult'
-        failedTelephoneNumbers:
+            $ref: '#/components/schemas/lookupErrorSchema'
+    createAsyncBulkLookupResponse:
+      type: object
+      properties:
+        links:
           type: array
-          description: The telephone numbers whose lookup failed.
+          description: Links for pagination (if applicable)
           items:
-            type: string
-          example:
-            - '+191955512345'
+            $ref: '#/components/schemas/linkSchema'
+        data:
+          type: object
+          description: The phone number lookup response data
+          properties:
+            requestId:
+              $ref: '#/components/schemas/requestId'
+            status:
+              $ref: '#/components/schemas/inProgressLookupStatusEnum'
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/lookupErrorSchema'
+    getAsyncBulkLookupResponse:
+      type: object
+      properties:
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/linkSchema'
+          example: []
+        data:
+          type: object
+          description: The phone number lookup response data
+          properties:
+            requestId:
+              $ref: '#/components/schemas/requestId'
+            status:
+              $ref: '#/components/schemas/inProgressLookupStatusEnum'
+            results:
+              type: array
+              description: >-
+                The carrier information results for the specified telephone
+                number.
+              items:
+                $ref: '#/components/schemas/lookupResult'
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/lookupErrorSchema'
+    lookupErrorResponse:
+      type: object
+      properties:
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/linkSchema'
+          example: []
+        data:
+          type: object
+          description: The phone number lookup response data
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/lookupErrorSchema'
     lookupResult:
       type: object
       description: Carrier information results for the specified telephone number.
       properties:
-        Response Code:
-          type: integer
-          description: Our vendor's response code.
-          example: 0
-        Message:
-          type: string
-          description: Message associated with the response code.
-          example: NOERROR
-        E.164 Format:
+        phoneNumber:
           type: string
           description: The telephone number in E.164 format.
-          example: '+19195551234'
-        Formatted:
-          type: string
-          description: The formatted version of the telephone number.
-          example: (919) 555-1234
-        Country:
-          type: string
-          description: The country of the telephone number.
-          example: US
-        Line Type:
-          type: string
-          description: The line type of the telephone number.
-          example: Mobile
-        Line Provider:
+          example: '+10072904498'
+        lineType:
+          $ref: '#/components/schemas/lineTypeEnum'
+        messagingProvider:
           type: string
           description: The messaging service provider of the telephone number.
           example: Verizon Wireless
-        Mobile Country Code:
+        voiceProvider:
           type: string
-          description: The first half of the Home Network Identity (HNI).
-          example: '310'
-        Mobile Network Code:
+          description: The voice service provider of the telephone number.
+          example: Verizon Wireless
+        countryCodeA3:
           type: string
-          description: The second half of the HNI.
-          example: '010'
-    tnLookupRequestError:
-      type: object
-      properties:
-        message:
+          description: >-
+            The country code of the telephone number in ISO 3166-1 alpha-3
+            format.
+          example: USA
+        deactivationReporter:
+          type: string
+          description: >
+            [DNI-Only](#section/DNI-Only).
+
+            The carrier that reported a deactivation event for this phone
+            number.
+        deactivationDate:
+          type: string
+          format: date-time-local
+          description: >-
+            [DNI-Only](#section/DNI-Only). The datetime the carrier reported a
+            deactivation event.
+          example: 2025-06-20 18:35
+        deactivationEvent:
+          $ref: '#/components/schemas/deactivationEventEnum'
+        latestMessageDeliveryStatus:
+          $ref: '#/components/schemas/latestMessageDeliveryStatusEnum'
+        initialMessageDeliveryStatusDate:
+          type: string
+          format: date
+          description: >-
+            [DNI-Only](#section/DNI-Only). The date the phone number entered the
+            status described in `latestMessageDeliveryStatus`. 
+
+            Think of this as the "start time" for that status.
+
+            Value resets every time the `latestMessageDeliveryStatus` changes.
+          example: '2025-06-20'
+        latestMessageDeliveryStatusDate:
           type: string
-          description: A description of what validation error occurred.
-          example: example error message
+          format: date
+          description: >-
+            [DNI-Only](#section/DNI-Only). The date bandwidth last received
+            delivery status information for this phone number. 
+
+            Use this field to understand how up-to-date the
+            `latestMessageDeliveryStatus` is.
+
+            Value resets every time the `latestMessageDeliveryStatus` changes.
+          example: '2025-06-21'
     accountId1:
       type: string
       description: User's account ID.
@@ -6720,109 +6903,68 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/mfaRequestError'
-    createLookupResponse:
+    createSyncLookupResponse:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/createSyncLookupResponse'
+          examples:
+            lookupCompleteWithDniExample:
+              $ref: '#/components/examples/lookupCompleteWithDniExample'
+            lookupCompleteExample:
+              $ref: '#/components/examples/lookupCompleteExample'
+            lookupPartialExample:
+              $ref: '#/components/examples/lookupPartialExample'
+            lookupFailedExample:
+              $ref: '#/components/examples/lookupFailedExample'
+    createAsyncBulkLookupResponse:
       description: Accepted
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/createLookupResponse'
+            $ref: '#/components/schemas/createAsyncBulkLookupResponse'
           examples:
-            lookupResponseExample:
+            lookupInProgressExample:
               $ref: '#/components/examples/lookupInProgressExample'
-    getLookupResponse:
+    getAsyncBulkLookupResponse:
       description: OK
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/lookupStatus'
+            $ref: '#/components/schemas/getAsyncBulkLookupResponse'
           examples:
+            lookupCompleteWithDniExample:
+              $ref: '#/components/examples/lookupCompleteWithDniExample'
+            lookupCompleteExample:
+              $ref: '#/components/examples/lookupCompleteExample'
             lookupInProgressExample:
               $ref: '#/components/examples/lookupInProgressExample'
+            lookupPartialExample:
+              $ref: '#/components/examples/lookupPartialExample'
             lookupFailedExample:
               $ref: '#/components/examples/lookupFailedExample'
-            lookupSingleNumberCompleteExample:
-              $ref: '#/components/examples/lookupSingleNumberCompleteExample'
-            lookupMultipleNumbersCompleteExample:
-              $ref: '#/components/examples/lookupMultipleNumbersCompleteExample'
-            lookupMultipleNumbersPartialCompleteExample:
-              $ref: >-
-                #/components/examples/lookupMultipleNumbersPartialCompleteExample
-            lookupSingleNumberCompleteNoInfoExample:
-              $ref: '#/components/examples/lookupSingleNumberCompleteNoInfoExample'
-    tnLookupBadRequestError:
+    tnLookupDefaultResponse:
       description: Bad Request
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
+            $ref: '#/components/schemas/lookupErrorResponse'
           examples:
             badRequest:
-              summary: Example Bad Request Error
-              value:
-                message: 'Some tns do not match e164 format: 1234'
-    tnLookupUnauthorizedError:
-      description: Unauthorized
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
-          examples:
+              $ref: '#/components/examples/badRequestExample'
             unauthorized:
-              summary: Example Unauthorized Error
-              value:
-                message: Unauthorized
-    tnLookupForbiddenError:
-      description: Forbidden
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
-          examples:
+              $ref: '#/components/examples/unauthorizedExample'
             forbidden:
-              summary: Example Forbidden Error
-              value:
-                message: >-
-                  Authorization header requires 'Credential' parameter.
-                  Authorization header requires 'Signature' parameter.
-                  Authorization header requires 'SignedHeaders' parameter.
-                  Authorization header requires existence of either a
-                  'X-Amz-Date' or a 'Date' header. Authorization=Basic
-                  Y2tvZloPTGhHgywYIzGlcGVlcGvvcGovYTIGIt=='
-    tnLookupMediaTypeError:
-      description: Unsupported Media Type
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
-          examples:
-            mediaType:
-              summary: Example Unsupported Media Type Error
-              value:
-                message: Content-Type must be application/json.
-    tnLookupNotFoundError:
-      description: Not Found
-    tnLookupTooManyRequestsError:
-      description: Too Many Requests
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
-          examples:
+              $ref: '#/components/examples/forbiddenExample'
             mediaType:
-              summary: Example Too Many Requests Error
-              value:
-                message: Too many requests.
-    tnLookupInternalServerError:
-      description: Internal Server Error
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tnLookupRequestError'
-          examples:
-            mediaType:
-              summary: Example Internal Server Error Error
-              value:
-                message: Request has not been passed further.
+              $ref: '#/components/examples/unsupportedMediaTypeExample'
+            notFound:
+              $ref: '#/components/examples/notFoundExample'
+            tooManyRequests:
+              $ref: '#/components/examples/tooManyRequestsExample'
+            internalServer:
+              $ref: '#/components/examples/internalServerErrorExample'
     getTollFreeVerificationStatusResponse:
       description: OK
       content:
@@ -7405,14 +7547,23 @@ components:
         type: string
       description: Filter results to calls with specified call Disconnect Cause.
       example: hangup
+    accountId1:
+      in: path
+      name: accountId
+      required: true
+      schema:
+        type: string
+        description: Your Bandwidth Account ID.
+        example: '9900000'
     requestId:
-      name: requestId
       in: path
+      name: requestId
       required: true
       schema:
         type: string
-      description: The phone number lookup request ID from Bandwidth.
-      example: 004223a0-8b17-41b1-bf81-20732adf5590
+        format: uuid
+        description: The phone number lookup request ID from Bandwidth.
+        example: 004223a0-8b17-41b1-bf81-20732adf5590
     tfPhoneNumberPathParam:
       in: path
       name: phoneNumber
@@ -7651,95 +7802,208 @@ components:
         type: validation
         description: 'Invalid answerUrl: only http and https are allowed.'
     singleNumberRequestExample:
-      summary: Example Number Lookup Request for One Number
+      summary: Number Lookup Request
       value:
-        tns:
-          - '+19195551234'
+        phoneNumbers:
+          - '+19196104423'
     multipleNumberRequestExample:
-      summary: Example Number Lookup Request for Multiple Numbers
+      summary: Number Lookup Request for Multiple Numbers
       value:
-        tns:
-          - '+19195551234'
-          - '+19195554321'
+        phoneNumbers:
+          - '+19196104423'
+          - '+19196104424'
     lookupInProgressExample:
-      summary: Example Lookup In Progress Response
+      summary: Numbers Lookup In Progress
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: IN_PROGRESS
+        links:
+          - href: href
+            rel: rel
+            method: GET
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: IN_PROGRESS
+          results: []
+        errors: []
     lookupFailedExample:
-      summary: Example Lookup Failed Response
+      summary: Numbers Lookup Failed
+      value:
+        links:
+          - href: href
+            rel: rel
+            method: GET
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: FAILED
+          results: []
+        errors:
+          - code: NO-MATCH
+            description: The following TNs could not be found in the Number Industry data
+            meta:
+              phoneNumbers:
+                - '+13992077164'
+              message: Invalid TNs
+              code: 1001
+            type: NumberInventory
+    lookupPartialExample:
+      summary: Numbers Lookup Partial Complete
+      value:
+        links:
+          - href: href
+            rel: rel
+            method: GET
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: PARTIAL_COMPLETE
+          results:
+            - phoneNumber: '+19196104423'
+              lineType: MOBILE
+              messagingProvider: Verizon Wireless
+              voiceProvider: Verizon Wireless
+              countryCodeA3: USA
+            - phoneNumber: '+19196104424'
+              lineType: MOBILE
+              messagingProvider: T-Mobile USA
+              voiceProvider: T-Mobile USA
+              countryCodeA3: USA
+        errors:
+          - code: NO-MATCH
+            description: The following TNs could not be found in the Number Industry data
+            meta:
+              phoneNumbers:
+                - '+13992077164'
+              message: Invalid TNs
+              code: 1001
+            type: NumberInventory
+    lookupCompleteExample:
+      summary: Numbers Lookup Complete (without DNI)
+      value:
+        links:
+          - href: href
+            rel: rel
+            method: GET
+        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: []
+    lookupCompleteWithDniExample:
+      summary: Numbers Lookup Complete (with DNI)
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: FAILED
-        failedTelephoneNumbers:
-          - '+191955512345'
-    lookupSingleNumberCompleteExample:
-      summary: Example Single Number Lookup Complete Response
+        links:
+          - href: href
+            rel: rel
+            method: GET
+        data:
+          requestId: 20732adf-bf81-8b17-41b1-004223a05590
+          status: COMPLETE
+          results:
+            - phoneNumber: '+10072904497'
+              countryCodeA3: USA
+              lineType: MOBILE
+              messagingProvider: T-MOBILE USA INC
+              voiceProvider: T-MOBILE USA INC
+              latestMessageDeliveryStatus: ACTIVE
+              initialMessageDeliveryStatusDate: '2025-05-14'
+              latestMessageDeliveryStatusDate: '2025-05-18'
+            - phoneNumber: '+10072904498'
+              countryCodeA3: USA
+              lineType: FIXED
+              voiceProvider: VERIZON
+              latestMessageDeliveryStatus: DEACTIVATED
+              initialMessageDeliveryStatusDate: '2025-09-05'
+              latestMessageDeliveryStatusDate: '2025-09-05'
+            - phoneNumber: '+10072904499'
+              lineType: MOBILE
+              countryCodeA3: USA
+              messagingProvider: VERIZON
+              voiceProvider: VERIZON
+              deactivationReporter: Verizon Wireless
+              deactivationDate: '2025-09-29 01:23:00'
+              deactivationEvent: DEACTIVATED
+              latestMessageDeliveryStatus: UNKNOWN
+        errors: []
+    badRequestExample:
+      summary: Example Bad Request Error
+      value:
+        links: []
+        data: {}
+        errors:
+          - type: bad-request
+            description: >-
+              Bad Request. Ensure that you have set the requestId as a URL path
+              parameter.
+    unauthorizedExample:
+      summary: Unauthorized Error
+      value:
+        links: []
+        data: {}
+        errors:
+          - type: Unauthorized
+            description: You are not authorized to access this resource.
+            code: '1'
+        page: null
+    forbiddenExample:
+      summary: Forbidden Error
+      value:
+        links: []
+        data: {}
+        errors:
+          - type: Forbidden
+            description: You do not have permission to access this resource.
+            code: '2'
+        page: null
+    unsupportedMediaTypeExample:
+      summary: Unsupported Media Type Error
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-    lookupMultipleNumbersCompleteExample:
-      summary: Example Multiple Numbers Lookup Complete Response
+        links: []
+        data: {}
+        errors:
+          - type: invalid-content-type
+            description: >-
+              Invalid content-type. Ensure that your content-type header is set
+              to application/json.
+    notFoundExample:
+      summary: Not Found Error
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195554321'
-            Formatted: (919) 555-4321
-            Country: US
-            Line Type: Mobile
-            Line Provider: T-Mobile USA
-            Mobile Country Code: '310'
-            Mobile Network Code: '160'
-    lookupMultipleNumbersPartialCompleteExample:
-      summary: Example Multiple Numbers Lookup Partial Complete Response
+        links: []
+        data: {}
+        errors:
+          - type: not-found
+            description: >-
+              RequestId not found. Ensure that the requestId used in the URL
+              path is valid and maps to a previous request that was submitted.
+    tooManyRequestsExample:
+      summary: Too Many Requests Error
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: PARTIAL_COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-        failedTelephoneNumbers:
-          - '+191955512345'
-    lookupSingleNumberCompleteNoInfoExample:
-      summary: Example Single Number Lookup Complete with No Information Response
+        links: []
+        data: {}
+        errors:
+          - type: rate-limiting
+            description: >-
+              Rate limit exceeded. Wait for the time specified in the
+              Retry-After header before sending another request.
+    internalServerErrorExample:
+      summary: Internal Server Error
       value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 3
-            Message: NXDOMAIN
-            E.164 Format: '+19195550000'
-            Formatted: (919) 555-0000
-            Country: US
+        links: []
+        data: {}
+        errors:
+          - code: '500'
+            type: unexpected-error
+            description: >-
+              Unexpected error. Please contact Bandwidth Support if your
+              requests are receiving this status code for an extended period of
+              time.
   requestBodies:
     createMessageRequest:
       content:
@@ -8039,18 +8303,28 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/verifyCodeRequest'
-    createLookupRequest:
-      description: Phone number lookup request.
+    createSyncLookupRequest:
+      description: Synchronous phone number lookup request.
       required: true
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/lookupRequest'
+            $ref: '#/components/schemas/syncLookupRequest'
           examples:
             singleNumberRequestExample:
               $ref: '#/components/examples/singleNumberRequestExample'
             multipleNumberRequestExample:
               $ref: '#/components/examples/multipleNumberRequestExample'
+    createAsyncBulkLookupRequest:
+      description: Asynchronous bulk phone number lookup request.
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/asyncLookupRequest'
+          examples:
+            multipleNumberRequestExample:
+              $ref: '#/components/examples/multipleNumberRequestExample'
     requestTollFreeVerificationRequest:
       description: Request for verification of a toll-free phone number.
       required: true