API Evangelist conversational phrasing for CRM Subpackage Engagements API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CRM Subpackage Engagements API
  version: 1.0.0
extends: openapi/merge-subpackage-engagements-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: 7
- target: $.paths['/crm/v1/engagements'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM engagements
      effect: read
      questions:
      - Can I pull calls, meetings and emails logged in a customer's CRM?
      - Which engagements started within a given window?
      instructions:
      - text: List engagements started after {started_after}.
        slots:
          started_after: query.started_after
      - text: Show CRM engagements that started before {started_before}.
        slots:
          started_before: query.started_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a CRM engagement
      effect: write
      questions:
      - How do I log a call or meeting in a customer's CRM?
      - Can I write an engagement to the CRM asynchronously?
      instructions:
      - text: Log engagement {engagement} in the CRM.
        slots:
          engagement: requestBody.model
      - text: Create engagement {engagement} with debug mode {is_debug_mode}.
        slots:
          engagement: requestBody.model
          is_debug_mode: query.is_debug_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM engagement
      effect: read
      questions:
      - Can I see the details of one logged call or meeting?
      - What's recorded on a single CRM engagement?
      instructions:
      - text: Get engagement {id}.
        slots:
          id: path.id
      - text: Show me the CRM engagement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM engagement
      effect: write
      questions:
      - Can I edit a meeting or call that's already logged in the CRM?
      - Is it possible to change the content of an existing engagement?
      instructions:
      - text: Update engagement {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.model
      - text: Patch CRM engagement {id} to {changes} asynchronously {run_async}.
        slots:
          id: path.id
          changes: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields allowed when updating an engagement
      effect: read
      questions:
      - Which fields can I change on a specific CRM engagement?
      - What does the CRM let me edit on an existing engagement?
      instructions:
      - text: Show editable fields for engagement {id}.
        slots:
          id: path.id
      - text: Get update metadata for CRM engagement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to log an engagement
      effect: read
      questions:
      - Which fields are required to log a new engagement in this CRM?
      - What does the CRM accept when creating a call or meeting record?
      instructions:
      - text: Show engagement creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for CRM engagements.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagements/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions on engagements
      effect: read
      questions:
      - What custom fields does the CRM define on engagements?
      - Can I list only custom engagement field classes?
      instructions:
      - text: List engagement field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show engagement field classes that are common model fields {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'