# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse CRM Public Company API
  version: 1.0.0
extends: openapi/sendpulse-company-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: 6
- target: $.paths['/companies/short-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up companies in a compact summary form
      effect: read
      questions:
      - Can I get just the short summary of CRM companies matching a name or email?
      - What's the lightweight way to look up company IDs and names without full details?
      instructions:
      - text: Get short data for companies named {companyName}.
        slots:
          companyName: requestBody.companyName
      - text: Return compact summaries of companies matching phone {phone}.
        slots:
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and list CRM companies with full details
      effect: read
      questions:
      - Which CRM companies were created between two dates, with their full records?
      - Can I filter my company list by the responsible manager or a search string?
      instructions:
      - text: List full company records owned by team member {responsibleId}.
        slots:
          responsibleId: requestBody.responsibleId
      - text: Search companies for {searchString} and return {limit} full records.
        slots:
          searchString: requestBody.searchString
          limit: requestBody.limit
      - text: List companies added from {dateFrom} to {dateTo} that have no contacts.
        slots:
          dateFrom: requestBody.dateFrom
          dateTo: requestBody.dateTo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company in the CRM
      effect: write
      questions:
      - How do I add a new company record to my CRM?
      - Can I set an annual business volume and currency when I create a company?
      instructions:
      - text: Create a company called {companyName}.
        slots:
          companyName: requestBody.companyName
      - text: Add company {companyName} at {address} and assign it to {responsibleId}.
        slots:
          companyName: requestBody.companyName
          address: requestBody.address
          responsibleId: requestBody.responsibleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's details
      effect: read
      questions:
      - What does the CRM have on file for a particular company?
      - Can I fetch one company record by its ID?
      instructions:
      - text: Show the details of company {companyId}.
        slots:
          companyId: path.companyId
      - text: Fetch company record {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company's details
      effect: write
      questions:
      - How do I rename an existing company in the CRM?
      - Can I change who is responsible for a company I already created?
      instructions:
      - text: Rename company {companyId} to {companyName}.
        slots:
          companyId: path.companyId
          companyName: requestBody.companyName
      - text: Reassign existing company {companyId} to team member {responsibleId}.
        slots:
          companyId: path.companyId
          responsibleId: requestBody.responsibleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company
      effect: destructive
      questions:
      - How do I remove a company from my CRM entirely?
      - Can I delete a duplicate company record?
      instructions:
      - text: Delete company {companyId}.
        slots:
          companyId: path.companyId
      - text: Remove the company record {companyId} from the CRM.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'