naftiko: 1.0.0-alpha2
info:
  label: Regal Branded Phone Numbers
  description: Regal Branded Phone Numbers API — register, update, and remove branded caller ID and spam remediation entries on a per-carrier basis.
  tags:
    - Regal
    - Branded Caller ID
    - Phone Numbers
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      REGAL_API_KEY: REGAL_API_KEY
capability:
  consumes:
    - type: http
      namespace: branded-phone-numbers
      baseUri: https://api.regal.ai/v1
      description: Regal Branded Phone Numbers capability.
      resources:
        - name: brandedPhoneNumbers
          path: /brandedPhoneNumbers
          operations:
            - name: postbrandedphonenumber
              method: POST
              description: Register a new branded phone number with one or more carriers.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
        - name: brandedPhoneNumber
          path: /brandedPhoneNumbers/{phoneNumber}
          operations:
            - name: patchbrandedphonenumber
              method: PATCH
              description: Partially update a branded phone number registration.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: phoneNumber
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
            - name: deletebrandedphonenumber
              method: DELETE
              description: Delete a branded phone number registration after carrier opt-outs complete.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: phoneNumber
                  in: path
                  type: string
                  required: true
      authentication:
        type: apikey
        key: Authorization
        value: '{{env.REGAL_API_KEY}}'
        placement: header
  exposes:
    - type: rest
      namespace: branded-phone-numbers-rest
      port: 8080
      description: REST adapter for Branded Phone Numbers.
      resources:
        - path: /v1/brandedPhoneNumbers
          name: brandedPhoneNumbers
          operations:
            - method: POST
              name: postbrandedphonenumber
              description: Register a new branded phone number.
              call: branded-phone-numbers.postbrandedphonenumber
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/brandedPhoneNumbers/{phoneNumber}
          name: brandedPhoneNumber
          operations:
            - method: PATCH
              name: patchbrandedphonenumber
              description: Partially update a branded phone number.
              call: branded-phone-numbers.patchbrandedphonenumber
              with:
                phoneNumber: rest.path.phoneNumber
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
            - method: DELETE
              name: deletebrandedphonenumber
              description: Delete a branded phone number registration.
              call: branded-phone-numbers.deletebrandedphonenumber
              with:
                phoneNumber: rest.path.phoneNumber
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: branded-phone-numbers-mcp
      port: 9090
      transport: http
      description: MCP adapter for Branded Phone Numbers.
      tools:
        - name: regal-register-branded-phone-number
          description: Register a new branded phone number with one or more carriers.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: branded-phone-numbers.postbrandedphonenumber
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: regal-update-branded-phone-number
          description: Partially update an existing branded phone number registration.
          hints:
            readOnly: false
            destructive: false
            idempotent: true
          call: branded-phone-numbers.patchbrandedphonenumber
          with:
            phoneNumber: tools.phoneNumber
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: regal-delete-branded-phone-number
          description: Delete a branded phone number registration.
          hints:
            readOnly: false
            destructive: true
            idempotent: true
          call: branded-phone-numbers.deletebrandedphonenumber
          with:
            phoneNumber: tools.phoneNumber
          outputParameters:
            - type: object
              mapping: $.