# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Amo Widget API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-amo-widget-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: 7
- target: $.paths['/api/amo-widget/v1/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List providers available to the amoCRM widget
      effect: read
      questions:
      - Which providers can the amoCRM widget run a test against?
      - What provider options does the amoCRM widget offer?
      instructions:
      - text: List the providers available in the amoCRM widget.
      - text: Show the amoCRM widget provider list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/log'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a log entry from the amoCRM widget
      effect: write
      questions:
      - How does the amoCRM widget report its client-side logs?
      - Where do amoCRM widget log messages get posted?
      instructions:
      - text: Post a log entry from the amoCRM widget.
      - text: Record this amoCRM widget error in the widget log.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/oauth/install'].get
  update:
    x-apievangelist-phrasing:
      intent: Complete the amoCRM widget OAuth install
      effect: write
      questions:
      - How is the amoCRM widget installed through OAuth?
      - What happens when amoCRM redirects back with an authorization code?
      instructions:
      - text: Finish the amoCRM widget install with code {code} for client {client_id}.
        slots:
          code: query.code
          client_id: query.client_id
      - text: Complete the widget OAuth install for account {referer}.
        slots:
          referer: query.referer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/webhooks/uninstall'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle the amoCRM widget uninstall webhook
      effect: destructive
      questions:
      - What happens when someone uninstalls the amoCRM widget?
      - Where does amoCRM notify us that the widget was removed?
      instructions:
      - text: Process the amoCRM widget uninstall webhook.
      - text: Handle removal of the widget from an amoCRM account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a test from an amoCRM record
      effect: write
      questions:
      - How do I start a test for an email address from inside an amoCRM lead or contact?
      - Can I choose which providers the amoCRM widget test runs against?
      instructions:
      - text: Start a widget test for {email} on {entity_type} {entity_id}.
        slots:
          email: requestBody.email
          entity_type: requestBody.entity_type
          entity_id: requestBody.entity_id
      - text: Run an amoCRM widget test for {email} against {providers} on {entity_type} {entity_id}.
        slots:
          email: requestBody.email
          providers: requestBody.providers
          entity_type: requestBody.entity_type
          entity_id: requestBody.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/tests/{token}/poll'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of an amoCRM widget test
      effect: read
      questions:
      - Has my amoCRM widget test finished yet?
      - How do I poll for the result of a widget test?
      instructions:
      - text: Poll widget test {token}.
        slots:
          token: path.token
      - text: Check whether test {token} has results.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/amo-widget/v1/tests/{token}/save-note'].post
  update:
    x-apievangelist-phrasing:
      intent: Save widget test results as an amoCRM note
      effect: write
      questions:
      - Can I attach a widget test result to the amoCRM record as a note?
      - How do I save test findings back into amoCRM?
      instructions:
      - text: Save the results of test {token} as a note in amoCRM.
        slots:
          token: path.token
      - text: Write test {token} back to the lead as a note.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'