# 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 Notes API
  version: 1.0.0
extends: openapi/merge-subpackage-notes-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: 5
- target: $.paths['/crm/v1/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM notes
      effect: read
      questions:
      - How do I pull the notes reps logged in a customer's CRM?
      - Can I list notes attached to one opportunity or one contact?
      - Which CRM notes were written by a particular owner?
      instructions:
      - text: List CRM notes on opportunity {opportunity_id}.
        slots:
          opportunity_id: query.opportunity_id
      - text: Show notes about contact {contact_id}.
        slots:
          contact_id: query.contact_id
      - text: Find notes for account {account_id} owned by {owner_id}.
        slots:
          account_id: query.account_id
          owner_id: query.owner_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note in the CRM
      effect: write
      questions:
      - Can I log a call summary as a note in the linked CRM?
      - What fields go into creating a CRM note?
      instructions:
      - text: Create a CRM note from {note}.
        slots:
          note: requestBody.model
      - text: 'Log this meeting summary as a note: {note}.'
        slots:
          note: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CRM note
      effect: read
      questions:
      - How do I read a single note from the CRM?
      - Can I see the linked account and contact on one note?
      instructions:
      - text: Get CRM note {id}.
        slots:
          id: path.id
      - text: Fetch note {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/notes/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating a CRM note takes
      effect: read
      questions:
      - Which fields does the CRM require when I create a note?
      - Can I check the note create schema before posting?
      instructions:
      - text: Show CRM note creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the note create metadata.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/notes/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for CRM notes
      effect: read
      questions:
      - What custom fields has the CRM added to notes?
      - Can I list only the custom field classes on notes?
      instructions:
      - text: List note remote field classes for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom field definitions on CRM notes.
      method: generated
      generated: '2026-09-26'