API Evangelist conversational phrasing for Paubox Forms Form management API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Paubox Forms Form management API
  version: 1.0.0
extends: openapi/paubox-form-management-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: 8
- target: $.paths['/api/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms for a customer
      effect: read
      questions:
      - What forms do I have, and can I see only the archived ones?
      - Can I search my forms by title or description?
      - What's the maximum number of forms returned per page?
      instructions:
      - text: List the forms for customer {customer_id}.
        slots:
          customer_id: query.customer_id
      - text: Search customer {customer_id}'s forms for {search}.
        slots:
          customer_id: query.customer_id
          search: query.search
      - text: Show only active forms for customer {customer_id} ({active}).
        slots:
          customer_id: query.customer_id
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new form
      effect: write
      questions:
      - How do I build a new form through the API?
      - Can a new form collect signatures and notify people on each submission?
      - Can I connect a marketing form to a contact list so signups become subscribers?
      instructions:
      - text: Create form {title} for customer {customer_id} with schema {form_json}, version {version}.
        slots:
          title: requestBody.title
          customer_id: requestBody.customer_id
          form_json: requestBody.form_json
          version: requestBody.version
      - text: Create a marketing form {title} for customer {customer_id} that adds signups to list {subscription_list_id}, schema {form_json} v{version}.
        slots:
          title: requestBody.title
          customer_id: requestBody.customer_id
          subscription_list_id: requestBody.subscription_list_id
          form_json: requestBody.form_json
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get form and submission statistics
      effect: read
      questions:
      - How many active forms do I have and how many submissions came in this past week?
      - What's my total form submission count?
      instructions:
      - text: Show my form statistics.
      - text: Get form stats for customer {customer_id}.
        slots:
          customer_id: query.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a form under a new title
      effect: write
      questions:
      - Can I duplicate an existing form instead of building it from scratch?
      - Does a copied form keep its submission count or vanity URL?
      instructions:
      - text: Copy form {form_id} as {title}.
        slots:
          form_id: requestBody.form_id
          title: requestBody.title
      - text: Duplicate form {form_id} and name the copy {title}.
        slots:
          form_id: requestBody.form_id
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/{form_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form's full definition as its owner
      effect: read
      questions:
      - How do I retrieve the full definition of one of my forms, even if it's archived?
      - Can I view an inactive form's schema from the admin side?
      instructions:
      - text: Get the full definition of my form {form_id}.
        slots:
          form_id: path.form_id
      - text: Show the admin view of form {form_id}, including if it's archived.
        slots:
          form_id: path.form_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/{form_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a form's settings or fields
      effect: write
      questions:
      - How do I change who gets notified when a form is submitted?
      - Can I reactivate a form or set a vanity URL for it?
      instructions:
      - text: Rename form {form_id} to {title}.
        slots:
          form_id: path.form_id
          title: requestBody.title
      - text: Set the notification recipients on form {form_id} to {recipient}.
        slots:
          form_id: path.form_id
          recipient: requestBody.recipient
      - text: Set form {form_id} active to {active}.
        slots:
          form_id: path.form_id
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/{form_id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a form and stop submissions
      effect: destructive
      questions:
      - How do I archive a form so it stops accepting responses?
      - Does archiving a form also deactivate it?
      instructions:
      - text: Archive form {form_id}.
        slots:
          form_id: path.form_id
      - text: Retire form {form_id} so nobody can submit it anymore.
        slots:
          form_id: path.form_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/forms/{form_id}/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Unarchive a form
      effect: write
      questions:
      - Can I restore a form I archived?
      - Will unarchiving a form make it accept submissions again?
      instructions:
      - text: Unarchive form {form_id}.
        slots:
          form_id: path.form_id
      - text: Bring form {form_id} back out of the archive.
        slots:
          form_id: path.form_id
      method: generated
      generated: '2026-10-01'