Gainsight CS Company API — Companies

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Company API — Companies
  description: 'Gainsight CS Company API — Companies. 5 operations. Lead operation: Gainsight Insert company records. Self-contained
    Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Companies
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-company-companies
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Company API — Companies business capability. Self-contained, no shared references.
    resources:
    - name: data-objects-Company
      path: /data/objects/Company
      operations:
      - name: insertcompanies
        method: POST
        description: Gainsight Insert company records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecompanies
        method: PUT
        description: Gainsight Update company records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keys
          in: query
          type: string
          description: Comma-separated list of key field names for matching
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-objects-Company-search
      path: /data/objects/Company/search
      operations:
      - name: searchcompanies
        method: POST
        description: Gainsight Search company 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-Company-recordId
      path: /data/objects/Company/{recordId}
      operations:
      - name: getcompany
        method: GET
        description: Gainsight Get a company record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecompany
        method: DELETE
        description: Gainsight Delete a company 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-company-companies-rest
    port: 8080
    description: REST adapter for Gainsight CS Company API — Companies. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/data/objects/company
      name: data-objects-company
      description: REST surface for data-objects-Company.
      operations:
      - method: POST
        name: insertcompanies
        description: Gainsight Insert company records
        call: cs-company-companies.insertcompanies
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecompanies
        description: Gainsight Update company records
        call: cs-company-companies.updatecompanies
        with:
          keys: rest.keys
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/company/search
      name: data-objects-company-search
      description: REST surface for data-objects-Company-search.
      operations:
      - method: POST
        name: searchcompanies
        description: Gainsight Search company records
        call: cs-company-companies.searchcompanies
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/company/{recordid}
      name: data-objects-company-recordid
      description: REST surface for data-objects-Company-recordId.
      operations:
      - method: GET
        name: getcompany
        description: Gainsight Get a company record
        call: cs-company-companies.getcompany
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompany
        description: Gainsight Delete a company record
        call: cs-company-companies.deletecompany
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-company-companies-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Company API — Companies. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: gainsight-insert-company-records
      description: Gainsight Insert company records
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-company-companies.insertcompanies
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-update-company-records
      description: Gainsight Update company records
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cs-company-companies.updatecompanies
      with:
        keys: tools.keys
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-search-company-records
      description: Gainsight Search company records
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cs-company-companies.searchcompanies
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-company-record
      description: Gainsight Get a company record
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-company-companies.getcompany
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-delete-company-record
      description: Gainsight Delete a company record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cs-company-companies.deletecompany
      outputParameters:
      - type: object
        mapping: $.