Sinch Fax API

naftiko: 1.0.0-alpha2
info:
  label: Sinch Fax API
  description: 'Sinch Fax API. 6 operations. Lead operation: Create a Fax Service. Self-contained Naftiko capability covering
    one Sinch business surface.'
  tags:
  - Sinch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SINCH_API_KEY: SINCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fax-general
    baseUri: https://fax.api.sinch.com
    description: Sinch Fax API business capability. Self-contained, no shared references.
    resources:
    - name: v3-projects-project_id-services
      path: /v3/projects/{project_id}/services
      operations:
      - name: createservice
        method: POST
        description: Create a Fax Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listservices
        method: GET
        description: List Fax Services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-projects-project_id-services-service_id
      path: /v3/projects/{project_id}/services/{service_id}
      operations:
      - name: getservice
        method: GET
        description: Get a Fax Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateservice
        method: PATCH
        description: Update a Fax Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteservice
        method: DELETE
        description: Delete a Fax Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-projects-project_id-services-service_id-numbers
      path: /v3/projects/{project_id}/services/{service_id}/numbers
      operations:
      - name: listservicenumbers
        method: GET
        description: List Numbers for a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SINCH_API_KEY}}'
  exposes:
  - type: rest
    namespace: fax-general-rest
    port: 8080
    description: REST adapter for Sinch Fax API. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v3/projects/{project-id}/services
      name: v3-projects-project-id-services
      description: REST surface for v3-projects-project_id-services.
      operations:
      - method: POST
        name: createservice
        description: Create a Fax Service
        call: fax-general.createservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listservices
        description: List Fax Services
        call: fax-general.listservices
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/projects/{project-id}/services/{service-id}
      name: v3-projects-project-id-services-service-id
      description: REST surface for v3-projects-project_id-services-service_id.
      operations:
      - method: GET
        name: getservice
        description: Get a Fax Service
        call: fax-general.getservice
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateservice
        description: Update a Fax Service
        call: fax-general.updateservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteservice
        description: Delete a Fax Service
        call: fax-general.deleteservice
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/projects/{project-id}/services/{service-id}/numbers
      name: v3-projects-project-id-services-service-id-numbers
      description: REST surface for v3-projects-project_id-services-service_id-numbers.
      operations:
      - method: GET
        name: listservicenumbers
        description: List Numbers for a Service
        call: fax-general.listservicenumbers
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fax-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sinch Fax API. One tool per consumed operation, routed inline through this capability's consumes
      block.
    tools:
    - name: create-fax-service
      description: Create a Fax Service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fax-general.createservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-fax-services
      description: List Fax Services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fax-general.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: get-fax-service
      description: Get a Fax Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fax-general.getservice
      outputParameters:
      - type: object
        mapping: $.
    - name: update-fax-service
      description: Update a Fax Service
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fax-general.updateservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-fax-service
      description: Delete a Fax Service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fax-general.deleteservice
      outputParameters:
      - type: object
        mapping: $.
    - name: list-numbers-service
      description: List Numbers for a Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fax-general.listservicenumbers
      outputParameters:
      - type: object
        mapping: $.