Upvest Investment API — Savings Plans

naftiko: 1.0.0-alpha2
info:
  label: Upvest Investment API — Savings Plans
  description: 'Upvest Investment API — Savings Plans. 5 operations. Lead operation: Upvest List savings plans. Self-contained
    Naftiko capability covering one Upvest business surface.'
  tags:
  - Upvest
  - Savings Plans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPVEST_API_KEY: UPVEST_API_KEY
capability:
  consumes:
  - type: http
    namespace: investment-savings-plans
    baseUri: https://api.upvest.co
    description: Upvest Investment API — Savings Plans business capability. Self-contained, no shared references.
    resources:
    - name: savings_plans
      path: /savings_plans
      operations:
      - name: listsavingsplans
        method: GET
        description: Upvest List savings plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsavingsplan
        method: POST
        description: Upvest Create a savings plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: savings_plans-savings_plan_id
      path: /savings_plans/{savings_plan_id}
      operations:
      - name: retrievesavingsplan
        method: GET
        description: Upvest Retrieve a savings plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesavingsplan
        method: PATCH
        description: Upvest Update a savings plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesavingsplan
        method: DELETE
        description: Upvest Delete a savings plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.UPVEST_API_KEY}}'
  exposes:
  - type: rest
    namespace: investment-savings-plans-rest
    port: 8080
    description: REST adapter for Upvest Investment API — Savings Plans. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/savings-plans
      name: savings-plans
      description: REST surface for savings_plans.
      operations:
      - method: GET
        name: listsavingsplans
        description: Upvest List savings plans
        call: investment-savings-plans.listsavingsplans
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsavingsplan
        description: Upvest Create a savings plan
        call: investment-savings-plans.createsavingsplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/savings-plans/{savings-plan-id}
      name: savings-plans-savings-plan-id
      description: REST surface for savings_plans-savings_plan_id.
      operations:
      - method: GET
        name: retrievesavingsplan
        description: Upvest Retrieve a savings plan
        call: investment-savings-plans.retrievesavingsplan
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesavingsplan
        description: Upvest Update a savings plan
        call: investment-savings-plans.updatesavingsplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesavingsplan
        description: Upvest Delete a savings plan
        call: investment-savings-plans.deletesavingsplan
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: investment-savings-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Upvest Investment API — Savings Plans. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: upvest-list-savings-plans
      description: Upvest List savings plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: investment-savings-plans.listsavingsplans
      outputParameters:
      - type: object
        mapping: $.
    - name: upvest-create-savings-plan
      description: Upvest Create a savings plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: investment-savings-plans.createsavingsplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: upvest-retrieve-savings-plan
      description: Upvest Retrieve a savings plan
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: investment-savings-plans.retrievesavingsplan
      outputParameters:
      - type: object
        mapping: $.
    - name: upvest-update-savings-plan
      description: Upvest Update a savings plan
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: investment-savings-plans.updatesavingsplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: upvest-delete-savings-plan
      description: Upvest Delete a savings plan
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: investment-savings-plans.deletesavingsplan
      outputParameters:
      - type: object
        mapping: $.