# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Integration Customer sessions API
  version: 1.0.0
extends: openapi/talon-one-customer-sessions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v2/customer_sessions/{customerSessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer session
      effect: read
      questions:
      - What's currently in a shopper's session, without changing it?
      - Can I read a customer session's cart and state by its ID?
      instructions:
      - text: Get customer session {customerSessionId}.
        slots:
          customerSessionId: path.customerSessionId
      - text: Show the cart and state of session {customerSessionId}.
        slots:
          customerSessionId: path.customerSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customer_sessions/{customerSessionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cart session and get promotion effects
      effect: write
      questions:
      - How do I send a shopper's cart and get back the discounts that apply?
      - Can I evaluate a cart with a dry run so nothing is saved?
      - How do I close a session when the order is placed?
      instructions:
      - text: Update customer session {customerSessionId} with {customerSession}.
        slots:
          customerSessionId: path.customerSessionId
          customerSession: requestBody.customerSession
      - text: Dry-run session {customerSessionId} with cart data {customerSession}, dry {dry}.
        slots:
          customerSessionId: path.customerSessionId
          customerSession: requestBody.customerSession
          dry: query.dry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customer_sessions/{customerSessionId}/returns'].post
  update:
    x-apievangelist-phrasing:
      intent: Return items from a closed session
      effect: write
      questions:
      - How do I process a return and roll back the discounts on those items?
      - What state does a session move to after items are returned?
      instructions:
      - text: Return cart items {return} from session {customerSessionId}.
        slots:
          return: requestBody.return
          customerSessionId: path.customerSessionId
      - text: Create a return request of {return} for closed session {customerSessionId} as a dry run {dry}.
        slots:
          return: requestBody.return
          customerSessionId: path.customerSessionId
          dry: query.dry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customer_sessions/{customerSessionId}/reopen'].put
  update:
    x-apievangelist-phrasing:
      intent: Reopen a closed customer session
      effect: write
      questions:
      - Can I edit an order after its session was closed?
      - What happens to effects when a closed session is reopened?
      instructions:
      - text: Reopen customer session {customerSessionId}.
        slots:
          customerSessionId: path.customerSessionId
      - text: Set closed session {customerSessionId} back to open so it can be edited.
        slots:
          customerSessionId: path.customerSessionId
      method: generated
      generated: '2026-09-26'