Gainsight CS Person API — People

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Person API — People
  description: 'Gainsight CS Person API — People. 4 operations. Lead operation: Gainsight Upsert person records. Self-contained
    Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - People
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-person-people
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Person API — People business capability. Self-contained, no shared references.
    resources:
    - name: data-objects-Person
      path: /data/objects/Person
      operations:
      - name: upsertpeople
        method: POST
        description: Gainsight Upsert person records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keys
          in: query
          type: string
          description: Comma-separated key fields for matching (e.g., Email)
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-objects-Person-search
      path: /data/objects/Person/search
      operations:
      - name: searchpeople
        method: POST
        description: Gainsight Search person records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-objects-Person-recordId
      path: /data/objects/Person/{recordId}
      operations:
      - name: getperson
        method: GET
        description: Gainsight Get a person record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteperson
        method: DELETE
        description: Gainsight Delete a person record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: accessKey
      value: '{{env.GAINSIGHT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cs-person-people-rest
    port: 8080
    description: REST adapter for Gainsight CS Person API — People. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/data/objects/person
      name: data-objects-person
      description: REST surface for data-objects-Person.
      operations:
      - method: POST
        name: upsertpeople
        description: Gainsight Upsert person records
        call: cs-person-people.upsertpeople
        with:
          keys: rest.keys
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/person/search
      name: data-objects-person-search
      description: REST surface for data-objects-Person-search.
      operations:
      - method: POST
        name: searchpeople
        description: Gainsight Search person records
        call: cs-person-people.searchpeople
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/person/{recordid}
      name: data-objects-person-recordid
      description: REST surface for data-objects-Person-recordId.
      operations:
      - method: GET
        name: getperson
        description: Gainsight Get a person record
        call: cs-person-people.getperson
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteperson
        description: Gainsight Delete a person record
        call: cs-person-people.deleteperson
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-person-people-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Person API — People. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: gainsight-upsert-person-records
      description: Gainsight Upsert person records
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-person-people.upsertpeople
      with:
        keys: tools.keys
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-search-person-records
      description: Gainsight Search person records
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cs-person-people.searchpeople
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-person-record
      description: Gainsight Get a person record
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-person-people.getperson
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-delete-person-record
      description: Gainsight Delete a person record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cs-person-people.deleteperson
      outputParameters:
      - type: object
        mapping: $.