# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Showpad CRM API
  version: 1.0.0
extends: openapi/showpad-crm-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['/crm/recommendations/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM recommendation rules
      effect: read
      questions:
      - Which content recommendation rules are set up for our CRM instance?
      - Can I find every recommendation rule that uses a particular tag?
      instructions:
      - text: List the recommendation rules for CRM instance {crmInstanceId}.
        slots:
          crmInstanceId: query.crmInstanceId
      - text: Find recommendation rules that reference tags {tagIds}.
        slots:
          tagIds: query.tagIds
      - text: Get the next page of recommendation rules after cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/recommendations/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM recommendation rule
      effect: write
      questions:
      - How do I recommend specific content when a CRM field has a certain value?
      - Can I link CRM conditions to asset tags so reps see the right material?
      instructions:
      - text: Create a recommendation rule in CRM instance {crmInstanceId} with conditions {conditions} recommending tags {tags}.
        slots:
          crmInstanceId: requestBody.crmInstanceId
          conditions: requestBody.conditions
          tags: requestBody.tags
      - text: 'Add a new rule to CRM instance {crmInstanceId}: when {conditions}, suggest assets tagged {tags}.'
        slots:
          crmInstanceId: requestBody.crmInstanceId
          conditions: requestBody.conditions
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/recommendations/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM recommendation rule
      effect: read
      questions:
      - How do I inspect the conditions and tags of one recommendation rule?
      - What does a single CRM recommendation rule look like in detail?
      instructions:
      - text: Get recommendation rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Show the conditions and tag criteria of rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/recommendations/rules/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM recommendation rule
      effect: write
      questions:
      - How do I change the conditions on an existing recommendation rule?
      - Can I adjust which tags an existing rule recommends?
      instructions:
      - text: Update rule {ruleId} in CRM instance {crmInstanceId} to conditions {conditions} and tags {tags}.
        slots:
          ruleId: path.ruleId
          crmInstanceId: requestBody.crmInstanceId
          conditions: requestBody.conditions
          tags: requestBody.tags
      - text: Replace the tags on existing rule {ruleId} with {tags}, keeping instance {crmInstanceId} and conditions {conditions}.
        slots:
          ruleId: path.ruleId
          crmInstanceId: requestBody.crmInstanceId
          conditions: requestBody.conditions
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/recommendations/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM recommendation rule
      effect: destructive
      questions:
      - How do I remove an outdated recommendation rule?
      - Is deleting a recommendation rule permanent?
      instructions:
      - text: Delete recommendation rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Permanently remove CRM rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/shared-space-records/{sharedSpaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CRM records for a Shared Space
      effect: read
      questions:
      - Which CRM records and activities are tied to a given Shared Space?
      - Can I see the account linked to a Shared Space?
      instructions:
      - text: Get the CRM records for Shared Space {sharedSpaceId}.
        slots:
          sharedSpaceId: path.sharedSpaceId
      - text: Show the activity history logged to CRM for Shared Space {sharedSpaceId}.
        slots:
          sharedSpaceId: path.sharedSpaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crm/share-records/{shareId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CRM records for a Share
      effect: read
      questions:
      - Which CRM records are associated with a Share I sent?
      - How do I audit the activity history of a single Share?
      instructions:
      - text: Get the CRM records for Share {shareId}.
        slots:
          shareId: path.shareId
      - text: Show the CRM activity history of Share {shareId}.
        slots:
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'