openapi: 3.2.0
info:
  title: Teliax Managed Port Processing API
  version: v1
  contact:
    name: Ringer API Support
    url: https://ringer.tel
    email: api-support@ringer.tel
  description: 'Operations tagged Managed Port Processing 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: Managed Port Processing
  description: Customer-safe TNIQ-managed carrier and NPAC processing
paths:
  /v1/port-projects/projects/{projectId}/managed-processing:
    get:
      tags:
      - Managed Port Processing
      summary: Poll the customer-safe managed-processing state
      operationId: get_1
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ManagedProcessingResponse'
    post:
      tags:
      - Managed Port Processing
      summary: Submit a prepared port project to TNIQ-managed processing
      description: Idempotently starts carrier routing, LSR/CSR handling, and gated NPAC processing.
      operationId: submit
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Idempotency-Key
        in: header
        description: 1-200 printable ASCII characters
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitManagedProcessingRequest'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ManagedProcessingResponse'
    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/port-projects/projects/{projectId}/managed-processing/actions/{actionId}/satisfy:
    post:
      tags:
      - Managed Port Processing
      summary: Satisfy one open managed-processing customer action
      operationId: satisfy
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: actionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SatisfyActionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ManagedProcessingResponse'
    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:
    ManagedProcessingResponse:
      type: object
      properties:
        processId:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
        state:
          type: string
        version:
          type: integer
          format: int64
        customerActions:
          type: array
          items:
            $ref: '#/components/schemas/CustomerActionResponse'
        errorCode:
          type: string
        message:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ActionScope:
      type: object
      properties:
        groupId:
          type: string
          format: uuid
        tns:
          type: array
          items:
            type: string
    SubmitManagedProcessingRequest:
      type: object
      properties:
        desiredDueDate:
          type: string
          format: date
    SatisfyActionRequest:
      required:
      - responseType
      type: object
      properties:
        responseType:
          type: string
        documentId:
          type: string
          format: uuid
        fields:
          type: object
          additionalProperties:
            type: string
        desiredDueDate:
          type: string
          format: date
        acknowledged:
          type: boolean
    CustomerActionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        message:
          type: string
        scope:
          $ref: '#/components/schemas/ActionScope'
        allowedResponse:
          type: string
        requiredDocumentType:
          type: string
        openedAt:
          type: string
          format: date-time
  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