# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform Functions Business Admin Users API
  version: 1.0.0
extends: openapi/punchh-business-admin-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api2/dashboard/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin roles in the business
      effect: read
      questions:
      - Which admin roles have been set up for our business?
      - What role names can I assign to a new business admin?
      instructions:
      - text: List all admin roles in the business.
      - text: Show me the roles available for dashboard admins.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/business_admins'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business admin's details
      effect: read
      questions:
      - How can I see the details of one business admin?
      - What information is stored about a dashboard admin?
      instructions:
      - text: Show business admin {business_admin_id}.
        slots:
          business_admin_id: requestBody.business_admin_id
      - text: Get the profile and role of admin {business_admin_id}.
        slots:
          business_admin_id: requestBody.business_admin_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/business_admins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business admin
      effect: write
      questions:
      - Can I add a new dashboard admin directly without sending an invite?
      - What details are needed to create a business admin?
      instructions:
      - text: Create business admin {business_admin}.
        slots:
          business_admin: requestBody.business_admin
      - text: Add a new dashboard admin account with details {business_admin}.
        slots:
          business_admin: requestBody.business_admin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/business_admins'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business admin
      effect: destructive
      questions:
      - How do I remove an admin who left the company?
      - Can a business admin account be deleted by API?
      instructions:
      - text: Delete business admin {business_admin_id}.
        slots:
          business_admin_id: requestBody.business_admin_id
      - text: Remove admin {business_admin_id} from the dashboard.
        slots:
          business_admin_id: requestBody.business_admin_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/business_admins'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business admin
      effect: write
      questions:
      - Can I change a business admin's role or details?
      - Which fields on an existing admin can be edited?
      instructions:
      - text: Update business admin {business_admin_id} with {business_admin}.
        slots:
          business_admin_id: requestBody.business_admin_id
          business_admin: requestBody.business_admin
      - text: Change the role of admin {business_admin_id}.
        slots:
          business_admin_id: requestBody.business_admin_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/business_admins/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to be a business admin
      effect: write
      questions:
      - How do I invite a new manager to use the loyalty dashboard?
      - Does inviting an admin send them an email to join?
      instructions:
      - text: Invite {business_admin} to the dashboard as an admin.
        slots:
          business_admin: requestBody.business_admin
      - text: Send a business admin invitation to {business_admin}.
        slots:
          business_admin: requestBody.business_admin
      method: generated
      generated: '2026-10-01'