# 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 Migration Users API
  version: 1.0.0
extends: openapi/punchh-business-migration-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: 4
- target: $.paths['/api2/dashboard/migration_users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a guest to migrate from an old program
      effect: write
      questions:
      - How do I bring a member over from our previous loyalty program with their points?
      - Can migrated rewards carry an expiration date?
      instructions:
      - text: Create a migration user with phone {phone} and {original_points} points from the old program.
        slots:
          phone: requestBody.phone
          original_points: requestBody.original_points
      - text: Migrate member {original_membership_no} ({email}) with {migrated_rewards} in rewards.
        slots:
          original_membership_no: requestBody.original_membership_no
          email: requestBody.email
          migrated_rewards: requestBody.migrated_rewards
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/migration_users/{ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business migration user
      effect: destructive
      questions:
      - Can I remove a guest from the migration list before they're imported?
      - Which ID do I need to delete a migration user?
      instructions:
      - text: Delete migration user {ID}.
        slots:
          ID: path.ID
      - text: Remove business migration record {ID}.
        slots:
          ID: path.ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/migration_users/{ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business migration user
      effect: write
      questions:
      - How do I correct the points or contact details on a migration record?
      - Can I change a migration user's conversion rate after creating them?
      instructions:
      - text: Update migration user {ID} to {original_points} original points.
        slots:
          ID: path.ID
          original_points: requestBody.original_points
      - text: Change the email on migration user {ID} to {email}.
        slots:
          ID: path.ID
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/migration_users/bulk_bmu_upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk upload migration users from a CSV
      effect: write
      questions:
      - Can I upload a whole CSV of members from our previous loyalty program at once?
      - Can the migration CSV be pulled from a hosted URL instead of a local file?
      instructions:
      - text: Bulk upload migration users from {import_file_url} as {name}.
        slots:
          import_file_url: requestBody.import_file_url
          name: requestBody.name
      - text: Import the migration CSV {bulk_guest_activity_file} under the name {name}.
        slots:
          bulk_guest_activity_file: requestBody.bulk_guest_activity_file
          name: requestBody.name
      method: generated
      generated: '2026-10-01'