Alianza Dynamic Inventory API

openapi: 3.2.0
info:
  title: Alianza Dynamic Inventory API
  version: '2'
  description: 'Operations tagged Dynamic Inventory across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
tags:
- name: Dynamic Inventory
paths:
  /v2/partition/{partitionId}/account/{accountId}/dynamic-inventory/tn-search:
    get:
      tags:
      - Dynamic Inventory
      summary: 'Retrieve telephone number list matching query parameters from carrier''s dynamic inventory '
      description: ''
      operationId: retrieveTnsFromCarriersDynamicInventory
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: npa
        in: query
        description: The three-digit number that identifies the telephone service region
        required: false
        schema:
          type: string
      - name: npa-nxx
        in: query
        description: A six-digit code that is used to identify telephone numbers
        required: false
        schema:
          type: string
      - name: qty
        in: query
        description: Desired quantity of telephone numbers
        required: false
        schema:
          type: integer
          format: int32
      - name: sequential
        in: query
        description: When true to returns sequential numbers
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: DynamicInventoryX
              $ref: '#/components/schemas/DynamicInventoryX_2'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: DynamicInventoryX
                  $ref: '#/components/schemas/DynamicInventoryX_2'
        '400':
          description: Invalid account ID supplied
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: DynamicInventoryX
              $ref: '#/components/schemas/DynamicInventoryX_2'
          schema:
            type: array
            items:
              originalRef: DynamicInventoryX
              $ref: '#/components/schemas/DynamicInventoryX_2'
        '400':
          description: Invalid account ID supplied
  /v2/partition/{partitionId}/account/{accountId}/dynamic-inventory/orders:
    post:
      tags:
      - Dynamic Inventory
      summary: Creates Dynamic inventory orders, those orders eventually will activate telephone numbers received on a request
      description: ''
      operationId: createDynamicInventoryOrders
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: DynamicInventoryOrderX
            $ref: '#/components/schemas/DynamicInventoryOrderX_2'
          content:
            application/json:
              schema:
                originalRef: DynamicInventoryOrderX
                $ref: '#/components/schemas/DynamicInventoryOrderX_2'
        '400':
          description: Invalid carrierId
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: DynamicInventoryOrderX
            $ref: '#/components/schemas/DynamicInventoryOrderX_2'
          schema:
            originalRef: DynamicInventoryOrderX
            $ref: '#/components/schemas/DynamicInventoryOrderX_2'
        '400':
          description: Invalid carrierId
      requestBody:
        content:
          application/json:
            schema:
              originalRef: DynamicTelephoneNumberActivationX
              $ref: '#/components/schemas/DynamicTelephoneNumberActivationX_2'
        description: Dynamic inventory order request object
        required: true
components:
  schemas:
    E911AddressX:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        middleInitial:
          type: string
        lastName:
          type: string
        businessName:
          type: string
        streetNumber:
          type: string
        streetNumberSuffix:
          type: string
        preDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        streetName:
          type: string
        streetSuffix:
          type: string
        postDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        secondaryLocationDescription:
          type: string
          enum:
          - ''
          - APARTMENT
          - BUILDING
          - BASEMENT
          - DEPARTMENT
          - FLOOR
          - FRONT
          - HANGER
          - KEY
          - LOBBY
          - LOT
          - LOWER
          - OFFICE
          - PENTHOUSE
          - PIER
          - REAR
          - ROOM
          - SIDE
          - SLIP
          - SPACE
          - SUITE
          - STOP
          - TRAILER
          - UNIT
          - UPPER
        unit:
          type: string
        customerType:
          type: string
          enum:
          - BUSINESS
          - RESIDENTIAL
        latitude:
          type: string
          description: -90 through 90, 4-6 decimals
        longitude:
          type: string
          description: -180 through 180, 4-6 decimals
        language:
          type: string
          description: Optional, see /v2/ref/language for supported languages
    DynamicInventoryX_2:
      type: object
      properties:
        carrierId:
          type: string
        orderId:
          type: string
        tns:
          type: array
          uniqueItems: true
          items:
            originalRef: DynamicInventoryOrderTelephoneNumberX
            $ref: '#/components/schemas/DynamicInventoryOrderTelephoneNumberX'
        id:
          type: string
    DynamicTelephoneNumberActivationX_2:
      type: object
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        carrierId:
          type: string
        orderId:
          type: string
        tnQuantity:
          type: integer
          format: int32
        deviceId:
          type: string
        userId:
          type: string
        customerServiceRecord:
          originalRef: LatLongCustomerServiceRecordX
          $ref: '#/components/schemas/LatLongCustomerServiceRecordX_2'
        directoryListing:
          originalRef: DirectoryListingX
          $ref: '#/components/schemas/DirectoryListingX_2'
        e911Address:
          originalRef: E911AddressX
          $ref: '#/components/schemas/E911AddressX'
        tnSettings:
          originalRef: TelephoneNumberAccountBareX
          $ref: '#/components/schemas/TelephoneNumberAccountBareX'
        ringType:
          type: string
          enum:
          - StandardRing
          - Ring1
          - Ring2
          - Ring3
          - Ring4
          - Ring5
          - Ring6
          - Ring7
        archived:
          type: boolean
        alianzaOrderId:
          type: string
        id:
          type: string
    DirectoryListingX_2:
      type: object
      properties:
        listed:
          type: boolean
        type:
          type: string
          enum:
          - ERROR
          - LIST_PUBLISH
          - LIST_NOT_PUBLISH
          - NOT_LIST_NOT_PUBLISH
          - PORTED
          - COMPLEX
        address:
          originalRef: AddressX
          $ref: '#/components/schemas/AddressX_2'
    DynamicInventoryOrderTelephoneNumberX:
      type: object
      properties:
        tn:
          type: string
        id:
          type: string
    LatLongCustomerServiceRecordX_2:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        middleInitial:
          type: string
        lastName:
          type: string
        businessName:
          type: string
        streetNumber:
          type: string
        streetNumberSuffix:
          type: string
        preDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        streetName:
          type: string
        streetSuffix:
          type: string
        postDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        secondaryLocationDescription:
          type: string
          enum:
          - ''
          - APARTMENT
          - BUILDING
          - BASEMENT
          - DEPARTMENT
          - FLOOR
          - FRONT
          - HANGER
          - KEY
          - LOBBY
          - LOT
          - LOWER
          - OFFICE
          - PENTHOUSE
          - PIER
          - REAR
          - ROOM
          - SIDE
          - SLIP
          - SPACE
          - SUITE
          - STOP
          - TRAILER
          - UNIT
          - UPPER
        unit:
          type: string
        customerType:
          type: string
          enum:
          - BUSINESS
          - RESIDENTIAL
        firstNameSecondary:
          type: string
        blockCustomerName:
          type: boolean
        customerName:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
    DynamicInventoryOrderX_2:
      type: object
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        customerServiceRecord:
          originalRef: LatLongCustomerServiceRecordX
          $ref: '#/components/schemas/LatLongCustomerServiceRecordX_2'
        directoryListing:
          originalRef: DirectoryListingX
          $ref: '#/components/schemas/DirectoryListingX_2'
        e911Address:
          originalRef: E911AddressX
          $ref: '#/components/schemas/E911AddressX'
        inventory:
          type: array
          uniqueItems: true
          items:
            originalRef: DynamicInventoryX
            $ref: '#/components/schemas/DynamicInventoryX_2'
        id:
          type: string
    TelephoneNumberAccountBareX:
      type: object
      properties:
        phoneNumber:
          type: string
        referenceType:
          type: string
          enum:
          - SIP_TRUNK
          - END_USER
          - IVR
          - LINE_APPEARANCE
          - LINE_HUNTGROUP
          - TELEPHONE
          - VFAX
          - BUSINESS_LINE
          - BUSINESS_LINE_HUNT_GROUP
          - CALL_GROUP
          - CALL_QUEUE
          - AUTO_ATTENDANT
          - SPECIALTY_LINE
          - CONTACT_CENTER
        referenceId:
          type: string
        functionType:
          type: string
          enum:
          - ELS
          - TollFree
          - TemporaryNumber
          - SPTN
        canAcceptSMS:
          type: boolean
        operationalStatus:
          type: string
          enum:
          - ACTIVE
          - STAGED
        portId:
          type: string
        servicePackageType:
          type: string
          enum:
          - Usage
          - PrimaryLocalFlatRate
          - PrimaryLocalAndDomesticLDFlatRate
          - SecondaryLocalFlatRate
          - SecondaryLocalAndDomesticLDFlatRate
        tollFree:
          type: boolean
        id:
          type: string
    AddressX_2:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        middleInitial:
          type: string
        lastName:
          type: string
        businessName:
          type: string
        streetNumber:
          type: string
        streetNumberSuffix:
          type: string
        preDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        streetName:
          type: string
        streetSuffix:
          type: string
        postDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        secondaryLocationDescription:
          type: string
          enum:
          - ''
          - APARTMENT
          - BUILDING
          - BASEMENT
          - DEPARTMENT
          - FLOOR
          - FRONT
          - HANGER
          - KEY
          - LOBBY
          - LOT
          - LOWER
          - OFFICE
          - PENTHOUSE
          - PIER
          - REAR
          - ROOM
          - SIDE
          - SLIP
          - SPACE
          - SUITE
          - STOP
          - TRAILER
          - UNIT
          - UPPER
        unit:
          type: string
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-apidocs-swagger2-original.json
- alianza-openapi-original.yml