CSG Forte REST API — Customers

naftiko: 1.0.0-alpha2
info:
  label: CSG Forte REST API — Customers
  description: 'CSG Forte REST API — Customers. 5 operations. Lead operation: List customers. Self-contained Naftiko capability
    covering one Csg business surface.'
  tags:
  - Csg
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CSG_API_KEY: CSG_API_KEY
capability:
  consumes:
  - type: http
    namespace: forte-rest-customers
    baseUri: https://api.forte.net/v3
    description: CSG Forte REST API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organizationId-locations-locationId-customers
      path: /organizations/{organizationId}/locations/{locationId}/customers
      operations:
      - name: listcustomers
        method: GET
        description: List customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: first_name
          in: query
          type: string
        - name: last_name
          in: query
          type: string
        - name: customer_token
          in: query
          type: string
        - name: page_index
          in: query
          type: integer
        - name: page_size
          in: query
          type: integer
      - name: createcustomer
        method: POST
        description: Create a customer record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-locations-locationId-customers-customerId
      path: /organizations/{organizationId}/locations/{locationId}/customers/{customerId}
      operations:
      - name: getcustomer
        method: GET
        description: Get customer details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: customerId
          in: path
          type: string
          required: true
      - name: updatecustomer
        method: PUT
        description: Update a customer record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: customerId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecustomer
        method: DELETE
        description: Delete a customer record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: customerId
          in: path
          type: string
          required: true
    authentication:
      type: basic
      username: '{{env.CSG_USER}}'
      password: '{{env.CSG_PASS}}'
  exposes:
  - type: rest
    namespace: forte-rest-customers-rest
    port: 8080
    description: REST adapter for CSG Forte REST API — Customers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/locations/{locationid}/customers
      name: organizations-organizationid-locations-locationid-customers
      description: REST surface for organizations-organizationId-locations-locationId-customers.
      operations:
      - method: GET
        name: listcustomers
        description: List customers
        call: forte-rest-customers.listcustomers
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          first_name: rest.first_name
          last_name: rest.last_name
          customer_token: rest.customer_token
          page_index: rest.page_index
          page_size: rest.page_size
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomer
        description: Create a customer record
        call: forte-rest-customers.createcustomer
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/locations/{locationid}/customers/{customerid}
      name: organizations-organizationid-locations-locationid-customers-customerid
      description: REST surface for organizations-organizationId-locations-locationId-customers-customerId.
      operations:
      - method: GET
        name: getcustomer
        description: Get customer details
        call: forte-rest-customers.getcustomer
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          customerId: rest.customerId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomer
        description: Update a customer record
        call: forte-rest-customers.updatecustomer
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          customerId: rest.customerId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomer
        description: Delete a customer record
        call: forte-rest-customers.deletecustomer
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          customerId: rest.customerId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: forte-rest-customers-mcp
    port: 9090
    transport: http
    description: MCP adapter for CSG Forte REST API — Customers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-customers
      description: List customers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: forte-rest-customers.listcustomers
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        first_name: tools.first_name
        last_name: tools.last_name
        customer_token: tools.customer_token
        page_index: tools.page_index
        page_size: tools.page_size
      outputParameters:
      - type: object
        mapping: $.
    - name: create-customer-record
      description: Create a customer record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: forte-rest-customers.createcustomer
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-customer-details
      description: Get customer details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: forte-rest-customers.getcustomer
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        customerId: tools.customerId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer-record
      description: Update a customer record
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: forte-rest-customers.updatecustomer
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        customerId: tools.customerId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-customer-record
      description: Delete a customer record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: forte-rest-customers.deletecustomer
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        customerId: tools.customerId
      outputParameters:
      - type: object
        mapping: $.