Copper Developer API — Opportunities

naftiko: 1.0.0-alpha2
info:
  label: Copper Developer API — Opportunities
  description: 'Copper Developer API — Opportunities. 5 operations. Lead operation: Create an Opportunity. Self-contained
    Naftiko capability covering one Copper business surface.'
  tags:
  - Copper
  - Opportunities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COPPER_API_KEY: COPPER_API_KEY
capability:
  consumes:
  - type: http
    namespace: developer-opportunities
    baseUri: https://api.copper.com/developer_api/v1
    description: Copper Developer API — Opportunities business capability. Self-contained, no shared references.
    resources:
    - name: opportunities
      path: /opportunities
      operations:
      - name: createopportunity
        method: POST
        description: 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: opportunities-search
      path: /opportunities/search
      operations:
      - name: searchopportunities
        method: POST
        description: Search Opportunities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: opportunities-id
      path: /opportunities/{id}
      operations:
      - name: getopportunity
        method: GET
        description: Get an Opportunity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateopportunity
        method: PUT
        description: Update an Opportunity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteopportunity
        method: DELETE
        description: Delete an Opportunity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-PW-AccessToken
      value: '{{env.COPPER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: developer-opportunities-rest
    port: 8080
    description: REST adapter for Copper Developer API — Opportunities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/opportunities
      name: opportunities
      description: REST surface for opportunities.
      operations:
      - method: POST
        name: createopportunity
        description: Create an Opportunity
        call: developer-opportunities.createopportunity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/opportunities/search
      name: opportunities-search
      description: REST surface for opportunities-search.
      operations:
      - method: POST
        name: searchopportunities
        description: Search Opportunities
        call: developer-opportunities.searchopportunities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/opportunities/{id}
      name: opportunities-id
      description: REST surface for opportunities-id.
      operations:
      - method: GET
        name: getopportunity
        description: Get an Opportunity
        call: developer-opportunities.getopportunity
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateopportunity
        description: Update an Opportunity
        call: developer-opportunities.updateopportunity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteopportunity
        description: Delete an Opportunity
        call: developer-opportunities.deleteopportunity
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: developer-opportunities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Copper Developer API — Opportunities. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-opportunity
      description: Create an Opportunity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: developer-opportunities.createopportunity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-opportunities
      description: Search Opportunities
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: developer-opportunities.searchopportunities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-opportunity
      description: Get an Opportunity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: developer-opportunities.getopportunity
      outputParameters:
      - type: object
        mapping: $.
    - name: update-opportunity
      description: Update an Opportunity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: developer-opportunities.updateopportunity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-opportunity
      description: Delete an Opportunity
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: developer-opportunities.deleteopportunity
      outputParameters:
      - type: object
        mapping: $.