openapi: 3.2.0
info:
  title: Teliax CIC Reference Data API
  version: v1
  contact:
    name: Ringer API Support
    url: https://ringer.tel
    email: api-support@ringer.tel
  description: 'Operations tagged CIC Reference Data across 2 of this provider''s published API definitions: teliax-tniq-openapi.json, teliax-tniq-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.tniq.ringer.tel
  description: Production
- url: https://tniq-api.ringer.tel
  description: Production (legacy alias)
- url: https://staging-api.ringer.tel
  description: Staging
tags:
- name: CIC Reference Data
  description: Authenticated NANPA FGD assignment reference data; not carrier routing configuration
paths:
  /v1/reference-data/cics/resolve:
    post:
      tags:
      - CIC Reference Data
      summary: Resolve up to 100 distinct CICs in one bounded request
      operationId: resolve
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CicResolveRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CicResolveResponse'
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/reference-data/cics:
    get:
      tags:
      - CIC Reference Data
      summary: Search NANPA Feature Group D CIC assignments
      operationId: list_1
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: active
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        required: false
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageCicDirectorySummaryDto'
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/reference-data/cics/{cic}:
    get:
      tags:
      - CIC Reference Data
      summary: Inspect one NANPA Feature Group D CIC assignment
      operationId: detail
      parameters:
      - name: cic
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CicDirectoryDetailDto'
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
components:
  schemas:
    CicResolutionDto:
      type: object
      properties:
        cic:
          type: string
        found:
          type: boolean
        assigneeName:
          type: string
        recordStatus:
          type: string
        retired:
          type: boolean
    SortObject:
      type: object
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    CicResolveRequest:
      required:
      - cics
      type: object
      properties:
        cics:
          maxItems: 500
          minItems: 0
          type: array
          items:
            type: string
    PageCicDirectorySummaryDto:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/CicDirectorySummaryDto'
        number:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
        numberOfElements:
          type: integer
          format: int32
        first:
          type: boolean
        pageable:
          $ref: '#/components/schemas/PageableObject'
        last:
          type: boolean
        empty:
          type: boolean
    CicDatasetFreshnessDto:
      type: object
      properties:
        sourceName:
          type: string
        sourceAsOf:
          type: string
          format: date-time
        retrievedAt:
          type: string
          format: date-time
        freshness:
          type: string
    CicDirectorySummaryDto:
      type: object
      properties:
        cic:
          type: string
        assigneeName:
          type: string
        recordStatus:
          type: string
        assignmentDate:
          type: string
          format: date
        sourceAsOf:
          type: string
          format: date-time
        retired:
          type: boolean
        freshness:
          type: string
    PageableObject:
      type: object
      properties:
        offset:
          type: integer
          format: int64
        sort:
          $ref: '#/components/schemas/SortObject'
        pageSize:
          type: integer
          format: int32
        pageNumber:
          type: integer
          format: int32
        paged:
          type: boolean
        unpaged:
          type: boolean
    CicResolveResponse:
      type: object
      properties:
        results:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CicResolutionDto'
        dataset:
          $ref: '#/components/schemas/CicDatasetFreshnessDto'
    CicDirectoryDetailDto:
      type: object
      properties:
        cic:
          type: string
        featureGroup:
          type: string
        iacCode:
          type: string
        assigneeName:
          type: string
        recordStatus:
          type: string
        assignmentDate:
          type: string
          format: date
        contactName:
          type: string
        contactPhone:
          type: string
        contactEmail:
          type: string
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        sourceAsOf:
          type: string
          format: date-time
        retrievedAt:
          type: string
          format: date-time
        retired:
          type: boolean
        freshness:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Bearer token authentication. Pass your API token or user JWT in the Authorization header: Authorization: Bearer YOUR_TOKEN'
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- teliax-tniq-openapi.json
- teliax-tniq-openapi.yml