Unum HR Connect API — Eligibility

naftiko: 1.0.0-alpha2
info:
  label: Unum HR Connect API — Eligibility
  description: 'Unum HR Connect API — Eligibility. 5 operations. Lead operation: List Eligible Members. Self-contained Naftiko
    capability covering one Unum business surface.'
  tags:
  - Unum
  - Eligibility
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNUM_API_KEY: UNUM_API_KEY
capability:
  consumes:
  - type: http
    namespace: hr-connect-eligibility
    baseUri: https://api.unum.com/v1
    description: Unum HR Connect API — Eligibility business capability. Self-contained, no shared references.
    resources:
    - name: eligibility-members
      path: /eligibility/members
      operations:
      - name: listeligiblemembers
        method: GET
        description: List Eligible Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: query
          type: string
          description: Employer group identifier
          required: true
        - name: effectiveDate
          in: query
          type: string
          description: Effective date for eligibility check (YYYY-MM-DD)
        - name: page
          in: query
          type: integer
          description: Page number for pagination
        - name: limit
          in: query
          type: integer
          description: Number of records per page
      - name: submitmembereligibility
        method: POST
        description: Submit Member Eligibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: eligibility-members-memberId
      path: /eligibility/members/{memberId}
      operations:
      - name: getmembereligibility
        method: GET
        description: Get Member Eligibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: memberId
          in: path
          type: string
          description: Unique member identifier
          required: true
      - name: updatemembereligibility
        method: PUT
        description: Update Member Eligibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: memberId
          in: path
          type: string
          description: Unique member identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: terminatemembereligibility
        method: DELETE
        description: Terminate Member Eligibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: memberId
          in: path
          type: string
          description: Unique member identifier
          required: true
        - name: terminationDate
          in: query
          type: string
          description: Effective termination date
          required: true
        - name: terminationReason
          in: query
          type: string
          description: Reason for termination
    authentication:
      type: bearer
      token: '{{env.UNUM_API_KEY}}'
  exposes:
  - type: rest
    namespace: hr-connect-eligibility-rest
    port: 8080
    description: REST adapter for Unum HR Connect API — Eligibility. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/eligibility/members
      name: eligibility-members
      description: REST surface for eligibility-members.
      operations:
      - method: GET
        name: listeligiblemembers
        description: List Eligible Members
        call: hr-connect-eligibility.listeligiblemembers
        with:
          groupId: rest.groupId
          effectiveDate: rest.effectiveDate
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: submitmembereligibility
        description: Submit Member Eligibility
        call: hr-connect-eligibility.submitmembereligibility
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eligibility/members/{memberid}
      name: eligibility-members-memberid
      description: REST surface for eligibility-members-memberId.
      operations:
      - method: GET
        name: getmembereligibility
        description: Get Member Eligibility
        call: hr-connect-eligibility.getmembereligibility
        with:
          memberId: rest.memberId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemembereligibility
        description: Update Member Eligibility
        call: hr-connect-eligibility.updatemembereligibility
        with:
          memberId: rest.memberId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: terminatemembereligibility
        description: Terminate Member Eligibility
        call: hr-connect-eligibility.terminatemembereligibility
        with:
          memberId: rest.memberId
          terminationDate: rest.terminationDate
          terminationReason: rest.terminationReason
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hr-connect-eligibility-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unum HR Connect API — Eligibility. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-eligible-members
      description: List Eligible Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hr-connect-eligibility.listeligiblemembers
      with:
        groupId: tools.groupId
        effectiveDate: tools.effectiveDate
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-member-eligibility
      description: Submit Member Eligibility
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hr-connect-eligibility.submitmembereligibility
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-member-eligibility
      description: Get Member Eligibility
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hr-connect-eligibility.getmembereligibility
      with:
        memberId: tools.memberId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-member-eligibility
      description: Update Member Eligibility
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: hr-connect-eligibility.updatemembereligibility
      with:
        memberId: tools.memberId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: terminate-member-eligibility
      description: Terminate Member Eligibility
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hr-connect-eligibility.terminatemembereligibility
      with:
        memberId: tools.memberId
        terminationDate: tools.terminationDate
        terminationReason: tools.terminationReason
      outputParameters:
      - type: object
        mapping: $.