# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CRM Company Service API
  version: 1.0.0
extends: openapi/vendasta-crmcompanyservice-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['/v1/crm/company/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company in the CRM
      effect: write
      questions:
      - How do I add a new company record to the CRM?
      - What goes into a company object when creating one?
      instructions:
      - text: Create CRM company {company} in namespace {namespace}.
        slots:
          company: requestBody.crmObject
          namespace: requestBody.namespace
      - text: Add a new company record {company} to the {namespace} CRM.
        slots:
          company: requestBody.crmObject
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/company/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM company
      effect: destructive
      questions:
      - Can I remove a company from the CRM?
      - What do I need to delete a company record?
      instructions:
      - text: Delete CRM company {company} in namespace {namespace}.
        slots:
          company: requestBody.crmObjectId
          namespace: requestBody.namespace
      - text: Remove company {company} from the {namespace} CRM.
        slots:
          company: requestBody.crmObjectId
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/company/field-options'].post
  update:
    x-apievangelist-phrasing:
      intent: List allowed values for a company field
      effect: read
      questions:
      - What options can a company dropdown field take?
      - Can I search the choices available for a company field?
      instructions:
      - text: List the options for company field {field} in namespace {namespace}.
        slots:
          field: requestBody.fieldId
          namespace: requestBody.namespace
      - text: Find values of company field {field} in {namespace} matching {term}.
        slots:
          field: requestBody.fieldId
          namespace: requestBody.namespace
          term: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/company/get-multi'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several CRM companies by ID
      effect: read
      questions:
      - Can I load a few company records at once when I know their IDs?
      - Is it possible to return only certain fields for each company?
      instructions:
      - text: Get CRM companies {ids} in namespace {namespace}.
        slots:
          ids: requestBody.crmObjectIds
          namespace: requestBody.namespace
      - text: Fetch companies {ids} from {namespace} with only fields {mask}.
        slots:
          ids: requestBody.crmObjectIds
          namespace: requestBody.namespace
          mask: requestBody.fieldMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/company/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List and search CRM companies
      effect: read
      questions:
      - Which companies are in my CRM?
      - Can I search or sort the company list?
      instructions:
      - text: List CRM companies in namespace {namespace}.
        slots:
          namespace: requestBody.namespace
      - text: Search companies in {namespace} for {search}, sorted by {sort}.
        slots:
          namespace: requestBody.namespace
          search: requestBody.search
          sort: requestBody.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/crm/company/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM company
      effect: write
      questions:
      - Can I change details on a company already in the CRM?
      - Is there a way to update only specific company fields?
      instructions:
      - text: Update CRM company {company} in namespace {namespace}.
        slots:
          company: requestBody.crmObject
          namespace: requestBody.namespace
      - text: Change only fields {mask} on company {company} in {namespace}.
        slots:
          mask: requestBody.fieldMask
          company: requestBody.crmObject
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'