Gainsight CS Renewal Center API — Opportunities

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Renewal Center API — Opportunities
  description: 'Gainsight CS Renewal Center API — Opportunities. 4 operations. Lead operation: Gainsight Create an opportunity.
    Self-contained Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Opportunities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-renewal-center-opportunities
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Renewal Center API — Opportunities business capability. Self-contained, no shared references.
    resources:
    - name: data-objects-Opportunity
      path: /data/objects/Opportunity
      operations:
      - name: createopportunity
        method: POST
        description: Gainsight Create an opportunity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateopportunity
        method: PUT
        description: Gainsight Update opportunities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keys
          in: query
          type: string
          description: Comma-separated key fields for matching
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-objects-Opportunity-search
      path: /data/objects/Opportunity/search
      operations:
      - name: searchopportunities
        method: POST
        description: Gainsight Search opportunities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-objects-Opportunity-recordId
      path: /data/objects/Opportunity/{recordId}
      operations:
      - name: getopportunity
        method: GET
        description: Gainsight Get an opportunity
        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-renewal-center-opportunities-rest
    port: 8080
    description: REST adapter for Gainsight CS Renewal Center API — Opportunities. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/data/objects/opportunity
      name: data-objects-opportunity
      description: REST surface for data-objects-Opportunity.
      operations:
      - method: POST
        name: createopportunity
        description: Gainsight Create an opportunity
        call: cs-renewal-center-opportunities.createopportunity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateopportunity
        description: Gainsight Update opportunities
        call: cs-renewal-center-opportunities.updateopportunity
        with:
          keys: rest.keys
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/opportunity/search
      name: data-objects-opportunity-search
      description: REST surface for data-objects-Opportunity-search.
      operations:
      - method: POST
        name: searchopportunities
        description: Gainsight Search opportunities
        call: cs-renewal-center-opportunities.searchopportunities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/objects/opportunity/{recordid}
      name: data-objects-opportunity-recordid
      description: REST surface for data-objects-Opportunity-recordId.
      operations:
      - method: GET
        name: getopportunity
        description: Gainsight Get an opportunity
        call: cs-renewal-center-opportunities.getopportunity
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-renewal-center-opportunities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Renewal Center API — Opportunities. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: gainsight-create-opportunity
      description: Gainsight Create an opportunity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-renewal-center-opportunities.createopportunity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-update-opportunities
      description: Gainsight Update opportunities
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cs-renewal-center-opportunities.updateopportunity
      with:
        keys: tools.keys
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-search-opportunities
      description: Gainsight Search opportunities
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: cs-renewal-center-opportunities.searchopportunities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-opportunity
      description: Gainsight Get an opportunity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-renewal-center-opportunities.getopportunity
      outputParameters:
      - type: object
        mapping: $.