FactSet IRN Configuration API — Phone

naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Configuration API — Phone
  description: 'FactSet IRN Configuration API — Phone. 4 operations. Lead operation: Factset Get List of the Phone Types Configured
    in Your Group. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Phone
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-configuration-phone
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Configuration API — Phone business capability. Self-contained, no shared references.
    resources:
    - name: v1-phone-number-types
      path: /v1/phone-number-types
      operations:
      - name: getphonenumbertypes
        method: GET
        description: Factset Get List of the Phone Types Configured in Your Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createphonenumbertype
        method: POST
        description: Factset Create a Phone Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-phone-number-types-phoneNumberTypeId
      path: /v1/phone-number-types/{phoneNumberTypeId}
      operations:
      - name: updatephonenumbertype
        method: PUT
        description: Factset Edit a Phone Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phoneNumberTypeId
          in: path
          type: string
          description: phoneNumberTypeId to update associated record
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletephonenumbertype
        method: DELETE
        description: Factset Delete a Phone Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phoneNumberTypeId
          in: path
          type: string
          description: phoneNumberTypeId for deleting associated record
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-configuration-phone-rest
    port: 8080
    description: REST adapter for FactSet IRN Configuration API — Phone. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/phone-number-types
      name: v1-phone-number-types
      description: REST surface for v1-phone-number-types.
      operations:
      - method: GET
        name: getphonenumbertypes
        description: Factset Get List of the Phone Types Configured in Your Group
        call: irn-configuration-phone.getphonenumbertypes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createphonenumbertype
        description: Factset Create a Phone Type
        call: irn-configuration-phone.createphonenumbertype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/phone-number-types/{phonenumbertypeid}
      name: v1-phone-number-types-phonenumbertypeid
      description: REST surface for v1-phone-number-types-phoneNumberTypeId.
      operations:
      - method: PUT
        name: updatephonenumbertype
        description: Factset Edit a Phone Type
        call: irn-configuration-phone.updatephonenumbertype
        with:
          phoneNumberTypeId: rest.phoneNumberTypeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletephonenumbertype
        description: Factset Delete a Phone Type
        call: irn-configuration-phone.deletephonenumbertype
        with:
          phoneNumberTypeId: rest.phoneNumberTypeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-configuration-phone-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Configuration API — Phone. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-get-list-phone-types
      description: Factset Get List of the Phone Types Configured in Your Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-phone.getphonenumbertypes
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-phone-type
      description: Factset Create a Phone Type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-configuration-phone.createphonenumbertype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-phone-type
      description: Factset Edit a Phone Type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-configuration-phone.updatephonenumbertype
      with:
        phoneNumberTypeId: tools.phoneNumberTypeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-phone-type
      description: Factset Delete a Phone Type
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-configuration-phone.deletephonenumbertype
      with:
        phoneNumberTypeId: tools.phoneNumberTypeId
      outputParameters:
      - type: object
        mapping: $.