Hightouch Management API — Syncs

naftiko: 1.0.0-alpha2
info:
  label: Hightouch Management API — Syncs
  description: 'Hightouch Management API — Syncs. 5 operations. Lead operation: List syncs. Self-contained Naftiko capability
    covering one Hightouch business surface.'
  tags:
  - Hightouch
  - Syncs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HIGHTOUCH_API_KEY: HIGHTOUCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: hightouch-syncs
    baseUri: https://api.hightouch.com
    description: Hightouch Management API — Syncs business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-syncs
      path: /api/v1/syncs
      operations:
      - name: listsyncs
        method: GET
        description: List syncs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsync
        method: POST
        description: Create a sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-syncs-id
      path: /api/v1/syncs/{id}
      operations:
      - name: getsync
        method: GET
        description: Get a sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-v1-syncs-id-runs
      path: /api/v1/syncs/{id}/runs
      operations:
      - name: listsyncruns
        method: GET
        description: List sync runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-v1-syncs-id-trigger
      path: /api/v1/syncs/{id}/trigger
      operations:
      - name: triggersync
        method: POST
        description: Trigger a sync run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.HIGHTOUCH_API_KEY}}'
  exposes:
  - type: rest
    namespace: hightouch-syncs-rest
    port: 8080
    description: REST adapter for Hightouch Management API — Syncs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/syncs
      name: api-v1-syncs
      description: REST surface for api-v1-syncs.
      operations:
      - method: GET
        name: listsyncs
        description: List syncs
        call: hightouch-syncs.listsyncs
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsync
        description: Create a sync
        call: hightouch-syncs.createsync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/syncs/{id}
      name: api-v1-syncs-id
      description: REST surface for api-v1-syncs-id.
      operations:
      - method: GET
        name: getsync
        description: Get a sync
        call: hightouch-syncs.getsync
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/syncs/{id}/runs
      name: api-v1-syncs-id-runs
      description: REST surface for api-v1-syncs-id-runs.
      operations:
      - method: GET
        name: listsyncruns
        description: List sync runs
        call: hightouch-syncs.listsyncruns
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/syncs/{id}/trigger
      name: api-v1-syncs-id-trigger
      description: REST surface for api-v1-syncs-id-trigger.
      operations:
      - method: POST
        name: triggersync
        description: Trigger a sync run
        call: hightouch-syncs.triggersync
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hightouch-syncs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Hightouch Management API — Syncs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-syncs
      description: List syncs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hightouch-syncs.listsyncs
      outputParameters:
      - type: object
        mapping: $.
    - name: create-sync
      description: Create a sync
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hightouch-syncs.createsync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sync
      description: Get a sync
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hightouch-syncs.getsync
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-sync-runs
      description: List sync runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hightouch-syncs.listsyncruns
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-sync-run
      description: Trigger a sync run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hightouch-syncs.triggersync
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.