openapi: 3.0.1
info:
  title: Number Acquisition
  description: >-
    Bandwidth's Number Acquisition API


    This API provides endpoints to order phone numbers via a New Number Order
    and to import previously acquired telephone numbers into an account via an
    Import to Account Orders order.
  contact:
    name: Bandwidth
    url: https://dev.bandwidth.com/apis/numbers-apis/number-acquisition/
    email: support@bandwidth.com
  version: 1.0.0
  termsOfService: https://www.bandwidth.com/legal/terms-of-service/
servers:
  - url: https://api.bandwidth.com/api/v2
    description: Production
security:
  - Basic: []
  - Bearer: []
paths:
  /accounts/{accountId}/orders:
    get:
      description: >-
        Retrieve order IDs and order details for previously attempted new phone
        number orders. A maximum of 1,000 orders can be retrieved per request.
        If no date range or specific query parameter (marked by <b
        class="required">*</b> below) is provided, the order results will be
        limited to the last two years.

        <p>This request will return a list of the orders that match the criteria
        imposed by the provided query parameters.  The orders list contains a
        detailed description of each order.  Notice that the first elements of
        the payload provide link information that can be used to page through a
        paginated list of orders.  Pagination can be controlled by use of the
        size and page query parameters.</p>

        <p>This order returns a <code>204: No Content</code> when the endpoint
        finds no results matching the parameters provided.</p>
      operationId: listNewPhoneNumberOrders
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/requiredPageQueryParam'
        - $ref: '#/components/parameters/requiredSizeQueryParam'
        - $ref: '#/components/parameters/startDateQueryParam'
        - $ref: '#/components/parameters/endDateQueryParam'
        - $ref: '#/components/parameters/customerOrderIdQueryParam'
        - $ref: '#/components/parameters/newPhoneNumberOrderStatusQueryParam'
        - $ref: '#/components/parameters/userIdQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/listNewPhoneNumberOrders200Response'
        '204':
          $ref: '#/components/responses/listNewPhoneNumberOrders204Response'
        '400':
          $ref: '#/components/responses/listNewPhoneNumberOrders400Response'
      summary: List New Number Orders
      tags:
        - New Number Orders
    post:
      description: >-
        <span>A POST to the /orders resource is used to request that the system
        provide one or more phone number(s) for use by the account. The post
        creates a new number order record to preserve the request, as well as
        the response of the Bandwidth App API to the request.  A well-formed
        POST on the /orders resource will create an order record, and return an
        order ID string that can be used to uniquely identify the new number
        order request. 


        Capabilities that are not universally available are defined in the table
        below. The following request schemas and parameters are only allowed for
        numbers from specific region/country:

        | Number Region | Request Object Type | Request Parameter |

        |:--------------|:------------------|------------------|

        |NANP|rateCenterSearchAndOrderType|-|

        |NANP|areaCodeSearchAndOrderType|-|

        |NANP|npaNxxSearchAndOrderType|-|

        |NANP|tollFreeWildCharSearchAndOrderType|-|

        |NANP|tollFreeVanitySearchAndOrderType|-|

        |NANP|lataSearchAndOrderType|-|

        |NANP|zipSearchAndOrderType|-|

        |NANP|citySearchAndOrderType|-|

        |NANP|stateSearchAndOrderType|-|

        |NANP|combinedSearchAndOrderType|-|

        |NANP|-|backOrderRequested|

        |NANP|-|closeOrder|

        |NANP|-|protected TnAttribute|

        |NANP|-|reservationIdList in ExistingTelephoneNumberOrderType schema|


        <p>Please visit <a
        href='/docs/numbers/guides/searchingForNumbers/'>Guides and
        Tutorials</a> to learn more.</p>
      operationId: createNewPhoneNumberOrder
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/createNewPhoneNumberOrderRequest'
      responses:
        '201':
          $ref: '#/components/responses/createNewPhoneNumberOrder201Response'
        '400':
          $ref: '#/components/responses/createNewPhoneNumberOrder400Response'
      summary: Create New Number Orders
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/totals:
    get:
      description: Retrieves a total number of phone number orders.
      operationId: getTotalOrdersByStatus
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/statusQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/newNumberOrderTotalsResponse200'
      summary: Get New Number Order Phone Number Count Totals
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}:
    get:
      description: >-
        Get all of the details associated with an identified order. <p>Please
        visit <a href='/docs/numbers/guides/searchingForNumbers/'>Guides and
        Tutorials</a> to learn more.</p>
      operationId: getNewPhoneNumberOrder
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
        - $ref: >-
            #/components/parameters/newPhoneNumberOrderPhoneNumberDetailQueryParam
      responses:
        '200':
          $ref: '#/components/responses/retrieveNewPhoneNumberOrder200Response'
        '404':
          $ref: '#/components/responses/retrieveNewPhoneNumberOrder404Response'
      summary: Get New Number Order Details
      tags:
        - New Number Orders
    put:
      description: >-
        For orders that support Backorder capabilities, new number orders may
        stay in backordered state while the order is filled. While in this state
        it is possible to update the modifiable fields in the record, as well as
        to request that backorder processing of the order be ended.

        The fields that can be updated are...


        <ul>

        <li>The order name</li>

        <li>The customer order ID</li>

        <li>The backordered state.</li>

        </ul>


        Specifying a &lt;CloseOrder&gt; element (XML) or "closeOrder" key (JSON)
        with a value of true will cancel the backorder request, leaving the
        currently ordered numbers on the account.  No further numbers will be
        added to the account as a result of the order.
      operationId: updateNewPhoneNumberOrder
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/updateNewPhoneNumberOrderRequest'
      responses:
        '200':
          $ref: '#/components/responses/updateNewPhoneNumberOrder200Response'
        '400':
          $ref: '#/components/responses/updateNewPhoneNumberOrder400Response'
        '404':
          $ref: '#/components/responses/updateNewPhoneNumberOrder404Response'
      summary: Update New Number Order
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/areaCodes:
    get:
      description: Retrieves the area codes of the phone numbers from the specified order.
      operationId: listOrderAreaCodes
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/newNumberOrderAreaCodesResponse200'
      summary: List New Number Order Area Codes [NANP]
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/history:
    get:
      description: Retrieve a full history of updates and changes associated with an order.
      operationId: getOrderHistory
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getNewNumberOrderHistoryResponse200'
        '404':
          $ref: '#/components/responses/getNewNumberOrderHistoryResponse404'
      summary: Get New Number Order History
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/notes:
    get:
      description: >-
        Retrieve all notes associated with the order.

        <p>This order returns a <code>204: No Content</code> when the endpoint
        finds no results matching the parameters provided.</p>
      operationId: listOrderNotes
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/newNumberOrderNotesGetResponse200'
        '204':
          $ref: '#/components/responses/newNumberOrderNotesGetResponse204'
      summary: List New Number Order Notes
      tags:
        - New Number Orders
    post:
      description: >-
        Add a note to an order. This causes a notification to be sent to
        Bandwidth Operations, so that they may assist as necessary. A note may
        be up to 500 characters in length.
      operationId: createOrderNote
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/postNewNumberOrderNotesRequest'
      responses:
        '201':
          $ref: '#/components/responses/newNumberOrderNotesPostResponse201'
        '400':
          $ref: '#/components/responses/newNumberOrderNotesPostResponse400'
      summary: Create New Number Order Note
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/notes/{noteId}:
    put:
      description: Update a specified note. Notes may only be updated, not deleted.
      operationId: updateOrderNote
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
        - $ref: '#/components/parameters/noteIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/putNewNumberOrderNotesRequest'
      responses:
        '200':
          $ref: '#/components/responses/putNewNumberOrderNotesResponse200'
        '400':
          $ref: '#/components/responses/putNewNumberOrderNotesResponse400'
      summary: Update New Number Order Note
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/npaNxx:
    get:
      description: Retrieves the Npa-Nxx of the phone numbers from the specified order.
      operationId: listOrderNpaNxx
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getNewNumberOrderNpaNxxResponse200'
      summary: List New Number Order Npa-Nxx [NANP]
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/tns:
    get:
      description: >-
        Returns a list of phone numbers associated with the ID of a given new
        number order.
      operationId: listOrderTns
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getNewNumberOrderTnListResponse200'
        '404':
          $ref: '#/components/responses/getNewNumberOrderTnListResponse404'
      summary: List Phone Numbers from a New Number Order
      tags:
        - New Number Orders
  /accounts/{accountId}/orders/{orderId}/totals:
    get:
      description: >-
        Retrieves the total quantity of phone numbers from the specified new
        number order.
      operationId: getOrderTotals
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getNewNumberOrderIdTotalsResponse200'
      summary: Get Quantity Of Phone Numbers In New Number Order
      tags:
        - New Number Orders
  /cities:
    get:
      description: >-
        The /cities resource returns all the cities in the indicated state that
        are supported from a coverage perspective and, if requested, that
        contain orderable inventory. The values returned indicate the names of
        the cities and, if <b>available</b> is specified, then returns the
        available inventory by city. Note that the mapping between rate center
        and city is not completely predictable because multiple cities can be
        served by a single rate center and it may take multiple rate centers to
        serve a city. The rate centers results are more predictable because they
        are defined strictly in telecommunication terms. The rate centers and
        cities API calls return information about the Bandwidth CLEC network,
        including coverage data, indicating both the extent of on-net and
        off-net coverage, as well as number availability, again from an on-net
        and off-net perspective. The rules are as follows: <ul><li>If
        supported=true is specified, then the coverage or availability is
        reported for the Bandwidth CLEC only.</li><li>If supported is omitted or
        false, then the coverage or availability is reported for the combination
        of the Bandwidth CLEC and our partners.</li><li>If available=true is
        specified, then only rate centers in which we have available numbers are
        reported.</li><li>If available is omitted or false, then all rate
        centers within the scope defined by supported will be
        returned.</li></ul>These rules apply to both the /rateCenters and
        /cities API calls. <table border="1" cellpadding="0" cellspacing="0">
        <tbody> <tr> <td valign="top"> </td> <td valign="top"> Supported = true
        </td> <td valign="top"> Supported is missing </td> </tr> <tr> <td
        valign="top"> available = true </td> <td valign="top"> Available numbers
        within the Bandwidth CLEC network </td> <td valign="top"> Available
        numbers within the Bandwidth CLEC network combined with our partner
        networks </td> </tr> <tr> <td valign="top"> available is missing </td>
        <td valign="top"> Coverage in the Bandwidth CLEC </td> <td valign="top">
        Coverage of the combined Bandwidth CLEC + Partner networks </td> </tr>
        </tbody> </table>
      operationId: listCities
      parameters:
        - $ref: '#/components/parameters/stateQueryParam'
        - $ref: '#/components/parameters/availableCityQueryParam'
        - $ref: '#/components/parameters/supportedQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/listCities200Response'
        '400':
          $ref: '#/components/responses/listCities400Response'
        '500':
          $ref: '#/components/responses/listCities500Response'
      summary: List Cities [NANP]
      tags:
        - Coverage
  /rateCenters:
    get:
      description: >-
        The rateCenters resource returns all the rate centers in the indicated
        state that are supported from a coverage perspective and, if requested,
        that contain orderable inventory. The values returned indicate the names
        of the rate centers and, if the query parameter <b>available</b> is
        specified, then returns the available inventory by rate center. The rate
        centers API call returns information about the Bandwidth CLEC network,
        including coverage data, indicating both the extent of on-net and
        off-net coverage, as well as number availability, again from an on-net
        and off-net perspective. The rules are as follows: <ul><li>If
        supported=true is specified, then the coverage or availability is
        reported for the Bandwidth CLEC only.</li><li>If supported=true is
        omitted or false, then the coverage or availability is reported for the
        combination of the Bandwidth CLEC and our partners.</li><li>If
        available=true is specified, then only rate centers in which we have
        available numbers are reported.</li><li>If available is omitted or
        false, then all rate centers within the scope defined by supported will
        be returned.</li></ul>These rules apply to both the /rateCenters and
        /cities API calls. <table border="1" cellpadding="0" cellspacing="0">
        <tbody> <tr> <td valign="top"> </td> <td valign="top"> Supported = true
        </td> <td valign="top"> Supported is missing </td> </tr> <tr> <td
        valign="top"> available = true </td> <td valign="top"> Available numbers
        within the Bandwidth CLEC network </td> <td valign="top"> Available
        numbers within the Bandwidth CLEC network combined with our partner
        networks </td> </tr> <tr> <td valign="top"> available is missing </td>
        <td valign="top"> Coverage in the Bandwidth CLEC </td> <td valign="top">
        Coverage of the combined Bandwidth CLEC + Partner networks </td> </tr>
        </tbody> </table>
      operationId: listRateCenters
      parameters:
        - $ref: '#/components/parameters/stateQueryParam'
        - $ref: '#/components/parameters/availableRateCenterQueryParam'
        - $ref: '#/components/parameters/supportedQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/listRateCenters200Response'
        '400':
          $ref: '#/components/responses/listRateCenters400Response'
        '500':
          $ref: '#/components/responses/listRateCenters500Response'
      summary: List Rate Centers
      tags:
        - Coverage
  /coveredRateCenters:
    get:
      description: >-
        The Covered Rate Centers API returns information about the Bandwidth
        CLEC network, including coverage data. This indicates the extent of
        on-net and off-net coverage, as well as number availability.
      operationId: listCoveredRateCenters
      parameters:
        - $ref: '#/components/parameters/pageQueryParam'
        - $ref: '#/components/parameters/sizeQueryParam'
        - $ref: '#/components/parameters/embedQueryParam'
        - $ref: '#/components/parameters/optionalStateQueryParam'
        - $ref: '#/components/parameters/abbreviationQueryParam'
        - $ref: '#/components/parameters/nameQueryParam'
        - $ref: '#/components/parameters/zipQueryParam'
        - $ref: '#/components/parameters/cityQueryParam'
        - $ref: '#/components/parameters/lataQueryParam'
        - $ref: '#/components/parameters/tierQueryParam'
        - $ref: '#/components/parameters/npaQueryParam'
        - $ref: '#/components/parameters/npaNxxQueryParam'
        - $ref: '#/components/parameters/npaNxxXQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/listCoveredRateCenters200Response'
        '204':
          $ref: '#/components/responses/listCoveredRateCenters204Response'
        '303':
          $ref: '#/components/responses/listCoveredRateCenters303Response'
        '400':
          $ref: '#/components/responses/listCoveredRateCenters400Response'
        '500':
          $ref: '#/components/responses/listCoveredRateCenters500Response'
      summary: List Covered Rate Centers
      tags:
        - Coverage
  /coveredRateCenters/{rateCenterId}:
    get:
      description: Get information about a covered rate center by ID.
      operationId: getCoveredRateCenter
      parameters:
        - $ref: '#/components/parameters/rateCenterIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getCoveredRateCenter200Response'
        '404':
          $ref: '#/components/responses/getCoveredRateCenter404Response'
      summary: Get Covered Rate Center
      tags:
        - Coverage
  /accounts/{accountId}/availableNpaNxx:
    get:
      description: Retrieves a list of available Npa-Nxx phone numbers.
      operationId: getAvailableNpaNxx
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/areaCodeQueryParam'
        - $ref: '#/components/parameters/optionalStateQueryParam'
        - $ref: '#/components/parameters/quantityQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/getAvailableNpaNxx200Response'
        '400':
          $ref: '#/components/responses/getAvailableNpaNxx400Response'
        '404':
          $ref: '#/components/responses/getAvailableNpaNxx404Response'
      summary: List Available NPA-NXX Phone Numbers [NANP]
      tags:
        - Coverage
  /accounts/{accountId}/importToAccount:
    get:
      tags:
        - Import to Account Orders
      description: >
        Retrieve a list of the Import to Account orders that have previously
        been performed on the account. The query must always specify pagination
        parameters (size, page). The results can also be optionally limited with
        start date and end date. Returns a 204 if no results are found.
      summary: List Import to Account Orders
      operationId: listImportToAccountOrders
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/requiredPageQueryParam'
        - $ref: '#/components/parameters/requiredSizeQueryParam'
        - $ref: '#/components/parameters/startDateQueryParam'
        - $ref: '#/components/parameters/endDateQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/listImportToAccountOrders200Response'
        '204':
          $ref: '#/components/responses/importToAccount204Response'
        '400':
          $ref: '#/components/responses/listImportToAccountOrders400Response'
        '401':
          $ref: '#/components/responses/importToAccountUnauthorized401Response'
        '403':
          $ref: '#/components/responses/importToAccountForbidden403Response'
        '404':
          $ref: '#/components/responses/importToAccountNotFound404Response'
        '405':
          $ref: '#/components/responses/importToAccount405Response'
        '429':
          $ref: '#/components/responses/importToAccountTooManyRequests429Response'
        '500':
          $ref: '#/components/responses/importToAccount500Response'
  /accounts/{accountId}/importToAccount/{orderId}:
    get:
      tags:
        - Import to Account Orders
      description: >-
        Retrieve information about an Import to Account order with the specified
        ID.
      summary: Fetch Import to Account Order Status
      operationId: getImportToAccountOrder
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/importToAccountOrderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/importToAccountNumberOrderResponseForGet'
        '401':
          $ref: '#/components/responses/importToAccountUnauthorized401Response'
        '403':
          $ref: '#/components/responses/importToAccountForbidden403Response'
        '404':
          $ref: '#/components/responses/getImportToAccountOrder404Response'
        '405':
          $ref: '#/components/responses/importToAccount405Response'
        '429':
          $ref: '#/components/responses/importToAccountTooManyRequests429Response'
        '500':
          $ref: '#/components/responses/importToAccount500Response'
  /accounts/{accountId}/importToAccount/{orderId}/history:
    get:
      tags:
        - Import to Account Orders
      description: Retrieves the history of the specified Import to Account order.
      summary: Fetch Import to Account Order History
      operationId: getImportToAccountOrderHistory
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/importToAccountOrderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getImportToAccountOrderHistory200Response'
        '401':
          $ref: '#/components/responses/importToAccountUnauthorized401Response'
        '403':
          $ref: '#/components/responses/importToAccountForbidden403Response'
        '404':
          $ref: '#/components/responses/importToAccountNotFound404Response'
        '405':
          $ref: '#/components/responses/importToAccount405Response'
        '429':
          $ref: '#/components/responses/importToAccountTooManyRequests429Response'
        '500':
          $ref: '#/components/responses/importToAccount500Response'
  /accounts/{accountId}/importToAccount/batches:
    get:
      tags:
        - Import to Account Orders
      description: >-
        The batches resource enumerates all of the batches that have been used
        for importing numbers into an account.

        If there is the need to import a large number of telephone numbers into
        an account, the import is submitted as a <b>batch</b>, which is a
        collection of submissions that are held together by a batch ID. This
        batch of orders can subsequently be retrieved by retrieving all of the
        orders that share a batch ID. Returns a 204 if no results are found.
      summary: List Import to Account Order Batches
      operationId: listImportToAccountOrderBatches
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/listImportToAccountOrderBatches200Response'
        '204':
          $ref: '#/components/responses/importToAccount204Response'
        '401':
          $ref: '#/components/responses/importToAccountUnauthorized401Response'
        '403':
          $ref: '#/components/responses/importToAccountForbidden403Response'
        '404':
          $ref: '#/components/responses/importToAccountNotFound404Response'
        '405':
          $ref: '#/components/responses/importToAccount405Response'
        '429':
          $ref: '#/components/responses/importToAccountTooManyRequests429Response'
        '500':
          $ref: '#/components/responses/importToAccount500Response'
  /accounts/{accountId}/importToAccount/batches/{batchId}:
    get:
      tags:
        - Import to Account Orders
      description: >-
        A batch ID identifies a specific batch of one or more orders that
        constitute a complete import of a (potentially large number of)
        telephone numbers. Retrieving the information associated with a specific
        batch ID describes the orders that were included in that batch, and the
        status and ID of those orders. Returns a 204 if no results are found.
      summary: Fetch Import to Account Orders Status by Batch ID
      operationId: listImportToAccountOrdersByBatchId
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/batchIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getImportToAccountOrdersByBatchId200Response'
        '204':
          $ref: '#/components/responses/importToAccount204Response'
        '401':
          $ref: '#/components/responses/importToAccountUnauthorized401Response'
        '403':
          $ref: '#/components/responses/importToAccountForbidden403Response'
        '404':
          $ref: '#/components/responses/importToAccountNotFound404Response'
        '405':
          $ref: '#/components/responses/importToAccount405Response'
        '429':
          $ref: '#/components/responses/importToAccountTooManyRequests429Response'
        '500':
          $ref: '#/components/responses/importToAccount500Response'
components:
  parameters:
    accountIdPathParam:
      description: User's account ID.
      example: '1234567'
      in: path
      name: accountId
      required: true
      schema:
        type: string
    requiredPageQueryParam:
      description: >-
        An ID of the first element in a page.  This value will indicate the
        first value, not the page number, of the initial entry in the page being
        requested. The initial page is tagged with the ID `1` as a convention.
      in: query
      name: page
      required: true
      schema:
        default: 1
        example: 1
        type: integer
    startDateQueryParam:
      description: >-
        The starting date of a search in yy-mm-dd format. startdate and enddate
        <strong>must</strong> be used as a pair.
      in: query
      name: startDate
      required: false
      schema:
        example: 22-10-31
        type: string
    requiredSizeQueryParam:
      description: The number of elements to retrieve
      in: query
      name: size
      required: true
      schema:
        example: 30
        type: integer
    endDateQueryParam:
      description: >-
        The ending date of a search in yy-mm-dd format. startdate and enddate
        <strong>must</strong> be used as a pair.
      in: query
      name: endDate
      required: false
      schema:
        example: 23-10-31
        type: string
    customerOrderIdQueryParam:
      description: >
        Filter orders by a customer-assigned reference ID. Because
        `customerOrderId` is not unique — Bandwidth applies no uniqueness
        constraint — this query may return multiple orders if the same value was
        used across multiple orders. Each result will have a distinct
        Bandwidth-assigned `orderId`. To retrieve a single specific order, use
        its `orderId` instead.
      example: ABCCorp12345
      in: query
      name: customerOrderId
      schema:
        type: string
    newPhoneNumberOrderStatusQueryParam:
      description: The status of the orders that should be in the returned set
      example: BACKORDERED
      in: query
      name: status
      required: false
      schema:
        $ref: '#/components/schemas/visibleOrderStatusJson'
    userIdQueryParam:
      description: The userId that submitted the order
      in: query
      name: userId
      schema:
        example: testUser
        type: string
    orderIdPathParam:
      description: ID of order to retrieve
      example: bf1305b8-8998-1111-2222-51ba3ce52d4e
      in: path
      name: orderId
      required: true
      schema:
        type: string
    importToAccountOrderIdPathParam:
      description: Import to Account order's ID.
      in: path
      name: orderId
      required: true
      schema:
        type: string
      example: 093a9f9b-1a78-4e47-b6e2-776a484596f4
    batchIdPathParam:
      description: Import to Account order's batch ID.
      in: path
      name: batchId
      required: true
      schema:
        type: string
      example: 093a9f9b-1a78-4e47-b6e2-776a484596f4
    newPhoneNumberOrderPhoneNumberDetailQueryParam:
      description: >-
        if true, an extended payload describing details about the ordered phone
        numbers will be provided
      example: true
      in: query
      name: tndetail
      required: false
      schema:
        default: false
        type: boolean
    statusQueryParam:
      description: >-
        The status of an order. Possible values are RECEIVED, COMPLETE, PARTIAL,
        BACKORDERED, FAILED, and PROCESSING.
      in: query
      name: status
      schema:
        type: string
    noteIdPathParam:
      description: Note ID
      example: '123'
      in: path
      name: noteId
      required: true
      schema:
        type: string
    stateQueryParam:
      name: state
      description: A 2 character state code.
      in: query
      required: true
      schema:
        type: string
      example: NC
    availableCityQueryParam:
      name: available
      description: >-
        If set to true, the payload includes the quantity of the available phone
        numbers in that city.
      in: query
      required: false
      schema:
        type: boolean
      example: true
    supportedQueryParam:
      name: supported
      description: >-
        If set to true, the payload will show rate centers that Bandwidth serves
        directly.
      in: query
      required: false
      schema:
        type: boolean
      example: true
    availableRateCenterQueryParam:
      name: available
      description: >-
        If set to true, the payload includes the quantity of the available phone
        numbers in that rate center.
      in: query
      required: false
      schema:
        type: boolean
      example: true
    pageQueryParam:
      name: page
      description: >-
        The starting value for a paginated response. The default is '1',
        indicating the first page of results.
      in: query
      required: true
      schema:
        type: number
      example: 1
    sizeQueryParam:
      name: size
      description: The number of rate centers to include in a paginated result payload.
      in: query
      required: true
      schema:
        type: number
      example: 50
    embedQueryParam:
      name: embed
      description: >-
        A set of fields to be included in the response. Lists of zip codes,
        cities, vendors, NpaNxxXs, and counts of available or limited available
        phone numbers are not included for each rate center by default. For
        example, if the payload should contain a list of the cities covered by
        the rate centers, then embed=cities would be included as a query
        parameter. A list of vendors is available only for admin users. No
        filter parameters are supported if LocalRateCenters is specified. In
        this case, only size, page, and any other embed parameters are
        supported.
      in: query
      required: false
      schema:
        type: array
        items:
          type: string
    abbreviationQueryParam:
      name: abbreviation
      description: A rate center's abbreviation.
      in: query
      required: false
      schema:
        type: string
      example: BARTLESVL
    nameQueryParam:
      name: name
      description: The name of a rate center.
      in: query
      required: false
      schema:
        type: string
      example: BARTLESVILLE
    zipQueryParam:
      name: zip
      description: A 5 digit ZIP code of the area covered by the rate center.
      in: query
      required: false
      schema:
        type: string
      example: '74029'
    cityQueryParam:
      name: city
      description: The name of a city covered by the rate center.
      in: query
      required: false
      schema:
        type: string
      example: DEWEY
    lataQueryParam:
      name: lata
      description: A 3 or 5 digit rate center's LATA.
      in: query
      required: false
      schema:
        type: number
      example: 538
    tierQueryParam:
      name: tier
      description: The tier associated with covered rate center; a value from 0 to 5.
      in: query
      required: false
      schema:
        type: number
      example: 0
    npaQueryParam:
      name: npa
      description: The 3 digit NPA or area code covered by the rate center.
      in: query
      required: false
      schema:
        type: number
      example: 918
    npaNxxQueryParam:
      name: npaNxx
      description: The 6 digits NPA and NXX values covered by the rate center.
      in: query
      required: false
      schema:
        type: number
      example: 918886
    npaNxxXQueryParam:
      name: npaNxxX
      description: >-
        The 7 digits of the NPA, NXX, and thousands-block values covered by the
        rate center.
      in: query
      required: false
      schema:
        type: number
      example: 9188862
    optionalStateQueryParam:
      name: state
      description: A 2 character state code
      in: query
      required: false
      schema:
        type: string
      example: OK
    rateCenterIdPathParam:
      name: rateCenterId
      in: path
      required: true
      schema:
        type: string
    areaCodeQueryParam:
      name: areaCode
      description: >-
        The allowed number ranges are [2-9] for the first digit and [0-9] for
        both the second and third digits.
      in: query
      required: false
      schema:
        type: string
      example: '919'
    quantityQueryParam:
      name: quantity
      description: >-
        Filters out any Npa-Nxx grouped phone numbers whose quantity falls short
        of the given quantity.
      in: query
      required: false
      schema:
        type: integer
      example: 150
  requestBodies:
    createNewPhoneNumberOrderRequest:
      content:
        application/json:
          examples:
            combinedSearchAndOrderType (local vanity) [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderLocalVanityNanpJsonExample
            combinedSearchAndOrderType (protected status) [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderProtectedStatusNanpJsonExample
            combinedSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderNanpJsonExample
            existingPhoneNumberOrderType:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderExistingPhoneNumberOrderTypeJsonExample
          schema:
            $ref: '#/components/schemas/createNewPhoneNumberOrderRequestSchemaJson'
        application/xml:
          examples:
            AreaCodeSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderAreaCodeSearchAndOrderNanpXmlExample
            CitySearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCitySearchAndOrderNanpXmlExample
            CombinedSearchAndOrderType (local vanity) [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderLocalVanityNanpXmlExample
            CombinedSearchAndOrderType (protected status) [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderProtectedStatusNanpXmlExample
            CombinedSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderCombinedSearchAndOrderNanpXmlExample
            ExistingTelephoneNumberOrderType:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderExistingTelephoneNumberOrderTypeXmlExample
            General:
              $ref: '#/components/examples/createNewPhoneNumberOrderGeneralXmlExample'
            LATASearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderLataSearchAndOrderNanpXmlExample
            NPANXXSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderNpaNxxSearchAndOrderNanpXmlExample
            RateCenterSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderRateCenterSearchAndOrderNanpXmlExample
            StateSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderStateSearchAndOrderNanpXmlExample
            TollFreeVanitySearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderTollFreeVanitySearchAndOrderNanpXmlExample
            TollFreeWildCharSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderTollFreeWildCharSearchAndOrderNanpXmlExample
            ZIPSearchAndOrderType [NANP]:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrderZipSearchAndOrderNanpXmlExample
          schema:
            oneOf:
              - $ref: '#/components/schemas/existingTelephoneNumberOrder'
              - $ref: '#/components/schemas/rateCenterSearchAndOrderNanp'
              - $ref: '#/components/schemas/areaCodeSearchAndOrderNanp'
              - $ref: '#/components/schemas/npaNxxSearchAndOrderNanp'
              - $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderNanp'
              - $ref: '#/components/schemas/tollFreeVanitySearchAndOrderNanp'
              - $ref: '#/components/schemas/lataSearchAndOrderNanp'
              - $ref: '#/components/schemas/zipSearchAndOrderNanp'
              - $ref: '#/components/schemas/citySearchAndOrderNanp'
              - $ref: '#/components/schemas/stateSearchAndOrderNanp'
              - $ref: '#/components/schemas/combinedSearchAndOrderNanp'
    updateNewPhoneNumberOrderRequest:
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/updateNewPhoneNumberOrderJsonExample'
          schema:
            $ref: '#/components/schemas/updateNewPhoneNumberOrderJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/updateNewPhoneNumberOrderXmlExample'
          schema:
            $ref: '#/components/schemas/orderUpdate'
    postNewNumberOrderNotesRequest:
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/postNewNumberOrderNotesRequestXmlExample'
          schema:
            $ref: '#/components/schemas/note'
    putNewNumberOrderNotesRequest:
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/putNewNumberOrderNotesRequestXmlExample'
          schema:
            $ref: '#/components/schemas/note'
  examples:
    createNewPhoneNumberOrderCombinedSearchAndOrderLocalVanityNanpJsonExample:
      description: >-
        Specify areaCode and localVanity to order phone numbers matching a
        specific alphanumeric pattern between 4 and 7 characters long.

        Limitations: areaCode is required when searching for a local vanity
        number. No other parameter combinations are allowed here. This order
        type is unsupported with backOrderRequested=true.
      value:
        backOrderRequested: false
        customerOrderId: SJM00004
        orderType:
          areaCode: '617'
          endsIn: false
          localVanity: newcars
          quantity: 1
          type: combinedSearchAndOrderType
        subAccountId: 743
        tags:
          - tagName: customerId
            tagValue: 11111111-1111-1111-1111-111111111111
    createNewPhoneNumberOrderCombinedSearchAndOrderProtectedStatusNanpJsonExample:
      description: combinedSearchAndOrderType on a number in Protected status
      value:
        backOrderRequested: false
        customerOrderId: SJM00005
        orderType:
          city: RALEIGH
          enableLCA: false
          npaNxx: '919439'
          quantity: 1
          state: NC
          type: combinedSearchAndOrderType
        partialAllowed: false
        phoneNumberAttributes:
          - PROTECTED
        subAccountId: 743
        tags:
          - tagName: customerId
            tagValue: 11111111-1111-1111-1111-111111111111
    createNewPhoneNumberOrderCombinedSearchAndOrderNanpJsonExample:
      description: >-
        Specify any combination of: areaCode, rateCenter, state, npaNxx,
        npaNxxX, lata, city, and zip, with the following limitations: areaCode,
        npaNxx and npaNxxX are mutually exclusive; LCA search is supported only
        for one of the following criteria: npaNxx, npaNxxX, rateCenter and
        state; if city or rateCenter is specified, then state is required.
      value:
        backOrderRequested: false
        customerOrderId: SJM00003
        orderType:
          areaCode: '617'
          city: RALEIGH
          enableLCA: false
          lata: '224'
          quantity: 1
          rateCenter: RALEIGH
          state: NC
          type: combinedSearchAndOrderType
          zip: '27606'
        partialAllowed: false
        subAccountId: 743
        tags:
          - tagName: customerId
            tagValue: 11111111-1111-1111-1111-111111111111
    createNewPhoneNumberOrderExistingPhoneNumberOrderTypeJsonExample:
      description: >-
        Order a set of phone numbers known to be available. Typically, when the
        numbers have been found and/or reserved using a separate
        availableNumbers search. If the numbers have previously been reserved, a
        reservation ID must be included for each number.
      value:
        autoActivate: true
        customerOrderId: SJM00002
        orderType:
          phoneNumbers:
            - '+19193752369'
            - '+19193752720'
          reservationIds:
            - a8e7d1f9-2c5a-4e3b-8f1c-5d9a7b3e1f02
            - b4f6c8a1-7e9d-4023-95b7-1a6c4d8e3f5a
          type: existingPhoneNumberOrderType
        partialAllowed: false
        tags:
          - tagName: customerId
            tagValue: 11111111-1111-1111-1111-111111111111
        requirementsPackageId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        subAccountId: 873
        voiceConfigurationPackageId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
        voiceIntegrationIds:
          - 5fa85f64-5717-4562-b3fc-2c963f66afa6
          - 5fa85f64-5717-4562-b3fc-2c963f66afa7
    createNewPhoneNumberOrderAreaCodeSearchAndOrderNanpXmlExample:
      description: >-
        Allowed ranges ~ [2-9] for the first digit and [0, 9] for both the
        second and third digits.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <AreaCodeSearchAndOrderType>
                <AreaCode>435</AreaCode>
                <Quantity>1</Quantity>
            </AreaCodeSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderCitySearchAndOrderNanpXmlExample:
      description: Specify the City and State to be ordered from.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <CitySearchAndOrderType>
                <Quantity>1</Quantity>
                <City>RALEIGH</City>
                <State>NC</State>
            </CitySearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderCombinedSearchAndOrderLocalVanityNanpXmlExample:
      description: >-
        Specify AreaCode and LocalVanity to order phone numbers matching a
        specific alphanumeric pattern between 4 and 7 characters long.

        Limitations: AreaCode is always required. No parameter combinations are
        allowed here/ This order type is unsupported with
        BackOrderRequested=true.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Local Vanity Order</Name>
            <CombinedSearchAndOrderType>
                <AreaCode>617</AreaCode>
                <LocalVanity>newcars</LocalVanity>
                <Quantity>1</Quantity>
                <EndsIn>false</EndsIn>
            </CombinedSearchAndOrderType>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderCombinedSearchAndOrderProtectedStatusNanpXmlExample:
      description: CombinedSearchAndOrderType with established Protected status
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <CombinedSearchAndOrderType>
                <NpaNxx>919439</NpaNxx>
                <City>RALEIGH</City>
                <State>NC</State>
                <EnableLCA>false</EnableLCA>
                <Quantity>1</Quantity>
            </CombinedSearchAndOrderType>
            <TnAttributes>
                    <TnAttribute>Protected</TnAttribute>
                    <TnAttribute>External</TnAttribute>
                    <TnAttribute>Imported</TnAttribute>
            </TnAttributes>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderCombinedSearchAndOrderNanpXmlExample:
      description: >-
        Specify the any combination of: AreaCode, RateCenter, State, NpaNxx,
        NpaNxxX, Lata, City, Zip. But with following limitations: AreaCode,
        NpaNxx and NpaNxxX are mutually exclusive, LCA search is supported only
        for one of the following criteria: NpaNxx, NpaNxxX, RateCenter and
        State. If City or RateCenter is specified, then State is required.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <CombinedSearchAndOrderType>
                <Quantity>1</Quantity>
                <AreaCode>617</AreaCode>
                <RateCenter>RALEIGH</RateCenter>
                <State>NC</State>
                <NpaNxx>919439</NpaNxx>
                <NpaNxxX>9194391</NpaNxxX>
                <Lata>224</Lata>
                <City>RALEIGH</City>
                <Zip>27606</Zip>
                <EnableLCA>false</EnableLCA>
            </CombinedSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderExistingTelephoneNumberOrderTypeXmlExample:
      description: >-
        Order a set of phone numbers known to be available. This often results
        if the numbers have been found using a separate availableNumbers search.
        If the numbers have previously been reserved, a reservation ID must be
        included
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Existing Number Order</Name>
            <ExistingTelephoneNumberOrderType>
                <TelephoneNumberList>
                    <TelephoneNumber>+19193752369</TelephoneNumber>
                    <TelephoneNumber>+19193752720</TelephoneNumber>
                    <TelephoneNumber>+19193752648</TelephoneNumber>
                </TelephoneNumberList>
                <ReservationIdList>
                    <ReservationId>[GUID]</ReservationId>
                    <ReservationId>[GUID]</ReservationId>
                </ReservationIdList>
            </ExistingTelephoneNumberOrderType>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderGeneralXmlExample:
      description: The 'wrapper' Request Payload'
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>SJM00001</CustomerOrderId>
            <!--
                There are various types of orders, all of which are submitted in the 'xxxOrderType'
                element of the Order Request payload. Replace
                this comment to create a complete payload that includes the order type and the
                common elements.
                Take a look at the example payloads as well.
            -->
            <SiteId>202</SiteId>
            <PeerId>518824</PeerId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <TnAttributes/>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderLataSearchAndOrderNanpXmlExample:
      description: Specify the LATA to order phone numbers from.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <LATASearchAndOrderType>
                <Quantity>1</Quantity>
                <Lata>224</Lata>
            </LATASearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderNpaNxxSearchAndOrderNanpXmlExample:
      description: >-
        Specify the NpaNxx combination to be ordered. Valid Npa values ~ [2-9]
        for the first digit, and [0-9] for both the second and third digits.
        Valid Nxx values ~ [2-9] for the first digit, and [0-9] for both the
        second and third digits. A similar approach is viable for NPANXXXX. The
        EnableLCA flag turns LCA search on or off.


        Limitations:

        These order types are unsupported with BackOrderRequested=true
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <NPANXXSearchAndOrderType>
                <NpaNxx>919439</NpaNxx>
                <EnableTNDetail>true</EnableTNDetail>
                <EnableLCA>false</EnableLCA>
                <Quantity>1</Quantity>
            </NPANXXSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderRateCenterSearchAndOrderNanpXmlExample:
      description: Specify the Rate Center and the State.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <RateCenterSearchAndOrderType>
                <RateCenter>RALEIGH</RateCenter>
                <State>NC</State>
                <Quantity>1</Quantity>
            </RateCenterSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderStateSearchAndOrderNanpXmlExample:
      description: Specify the State to be searched for phone numbers.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <StateSearchAndOrderType>
                <Quantity>1</Quantity>
                <State>NC</State>
            </StateSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderTollFreeVanitySearchAndOrderNanpXmlExample:
      description: >-
        Specify a Toll Free Vanity search, where the numbers ordered match a
        specific alphanumeric pattern between 4 and 7 characters long.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <TollFreeVanitySearchAndOrderType>
                <Quantity>1</Quantity>
                <TollFreeVanity>newcars</TollFreeVanity>
            </TollFreeVanitySearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderTollFreeWildCharSearchAndOrderNanpXmlExample:
      description: >-
        Specify the Toll Free wild card pattern. To be ordered, comprised of 3
        digits beginning with '8'. Examples are 8**, 87*, etc.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <TollFreeWildCharSearchAndOrderType>
                <Quantity>1</Quantity>
                <TollFreeWildCardPattern>8**</TollFreeWildCardPattern>
            </TollFreeWildCharSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    createNewPhoneNumberOrderZipSearchAndOrderNanpXmlExample:
      description: Specify the Zip Code to be ordered from.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Order>
            <CustomerOrderId>123456789</CustomerOrderId>
            <Name>Area Code Order</Name>
            <BackOrderRequested>false</BackOrderRequested>
            <ZIPSearchAndOrderType>
                <Quantity>1</Quantity>
                <Zip>27606</Zip>
            </ZIPSearchAndOrderType>
            <PartialAllowed>true</PartialAllowed>
            <SiteId>743</SiteId>
            <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
            <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
            <VoiceIntegrationIds>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
              <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
            </VoiceIntegrationIds>
            <AutoActivate>true</AutoActivate>
            <Tags>
              <Tag>
                <TagName>customerId</TagName>
                <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
              </Tag>
            </Tags>
        </Order>
    updateNewPhoneNumberOrderJsonExample:
      description: Request to update an existing New Number Order using Json
      value:
        closeOrder: true
        customerOrderId: '123456789'
    updateNewPhoneNumberOrderXmlExample:
      description: Request to update an existing New Number Order using XML
      value: >-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>

        <Order>
            <Name>Available Phone Number order</Name>    
            <CustomerOrderId>123456789</CustomerOrderId>
        <!-- Only alphanumeric values, dashes and spaces are allowed. Max length
        is 40 characters. -->
            <CloseOrder>true</CloseOrder>
        </Order>
    postNewNumberOrderNotesRequestXmlExample:
      description: Request to add a note to a New Number Order using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Note>
            <UserId>userId</UserId>
            <!-- note the userId must match the logged-in user -->
            <Description>note text</Description>
        </Note>
    putNewNumberOrderNotesRequestXmlExample:
      description: Request to update a note on a New Number Order using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Note>
            <UserId>userId</UserId>
            <Description>note text</Description>
        </Note>
    listNewPhoneNumberOrders200ResponseJsonExample:
      description: Ok response example for listing New Phone Number Orders using Json
      value:
        links:
          first: >-
            https://api.bandwidth.com/api/v2/accounts/12346165/orders?size=2&page=1
          next: >-
            https://api.bandwidth.com/api/v2/accounts/12346165/orders?size=2&page=021f0877-55b4-4605-ad8e-a38f531dd33e
        orders:
          - accountId: 12346165
            customerOrderId: generatedByProto
            lastModifiedDate: '2025-05-13T18:46:28.237Z'
            orderDate: '2025-05-13T18:46:26.989Z'
            orderId: 6f628cdc-cb4c-4e6f-a79d-e61236442cb7
            orderStatus: COMPLETE
            voiceIntegrationIds:
              - 5fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fa85f64-5717-4562-b3fc-2c963f66afa7
            bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
            orderType: new_number
            phoneNumberCount: 1
            phoneNumberDetails:
              cities:
                - city: MANHATTAN
                  count: 1
              rateCenters:
                - count: 1
                  rateCenter: NWYRCYZN01
              states:
                - count: 1
                  state: NY
              tiers:
                - count: 1
                  tier: 0
              vendors:
                - count: 1
                  vendorId: 49
                  vendorName: Bandwidth CLEC
            summary: 1 number ordered in (212)
            tags:
              - tagName: customerId
                tagValue: 11111111-1111-1111-1111-111111111111
            userId: user1
          - accountId: 12346165
            customerOrderId: testCustomerOrderId
            lastModifiedDate: '2025-05-13T18:35:59.845Z'
            orderDate: '2025-05-13T18:35:58.337Z'
            orderId: 5e94e722-6624-48b0-a742-612603c2c781
            orderStatus: COMPLETE
            voiceIntegrationIds:
              - 5fa85f64-5717-4562-b3fc-2c963f66afa6
              - 5fa85f64-5717-4562-b3fc-2c963f66afa7
            bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d2
            orderType: new_number
            phoneNumberCount: 3
            phoneNumberDetails:
              cities:
                - city: WASHINGTON
                  count: 3
              rateCenters:
                - count: 3
                  rateCenter: WSHNGTNZN1
              states:
                - count: 3
                  state: DC
              tiers:
                - count: 3
                  tier: 0
              vendors:
                - count: 3
                  vendorId: 49
                  vendorName: Bandwidth CLEC
            summary: 3 numbers ordered in (202)
            tags:
              - tagName: customerId
                tagValue: 11111111-1111-1111-1111-111111111111
            userId: user1
        totalCount: 3
    listNewPhoneNumberOrders200ResponseXmlExample:
      description: Ok response example for listing New Phone Number Orders using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResponseSelectWrapper>
            <ListOrderIdUserIdDate>
                <TotalCount>122</TotalCount>
                <Links>
                <first>
                    <!-- Link=<https://api.bandwidth.com 443/v1.0/accounts/9900012/orders?page=1&size=3>;rel="first"; -->
                </first>
                <next>
                    <!-- Link=<https://api.bandwidth.com 443/v1.0/accounts/9900012/orders?page=cbdcfc94-81b1-4ce9-8b6d-f8d6b85381ba&size=3>;rel="next"; -->
                </next>
                </Links>
                <OrderIdUserIdDate>
                    <CountOfTNs>1</CountOfTNs>
                    <lastModifiedDate>2013-12-20T06</lastModifiedDate>
                    <OrderDate>2013-12-20T06</OrderDate>
                    <orderId>c5d8d076-345c-45d7-87b3-803a35cca89b</orderId>
                    <OrderStatus>COMPLETE</OrderStatus>
                    <VoiceIntegrationIds>
                      <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
                      <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
                    </VoiceIntegrationIds>
                    <BulkNumberSyncId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</BulkNumberSyncId>
                    <Tags>
                      <Tag>
                        <TagName>customerId</TagName>
                        <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
                      </Tag>
                    </Tags>
                    <TelephoneNumberDetails>
                        <States>
                            <StateWithCount>
                                <State>VA</State>
                                <Count>1</Count>
                            </StateWithCount>
                        </States>
                        <RateCenters>
                            <RateCenterWithCount>
                                <Count>1</Count>
                                <RateCenter>LADYSMITH</RateCenter>
                            </RateCenterWithCount>
                        </RateCenters>
                        <Cities>
                            <CityWithCount>
                                <City>LADYSMITH</City>
                                <Count>1</Count>
                            </CityWithCount>
                        </Cities>
                        <Tiers>
                            <TierWithCount>
                                <Tier>0</Tier>
                                <Count>1</Count>
                            </TierWithCount>
                        </Tiers>
                        <Vendors>
                            <VendorWithCount>
                                <VendorId>49</VendorId>
                                <VendorName>Bandwidth CLEC</VendorName>
                                <Count>1</Count>
                            </VendorWithCount>
                        </Vendors>
                    </TelephoneNumberDetails>
                    <userId>bwc_user</userId>
                </OrderIdUserIdDate>
                <OrderIdUserIdDate>
                    <CountOfTNs>0</CountOfTNs>
                    <lastModifiedDate>2013-11-05T17</lastModifiedDate>
                    <OrderDate>2013-11-05T17</OrderDate>
                    <orderId>27da9f39-81f3-44ed-80ce-05ddf2db612d</orderId>
                    <OrderStatus>FAILED</OrderStatus>
                    <userId>wandedemo_user</userId>
                </OrderIdUserIdDate>
                <OrderIdUserIdDate>
                    <CountOfTNs>1</CountOfTNs>
                    <lastModifiedDate>2013-12-11T20</lastModifiedDate>
                    <OrderDate>2013-12-11T20</OrderDate>
                    <orderId>2bab589e-2cda-453b-9999-8f35441d4a1a</orderId>
                    <OrderStatus>COMPLETE</OrderStatus>
                    <VoiceIntegrationIds>
                      <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
                      <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
                    </VoiceIntegrationIds>
                    <BulkNumberSyncId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</BulkNumberSyncId>
                    <Tags>
                      <Tag>
                        <TagName>customerId</TagName>
                        <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
                      </Tag>
                    </Tags>
                    <TelephoneNumberDetails>
                        <!-- SNIP -->
                    </TelephoneNumberDetails>
                    <userId>bwc_user</userId>
                </OrderIdUserIdDate>
            </ListOrderIdUserIdDate>
        </ResponseSelectWrapper>
    listNewPhoneNumberOrders400ResponseJsonExample:
      description: >-
        Bad request response example for listing New Phone Number Orders using
        Json
      value:
        code: 400
        description: Please verify that your PAGE search input parameter is correct.
    listNewPhoneNumberOrders400ResponseXmlExample:
      description: >-
        Bad request response example for listing New Phone Number Orders using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ErrorResponse>
            <Code>400</Code>
            <Description>Please verify that your PAGE search input parameter is correct.</Description>
        </ErrorResponse>
    createNewPhoneNumberOrder201ResponseCombinedSearchAndOrderTypeJsonExample:
      description: >-
        Created response example for creating a New Phone Number Order using
        combinedSearchAndOrderType in Json
      value:
        order:
          autoActivate: true
          backOrderRequested: false
          id: d79121c4-e4af-4569-ae07-b7f51587c952
          orderCreateDate: '2025-05-06T17:58:29.964Z'
          orderType:
            enableLCA: true
            quantity: 3
            rateCenter: JERSEYCITY
            state: NJ
            type: combinedSearchAndOrderType
          partialAllowed: true
          subAccountId: 491
          voiceIntegrationIds:
            - 5fa85f64-5717-4562-b3fc-2c963f66afa6
            - 5fa85f64-5717-4562-b3fc-2c963f66afa7
          bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
          tags:
            - tagName: customerId
              tagValue: 11111111-1111-1111-1111-111111111111
        orderStatus: RECEIVED
    createNewPhoneNumberOrder201ResponseExistingPhoneNumberOrderTypeJsonExample:
      description: >-
        Created response example for creating a New Phone Number Order using
        existingPhoneNumberOrderType in Json
      value:
        order:
          autoActivate: true
          backOrderRequested: false
          closeOrder: true
          id: 20b21632-4fac-4ccc-9477-520d416182da
          orderCreateDate: '2025-05-06T15:52:18.546Z'
          orderType:
            phoneNumbers:
              - '+19894551000'
            reservationIds:
              - 943dd7d4-8c84-49f4-8704-b17963438106
            type: existingPhoneNumberOrderType
          partialAllowed: true
          subAccountId: 490
          voiceIntegrationIds:
            - 5fa85f64-5717-4562-b3fc-2c963f66afa6
            - 5fa85f64-5717-4562-b3fc-2c963f66afa7
          bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
          tags:
            - tagName: customerId
              tagValue: 11111111-1111-1111-1111-111111111111
        orderStatus: RECEIVED
    createNewPhoneNumberOrder201ResponseXmlExample:
      description: Created response example for creating a New Phone Number Order using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderResponse>
            <Order>
                <CustomerOrderId>123456789</CustomerOrderId>
                <id>34adcd9f-2c4a-4631-9dae-d1f318ed57bc</id>
                <Name>Zip Order</Name>
                <OrderCreateDate>2014-07-11T17:13:57.788Z</OrderCreateDate>
                <AutoActivate>true</AutoActivate>
                <BackOrderRequested>false</BackOrderRequested>
                <ZIPSearchAndOrderType>
                    <Quantity>1</Quantity>
                    <Zip>27606</Zip>
                </ZIPSearchAndOrderType>
                <TnAttributes>
                        <TnAttribute>Protected</TnAttribute>
                        <TnAttribute>External</TnAttribute>
                        <TnAttribute>Imported</TnAttribute>
                </TnAttributes>
                <PartialAllowed>true</PartialAllowed>
                <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
                <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
                <VoiceIntegrationIds>
                  <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
                  <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
                </VoiceIntegrationIds>
                <BulkNumberSyncId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</BulkNumberSyncId>
                <SiteId>3013</SiteId>
                <Tags>
                  <Tag>
                    <TagName>customerId</TagName>
                    <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
                  </Tag>
                </Tags>
            </Order>
        </OrderResponse>
    createNewPhoneNumberOrder400ResponseJsonExample:
      description: >-
        Bad request response example for creating a New Phone Number Order using
        Json
      value:
        errors:
          - code: 5016
            description: The SiteId submitted is invalid.
        order:
          autoActivate: true
          backOrderRequested: false
          orderCreateDate: '2025-05-06T17:57:47.268Z'
          orderType:
            enableLCA: true
            quantity: 3
            rateCenter: JERSEYCITY
            state: NJ
            type: combinedSearchAndOrderType
          partialAllowed: true
          subAccountId: 491
        orderStatus: FAILED
    createNewPhoneNumberOrder400ResponseXmlExample:
      description: >-
        Bad request response example for creating a New Phone Number Order using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderResponse>
            <ErrorList>
                <Error>
                    <Code>5016</Code>
                    <Description>The SiteId submitted is invalid.</Description>
                </Error>
            </ErrorList>
            <Order>
                <CustomerOrderId>123456789</CustomerOrderId>
                <Name>Area Code Order</Name>
                <OrderCreateDate>2014-07-08T14:29:13.174Z</OrderCreateDate>
                <AutoActivate>true</AutoActivate>
                <BackOrderRequested>false</BackOrderRequested>
                <AreaCodeSearchAndOrderType>
                    <AreaCode>435</AreaCode>
                    <Quantity>1</Quantity>
                </AreaCodeSearchAndOrderType>
                <TnAttributes>
                        <TnAttribute>Protected</TnAttribute>
                        <TnAttribute>External</TnAttribute>
                        <TnAttribute>Imported</TnAttribute>
                </TnAttributes>
                <PartialAllowed>true</PartialAllowed>
                <SiteId>763</SiteId>
            </Order>
        </OrderResponse>
    retrieveNewPhoneNumberOrder200ResponseCombinedSearchAndOrderSuccessfulJsonExample:
      description: A combinedSearchAndOrderType that was successfully completed
      value:
        completedPhoneNumbers:
          - '2018391014'
          - '2018391015'
          - '2018391016'
        completedQuantity: 3
        createdByUser: systemUser
        failedQuantity: 0
        lastModifiedDate: '2025-05-06T18:00:13.411Z'
        order:
          autoActivate: true
          backOrderRequested: false
          customerOrderId: testCustomerOrderId
          locationId: 500030
          name: Test CombinedSearchAndOrder
          orderCreateDate: '2025-05-06T18:00:12.912Z'
          orderType:
            enableLCA: true
            quantity: 3
            rateCenter: JERSEYCITY
            state: NJ
            type: combinedSearchAndOrderType
          partialAllowed: true
          subAccountId: 491
          voiceIntegrationIds:
            - 5fa85f64-5717-4562-b3fc-2c963f66afa6
            - 5fa85f64-5717-4562-b3fc-2c963f66afa7
          bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
          tags:
            - tagName: customerId
              tagValue: 11111111-1111-1111-1111-111111111111
        orderCompleteDate: '2025-05-06T18:00:13.408Z'
        orderStatus: COMPLETE
        serviceActivationOrderId: efc3d704-6dfa-4c9d-a43a-3f0e59d2c591
        serviceActivationOrderStatus: COMPLETE
        summary: 3 numbers ordered in (201)
    retrieveNewPhoneNumberOrder200ResponseCombinedSearchAndOrderUnsuccessfulJsonExample:
      description: >-
        A combinedSearchAndOrderType that was unable to fulfill phone numbers
        that matched the request criteria
      value:
        completedPhoneNumbers: []
        completedQuantity: 0
        createdByUser: systemUser
        errors:
          - code: 5017
            description: >-
              Only a partial quantity of the total phone numbers ordered could
              be fulfilled
        failedQuantity: 50
        lastModifiedDate: '2025-05-15T13:20:18.693Z'
        order:
          autoActivate: true
          backOrderRequested: false
          customerOrderId: testCustomerOrderId
          locationId: 500034
          name: Test CombinedSearchAndOrder
          orderCreateDate: '2025-05-15T13:20:18.366Z'
          orderType:
            areaCode: '201'
            enableLCA: false
            localVanity: 101k
            quantity: 50
            type: combinedSearchAndOrderType
          partialAllowed: false
          subAccountId: 495
          voiceIntegrationIds:
            - 5fa85f64-5717-4562-b3fc-2c963f66afa6
            - 5fa85f64-5717-4562-b3fc-2c963f66afa7
          tags:
            - tagName: customerId
              tagValue: 11111111-1111-1111-1111-111111111111
        orderCompleteDate: '2025-05-15T13:20:18.692Z'
        orderStatus: FAILED
        summary: 50 numbers requested
    retrieveNewPhoneNumberOrder200ResponseExistingPhoneNumberOrderSuccessfulJsonExample:
      value:
        completedPhoneNumbers:
          - '9894551000'
        completedQuantity: 1
        createdByUser: systemUser
        failedQuantity: 0
        lastModifiedDate: '2025-05-06T15:52:19.038Z'
        order:
          autoActivate: true
          backOrderRequested: false
          closeOrder: true
          locationId: 500029
          orderCreateDate: '2025-05-06T15:52:18.546Z'
          orderType:
            phoneNumbers:
              - '+19894551000'
            type: existingPhoneNumberOrderType
          partialAllowed: true
          subAccountId: 490
          voiceIntegrationIds:
            - 5fa85f64-5717-4562-b3fc-2c963f66afa6
            - 5fa85f64-5717-4562-b3fc-2c963f66afa7
          bulkNumberSyncId: d21315af-9b5b-4b45-a6f4-9106cbfe87d1
          tags:
            - tagName: customerId
              tagValue: 11111111-1111-1111-1111-111111111111
        orderCompleteDate: '2025-05-06T15:52:19.038Z'
        orderStatus: COMPLETE
        serviceActivationOrderId: efc3d704-6dfa-4c9d-a43a-3f0e59d2c591
        serviceActivationOrderStatus: COMPLETE
        summary: 1 number ordered in (989)
    retrieveNewPhoneNumberOrder200ResponseXmlExample:
      description: Ok response example for retrieving a New Phone Number Order using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderResponse>
            <CompletedQuantity>1</CompletedQuantity>
            <CreatedByUser>jbm</CreatedByUser>
            <LastModifiedDate>2014-01-06T19:09:44.027Z</LastModifiedDate>
            <OrderCompleteDate>2014-01-06T19:09:44.041Z</OrderCompleteDate>
            <Order>
                <CustomerOrderId>123456789</CustomerOrderId>
                <Name>Area Code Order</Name>
                <OrderCreateDate>2014-01-06T19:09:43.695Z</OrderCreateDate>
                <PeerId>303716</PeerId>
                <BackOrderRequested>false</BackOrderRequested>
                <AreaCodeSearchAndOrderType>
                    <AreaCode>804</AreaCode>
                    <Quantity>1</Quantity>
                </AreaCodeSearchAndOrderType>
                <TnAttributes>
                        <TnAttribute>Protected</TnAttribute>
                        <TnAttribute>External</TnAttribute>
                        <TnAttribute>Imported</TnAttribute>
                </TnAttributes>
                <PartialAllowed>true</PartialAllowed>
                <SiteId>743</SiteId>
                <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
                <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
                <VoiceIntegrationIds>
                  <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa6</VoiceIntegrationId>
                  <VoiceIntegrationId>5fa85f64-5717-4562-b3fc-2c963f66afa7</VoiceIntegrationId>
                </VoiceIntegrationIds>
                <BulkNumberSyncId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</BulkNumberSyncId>
                <AutoActivate>true</AutoActivate>
                <Tags>
                  <Tag>
                    <TagName>customerId</TagName>
                    <TagValue>11111111-1111-1111-1111-111111111111</TagValue>
                  </Tag>
                </Tags>
            </Order>
            <OrderStatus>COMPLETE</OrderStatus>
            <CompletedNumbers>
                <TelephoneNumber>
                    <FullNumber>+18042105666</FullNumber>
                </TelephoneNumber>
            </CompletedNumbers>
            <ServiceActivationOrderId>efc3d704-6dfa-4c9d-a43a-3f0e59d2c591</ServiceActivationOrderId>
            <ServiceActivationOrderStatus>COMPLETE</ServiceActivationOrderStatus>
            <FailedQuantity>0</FailedQuantity>
        </OrderResponse>
    retrieveNewPhoneNumberOrder404ResponseJsonExample:
      description: >-
        Not found response example for retrieving a New Phone Number Order using
        Json
      value:
        code: 404
        description: Order with such id was not found.
    retrieveNewPhoneNumberOrder404ResponseXmlExample:
      description: >-
        Not found response example for retrieving a New Phone Number Order using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ErrorResponse>
            <irisStatus>
                <Code>404</Code>
                <Description>Order with such id was not found.</Description>
            </irisStatus>
        </ErrorResponse>
    updateNewPhoneNumberOrder404ResponseJsonExample:
      description: >-
        Not found response example for updating a New Phone Number Order using
        Json
      value:
        errors:
          - code: 5035
            description: >-
              Order ID is invalid. Please check the order ID that you have
              submitted in your request is correct.
        orderStatus: FAILED
    updateNewPhoneNumberOrder404ResponseXmlExample:
      description: >-
        Not found response example for updating a New Phone Number Order using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderResponse>
          <ErrorList>
            <Error>
              <Code>5035</Code>
              <Description>Order ID is invalid. Please check the order ID that you have submitted in your request is correct.</Description>
            </Error>
          </ErrorList>
          <OrderStatus>FAILED</OrderStatus>
        </OrderResponse>
    getNewNumberOrderHistoryResponse200XmlExample:
      description: Ok response example for retrieving New Number Order History using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderHistoryWrapper>
            <OrderHistory>
                <OrderDate>2014-05-20T14:21:43.937Z</OrderDate>
                <Note>Order backordered - awaiting additional numbers</Note>
                <Author>System</Author>
                <Status>BACKORDERED</Status>
            </OrderHistory>
            <OrderHistory>
                <OrderDate>2014-05-20T14:24:43.428Z</OrderDate>
                <Note>Order backordered - awaiting additional numbers</Note>
                <Author>System</Author>
                <Status>BACKORDERED</Status>
                <Difference>CustomerOrderId : "" --&gt; hello</Difference>
            </OrderHistory>
        </OrderHistoryWrapper>
    getNewNumberOrderHistoryResponse200JsonExample:
      description: Ok response example for retrieving New Number Order History using Json
      value:
        orderHistory:
          - orderDate: '2014-05-20T14:21:43.937Z'
            note: Order backordered - awaiting additional numbers
            author: System
            status: BACKORDERED
          - orderDate: '2014-05-20T14:24:43.428Z'
            note: Order backordered - awaiting additional numbers
            author: System
            status: BACKORDERED
    getNewNumberOrderHistoryResponse404XmlExample:
      description: >-
        Not found response example for retrieving New Number Order History using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ErrorResponse>
            <ResponseStatus>
                <Description>The resource does not exist</Description>
            </ResponseStatus>
        </ErrorResponse>
    getNewNumberOrderHistoryResponse404JsonExample:
      description: >-
        Not found response example for retrieving New Number Order History using
        Json
      value:
        description: Not Found
    newNumberOrderTotalsResponse200XmlExample:
      description: Ok response example for retrieving New Number Order Totals using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResponseSelectWrapper>
            <ListOrderIdUserIdDate>
                <TotalCount>122</TotalCount>
            </ListOrderIdUserIdDate>
        </ResponseSelectWrapper>
    newNumberOrderAreaCodesResponse200XmlExample:
      description: Ok response example for retrieving New Number Order Area Codes using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TelephoneDetailsReports>
            <TelephoneDetailsReport>
                <AreaCode>888</AreaCode>
                <Count>1</Count>
            </TelephoneDetailsReport>
        </TelephoneDetailsReports>
    newNumberOrderNotesGetResponse200XmlExample:
      description: Ok response example for retrieving New Number Order Notes using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Notes>
            <Note>
                <Id>87037</Id>
                <UserId>jbm</UserId>
                <Description>This is a test note</Description>
                <LastDateModifier>2014-11-16T04:01:10.000Z</LastDateModifier>
            </Note>
            <Note>
                <Id>87039</Id>
                <UserId>smckinnon</UserId>
                <Description>This is a second test note</Description>
                <LastDateModifier>2014-11-16T04:08:46.000Z</LastDateModifier>
            </Note>
        </Notes>
    newNumberOrderNotesPostResponse400XmlExample:
      description: >-
        Bad request response example for adding a note to a New Number Order
        using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <NoteResponse>
            <ResponseStatus>
                <ErrorCode>12501</ErrorCode>
                <Description>Username is required</Description>
            </ResponseStatus>
        </NoteResponse>
    getNewNumberOrderTnListResponse200JsonExample:
      description: Ok response example for retrieving New Number Order TN List using Json
      value:
        count: 5
        phoneNumbers:
          - '+14349335313'
          - '+14349335314'
          - '+14349335315'
          - '+14349335316'
          - '+14349335317'
    getNewNumberOrderTnListResponse200XmlExample:
      description: Ok response example for retrieving New Number Order TN List using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TelephoneNumbers>
          <Count>1</Count>
          <TelephoneNumber>+18042105666</TelephoneNumber>
        </TelephoneNumbers>
    getNewNumberOrderTnListResponse404JsonExample:
      description: >-
        Not found response example for retrieving New Number Order TN List using
        Json
      value:
        description: Order ID does not correspond to a given account.
        errorCode: 404
    getNewNumberOrderTnListResponse404XmlExample:
      description: >-
        Not found response example for retrieving New Number Order TN List using
        XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ErrorResponse>
          <irisStatus>
            <ErrorCode>404</ErrorCode>
            <Description>Order ID does not correspond to a given account.</Description>
          </irisStatus>
        </ErrorResponse>
    putNewNumberOrderNotesResponse400XmlExample:
      description: >-
        Bad request response example for updating a note on a New Number Order
        using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <NoteResponse>
            <ResponseStatus>
                <ErrorCode>12501</ErrorCode>
                <Description>Username is required</Description>
            </ResponseStatus>
        </NoteResponse>
    getNewNumberOrderNpaNxxResponse200XmlExample:
      description: Ok response example for retrieving New Number Order NPA-NXXs using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TelephoneDetailsReports>
            <TelephoneDetailsReport>
                <NPA-NXX>888424</NPA-NXX>
                <Count>1</Count>
            </TelephoneDetailsReport>
        </TelephoneDetailsReports>
    getNewNumberOrderIdTotalsResponse200XmlExample:
      description: Ok response example for retrieving New Number Order ID Totals using XML
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TelephoneDetailsReports>
            <TelephoneDetailsReport>
                <Count>1</Count>
            </TelephoneDetailsReport>
        </TelephoneDetailsReports>
    listCities200ResponseJsonSimpleExample:
      value:
        resultCount: 8
        cities:
          - rcAbbreviation: DOUGLAS
            name: ADAMS
          - rcAbbreviation: FILLEY
            name: ADAMS
          - rcAbbreviation: AINSWORTH
            name: AINSWORTH
          - rcAbbreviation: LONG PINE
            name: AINSWORTH
          - rcAbbreviation: ODELL
            name: WYMORE
          - rcAbbreviation: BRADSHAW
            name: YORK
          - rcAbbreviation: YORK
            name: YORK
          - rcAbbreviation: WACO
            name: YORK
    listCities200ResponseJsonWithCountExample:
      value:
        resultCount: 9
        cities:
          - rcAbbreviation: FILLEY
            availablePhoneNumberCount: 266
            name: ADAMS
          - rcAbbreviation: DOUGLAS
            availablePhoneNumberCount: 378
            name: ADAMS
          - rcAbbreviation: WAKEFIELD
            availablePhoneNumberCount: 272
            name: ALLEN
          - rcAbbreviation: ASHLAND
            availablePhoneNumberCount: 129
            name: ASHLAND
          - rcAbbreviation: WEST POINT
            availablePhoneNumberCount: 85
            name: WEST POINT
          - rcAbbreviation: OAKLAND
            availablePhoneNumberCount: 290
            name: WEST POINT
          - rcAbbreviation: WESTERN
            availablePhoneNumberCount: 134
            name: WESTERN
          - rcAbbreviation: WAYNE
            availablePhoneNumberCount: 434
            name: WINSIDE
          - rcAbbreviation: BRADSHAW
            availablePhoneNumberCount: 274
            name: YORK
    listCities200ResponseXmlSimpleExample:
      value: |-
        <CityResponse>
          <ResultCount>8</ResultCount>
          <Cities>
            <City>
             <RcAbbreviation>DOUGLAS</RcAbbreviation>
             <Name>ADAMS</Name>
           </City>
            <City>
              <RcAbbreviation>FILLEY</RcAbbreviation>
              <Name>ADAMS</Name>
            </City>
            <City>
              <RcAbbreviation>AINSWORTH</RcAbbreviation>
              <Name>AINSWORTH</Name>
            </City>
            <City>
              <RcAbbreviation>LONG PINE</RcAbbreviation>
              <Name>AINSWORTH</Name>
            </City>
            <City>
              <RcAbbreviation>ODELL</RcAbbreviation>
              <Name>WYMORE</Name>
            </City>
            <City>
              <RcAbbreviation>BRADSHAW</RcAbbreviation>
              <Name>YORK</Name>
            </City>
            <City>
              <RcAbbreviation>YORK</RcAbbreviation>
              <Name>YORK</Name>
            </City>
            <City>
              <RcAbbreviation>WACO</RcAbbreviation>
              <Name>YORK</Name>
            </City>
          </Cities>
        </CityResponse>
    listCities200ResponseXmlWithCountExample:
      value: |-
        <CityResponse>
          <ResultCount>9</ResultCount>
          <Cities>
           <City>
              <RcAbbreviation>FILLEY</RcAbbreviation>
              <AvailableTelephoneNumberCount>266</AvailableTelephoneNumberCount>
              <Name>ADAMS</Name>
            </City>
            <City>
              <RcAbbreviation>DOUGLAS</RcAbbreviation>
              <AvailableTelephoneNumberCount>378</AvailableTelephoneNumberCount>
              <Name>ADAMS</Name>
            </City>
            <City>
              <RcAbbreviation>WAKEFIELD</RcAbbreviation>
              <AvailableTelephoneNumberCount>272</AvailableTelephoneNumberCount>
              <Name>ALLEN</Name>
            </City>
            <City>
              <RcAbbreviation>ASHLAND</RcAbbreviation>
              <AvailableTelephoneNumberCount>129</AvailableTelephoneNumberCount>
              <Name>ASHLAND</Name>
            </City>
            <City>
              <RcAbbreviation>WEST POINT</RcAbbreviation>
              <AvailableTelephoneNumberCount>85</AvailableTelephoneNumberCount>
              <Name>WEST POINT</Name>
            </City>
            <City>
              <RcAbbreviation>OAKLAND</RcAbbreviation>
              <AvailableTelephoneNumberCount>290</AvailableTelephoneNumberCount>
              <Name>WEST POINT</Name>
            </City>
            <City>
              <RcAbbreviation>WESTERN</RcAbbreviation>
              <AvailableTelephoneNumberCount>134</AvailableTelephoneNumberCount>
              <Name>WESTERN</Name>
            </City>
            <City>
              <RcAbbreviation>WAYNE</RcAbbreviation>
              <AvailableTelephoneNumberCount>434</AvailableTelephoneNumberCount>
              <Name>WINSIDE</Name>
            </City>
            <City>
              <RcAbbreviation>BRADSHAW</RcAbbreviation>
              <AvailableTelephoneNumberCount>274</AvailableTelephoneNumberCount>
              <Name>YORK</Name>
            </City>
          </Cities>
        </CityResponse>
    listCities400ResponseJsonExample:
      value:
        code: 4006
        description: The search criteria 'State' cannot be empty.
    listCities400ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <CityResponse>
            <Error>
                <Code>4006</Code>
                <Description>The search criteria 'State' cannot be empty.</Description>
            </Error>
            <ResultCount>0</ResultCount>
        </CityResponse>
    internalServerError500ResponseJsonExample:
      value:
        code: 4009
        description: >-
          Sorry, the search request could not be processed because a system
          error occurred; please retry your operation or contact inetwork
          support person.
    listCities500ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <CityResponse>
            <Error>
                <Code>4009</Code>
                <Description>Sorry, the search request could not be processed because a system error occurred; please retry your operation or contact inetwork support person.</Description>
            </Error>
            <ResultCount>0</ResultCount>
        </CityResponse>
    listRateCenters200ResponseJsonSimpleExample:
      value:
        resultCount: 9
        rateCenters:
          - abbreviation: ADAMS
            name: ADAMS
          - abbreviation: AINSWORTH
            name: AINSWORTH
          - abbreviation: ALBION
            name: ALBION
          - abbreviation: ALEXANDRIA
            name: ALEXANDRIA
          - abbreviation: WOOD RIVER
            name: WOOD RIVER
          - abbreviation: WYMORE
            name: WYMORE
          - abbreviation: WYFRYCSTHL
            name: WYNOT FORDYCE SAINT HELENA
          - abbreviation: YORK
            name: YORK
          - abbreviation: YUTAN
            name: YUTAN
    listRateCenters200ResponseJsonWithCountExample:
      value:
        resultCount: 8
        rateCenters:
          - abbreviation: ADAMS
            availablePhoneNumberCount: 108
            name: ADAMS
          - abbreviation: ALEXANDRIA
            availablePhoneNumberCount: 230
            name: ALEXANDRIA
          - abbreviation: ASHLAND
            availablePhoneNumberCount: 129
            name: ASHLAND
          - abbreviation: WEST POINT
            availablePhoneNumberCount: 85
            name: WEST POINT
          - abbreviation: WESTERN
            availablePhoneNumberCount: 134
            name: WESTERN
          - abbreviation: WILBER
            availablePhoneNumberCount: 135
            name: WILBER
          - abbreviation: WYMORE
            availablePhoneNumberCount: 132
            name: WYMORE
          - abbreviation: YUTAN
            availablePhoneNumberCount: 588
            name: YUTAN
    listRateCenters200ResponseXmlSimpleExample:
      value: |-
        <RateCenterResponse>
          <ResultCount>9</ResultCount>
          <RateCenters>
            <RateCenter>
              <Abbreviation>ADAMS</Abbreviation>
              <Name>ADAMS</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>AINSWORTH</Abbreviation>
              <Name>AINSWORTH</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>ALBION</Abbreviation>
              <Name>ALBION</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>ALEXANDRIA</Abbreviation>
              <Name>ALEXANDRIA</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WOOD RIVER</Abbreviation>
              <Name>WOOD RIVER</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WYMORE</Abbreviation>
              <Name>WYMORE</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WYFRYCSTHL</Abbreviation>
              <Name>WYNOT FORDYCE SAINT HELENA</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>YORK</Abbreviation>
              <Name>YORK</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>YUTAN</Abbreviation>
              <Name>YUTAN</Name>
            </RateCenter>
          </RateCenters>
        </RateCenterResponse>
    listRateCenters200ResponseXmlWithCountExample:
      value: |-
        <RateCenterResponse>
          <ResultCount>8</ResultCount>
          <RateCenters>
            <RateCenter>
              <Abbreviation>ADAMS</Abbreviation>
              <AvailableTelephoneNumberCount>108</AvailableTelephoneNumberCount>
              <Name>ADAMS</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>ALEXANDRIA</Abbreviation>
              <AvailableTelephoneNumberCount>230</AvailableTelephoneNumberCount>
              <Name>ALEXANDRIA</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>ASHLAND</Abbreviation>
              <AvailableTelephoneNumberCount>129</AvailableTelephoneNumberCount>
              <Name>ASHLAND</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WEST POINT</Abbreviation>
              <AvailableTelephoneNumberCount>85</AvailableTelephoneNumberCount>
              <Name>WEST POINT</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WESTERN</Abbreviation>
              <AvailableTelephoneNumberCount>134</AvailableTelephoneNumberCount>
              <Name>WESTERN</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WILBER</Abbreviation>
              <AvailableTelephoneNumberCount>135</AvailableTelephoneNumberCount>
              <Name>WILBER</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>WYMORE</Abbreviation>
              <AvailableTelephoneNumberCount>132</AvailableTelephoneNumberCount>
              <Name>WYMORE</Name>
            </RateCenter>
            <RateCenter>
              <Abbreviation>YUTAN</Abbreviation>
              <AvailableTelephoneNumberCount>588</AvailableTelephoneNumberCount>
              <Name>YUTAN</Name>
            </RateCenter>
          </RateCenters>
        </RateCenterResponse>
    listRateCenters400ResponseJsonExample:
      value:
        code: 4006
        description: The state abbreviation abc is not valid.
    listRateCenters400ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <RateCenterResponse>
            <Error>
                <Code>4006</Code>
                <Description>The state abbreviation abc is not valid.</Description>
            </Error>
            <ResultCount>0</ResultCount>
        </RateCenterResponse>
    listRateCenters500ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <RateCenterResponse>
            <Error>
                <Code>4009</Code>
                <Description>Sorry, the search request could not be processed because a system error occurred; please retry your operation or contact inetwork support person.</Description>
            </Error>
            <ResultCount>0</ResultCount>
        </RateCenterResponse>
    listCoveredRateCenters200ResponseJsonExample:
      value:
        totalCount: 10
        links:
          next: https://api.bandwidth.com/api/v2/coveredRateCenters?page=42&size=2
          first: https://api.bandwidth.com/api/v2/coveredRateCenters?page=1&size=2
        coveredRateCenters:
          - name: AVALON
            abbreviation: AVALON
            state: CA
            lata: 730
            availableNumberCount: 1
            limitedAvailableNumberCount: 1
            zipCodes:
              - '90731'
            cities:
              - SAN PEDRO
            tiers:
              - '0'
            npaNxxXs:
              - '3105100'
              - '3105101'
              - '3109498'
              - '3109499'
              - '4242260'
            id: 3151
            localRateCenterIds:
              - 369
              - 7843
              - 7945
              - 2461
              - 10741
              - 7059
          - name: BEVERLY HILLS
            abbreviation: BEVERLYHLS
            state: CA
            lata: 730
            availableNumberCount: 25
            limitedAvailableNumberCount: 20
            zipCodes:
              - '90013'
              - '90014'
              - '90015'
              - '90017'
              - '90044'
              - '90048'
              - '90059'
              - '90061'
              - '90071'
              - '90079'
              - '90210'
              - '90211'
              - '90212'
              - '90247'
              - '90248'
              - '90249'
              - '91352'
              - '91403'
              - '91411'
              - '91423'
              - '91504'
              - '91505'
            cities:
              - BEVERLY HILLS
              - BURBANK
              - GARDENA
              - LOS ANGELES
              - SHERMAN OAKS
              - SUN VALLEY
              - VAN NUYS
            tiers:
              - '0'
            npaNxxXs:
              - '3102010'
              - '3102011'
              - '3102012'
              - '3102013'
              - '3102014'
              - '3102015'
              - '3102016'
              - '3102017'
              - '3102018'
              - '3102019'
              - '4246669'
              - '4247770'
              - '4247771'
              - '4247772'
              - '4247773'
              - '4247774'
              - '4247775'
              - '4247776'
              - '4247777'
              - '4247778'
              - '4247779'
            id: 3538
            localRateCenterIds:
              - 4421
              - 14259
    listCoveredRateCenters200ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <CoveredRateCenters>
          <TotalCount>10</TotalCount>
          <Links>
            <First>Link=&lt;https://api.bandwidth.com/api/v2/coveredRateCenters?page=1&amp;size=2>;rel="first";</First>
            <Next>Link=&lt;https://api.bandwidth.com/api/v2/coveredRateCenters?page=42&amp;size=2>;rel="next";</Next>
          </Links>
          <CoveredRateCenter>
            <Name>AVALON</Name>
            <Abbreviation>AVALON</Abbreviation>
            <State>CA</State>
            <Lata>730</Lata>
            <AvailableNumberCount>1</AvailableNumberCount>
            <LimitedAvailableNumberCount>1</LimitedAvailableNumberCount>
            <ZipCodes>
              <ZipCode>90731</ZipCode>
            </ZipCodes>
          <Cities>
            <City>SAN PEDRO</City>
          </Cities>
          <Tiers>
            <Tier>0</Tier>
          </Tiers>
          <NpaNxxXs>
            <NpaNxxX>3105100</NpaNxxX>
            <NpaNxxX>3105101</NpaNxxX>
            <NpaNxxX>3109498</NpaNxxX>
            <NpaNxxX>3109499</NpaNxxX>
            <NpaNxxX>4242260</NpaNxxX>
          </NpaNxxXs>
          <Id>3151</Id>
          <LocalRateCenters>
            <RateCenterId>369</RateCenterId>
            <RateCenterId>7843</RateCenterId>
            <RateCenterId>7945</RateCenterId>
            <RateCenterId>2461</RateCenterId>
            <RateCenterId>10741</RateCenterId>
            <RateCenterId>7059</RateCenterId>
          </LocalRateCenters>
         </CoveredRateCenter>
        <CoveredRateCenter>
          <Name>BEVERLY HILLS</Name>
          <Abbreviation>BEVERLYHLS</Abbreviation>
          <State>CA</State>
          <Lata>730</Lata>
          <AvailableNumberCount>25</AvailableNumberCount>
          <LimitedAvailableNumberCount>20</LimitedAvailableNumberCount>
          <ZipCodes>
            <ZipCode>90013</ZipCode>
            <ZipCode>90014</ZipCode>
            <ZipCode>90015</ZipCode>
            <ZipCode>90017</ZipCode>
            <ZipCode>90044</ZipCode>
            <ZipCode>90048</ZipCode>
            <ZipCode>90059</ZipCode>
            <ZipCode>90061</ZipCode>
            <ZipCode>90071</ZipCode>
            <ZipCode>90079</ZipCode>
            <ZipCode>90210</ZipCode>
            <ZipCode>90211</ZipCode>
            <ZipCode>90212</ZipCode>
            <ZipCode>90247</ZipCode>
            <ZipCode>90248</ZipCode>
            <ZipCode>90249</ZipCode>
            <ZipCode>91352</ZipCode>
            <ZipCode>91403</ZipCode>
            <ZipCode>91411</ZipCode>
            <ZipCode>91423</ZipCode>
            <ZipCode>91504</ZipCode>
            <ZipCode>91505</ZipCode>
          </ZipCodes>
          <Cities>
            <City>BEVERLY HILLS</City>
            <City>BURBANK</City>
            <City>GARDENA</City>
            <City>LOS ANGELES</City>
            <City>SHERMAN OAKS</City>
            <City>SUN VALLEY</City>
            <City>VAN NUYS</City>
          </Cities>
          <Tiers>
            <Tier>0</Tier>
          </Tiers>
          <NpaNxxXs>
            <NpaNxxX>3102010</NpaNxxX>
            <NpaNxxX>3102011</NpaNxxX>
            <NpaNxxX>3102012</NpaNxxX>
            <NpaNxxX>3102013</NpaNxxX>
            <NpaNxxX>3102014</NpaNxxX>
            <NpaNxxX>3102015</NpaNxxX>
            <NpaNxxX>3102016</NpaNxxX>
            <NpaNxxX>3102017</NpaNxxX>
            <NpaNxxX>3102018</NpaNxxX>
            <NpaNxxX>3102019</NpaNxxX>
            <NpaNxxX>4246669</NpaNxxX>
            <NpaNxxX>4247770</NpaNxxX>
            <NpaNxxX>4247771</NpaNxxX>
            <NpaNxxX>4247772</NpaNxxX>
            <NpaNxxX>4247773</NpaNxxX>
            <NpaNxxX>4247774</NpaNxxX>
            <NpaNxxX>4247775</NpaNxxX>
            <NpaNxxX>4247776</NpaNxxX>
            <NpaNxxX>4247777</NpaNxxX>
            <NpaNxxX>4247778</NpaNxxX>
            <NpaNxxX>4247779</NpaNxxX>
          </NpaNxxXs>
          <Id>3538</Id>
          <LocalRateCenters>
          <RateCenterId>4421</RateCenterId>
          <RateCenterId>14259</RateCenterId>
          </LocalRateCenters>
          </CoveredRateCenter>
        </CoveredRateCenters>
    listCoveredRateCenters400ResponseJsonExample:
      value:
        errorCode: 4002
        description: >-
          Please verify that your NPA, NPA-NXX, or NPA-NXX-X search input
          parameters are correct.
    listCoveredRateCenters400ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <CoveredRateCenters>
          <ResponseStatus>
            <ErrorCode>4002</ErrorCode>
            <Description>Please verify that your NPA, NPA-NXX, or NPA-NXX-X search input parameters are correct.</Description>
          </ResponseStatus>
        </CoveredRateCenters>
    listCoveredRateCenters500ResponseJsonExample:
      value:
        description: The system encountered an error and could not fulfill your request
    listCoveredRateCenters500ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <CoveredRateCenters>
            <ResponseStatus>
                <Description>The system encountered an error and could not fulfill your request</Description>
            </ResponseStatus>
        </CoveredRateCenters>
    getCoveredRateCenter200ResponseJsonExample:
      description: Get a covered rate center by ID
      value:
        name: LOMITA
        abbreviation: LOMITA
        state: CA
        lata: 730
        availableNumberCount: 5536
        limitedAvailableNumberCount: 5236
        zipCodes:
          - '90044'
          - '90059'
          - '90061'
          - '90247'
          - '90248'
          - '90249'
          - '90717'
          - '90802'
          - '90813'
          - '90822'
          - '90831'
          - '90834'
        cities:
          - GARDENA
          - LOMITA
          - LONG BEACH
          - LOS ANGELES
        tiers:
          - '0'
        npaNxxXs:
          - '3102570'
          - '3102571'
        id: 6854
        localRateCenterIds:
          - 369
          - 7843
          - 7945
    getCoveredRateCenter200ResponseXmlExample:
      description: Get a covered rate center by ID
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <CoveredRateCenter>
           <Name>LOMITA</Name>
           <Abbreviation>LOMITA</Abbreviation>
           <State>CA</State>
           <Lata>730</Lata>
           <AvailableNumberCount>5536</AvailableNumberCount>
           <LimitedAvailableNumberCount>5236</LimitedAvailableNumberCount>
           <ZipCodes>
              <ZipCode>90044</ZipCode>
              <ZipCode>90059</ZipCode>
              <ZipCode>90061</ZipCode>
              <ZipCode>90247</ZipCode>
              <ZipCode>90248</ZipCode>
              <ZipCode>90249</ZipCode>
              <ZipCode>90717</ZipCode>
              <ZipCode>90802</ZipCode>
              <ZipCode>90813</ZipCode>
              <ZipCode>90822</ZipCode>
              <ZipCode>90831</ZipCode>
              <ZipCode>90834</ZipCode>
           </ZipCodes>
           <Cities>
              <City>GARDENA</City>
              <City>LOMITA</City>
              <City>LONG BEACH</City>
              <City>LOS ANGELES</City>
           </Cities>
           <Tiers>
              <Tier>0</Tier>
           </Tiers>
           <NpaNxxXs>
              <NpaNxxX>3102570</NpaNxxX>
              <NpaNxxX>3102571</NpaNxxX>
           </NpaNxxXs>
           <Id>6854</Id>
           <LocalRateCenters>
              <RateCenterId>369</RateCenterId>
              <RateCenterId>7843</RateCenterId>
              <RateCenterId>7945</RateCenterId>
           </LocalRateCenters>
        </CoveredRateCenter>
    getAvailableNpaNxx200ResponseJsonExample:
      value:
        availableNpaNxx:
          - city: NASHVILLE
            npa: '252'
            nxx: '220'
            quantity: 1
            state: NC
          - city: FARMVILLE
            npa: '252'
            nxx: '228'
            quantity: 1
            state: NC
    getAvailableNpaNxx200ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <SearchResultForAvailableNpaNxx>
          <AvailableNpaNxxList>
            <AvailableNpaNxx>
              <City>NASHVILLE</City>
              <Npa>252</Npa>
              <Nxx>220</Nxx>
              <Quantity>1</Quantity>
              <State>NC</State>
            </AvailableNpaNxx>
            <AvailableNpaNxx>
              <City>FARMVILLE</City>
              <Npa>252</Npa>
              <Nxx>228</Nxx>
              <Quantity>1</Quantity>
              <State>NC</State>
            </AvailableNpaNxx>
          </AvailableNpaNxxList>
        </SearchResultForAvailableNpaNxx>
    getAvailableNpaNxx400ResponseJsonExample:
      value:
        code: 4000
        description: >-
          The area code specified 433 is not present as a valid entry in our
          system
    getAvailableNpaNxx400ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <SearchResultForAvailableNpaNxx>
          <Error>
            <Code>4000</Code>
            <Description>The area code specified 433 is not present as a valid entry in our system</Description>
          </Error>
        </SearchResultForAvailableNpaNxx>
    getAvailableNpaNxx404ResponseJsonExample:
      value:
        code: 404
        description: Account '12345' does not exist or is locked
    getAvailableNpaNxx404ResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <SearchResultForAvailableNpaNxx>
            <Error>
                <Code>404</Code>
                <Description>Account '12345' does not exist or is locked</Description>
            </Error>
        </SearchResultForAvailableNpaNxx>
    listImportToAccountOrders400XmlExample:
      description: Bad request error response for listing Import to Account orders.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResponseSelectWrapper>
            <ListOrderIdUserIdDate>
                <ErrorMessage>End date must be greater than start date</ErrorMessage>
            </ListOrderIdUserIdDate>
        </ResponseSelectWrapper>
    listImportToAccountOrdersXmlExample:
      description: A list of Import to Account orders.
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <ResponseSelectWrapper>
            <ListOrderIdUserIdDate>
                <TotalCount>3</TotalCount>
                <OrderIdUserIdDate>
                    <accountId>14</accountId>
                    <CountOfTNs>2</CountOfTNs>
                    <userId>team_ua</userId>
                    <lastModifiedDate>2014-07-07T10:06:43.427Z</lastModifiedDate>
                    <OrderType>import_to_account</OrderType>
                    <OrderDate>2014-07-07T10:06:43.427Z</OrderDate>
                    <orderId>37a6447c-1a0b-4be9-ba89-3f5cb0aea142</orderId>
                    <OrderStatus>FAILED</OrderStatus>
                </OrderIdUserIdDate>
                <OrderIdUserIdDate>
                    <accountId>14</accountId>
                    <CountOfTNs>2</CountOfTNs>
                    <userId>team_ua</userId>
                    <lastModifiedDate>2014-07-07T10:05:56.595Z</lastModifiedDate>
                    <OrderType>import_to_account</OrderType>
                    <OrderDate>2014-07-07T10:05:56.595Z</OrderDate>
                    <orderId>743b0e64-3350-42e4-baa6-406dac7f4a85</orderId>
                    <OrderStatus>RECEIVED</OrderStatus>
                </OrderIdUserIdDate>
                <OrderIdUserIdDate>
                    <accountId>14</accountId>
                    <CountOfTNs>2</CountOfTNs>
                    <userId>team_ua</userId>
                    <lastModifiedDate>2014-07-07T09:32:17.234Z</lastModifiedDate>
                    <OrderType>import_to_account</OrderType>
                    <OrderDate>2014-07-07T09:32:17.234Z</OrderDate>
                    <orderId>f71eb4d2-bfef-4384-957f-45cd6321185e</orderId>
                    <OrderStatus>RECEIVED</OrderStatus>
                </OrderIdUserIdDate>
            </ListOrderIdUserIdDate>
        </ResponseSelectWrapper>
    getImportToAccountOrderXmlExample:
      description: An Import to Account order with completed status.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ImportToAccountNumberOrderResponse>
            <ImportedTelephoneNumberList>
                <TelephoneNumber>+19199918393</TelephoneNumber>
                <TelephoneNumber>+19199918394</TelephoneNumber>
            </ImportedTelephoneNumberList>
            <OrderRequest>
                <id>c5986599-3a7c-4eed-a5c4-9121c17d54ab</id>
                <OrderCreateDate>2014-04-18T16:38:05.001Z</OrderCreateDate>
                <PeerId>303716</PeerId>
                <ImportToAccountNumberOrderType>
                    <BillingType>NOCHARGE</BillingType>
                    <InitialStatus>Available</InitialStatus>
                    <TnAttributes>
                        <TnAttribute>Protected</TnAttribute>
                    </TnAttributes>
                    <TelephoneNumberList>
                        <TelephoneNumber>+19199918393</TelephoneNumber>
                        <TelephoneNumber>+19199918394</TelephoneNumber>
                    </TelephoneNumberList>
                    <Origin>UNDEFINED</Origin>
                    <VendorName>Bandwidth CLEC</VendorName>
                </ImportToAccountNumberOrderType>
                <OverrideFeatureRestrictions>false</OverrideFeatureRestrictions>
                <SiteId>743</SiteId>
                <VoiceConfigurationPackageId>d21315af-9b5b-4b45-a6f4-9106cbfe87d1</VoiceConfigurationPackageId>
                <RequirementsPackageId>3fa85f64-5717-4562-b3fc-2c963f66afa6</RequirementsPackageId>
                <AutoActivate>true</AutoActivate>
                <ImportExternalTnsAsShared>false</ImportExternalTnsAsShared>
            </OrderRequest>
            <OrderStatus>COMPLETE</OrderStatus>
            <ImportedTelephoneNumberDetailList>
                <TelephoneNumberDetail>
                    <FullNumber>+19199918393</FullNumber>
                </TelephoneNumberDetail>
                <TelephoneNumberDetail>
                    <FullNumber>+19199918394</FullNumber>
                </TelephoneNumberDetail>
            </ImportedTelephoneNumberDetailList>
        </ImportToAccountNumberOrderResponse>
    getImportToAccountOrder404XmlExample:
      description: Order not found error response.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ErrorResponse>
            <irisStatus>
                <Code>404</Code>
                <Description>Order with such id was not found.</Description>
            </irisStatus>
        </ErrorResponse>
    getImportToAccountOrderHistoryXmlExample:
      description: Order history for an Import to Account order.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderHistoryWrapper>
            <OrderHistory>
                <OrderDate>2015-06-16T14:03:10.225Z</OrderDate>
                <Note>Import to Account is received.</Note>
                <Author>admin</Author>
                <Status>RECEIVED</Status>
            </OrderHistory>
            <OrderHistory>
                <OrderDate>2015-06-16T14:03:10.789Z</OrderDate>
                <Note>Import to Account is partial.</Note>
                <Author>admin</Author>
                <Status>PARTIAL</Status>
            </OrderHistory>
        </OrderHistoryWrapper>
    listImportToAccountOrderBatchesXmlExample:
      description: A list of Import to Account order batches.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Batches>
            <Batch>
                <BatchId>phnpwrblk4</BatchId>
                <OrderCreateDate>2014-05-02T15-27-25.090Z</OrderCreateDate>
                <OrderId>4928ab9d-6bf6-4035-ac01-38a061d0f5d9</OrderId>
                <OrderStatus>IMPORT_COMPLETE</OrderStatus>
                <SubmittedTnCount>5000</SubmittedTnCount>
                <SuccessfulTnCount>5000</SuccessfulTnCount>
                <BatchSize>5000</BatchSize>
            </Batch>
            <Batch>
                <BatchId>+11111111111</BatchId>
                <OrderCreateDate>2013-10-10T15-25-16.952Z</OrderCreateDate>
                <OrderId>8ce7c80b-d1ce-46f1-a3a1-56a08373b576</OrderId>
                <OrderStatus>VALIDATION_FAILED</OrderStatus>
                <SubmittedTnCount>4670</SubmittedTnCount>
                <SuccessfulTnCount>0</SuccessfulTnCount>
                <BatchSize>4670</BatchSize>
            </Batch>
            <Batch>
                <BatchId>+18177974679</BatchId>
                <OrderCreateDate>2014-04-10T16-54-04.001Z</OrderCreateDate>
                <OrderId>26afaae3-2a8b-4405-96aa-1c38fe1fb74b</OrderId>
                <OrderStatus>IMPORT_COMPLETE</OrderStatus>
                <SubmittedTnCount>2358</SubmittedTnCount>
                <SuccessfulTnCount>2358</SuccessfulTnCount>
                <BatchSize>2358</BatchSize>
            </Batch>
        </Batches>
    getImportToAccountOrdersByBatchIdXmlExample:
      description: Import to Account orders for a specific batch ID.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Batches>
            <Batch>
                <BatchId>+11111111111</BatchId>
                <OrderCreateDate>2014-05-02T15-27-25.090Z</OrderCreateDate>
                <OrderId>4928ab9d-6bf6-4035-ac01-38a061d0f5d9</OrderId>
                <OrderStatus>IMPORT_COMPLETE</OrderStatus>
                <SubmittedTnCount>5000</SubmittedTnCount>
                <SuccessfulTnCount>5000</SuccessfulTnCount>
                <BatchSize>5000</BatchSize>
            </Batch>
            <Batch>
                <BatchId>+11111111111</BatchId>
                <OrderCreateDate>2013-10-10T15-25-16.952Z</OrderCreateDate>
                <OrderId>8ce7c80b-d1ce-46f1-a3a1-56a08373b576</OrderId>
                <OrderStatus>VALIDATION_FAILED</OrderStatus>
                <SubmittedTnCount>4670</SubmittedTnCount>
                <SuccessfulTnCount>0</SuccessfulTnCount>
                <BatchSize>4670</BatchSize>
            </Batch>
            <Batch>
                <BatchId>+11111111111</BatchId>
                <OrderCreateDate>2014-04-10T16-54-04.001Z</OrderCreateDate>
                <OrderId>26afaae3-2a8b-4405-96aa-1c38fe1fb74b</OrderId>
                <OrderStatus>IMPORT_COMPLETE</OrderStatus>
                <SubmittedTnCount>2358</SubmittedTnCount>
                <SuccessfulTnCount>2358</SuccessfulTnCount>
                <BatchSize>2358</BatchSize>
            </Batch>
        </Batches>
  responses:
    listNewPhoneNumberOrders200Response:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/listNewPhoneNumberOrders200ResponseJsonExample
          schema:
            $ref: '#/components/schemas/listNewPhoneNumberOrders200ResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/listNewPhoneNumberOrders200ResponseXmlExample
          schema:
            $ref: '#/components/schemas/tnOrderHistoryResponse'
      description: OK
    listNewPhoneNumberOrders204Response:
      description: No Content
    listNewPhoneNumberOrders400Response:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/listNewPhoneNumberOrders400ResponseJsonExample
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/listNewPhoneNumberOrders400ResponseXmlExample
          schema:
            $ref: '#/components/schemas/errorResponseXml'
      description: Bad Request
    createNewPhoneNumberOrder201Response:
      content:
        application/json:
          examples:
            combinedSearchAndOrderType:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrder201ResponseCombinedSearchAndOrderTypeJsonExample
            existingPhoneNumberOrderType:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrder201ResponseExistingPhoneNumberOrderTypeJsonExample
          schema:
            $ref: >-
              #/components/schemas/createNewPhoneNumberOrder201ResponseSchemaJson
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrder201ResponseXmlExample
          schema:
            $ref: '#/components/schemas/tnOrderCreatedResponse'
      description: Created
    createNewPhoneNumberOrder400Response:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrder400ResponseJsonExample
          schema:
            $ref: >-
              #/components/schemas/createNewPhoneNumberOrder400ResponseSchemaJson
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/createNewPhoneNumberOrder400ResponseXmlExample
          schema:
            $ref: '#/components/schemas/tnOrderBadResponse'
      description: Bad Request
    retrieveNewPhoneNumberOrder200Response:
      content:
        application/json:
          examples:
            combinedSearchAndOrderType (successful):
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder200ResponseCombinedSearchAndOrderSuccessfulJsonExample
            combinedSearchAndOrderType (unsuccessful):
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder200ResponseCombinedSearchAndOrderUnsuccessfulJsonExample
            existingPhoneNumberOrderType (successful):
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder200ResponseExistingPhoneNumberOrderSuccessfulJsonExample
          schema:
            $ref: >-
              #/components/schemas/retrieveNewPhoneNumberOrder200ResponseSchemaJson
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder200ResponseXmlExample
          schema:
            $ref: '#/components/schemas/tnOrderUpdatedResponse'
      description: OK
    retrieveNewPhoneNumberOrder404Response:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder404ResponseJsonExample
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/retrieveNewPhoneNumberOrder404ResponseXmlExample
          schema:
            $ref: '#/components/schemas/errorResponseXml'
      description: Not Found
    updateNewPhoneNumberOrder200Response:
      description: OK
    updateNewPhoneNumberOrder400Response:
      description: Bad Request
    updateNewPhoneNumberOrder404Response:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/updateNewPhoneNumberOrder404ResponseJsonExample
          schema:
            $ref: >-
              #/components/schemas/updateNewPhoneNumberOrder404ResponseSchemaJson
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/updateNewPhoneNumberOrder404ResponseXmlExample
          schema:
            $ref: '#/components/schemas/updateNewPhoneNumberOrder404ResponseSchemaXml'
      description: Not Found
    getNewNumberOrderHistoryResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderHistoryResponse200XmlExample
          schema:
            $ref: '#/components/schemas/orderHistoryWrapper'
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderHistoryResponse200JsonExample
          schema:
            $ref: '#/components/schemas/orderHistoryResponseJson'
      description: OK
    getNewNumberOrderHistoryResponse404:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderHistoryResponse404XmlExample
          schema:
            $ref: '#/components/schemas/errorResponseNoCode'
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderHistoryResponse404JsonExample
          schema:
            $ref: '#/components/schemas/responseStatusJsonNoCode'
      description: Not Found
    newNumberOrderTotalsResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/newNumberOrderTotalsResponse200XmlExample'
          schema:
            $ref: '#/components/schemas/tnOrderHistoryResponse'
      description: OK
    newNumberOrderAreaCodesResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/newNumberOrderAreaCodesResponse200XmlExample
          schema:
            $ref: '#/components/schemas/telephoneDetailsAreaCodes'
      description: OK
    newNumberOrderNotesGetResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/newNumberOrderNotesGetResponse200XmlExample
          schema:
            $ref: '#/components/schemas/orderNotesResponse'
      description: OK
    newNumberOrderNotesGetResponse204:
      description: No Content
    newNumberOrderNotesPostResponse201:
      description: Created
    newNumberOrderNotesPostResponse400:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/newNumberOrderNotesPostResponse400XmlExample
          schema:
            $ref: '#/components/schemas/noteErrorResponse'
      description: Bad Request
    getNewNumberOrderTnListResponse200:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderTnListResponse200JsonExample
          schema:
            $ref: '#/components/schemas/orderPhoneNumberGetResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderTnListResponse200XmlExample
          schema:
            $ref: '#/components/schemas/orderTelephoneNumbersResponse'
      description: OK
    getNewNumberOrderTnListResponse404:
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderTnListResponse404JsonExample
          schema:
            $ref: '#/components/schemas/responseStatusJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderTnListResponse404XmlExample
          schema:
            $ref: '#/components/schemas/errorResponse'
      description: Not Found
    putNewNumberOrderNotesResponse200:
      description: OK
    putNewNumberOrderNotesResponse400:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/putNewNumberOrderNotesResponse400XmlExample
          schema:
            $ref: '#/components/schemas/noteErrorResponse'
      description: Bad Request
    getNewNumberOrderNpaNxxResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderNpaNxxResponse200XmlExample
          schema:
            $ref: '#/components/schemas/telephoneDetailsNpaNxx'
      description: OK
    getNewNumberOrderIdTotalsResponse200:
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getNewNumberOrderIdTotalsResponse200XmlExample
          schema:
            $ref: '#/components/schemas/telephoneDetailsTotals'
      description: OK
    listCities200Response:
      description: OK
      content:
        application/json:
          examples:
            Simple response:
              $ref: '#/components/examples/listCities200ResponseJsonSimpleExample'
            Response with phone number count:
              $ref: '#/components/examples/listCities200ResponseJsonWithCountExample'
          schema:
            $ref: '#/components/schemas/cityResponseJson'
        application/xml:
          examples:
            Simple response:
              $ref: '#/components/examples/listCities200ResponseXmlSimpleExample'
            Response with phone number count:
              $ref: '#/components/examples/listCities200ResponseXmlWithCountExample'
          schema:
            $ref: '#/components/schemas/citySearchResults'
    listCities400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/listCities400ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listCities400ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/cityErrorResponseXml'
    listCities500Response:
      description: Internal Server Error
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/internalServerError500ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listCities500ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/cityErrorResponseXml'
    listRateCenters200Response:
      description: OK
      content:
        application/json:
          examples:
            Simple response:
              $ref: >-
                #/components/examples/listRateCenters200ResponseJsonSimpleExample
            Response with phone number count:
              $ref: >-
                #/components/examples/listRateCenters200ResponseJsonWithCountExample
          schema:
            $ref: '#/components/schemas/rateCenterResponseJson'
        application/xml:
          examples:
            Simple response:
              $ref: '#/components/examples/listRateCenters200ResponseXmlSimpleExample'
            Response with phone number count:
              $ref: >-
                #/components/examples/listRateCenters200ResponseXmlWithCountExample
          schema:
            $ref: '#/components/schemas/rateCenterSearchResults'
    listRateCenters400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/listRateCenters400ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listRateCenters400ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/rateCenterErrorResponseXml'
    listRateCenters500Response:
      description: Internal Server Error
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/internalServerError500ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listRateCenters500ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/rateCenterErrorResponseXml'
    listCoveredRateCenters200Response:
      description: OK
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters200ResponseJsonExample
          schema:
            $ref: '#/components/schemas/coveredRateCenterSearchResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters200ResponseXmlExample
          schema:
            $ref: '#/components/schemas/coveredRateCenterSearchResponse'
    listCoveredRateCenters204Response:
      description: No Content
    listCoveredRateCenters303Response:
      description: See Other
    listCoveredRateCenters400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters400ResponseJsonExample
          schema:
            $ref: '#/components/schemas/responseStatusJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters400ResponseXmlExample
          schema:
            $ref: '#/components/schemas/coveredRateCenterSearchErrorResponse'
    listCoveredRateCenters500Response:
      description: Internal Server Error
      content:
        application/json:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters500ResponseJsonExample
          schema:
            $ref: '#/components/schemas/coveredRateCenterErrorResponseJson'
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/listCoveredRateCenters500ResponseXmlExample
          schema:
            $ref: '#/components/schemas/coveredRateCenterErrorResponseXml'
    getCoveredRateCenter200Response:
      description: OK
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/getCoveredRateCenter200ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/coveredRateCenterJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/getCoveredRateCenter200ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/coveredRateCenterResponse'
    getCoveredRateCenter404Response:
      description: Not Found
    getAvailableNpaNxx200Response:
      description: OK
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx200ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/availableNpaNxxSearchResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx200ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/searchResultForAvailableNpaNxxWrapper'
    getAvailableNpaNxx400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx400ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx400ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/searchResultForAvailableNpaNxxErrorWrapper'
    getAvailableNpaNxx404Response:
      description: Not Found
      content:
        application/json:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx404ResponseJsonExample'
          schema:
            $ref: '#/components/schemas/errorResponseJson'
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/getAvailableNpaNxx404ResponseXmlExample'
          schema:
            $ref: '#/components/schemas/searchResultForAvailableNpaNxxErrorWrapper'
    listImportToAccountOrders400Response:
      description: Bad Request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/listImportToAccountOrders400ResponseSchema'
          examples:
            example:
              $ref: '#/components/examples/listImportToAccountOrders400XmlExample'
    listImportToAccountOrders200Response:
      description: OK
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listImportToAccountOrdersXmlExample'
          schema:
            $ref: '#/components/schemas/responseSelectWrapper'
    getImportToAccountOrderHistory200Response:
      description: OK
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/getImportToAccountOrderHistoryXmlExample'
          schema:
            $ref: '#/components/schemas/orderHistoryWrapper'
    listImportToAccountOrderBatches200Response:
      description: OK
      content:
        application/xml:
          examples:
            example:
              $ref: '#/components/examples/listImportToAccountOrderBatchesXmlExample'
          schema:
            $ref: '#/components/schemas/batches'
    getImportToAccountOrdersByBatchId200Response:
      description: OK
      content:
        application/xml:
          examples:
            example:
              $ref: >-
                #/components/examples/getImportToAccountOrdersByBatchIdXmlExample
          schema:
            $ref: '#/components/schemas/batches'
    importToAccountUnauthorized401Response:
      description: Unauthorized
    importToAccountForbidden403Response:
      description: Forbidden
    importToAccountNotFound404Response:
      description: Not Found
    getImportToAccountOrder404Response:
      description: Not Found
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/importToAccountErrorResponse'
          examples:
            example:
              $ref: '#/components/examples/getImportToAccountOrder404XmlExample'
    importToAccountTooManyRequests429Response:
      description: Too Many Requests
      headers:
        x-ratelimit-reset:
          description: The Unix timestamp (in seconds) at which the rate limit will reset.
          schema:
            type: integer
          example: 1775749577
    importToAccount500Response:
      description: Internal Server Error
    importToAccount405Response:
      description: Method Not Allowed
    importToAccount204Response:
      description: No Content
    importToAccountNumberOrderResponseForGet:
      description: OK
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/importToAccountNumberOrderResponseForGet'
          examples:
            example:
              $ref: '#/components/examples/getImportToAccountOrderXmlExample'
  schemas:
    serviceActivationOrderStatusEnum:
      description: >-
        The status of the related Service Activation order if this New Number
        order had autoActivate set to true.
      type: string
      enum:
        - RECEIVED
        - PROCESSING
        - COMPLETE
        - PARTIAL
        - FAILED
        - MISSING_REQUIREMENTS
    visibleOrderStatusJson:
      enum:
        - RECEIVED
        - COMPLETE
        - PARTIAL
        - FAILED
        - BACKORDERED
        - PROCESSING
      type: string
    tnOrderHistoryResponse:
      properties:
        ResponseSelectWrapper:
          properties:
            ListOrderIdUserIdDate:
              properties:
                Links:
                  $ref: '#/components/schemas/links'
                OrderIdUserIdDate:
                  items:
                    $ref: '#/components/schemas/orderSummary'
                  type: array
                TotalCount:
                  type: integer
              type: object
          type: object
      type: object
    links:
      items:
        oneOf:
          - $ref: '#/components/schemas/selfLink'
      title: Links
      type: array
    selfLink:
      properties:
        href:
          description: URI of the link
          example: /self/uri
          type: string
        method:
          description: HTTP method to be used
          example: GET
          type: string
        rel:
          description: Specifies the relationship between this link and the resource.
          example: SelfResource
          type: string
      title: Self Link
      type: object
    orderSummary:
      properties:
        CountOfTNs:
          type: integer
        CustomerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        LastModifiedNote:
          $ref: '#/components/schemas/note'
        OrderDate:
          type: string
        OrderId:
          type: string
        OrderStatus:
          type: string
        OrderType:
          type: string
        SuppCount:
          type: integer
        TelephoneNumberDetails:
          $ref: '#/components/schemas/telephoneNumberDetails'
        VoiceIntegrationIds:
          $ref: '#/components/schemas/voiceIntegrationIds'
        BulkNumberSyncId:
          $ref: '#/components/schemas/bulkNumberSyncId'
        Tags:
          $ref: '#/components/schemas/phoneNumberTagsXml'
        accountId:
          type: integer
        lastModifiedDate:
          type: string
        userId:
          type: string
      type: object
    telephoneNumberDetails:
      properties:
        Cities:
          items:
            $ref: '#/components/schemas/cityWithCount'
          type: array
          xml:
            wrapped: true
        RateCenters:
          items:
            $ref: '#/components/schemas/rateCenterWithCount'
          type: array
          xml:
            wrapped: true
        States:
          items:
            $ref: '#/components/schemas/stateWithCount'
          type: array
          xml:
            wrapped: true
        Tiers:
          items:
            $ref: '#/components/schemas/tiers'
          type: array
          xml:
            wrapped: true
        Vendors:
          items:
            $ref: '#/components/schemas/vendors'
          type: array
          xml:
            wrapped: true
      type: object
    note:
      properties:
        Note:
          properties:
            Description:
              description: This is the Order Note description.
              type: string
            Id:
              description: >-
                This is the Order Note identifier that is automatically
                generated by system.
              type: string
            LastDateModifier:
              description: This is the date when Order Note was last modified.
              type: string
            UserId:
              description: >-
                The UserId is authenticated for access to the network via a
                username string. It is required for UserId to match the
                logged-in user when making a new note.
              type: string
          type: object
      type: object
    vendors:
      properties:
        Count:
          type: integer
        VendorId:
          type: integer
        VendorName:
          type: string
      type: object
    tiers:
      properties:
        Count:
          type: integer
        Tier:
          type: string
      type: object
    stateWithCount:
      properties:
        Count:
          type: integer
        State:
          type: string
      type: object
    rateCenterWithCount:
      properties:
        Count:
          type: integer
        RateCenter:
          type: string
      type: object
    cityWithCount:
      properties:
        City:
          type: string
        Count:
          type: integer
      type: object
    listNewPhoneNumberOrders200ResponseJson:
      properties:
        links:
          $ref: '#/components/schemas/linksJson'
        orders:
          items:
            properties:
              accountId:
                type: integer
              customerOrderId:
                type: string
                description: >-
                  The customer-defined reference ID for this order, if one was
                  provided at creation. Not unique — Bandwidth applies no
                  uniqueness constraint, so multiple orders may share the same
                  value. Each order has a distinct Bandwidth-assigned `orderId`.
              lastModifiedDate:
                format: date-time
                type: string
              orderDate:
                format: date-time
                type: string
              orderId:
                type: string
              orderStatus:
                $ref: '#/components/schemas/visibleOrderStatusJson'
              orderType:
                type: string
              phoneNumberCount:
                type: integer
              phoneNumberDetails:
                $ref: '#/components/schemas/telephoneNumberDetailsJson'
              summary:
                type: string
              userId:
                type: string
              voiceIntegrationIds:
                $ref: '#/components/schemas/voiceIntegrationIdsJson'
              bulkNumberSyncId:
                $ref: '#/components/schemas/bulkNumberSyncId'
              tags:
                $ref: '#/components/schemas/phoneNumberTags'
          type: array
        totalCount:
          type: integer
      type: object
    telephoneNumberDetailsJson:
      properties:
        cities:
          items:
            $ref: '#/components/schemas/cityWithCountJson'
          type: array
        rateCenters:
          items:
            $ref: '#/components/schemas/rateCenterWithCountJson'
          type: array
        states:
          items:
            $ref: '#/components/schemas/stateWithCountJson'
          type: array
        tiers:
          items:
            $ref: '#/components/schemas/tiersJson'
          type: array
        vendors:
          items:
            $ref: '#/components/schemas/vendorsJson'
          type: array
      type: object
    linksJson:
      properties:
        first:
          description: The first (or only) page of results matching the query.
          type: string
        last:
          description: >-
            If more results exist than specified by 'size', this link return the
            last page of result.
          type: string
        next:
          description: >-
            If more results exist than specified by 'size', this link returns
            the next page of 'size' results.
          type: string
        previous:
          description: >-
            If the results are more than one page, this link returns the
            previous page of 'size' results.
          type: string
      type: object
    cityWithCountJson:
      properties:
        city:
          type: string
        count:
          type: integer
      type: object
    rateCenterWithCountJson:
      properties:
        count:
          type: integer
        rateCenter:
          type: string
      type: object
    stateWithCountJson:
      properties:
        count:
          type: integer
        state:
          type: string
      type: object
    tiersJson:
      properties:
        count:
          type: integer
        tier:
          type: integer
      type: object
    vendorsJson:
      properties:
        count:
          type: integer
        onNetVendor:
          type: boolean
        vendorId:
          type: integer
        vendorName:
          type: string
      type: object
    errorResponseJson:
      $ref: '#/components/schemas/irisStatusJson'
    irisStatusJson:
      properties:
        code:
          format: int32
          type: integer
        description:
          type: string
      type: object
    errorResponseXml:
      properties:
        ErrorResponse:
          properties:
            irisStatus:
              $ref: '#/components/schemas/irisStatus'
          type: object
    irisStatus:
      properties:
        Code:
          format: int32
          type: integer
        Description:
          type: string
      type: object
    existingTelephoneNumberOrder:
      title: Existing Telephone Number Order
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            ExistingTelephoneNumberOrderType:
              $ref: '#/components/schemas/existingTelephoneNumberOrderTypeXml'
          type: object
      xml:
        name: Order
    orderMetadata:
      properties:
        AutoActivate:
          default: true
          description: >-
            AutoActivate is used to indicate whether the service should be
            activated upon completion of the order. If not specified, the
            default value is true.
          type: boolean
        BackOrderRequested:
          type: boolean
        CloseOrder:
          type: boolean
        CustomerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        Name:
          type: string
        OrderCreateDate:
          type: string
        PartialAllowed:
          type: boolean
        PeerId:
          format: int32
          type: integer
        RequirementsPackageId:
          $ref: '#/components/schemas/requirementsPackageId'
        SiteId:
          format: int32
          type: integer
        TnAttributes:
          items:
            $ref: '#/components/schemas/tnAttribute'
          type: array
        VoiceConfigurationPackageId:
          $ref: '#/components/schemas/voiceConfigurationPackageId'
        VoiceIntegrationIds:
          $ref: '#/components/schemas/voiceIntegrationIds'
        Tags:
          $ref: '#/components/schemas/phoneNumberTagsXml'
      type: object
      xml:
        name: Order
    orderMetadataResponse:
      properties:
        AutoActivate:
          default: true
          description: >-
            AutoActivate is used to indicate whether the service should be
            activated upon completion of the order. If not specified, the
            default value is true.
          type: boolean
        BackOrderRequested:
          type: boolean
        CloseOrder:
          type: boolean
        CustomerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        Name:
          type: string
        OrderCreateDate:
          type: string
        PartialAllowed:
          type: boolean
        PeerId:
          format: int32
          type: integer
        RequirementsPackageId:
          $ref: '#/components/schemas/requirementsPackageId'
        SiteId:
          format: int32
          type: integer
        TnAttributes:
          items:
            $ref: '#/components/schemas/tnAttribute'
          type: array
        VoiceConfigurationPackageId:
          $ref: '#/components/schemas/voiceConfigurationPackageId'
        VoiceIntegrationIds:
          $ref: '#/components/schemas/voiceIntegrationIds'
        BulkNumberSyncId:
          $ref: '#/components/schemas/bulkNumberSyncId'
        Tags:
          $ref: '#/components/schemas/phoneNumberTagsXml'
      type: object
      xml:
        name: Order
    requirementsPackageId:
      description: Unique identifier for requirements package
      example: 93ac73e8-20a7-95ec-bd32-4e8270e66c31
      title: Requirements Package ID
      type: string
      xml:
        name: requirementsPackageId
    tnAttribute:
      description: >-
        The TnAttributes field specifies line attributes that will apply to the
        ported in phone numbers. If present, TnAttributes may have a value of
        PROTECTED. This element is not applicable for off-net and toll free
        port-types.
      properties:
        TnAttribute:
          type: string
      type: object
    voiceConfigurationPackageId:
      description: >-
        `voiceConfigurationPackageId` is the identifier of the voice
        configuration package containing the voice origination settings. Upon
        activation, phone numbers will be configured with the voice origination
        settings specified in the voice configuration package.
      example: c7951e4f-6285-4b75-83e5-392558f59067
      format: uuid
      title: Voice Configuration Package ID
      type: string
    voiceIntegrationIdsJson:
      description: >-
        A list of voice integration identifiers to associate with the phone
        numbers upon activation, 

        which will configure them with the specified voice integration settings.

        This creates a number syncing request that can be tracked with the
        bulkNumberSyncId.
      type: array
      items:
        type: string
        format: uuid
      title: Voice Integrations
      example:
        - 3fa85f64-5717-4562-b3fc-2c963f66afa6
    voiceIntegrationIds:
      description: >-
        A list of voice integration identifiers to associate with the phone
        numbers upon activation, 

        which will configure them with the specified voice integration settings.

        This creates a number syncing request that can be tracked with the
        bulkNumberSyncId.
      properties:
        VoiceIntegrationId:
          items:
            $ref: '#/components/schemas/voiceIntegrationId'
          type: array
          xml:
            wrapped: true
    voiceIntegrationId:
      type: array
      items:
        type: string
        format: uuid
      title: Voice Integrations
      example:
        - 5fa85f64-5717-4562-b3fc-2c963f66afa6
    bulkNumberSyncId:
      description: >-
        Adding voice integrations to the phone number(s) being ordered
        automatically kicks off an asynchronous bulk provisioning task. Use this
        ID to check the status of the provisioning request
        [here](https://dev.bandwidth.com/apis/universal-platform/voice-provisioning/#tag/Bulk-Voice-Phone-Number-Provisioning/operation/getBulkVoicePhoneNumbers).
      example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      format: uuid
      title: Bulk Number Sync ID
      type: string
    tagName:
      type: string
      description: >-
        Name of a tag to associate with a phone number. Only alphanumeric
        values, dashes and underscores are allowed. Between 1 and 255
        characters. Is case sensitive.
      example: customerId
    tagValue:
      type: string
      description: >-
        Value of a tag to associate with a phone number. Only alphanumeric
        values, dashes and underscores are allowed. Between 1 and 255
        characters. Is case sensitive.
      example: 11111111-1111-1111-1111-111111111111
    phoneNumberTag:
      description: A tag to associate with the phone numbers being ordered.
      properties:
        tagName:
          $ref: '#/components/schemas/tagName'
        tagValue:
          $ref: '#/components/schemas/tagValue'
      required:
        - tagName
        - tagValue
      type: object
    phoneNumberTagXml:
      description: A tag to associate with the phone numbers being ordered.
      properties:
        TagName:
          $ref: '#/components/schemas/tagName'
        TagValue:
          $ref: '#/components/schemas/tagValue'
      required:
        - TagName
        - TagValue
      type: object
      xml:
        name: Tag
    phoneNumberTags:
      description: >-
        Tags to associate with the phone numbers being ordered on order
        completion. For `PARTIAL` or `FAILED` orders, the tags will not be
        applied to phone numbers which are not successfully added to your
        account.
      type: array
      items:
        $ref: '#/components/schemas/phoneNumberTag'
    phoneNumberTagsXml:
      description: >-
        Tags to associate with the phone numbers being ordered on order
        completion. For `PARTIAL` or `FAILED` orders, the tags will not be
        applied to phone numbers which are not successfully added to your
        account.
      type: array
      items:
        $ref: '#/components/schemas/phoneNumberTagXml'
      xml:
        wrapped: true
    existingTelephoneNumberOrderTypeXml:
      properties:
        ReservationIdList:
          $ref: '#/components/schemas/ReservationIdList'
        TelephoneNumberList:
          $ref: '#/components/schemas/TelephoneNumberList'
      type: object
      xml:
        name: ExistingTelephoneNumberOrderType
    rateCenterSearchAndOrderNanp:
      title: Rate Center Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            RateCenterSearchAndOrderType:
              $ref: '#/components/schemas/rateCenterSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    rateCenterSearchAndOrderTypeXml:
      properties:
        EnableLCA:
          type: boolean
        Quantity:
          format: int32
          type: integer
        RateCenter:
          type: string
        State:
          type: string
      type: object
      xml:
        name: RateCenterSearchAndOrderType
    areaCodeSearchAndOrderNanp:
      title: Area Code Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            AreaCodeSearchAndOrderType:
              $ref: '#/components/schemas/areaCodeSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    areaCodeSearchAndOrderTypeXml:
      properties:
        AreaCode:
          type: string
        Quantity:
          format: int32
          type: integer
      type: object
      xml:
        name: AreaCodeSearchAndOrderType
    npaNxxSearchAndOrderNanp:
      title: NPA NXX Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            NPANXXSearchAndOrderType:
              $ref: '#/components/schemas/npaNxxSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    npaNxxSearchAndOrderTypeXml:
      properties:
        EnableLCA:
          type: boolean
        NpaNxx:
          type: string
        Quantity:
          format: int32
          type: integer
      type: object
      xml:
        name: NPANXXSearchAndOrderType
    tollFreeWildCharSearchAndOrderNanp:
      title: Toll Free Wild Char Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            TollFreeWildCharSearchAndOrderType:
              $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    tollFreeWildCharSearchAndOrderTypeXml:
      properties:
        Quantity:
          format: int32
          type: integer
        TollFreeWildCardPattern:
          type: string
      type: object
      xml:
        name: TollFreeWildCharSearchAndOrderType
    tollFreeVanitySearchAndOrderNanp:
      title: Toll Free Vanity Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            TollFreeVanitySearchAndOrderType:
              $ref: '#/components/schemas/tollFreeVanitySearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    tollFreeVanitySearchAndOrderTypeXml:
      properties:
        Quantity:
          format: int32
          type: integer
        TollFreeVanity:
          type: string
      type: object
      xml:
        name: TollFreeVanitySearchAndOrderType
    lataSearchAndOrderNanp:
      title: LATA Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            LATASearchAndOrderType:
              $ref: '#/components/schemas/lataSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    lataSearchAndOrderTypeXml:
      properties:
        LATA:
          type: string
        Quantity:
          format: int32
          type: integer
      type: object
      xml:
        name: LATASearchAndOrderType
    zipSearchAndOrderNanp:
      title: ZIP Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            ZIPSearchAndOrderType:
              $ref: '#/components/schemas/zipSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    zipSearchAndOrderTypeXml:
      properties:
        Quantity:
          format: int32
          type: integer
        Zip:
          type: string
      type: object
      xml:
        name: ZIPSearchAndOrderType
    citySearchAndOrderNanp:
      title: City Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            CitySearchAndOrderType:
              $ref: '#/components/schemas/citySearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    citySearchAndOrderTypeXml:
      properties:
        City:
          type: string
        Quantity:
          format: int32
          type: integer
        State:
          type: string
      type: object
      xml:
        name: CitySearchAndOrderType
    stateSearchAndOrderNanp:
      title: State Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            StateSearchAndOrderType:
              $ref: '#/components/schemas/stateSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    stateSearchAndOrderTypeXml:
      properties:
        Quantity:
          format: int32
          type: integer
        State:
          type: string
      type: object
      xml:
        name: StateSearchAndOrderType
    combinedSearchAndOrderNanp:
      title: Combined Search And Order NANP
      allOf:
        - $ref: '#/components/schemas/orderMetadata'
        - properties:
            CombinedSearchAndOrderType:
              $ref: '#/components/schemas/combinedSearchAndOrderTypeXml'
          type: object
      xml:
        name: Order
    combinedSearchAndOrderTypeXml:
      properties:
        AreaCode:
          type: string
        City:
          type: string
        EnableLCA:
          type: boolean
        EndsIn:
          type: boolean
        LATA:
          type: string
        LocalVanity:
          type: string
        NpaNxx:
          type: string
        NpaNxxX:
          type: string
        Quantity:
          format: int32
          type: integer
        RateCenter:
          type: string
        State:
          type: string
        Zip:
          type: string
      type: object
      xml:
        name: CombinedSearchAndOrderType
    createNewPhoneNumberOrderRequestSchemaJson:
      $ref: '#/components/schemas/newPhoneNumberOrder'
    newPhoneNumberOrder:
      properties:
        autoActivate:
          default: true
          description: >-
            AutoActivate is used to indicate whether the service should be
            activated upon completion of the order. If not specified, the
            default value is true.
          type: boolean
        backOrderRequested:
          nullable: true
          type: boolean
        closeOrder:
          default: false
          description: >-
            Applicable to new phone number orders where backOrderRequested=true
            and the order is still in progress. Setting this property to true
            will close the backorder process and set the order to a terminal
            state.
          nullable: true
          type: boolean
        customerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\ ]{1,255}$
          type: string
        id:
          example: c1b34921-ed73-4732-8a08-168e815514ec
          readOnly: true
          type: string
        lastModifiedBy:
          readOnly: true
          type: string
        locationId:
          type: integer
        name:
          type: string
        orderCreateDate:
          example: '2022-11-14T18:39:04.505Z'
          format: date-time
          readOnly: true
          type: string
        orderType:
          oneOf:
            - $ref: '#/components/schemas/existingPhoneNumberOrderType'
            - $ref: '#/components/schemas/combinedSearchAndOrderType'
        partialAllowed:
          nullable: true
          type: boolean
        phoneNumberAttributes:
          items:
            enum:
              - PROTECTED
              - EXTERNAL
              - IMPORTED
            type: string
          type: array
        requirementsPackageId:
          type: string
        subAccountId:
          type: integer
        voiceConfigurationPackageId:
          type: string
        voiceIntegrationIds:
          description: >-
            A list of voice integration identifiers to associate with the phone
            numbers upon activation, 

            which will configure them with the specified voice integration
            settings.
          items:
            format: uuid
            type: string
          type: array
        tags:
          $ref: '#/components/schemas/phoneNumberTags'
      required:
        - orderType
        - subAccountId
      type: object
    newPhoneNumberOrderResponse:
      properties:
        autoActivate:
          default: true
          description: >-
            AutoActivate is used to indicate whether the service should be
            activated upon completion of the order. If not specified, the
            default value is true.
          type: boolean
        backOrderRequested:
          nullable: true
          type: boolean
        closeOrder:
          default: false
          description: >-
            Applicable to new phone number orders where backOrderRequested=true
            and the order is still in progress. Setting this property to true
            will close the backorder process and set the order to a terminal
            state.
          nullable: true
          type: boolean
        customerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\ ]{1,255}$
          type: string
        id:
          example: c1b34921-ed73-4732-8a08-168e815514ec
          readOnly: true
          type: string
        lastModifiedBy:
          readOnly: true
          type: string
        locationId:
          type: integer
        name:
          type: string
        orderCreateDate:
          example: '2022-11-14T18:39:04.505Z'
          format: date-time
          readOnly: true
          type: string
        orderType:
          oneOf:
            - $ref: '#/components/schemas/existingPhoneNumberOrderType'
            - $ref: '#/components/schemas/combinedSearchAndOrderType'
        partialAllowed:
          nullable: true
          type: boolean
        phoneNumberAttributes:
          items:
            enum:
              - PROTECTED
              - EXTERNAL
              - IMPORTED
            type: string
          type: array
        requirementsPackageId:
          type: string
        subAccountId:
          type: integer
        voiceConfigurationPackageId:
          type: string
        voiceIntegrationIds:
          description: >-
            A list of voice integration identifiers to associate with the phone
            numbers upon activation, 

            which will configure them with the specified voice integration
            settings.
          items:
            format: uuid
            type: string
          type: array
        bulkNumberSyncId:
          description: >-
            Adding voice integrations to the phone number(s) being ordered
            automatically kicks off an asynchronous bulk provisioning task. Use
            this ID to check the status of the provisioning request
            [here](https://dev.bandwidth.com/apis/universal-platform/voice-provisioning/#tag/Bulk-Voice-Phone-Number-Provisioning/operation/getBulkVoicePhoneNumbers).
          format: uuid
          type: string
        tags:
          $ref: '#/components/schemas/phoneNumberTags'
      required:
        - orderType
        - subAccountId
      type: object
    existingPhoneNumberOrderType:
      title: Existing Phone Number Order Type
      properties:
        phoneNumbers:
          items:
            type: string
          type: array
        reservationIds:
          items:
            type: string
          type: array
        type:
          type: string
          enum:
            - existingPhoneNumberOrderType
      required:
        - type
        - phoneNumbers
      type: object
    combinedSearchAndOrderType:
      title: Combined Search And Order Type
      properties:
        areaCode:
          type: string
        city:
          type: string
        countryCodeA3:
          type: string
        enableLCA:
          type: boolean
        endsIn:
          nullable: true
          type: boolean
        lata:
          type: string
        localVanity:
          type: string
        npaNxx:
          type: string
        npaNxxX:
          type: string
        quantity:
          format: int32
          type: integer
        rateCenter:
          type: string
        state:
          type: string
        type:
          type: string
          enum:
            - combinedSearchAndOrderType
        zip:
          type: string
      required:
        - type
        - quantity
      type: object
    createNewPhoneNumberOrder201ResponseSchemaJson:
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/newPhoneNumberOrderResponse'
            - properties:
                orderStatus:
                  $ref: '#/components/schemas/visibleOrderStatusJson'
              type: object
          type: object
    createNewPhoneNumberOrder400ResponseSchemaJson:
      allOf:
        - $ref: '#/components/schemas/createNewPhoneNumberOrder201ResponseSchemaJson'
        - properties:
            errors:
              items:
                $ref: '#/components/schemas/irisStatusJson'
              type: array
          type: object
    tnOrderCreatedResponse:
      properties:
        OrderResponse:
          oneOf:
            - $ref: '#/components/schemas/existingTelephoneNumberOrderResponse'
            - $ref: '#/components/schemas/rateCenterSearchAndOrderResponse'
            - $ref: '#/components/schemas/areaCodeSearchAndOrderResponse'
            - $ref: '#/components/schemas/npaNxxSearchAndOrderResponse'
            - $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderResponse'
            - $ref: '#/components/schemas/tollFreeVanitySearchAndOrderResponse'
            - $ref: '#/components/schemas/lataSearchAndOrderResponse'
            - $ref: '#/components/schemas/zipSearchAndOrderResponse'
            - $ref: '#/components/schemas/citySearchAndOrderResponse'
            - $ref: '#/components/schemas/stateSearchAndOrderResponse'
            - $ref: '#/components/schemas/combinedSearchAndOrderResponse'
          xml:
            name: OrderResponse
      type: object
    tnOrderBadResponse:
      properties:
        ErrorList:
          items:
            properties:
              Error:
                properties:
                  Code:
                    type: integer
                  Description:
                    type: string
                type: object
          type: array
        OrderResponse:
          oneOf:
            - $ref: '#/components/schemas/existingTelephoneNumberOrder'
            - $ref: '#/components/schemas/rateCenterSearchAndOrderNanp'
            - $ref: '#/components/schemas/areaCodeSearchAndOrderNanp'
            - $ref: '#/components/schemas/npaNxxSearchAndOrderNanp'
            - $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderNanp'
            - $ref: '#/components/schemas/tollFreeVanitySearchAndOrderNanp'
            - $ref: '#/components/schemas/lataSearchAndOrderNanp'
            - $ref: '#/components/schemas/zipSearchAndOrderNanp'
            - $ref: '#/components/schemas/citySearchAndOrderNanp'
            - $ref: '#/components/schemas/stateSearchAndOrderNanp'
            - $ref: '#/components/schemas/combinedSearchAndOrderNanp'
          xml:
            name: OrderResponse
      type: object
    existingTelephoneNumberOrderResponse:
      title: Existing Telephone Number Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                ExistingTelephoneNumberOrderType:
                  $ref: '#/components/schemas/existingTelephoneNumberOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    rateCenterSearchAndOrderResponse:
      title: Rate Center Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                RateCenterSearchAndOrderType:
                  $ref: '#/components/schemas/rateCenterSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    orderResponseMetadata:
      allOf:
        - $ref: '#/components/schemas/orderMetadataResponse'
        - properties:
            id:
              example: c1b34921-ed73-4732-8a08-168e815514ec
              type: string
            orderCreateDate:
              example: '2022-11-14T18:39:04.505Z'
              type: string
              xml:
                name: OrderCreateDate
          type: object
    areaCodeSearchAndOrderResponse:
      title: Area Code Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                AreaCodeSearchAndOrderType:
                  $ref: '#/components/schemas/areaCodeSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    npaNxxSearchAndOrderResponse:
      title: NPA NXX Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                NPANXXSearchAndOrderType:
                  $ref: '#/components/schemas/npaNxxSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    tollFreeWildCharSearchAndOrderResponse:
      title: Toll Free Wild Char Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                TollFreeWildCharSearchAndOrderType:
                  $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    tollFreeVanitySearchAndOrderResponse:
      title: Toll Free Vanity Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                TollFreeVanitySearchAndOrderType:
                  $ref: '#/components/schemas/tollFreeVanitySearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    lataSearchAndOrderResponse:
      title: LATA Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                LATASearchAndOrderType:
                  $ref: '#/components/schemas/lataSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    zipSearchAndOrderResponse:
      title: ZIP Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                ZIPSearchAndOrderType:
                  $ref: '#/components/schemas/zipSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    citySearchAndOrderResponse:
      title: City Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                CitySearchAndOrderType:
                  $ref: '#/components/schemas/citySearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    stateSearchAndOrderResponse:
      title: State Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                StateSearchAndOrderType:
                  $ref: '#/components/schemas/stateSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    combinedSearchAndOrderResponse:
      title: Combined Search And Order Response
      properties:
        Order:
          allOf:
            - $ref: '#/components/schemas/orderResponseMetadata'
            - properties:
                CombinedSearchAndOrderType:
                  $ref: '#/components/schemas/combinedSearchAndOrderTypeXml'
              type: object
          type: object
          xml:
            name: Order
        OrderStatus:
          $ref: '#/components/schemas/orderStatus'
      type: object
      xml:
        name: OrderResponse
    updateNewPhoneNumberOrderJson:
      properties:
        closeOrder:
          description: Request that the order be closed (cancel backorder process).
          type: boolean
        customerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\ ]{1,255}$
          type: string
        name:
          type: string
      type: object
    orderUpdate:
      properties:
        Order:
          properties:
            CloseOrder:
              type: boolean
            CustomerOrderId:
              type: string
            Name:
              type: string
          type: object
      type: object
    retrieveNewPhoneNumberOrder200ResponseSchemaJson:
      properties:
        completedPhoneNumbers:
          items:
            type: string
          type: array
        completedQuantity:
          type: integer
        createdByUser:
          type: string
        failedPhoneNumbers:
          items:
            type: string
          type: array
        failedQuantity:
          type: integer
        lastModifiedDate:
          type: string
        orderCompleteDate:
          type: string
        orderStatus:
          $ref: '#/components/schemas/visibleOrderStatusJson'
        voiceIntegrationIds:
          $ref: '#/components/schemas/voiceIntegrationIdsJson'
        bulkNumberSyncId:
          $ref: '#/components/schemas/bulkNumberSyncId'
        serviceActivationOrderStatus:
          $ref: '#/components/schemas/serviceActivationOrderStatusEnum'
        orderType:
          discriminator:
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/existingPhoneNumberOrderType'
            - $ref: '#/components/schemas/rateCenterSearchAndOrderType'
            - $ref: '#/components/schemas/areaCodeSearchAndOrderType'
            - $ref: '#/components/schemas/npaNxxSearchAndOrderType'
            - $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderType'
            - $ref: '#/components/schemas/tollFreeVanitySearchAndOrderType'
            - $ref: '#/components/schemas/lataSearchAndOrderType'
            - $ref: '#/components/schemas/zipSearchAndOrderType'
            - $ref: '#/components/schemas/citySearchAndOrderType'
            - $ref: '#/components/schemas/stateSearchAndOrderType'
            - $ref: '#/components/schemas/combinedSearchAndOrderType'
        pendingQuantity:
          type: integer
        serviceActivationOrderId:
          type: string
        summary:
          type: string
        tags:
          $ref: '#/components/schemas/phoneNumberTags'
      type: object
    tnOrderUpdatedResponse:
      properties:
        OrderResponse:
          properties:
            CompletedNumbers:
              items:
                properties:
                  TelephoneNumber:
                    properties:
                      FullNumber:
                        type: string
                    type: object
                type: object
              type: array
            CompletedQuantity:
              type: integer
            CreatedByUser:
              type: string
            FailedQuantity:
              type: integer
            LastModifiedDate:
              type: string
            Order:
              oneOf:
                - $ref: '#/components/schemas/existingTelephoneNumberOrder'
                - $ref: '#/components/schemas/rateCenterSearchAndOrderNanp'
                - $ref: '#/components/schemas/areaCodeSearchAndOrderNanp'
                - $ref: '#/components/schemas/npaNxxSearchAndOrderNanp'
                - $ref: '#/components/schemas/tollFreeWildCharSearchAndOrderNanp'
                - $ref: '#/components/schemas/tollFreeVanitySearchAndOrderNanp'
                - $ref: '#/components/schemas/lataSearchAndOrderNanp'
                - $ref: '#/components/schemas/zipSearchAndOrderNanp'
                - $ref: '#/components/schemas/citySearchAndOrderNanp'
                - $ref: '#/components/schemas/stateSearchAndOrderNanp'
                - $ref: '#/components/schemas/combinedSearchAndOrderNanp'
            OrderCompleteDate:
              type: string
            OrderStatus:
              type: string
            VoiceIntegrationIds:
              $ref: '#/components/schemas/voiceIntegrationIds'
            BulkNumberSyncId:
              $ref: '#/components/schemas/bulkNumberSyncId'
            ServiceActivationOrderId:
              type: string
          type: object
      type: object
    rateCenterSearchAndOrderType:
      title: Rate Center Search And Order Type
      properties:
        enableLCA:
          type: boolean
        quantity:
          format: int32
          type: integer
        rateCenter:
          type: string
        state:
          type: string
        type:
          type: string
      type: object
    areaCodeSearchAndOrderType:
      title: Area Code Search And Order Type
      properties:
        areaCode:
          type: string
        quantity:
          format: int32
          type: integer
        type:
          type: string
      type: object
    npaNxxSearchAndOrderType:
      title: NPA NXX Search And Order Type
      properties:
        enableLCA:
          type: boolean
        npaNxx:
          type: string
        quantity:
          format: int32
          type: integer
        type:
          type: string
      type: object
    tollFreeWildCharSearchAndOrderType:
      title: Toll Free Wild Char Search And Order Type
      properties:
        quantity:
          format: int32
          type: integer
        tollFreeWildCardPattern:
          type: string
        type:
          type: string
      type: object
    tollFreeVanitySearchAndOrderType:
      title: Toll Free Vanity Search And Order Type
      properties:
        quantity:
          format: int32
          type: integer
        tollFreeVanity:
          type: string
        type:
          type: string
      type: object
    lataSearchAndOrderType:
      title: LATA Search And Order Type
      properties:
        lata:
          type: string
        quantity:
          format: int32
          type: integer
        type:
          type: string
      type: object
    zipSearchAndOrderType:
      title: ZIP Search And Order Type
      properties:
        quantity:
          format: int32
          type: integer
        type:
          type: string
        zip:
          type: string
      type: object
    citySearchAndOrderType:
      title: City Search And Order Type
      properties:
        city:
          type: string
        quantity:
          format: int32
          type: integer
        state:
          type: string
        type:
          type: string
      type: object
    stateSearchAndOrderType:
      title: State Search And Order Type
      properties:
        quantity:
          format: int32
          type: integer
        state:
          type: string
        type:
          type: string
      type: object
    updateNewPhoneNumberOrder404ResponseSchemaJson:
      properties:
        errors:
          items:
            properties:
              code:
                type: integer
              description:
                type: string
            type: object
          type: array
        orderStatus:
          $ref: '#/components/schemas/visibleOrderStatusJson'
    updateNewPhoneNumberOrder404ResponseSchemaXml:
      properties:
        OrderResponse:
          properties:
            ErrorList:
              properties:
                Error:
                  properties:
                    Code:
                      type: integer
                    Description:
                      type: string
                  type: object
              type: object
          type: object
      type: object
    telephoneDetailsAreaCodes:
      properties:
        TelephoneDetailsReports:
          properties:
            TelephoneDetailsReport:
              properties:
                AreaCode:
                  type: string
                Count:
                  type: integer
              type: object
          type: object
      type: object
    orderHistoryWrapper:
      properties:
        OrderHistoryWrapper:
          properties:
            OrderHistory:
              $ref: '#/components/schemas/orderHistory'
          type: object
      type: object
    orderHistoryResponseJson:
      properties:
        orderHistory:
          items:
            $ref: '#/components/schemas/orderHistoryJson'
          type: array
      type: object
    orderHistory:
      properties:
        Author:
          description: >-
            This is the user that initiated the event that caused the order
            history to be updated.
          type: string
        Difference:
          description: SUPP changes difference.
          type: string
        Note:
          description: This is the order note that accompanied the order history entry.
          type: string
        OrderDate:
          format: YYYY-MM-DDTHH:mm:ss.SSSZ
          description: This is the date/time when the order history entry was created.
          type: string
        Status:
          description: >-
            This is the state that the order was in when the order history event
            occurred.
          type: string
          enum:
            - RECEIVED
            - COMPLETE
            - PARTIAL
            - FAILED
            - BACKORDERED
            - PROCESSING
      type: object
    orderHistoryJson:
      properties:
        author:
          description: >-
            This is the user that initiated the event that caused the order
            history to be updated.
          type: string
        difference:
          description: SUPP changes difference.
          type: string
        note:
          description: This is the order note that accompanied the order history entry.
          type: string
        orderDate:
          format: YYYY-MM-DDTHH:mm:ss.SSSZ
          description: This is the date/time when the order history entry was created.
          type: string
        status:
          description: >-
            This is the state that the order was in when the order history event
            occurred.
          type: string
          enum:
            - RECEIVED
            - COMPLETE
            - PARTIAL
            - FAILED
            - BACKORDERED
            - PROCESSING
      type: object
    errorResponse:
      properties:
        ErrorResponse:
          $ref: '#/components/schemas/responseStatus'
      type: object
    errorResponseNoCode:
      properties:
        ErrorResponse:
          $ref: '#/components/schemas/responseStatusNoCode'
      type: object
    responseStatus:
      properties:
        Description:
          description: Detailed explanation about error
          type: string
        ErrorCode:
          description: Numeric designation of corresponding error
          type: integer
      type: object
    responseStatusNoCode:
      properties:
        Description:
          description: Detailed explanation about error
          type: string
      type: object
    orderNotesResponse:
      properties:
        Notes:
          items:
            properties:
              Description:
                type: string
              Id:
                type: integer
              LastDateModifier:
                format: date-time
                type: string
              UserId:
                type: string
            title: Note
            type: object
          type: array
      type: object
    noteErrorResponse:
      properties:
        NoteResponse:
          $ref: '#/components/schemas/responseStatus'
      type: object
    notes:
      properties:
        Notes:
          items:
            $ref: '#/components/schemas/note'
          type: array
      type: object
    notesResponse:
      properties:
        Notes:
          items:
            $ref: '#/components/schemas/note'
          type: array
      type: object
    telephoneDetailsNpaNxx:
      properties:
        TelephoneDetailsReports:
          properties:
            TelephoneDetailsReport:
              properties:
                Count:
                  type: integer
                NPA-NXX:
                  type: string
              type: object
          type: object
      type: object
    telephoneDetailsTotals:
      properties:
        TelephoneDetailsReports:
          properties:
            TelephoneDetailsReport:
              properties:
                Count:
                  type: integer
              type: object
          type: object
      type: object
    orderPhoneNumberGetResponseJson:
      properties:
        count:
          description: Number of phone numbers found on the given order
          type: integer
        phoneNumbers:
          description: List of phone numbers found on the given order
          type: array
          items:
            type: string
    orderTelephoneNumbersResponse:
      properties:
        TelephoneNumbers:
          properties:
            Count:
              type: integer
            TelephoneNumber:
              type: string
          type: object
      type: object
    responseStatusJson:
      properties:
        description:
          description: Detailed explanation about error
          type: string
        errorCode:
          description: Numeric designation of corresponding error
          type: integer
    responseStatusJsonNoCode:
      properties:
        description:
          description: Detailed explanation about error
          type: string
    orderStatus:
      example: RECEIVED
      type: string
      xml:
        name: OrderStatus
    ReservationIdList:
      items:
        type: string
        xml:
          name: ReservationId
      type: array
    TelephoneNumberList:
      items:
        type: string
        xml:
          name: TelephoneNumber
      type: array
    cityResponseJson:
      type: object
      properties:
        resultCount:
          type: integer
          format: int32
        cities:
          type: array
          items:
            $ref: '#/components/schemas/cityJson'
    cityJson:
      type: object
      properties:
        name:
          type: string
        rcAbbreviation:
          type: string
        availablePhoneNumberCount:
          type: integer
          format: int32
    citySearchResults:
      type: object
      properties:
        CityResponse:
          type: object
          properties:
            Cities:
              type: array
              items:
                $ref: '#/components/schemas/citySearchResult'
            ResultCount:
              type: integer
              format: int32
    citySearchResult:
      title: City
      type: object
      properties:
        Name:
          type: string
        RcAbbreviation:
          type: string
        AvailableTelephoneNumberCount:
          type: integer
          format: int32
    cityErrorResponseXml:
      type: object
      properties:
        CityResponse:
          type: object
          properties:
            Error:
              type: object
              properties:
                Code:
                  type: integer
                Description:
                  type: string
            ResultCount:
              type: integer
    rateCenterResponseJson:
      type: object
      properties:
        resultCount:
          type: integer
          format: int32
        rateCenters:
          type: array
          items:
            $ref: '#/components/schemas/rateCenterJson'
    rateCenterJson:
      type: object
      properties:
        name:
          type: string
        abbreviation:
          type: string
        availablePhoneNumberCount:
          type: integer
          format: int32
    rateCenterSearchResults:
      type: object
      properties:
        RateCenterResponse:
          type: object
          properties:
            RateCenters:
              type: array
              items:
                $ref: '#/components/schemas/rateCenterSearchResult'
            ResultCount:
              type: integer
              format: int32
    rateCenterSearchResult:
      title: RateCenter
      type: object
      properties:
        Name:
          type: string
        Abbreviation:
          type: string
        AvailableTelephoneNumberCount:
          type: integer
          format: int32
    rateCenterErrorResponseXml:
      type: object
      properties:
        RateCenterResponse:
          type: object
          properties:
            Error:
              type: object
              properties:
                Code:
                  type: integer
                Description:
                  type: string
            ResultCount:
              type: integer
    coveredRateCenterSearchResponseJson:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        coveredRateCenters:
          type: array
          items:
            $ref: '#/components/schemas/coveredRateCenterJson'
        links:
          $ref: '#/components/schemas/paginationLinksJson'
    coveredRateCenterJson:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        abbreviation:
          type: string
        state:
          type: string
        lata:
          type: integer
          format: int32
        availableNumberCount:
          type: integer
          format: int32
        limitedAvailableNumberCount:
          type: integer
          format: int32
        zipCodes:
          uniqueItems: true
          type: array
          items:
            type: string
        cities:
          uniqueItems: true
          type: array
          items:
            type: string
        tiers:
          uniqueItems: true
          type: array
          items:
            type: string
        npaNxxXs:
          uniqueItems: true
          type: array
          items:
            type: string
        npas:
          uniqueItems: true
          type: array
          items:
            type: string
        localRateCenterIds:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
    paginationLinksJson:
      type: object
      properties:
        first:
          type: string
        next:
          type: string
    coveredRateCenterSearchResponse:
      type: object
      properties:
        CoveredRateCenters:
          type: object
          properties:
            Links:
              $ref: '#/components/schemas/paginationLinks'
            TotalCount:
              type: integer
              format: int32
            CoveredRateCenter:
              type: array
              items:
                $ref: '#/components/schemas/coveredRateCenter'
    coveredRateCenter:
      type: object
      properties:
        Id:
          type: integer
          format: int32
        Name:
          type: string
        Abbreviation:
          type: string
        State:
          type: string
        Lata:
          type: integer
          format: int32
        AvailableNumberCount:
          type: integer
          format: int32
        LimitedAvailableNumberCount:
          type: integer
          format: int32
        ZipCodes:
          uniqueItems: true
          type: array
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: ZipCode
        Cities:
          uniqueItems: true
          type: array
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: City
        Tiers:
          uniqueItems: true
          type: array
          xml:
            wrapped: true
          items:
            type: string
            format: byte
            xml:
              name: Tier
        NpaNxxXs:
          uniqueItems: true
          type: array
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: NpaNxxX
        Npas:
          uniqueItems: true
          type: array
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: Npa
        LocalRateCenterIds:
          uniqueItems: true
          type: array
          xml:
            name: LocalRateCenters
            wrapped: true
          items:
            type: integer
            format: int32
            xml:
              name: RateCenterId
      xml:
        name: CoveredRateCenter
    paginationLinks:
      type: object
      title: Links
      properties:
        First:
          type: string
        Next:
          type: string
    coveredRateCenterSearchErrorResponse:
      type: object
      properties:
        CoveredRateCenters:
          $ref: '#/components/schemas/responseStatus'
    coveredRateCenterResponse:
      type: object
      properties:
        CoveredRateCenter:
          $ref: '#/components/schemas/coveredRateCenter'
    coveredRateCenterErrorResponseJson:
      type: object
      properties:
        description:
          type: string
    coveredRateCenterErrorResponseXml:
      type: object
      properties:
        CoveredRateCenters:
          type: object
          properties:
            ResponseStatus:
              type: object
              properties:
                Description:
                  type: string
    availableNpaNxxSearchResponseJson:
      type: object
      properties:
        availableNpaNxx:
          type: array
          items:
            $ref: '#/components/schemas/availableNpaNxxJson'
    availableNpaNxxJson:
      type: object
      properties:
        city:
          type: string
        npa:
          type: string
        nxx:
          type: string
        quantity:
          type: integer
          format: int32
        state:
          type: string
    searchResultForAvailableNpaNxxWrapper:
      type: object
      properties:
        SearchResultForAvailableNpaNxx:
          $ref: '#/components/schemas/searchResultForAvailableNpaNxx'
    searchResultForAvailableNpaNxx:
      type: object
      properties:
        AvailableNpaNxxList:
          type: array
          items:
            $ref: '#/components/schemas/availableNpaNxx'
    availableNpaNxx:
      type: object
      properties:
        Npa:
          type: string
        Nxx:
          type: string
        Quantity:
          type: integer
          format: int32
        City:
          type: string
        State:
          type: string
    searchResultForAvailableNpaNxxErrorWrapper:
      type: object
      properties:
        SearchResultForAvailableNpaNxx:
          $ref: '#/components/schemas/searchResultErrorResponseXml'
    searchResultErrorResponseXml:
      type: object
      properties:
        Error:
          type: object
          properties:
            Code:
              type: integer
            Description:
              type: string
    importToAccountNumberOrderType:
      type: object
      required:
        - TelephoneNumberList
        - BillingType
        - VendorName
      properties:
        TelephoneNumberList:
          $ref: '#/components/schemas/telephoneNumberList'
        BatchId:
          $ref: '#/components/schemas/batchId'
        BatchSize:
          $ref: '#/components/schemas/batchSize'
        Origin:
          $ref: '#/components/schemas/origin'
        VendorName:
          $ref: '#/components/schemas/vendorName'
        PhoneNumberInventoryGroupId:
          $ref: '#/components/schemas/phoneNumberInventoryGroupId'
        BillingType:
          $ref: '#/components/schemas/billingType'
        TnAttributes:
          $ref: '#/components/schemas/tnAttributes'
        InitialStatus:
          $ref: '#/components/schemas/initialStatus'
    telephoneNumberList:
      description: List of telephone numbers to be imported.
      type: array
      minItems: 1
      items:
        type: object
        properties:
          TelephoneNumber:
            description: Phone number in E.164 format.
            type: string
    importedTelephoneNumberList:
      description: List of telephone numbers that were imported.
      type: array
      minItems: 1
      items:
        type: object
        properties:
          TelephoneNumber:
            description: Phone number in E.164 format.
            type: string
    importedTelephoneNumberDetailList:
      description: List of telephone number details that were imported.
      type: array
      minItems: 1
      items:
        type: object
        properties:
          TelephoneNumberDetail:
            type: object
            properties:
              FullNumber:
                description: Phone number in E.164 format.
                type: string
    importToAccountNumberOrderResponseForGet:
      title: ImportToAccountNumberOrderResponse
      properties:
        ImportToAccountNumberOrderResponse:
          type: object
          properties:
            ImportedTelephoneNumberList:
              $ref: '#/components/schemas/importedTelephoneNumberList'
            OrderRequest:
              $ref: '#/components/schemas/importToAccountOrderResponseOrderRequest'
            OrderStatus:
              $ref: '#/components/schemas/importToAccountOrderStatus'
            ImportedTelephoneNumberDetailList:
              $ref: '#/components/schemas/importedTelephoneNumberDetailList'
            ErrorList:
              type: array
              items:
                $ref: '#/components/schemas/error'
    importToAccountOrderResponseOrderRequest:
      title: OrderRequest
      properties:
        id:
          description: Assigned order ID.
          type: string
          format: uuid
        ImportToAccountNumberOrderType:
          $ref: '#/components/schemas/importToAccountNumberOrderType'
        SiteId:
          description: The site ID to which the telephone numbers will be imported.
          type: integer
        PeerId:
          description: >-
            The SIP peer ID of the provided site to which the telephone numbers
            will be imported.
          type: integer
        VoiceConfigurationPackageId:
          $ref: '#/components/schemas/voiceConfigurationPackageId'
        RequirementsPackageId:
          $ref: '#/components/schemas/requirementsPackageId'
        AutoActivate:
          description: >-
            Indicates whether the service should be activated upon completion of
            the order. If not specified, the default value is true.
          type: boolean
        OrderCreatedDate:
          $ref: '#/components/schemas/orderCreatedDate'
        OverrideFeatureRestrictions:
          description: Used to override the account's purchase restrictions.
          type: boolean
        ImportExternalTnsAsShared:
          $ref: '#/components/schemas/importExternalTnsAsShared'
    listImportToAccountOrders400ResponseSchema:
      type: object
      properties:
        ResponseSelectWrapper:
          type: object
          properties:
            ListOrderIdUserIdDate:
              type: object
              properties:
                ErrorMessage:
                  type: string
    responseSelectWrapper:
      type: object
      properties:
        ResponseSelectWrapper:
          type: object
          properties:
            ListOrderIdUserIdDate:
              type: object
              properties:
                TotalCount:
                  type: integer
                Links:
                  $ref: '#/components/schemas/links'
                OrderIdUserIdDate:
                  type: array
                  items:
                    $ref: '#/components/schemas/orderIdUserIdDate'
    orderIdUserIdDate:
      type: object
      properties:
        CountOfTNs:
          type: integer
        userId:
          type: string
        lastModifiedDate:
          type: string
        orderId:
          type: string
        OrderType:
          type: string
        OrderDate:
          type: string
        OrderStatus:
          $ref: '#/components/schemas/importToAccountOrderStatus'
        TelephoneNumberDetails:
          $ref: '#/components/schemas/telephoneNumberDetails'
    batches:
      type: object
      properties:
        Batches:
          type: object
          properties:
            Batch:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/batch'
    batch:
      type: object
      properties:
        BatchId:
          type: string
        OrderId:
          $ref: '#/components/schemas/orderId'
        OrderCreateDate:
          $ref: '#/components/schemas/orderCreatedDate'
        OrderStatus:
          type: string
        SubmittedTnCount:
          type: integer
        SuccessfulTnCount:
          type: integer
        BatchSize:
          type: integer
    batchId:
      description: >-
        A user-chosen ID for the batch of phone numbers. This batch ID can span
        multiple number submissions. Up to 10 alphanumeric characters. If the
        submission is not intended to be grouped into a batch of submissions
        then the batch ID must be globally unique. It is recommended that the
        batch IDs be globally unique, and that imports not be grouped together
        in batches by use of a common batch ID.
      type: string
    batchSize:
      description: >-
        The number of TNs in the batch, aggregated across all of the orders in
        the batch. This total spans API calls, so if 3 calls are necessary to
        import 15000 numbers, this value would be 15000. It is recommended to
        use a batch size equal to the number of telephone numbers in the API
        call, and use a different batch name for each API call - essentially
        limiting a batch to a single API call.
      type: integer
    origin:
      description: >-
        The origin type of numbers, defaulting to 'UNDEFINED' if not ported into
        IRIS.
      type: string
      enum:
        - UNDEFINED
        - PORTED_IN
    vendorName:
      description: >-
        The vendor that owns the number that is being ported in. If the number
        is manually ported to a partner's network then this would reflect that
        partner.
      type: string
    phoneNumberInventoryGroupId:
      description: >-
        Relevant for international numbers only. The PhoneNumberInventoryGroupId
        denotes a specific category for an international phone number to belong
        to. An international number requires a PhoneNumberInventoryGroup
        similarly to how a NANP number requires a valid rate center association.
      type: integer
    billingType:
      description: Type of billing rules to be applied.
      type: string
      enum:
        - NOCHARGE
        - PORTIN
        - NEWNUMBER
        - PROJECTPORT
    tnAttributes:
      description: List of phone number attributes to be assigned.
      type: object
      properties:
        TnAttribute:
          type: string
          enum:
            - Protected
    initialStatus:
      description: >-
        TN status to be assigned to imported telephone numbers. Requires the
        "Protected" TnAttribute.
      type: string
      enum:
        - Available
    orderId:
      description: The identifier that uniquely identifies an order.
      type: string
      maxLength: 255
    orderCreatedDate:
      description: Creation date of the order.
      type: string
    error:
      title: Error
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular instance of this problem.
          example: optional-error-id
        type:
          $ref: '#/components/schemas/errorType'
        description:
          $ref: '#/components/schemas/errorDescription'
        code:
          $ref: '#/components/schemas/errorCode'
        meta:
          type: object
          description: >-
            A meta object containing application-specific information or
            non-standard metadata about the error.
        source:
          $ref: '#/components/schemas/errorSource'
      required:
        - code
        - description
    errorCode:
      type: integer
      format: int32
      description: >-
        An application-specific error code for services with extensive error
        scenarios to supplement `description`.
      minimum: 4
      example: 51130
    errorDescription:
      type: string
      description: >-
        A human-readable explanation that SHOULD be specific to this occurrence
        of the problem.
      example: There was an issue with a field in your request body
    errorType:
      type: string
      description: >-
        A short, human-readable summary of the problem that SHOULD NOT change
        from occurrence to occurrence of the problem.
      example: REQUEST_ERROR
    errorSource:
      title: Error Source
      type: object
      properties:
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error.
          example: someParameter
        field:
          type: string
          description: A string indicating which request body field caused the error.
          example: someField
        header:
          type: string
          description: A string indicating which header field caused the error.
    importExternalTnsAsShared:
      description: >-
        If set to true, the order will import any external numbers as shared
        numbers, adding voice service to the destination account without
        affecting existing messaging configuration or provisioning. If the
        numbers are being imported to the same account as their existing
        messaging service, they must be imported to the same SIP peer where
        messaging is already active. If omitted or set to false, the order will
        reject importing any external numbers.
      type: boolean
      default: false
    importToAccountErrorResponse:
      type: object
      properties:
        ErrorResponse:
          type: object
          properties:
            irisStatus:
              type: object
              properties:
                Code:
                  type: integer
                Description:
                  type: string
    importToAccountOrderStatus:
      description: The status of an Import to Account order.
      type: string
      enum:
        - RECEIVED
        - COMPLETE
        - PARTIAL
        - FAILED
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      description: >-
        Basic authentication is a simple authentication scheme built into the
        HTTP protocol. To use it, send your HTTP requests with an Authorization
        header that contains the word Basic followed by a space and a
        base64-encoded string `username:password`.

        Example: `Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer authentication (also called token authentication) is an HTTP
        authentication scheme that involves security 

        tokens called bearer tokens. The name “Bearer authentication” can be
        understood as “give access to the bearer

        of this token.” The client must send this token in the `Authorization`
        header when making requests to

        protected resources.


        - Example: `Authorization: Bearer <token>`


        Where `<token>` should be replaced with the token string without angle
        brackets.


        For more information, see the following guide:
        [Credentials](https://dev.bandwidth.com/docs/credentials)
tags:
  - name: New Number Orders
    description: >-
      <p>The Number Order API ("Orders") lets users procure phone numbers and
      add them to their Bandwidth account. Number Orders are asynchronous: when
      users submit a POST request, they receive an OrderId that they can poll or
      subscribe to updates for until the order reaches a final state.

      Users can procure numbers in several ways with the Number Order API:</p>

      <ul>
        <li>Search and Order: Provide search criteria and purchase numbers that match.</li>
        <li>Existing Number Order: Provide a list of specific numbers, and if they're still available, they'll be added to the account.</li>
        <li>Backordering: If numbers matching the specified criteria aren't currently available, they can be placed in backorder and Bandwidth will fulfill it automatically once they become available. Users can also use the Order Notification Webhook to receive callbacks or email notifications as the order progresses.</li>
      </ul>

      Related resources:<br/>

      <a
      href="https://dev.bandwidth.com/docs/numbers/guides/searchingForNumbers">Guide
      to Searching and Ordering Numbers</a><br/>

      <a
      href="https://dev.bandwidth.com/docs/numbers/webhooks/orderWebhook">Order
      Notification Webhook</a>

      </p>
  - name: Coverage
    description: >-
      These APIs provide information related to Bandwidth's geographic coverage
      and phone number types supported, as well as the availability of phone
      number inventory.
  - name: Import to Account Orders
    description: >-
      The Import to Account Order API allows users to import previously ported
      or otherwise acquired telephone numbers into their Bandwidth account.
      Import orders can be submitted individually or as part of a batch for
      large-scale imports. Users can track order status, view order history, and
      manage batches of import orders.
