API Evangelist conversational phrasing for act.web.api Preferences API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for act.web.api Preferences API
  version: 1.0.0
extends: openapi/act-preferences-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: 12
- target: $.paths['/api/preferences/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a user preference by id
      effect: write
      questions:
      - How do I change the value of a preference I already know the id of?
      - Can I create or overwrite one preference at a specific key path?
      instructions:
      - text: Set preference {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Overwrite the preference at {id} with {value}.
        slots:
          id: path.id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user preference
      effect: destructive
      questions:
      - How do I remove a saved user preference?
      - Can I reset a setting by deleting its preference entry?
      instructions:
      - text: Delete preference {id}.
        slots:
          id: path.id
      - text: Remove the saved setting {id} from my preferences.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my preferences
      effect: read
      questions:
      - What preferences are saved for my user?
      - Can I fetch only certain preference keys?
      instructions:
      - text: Show all my saved preferences.
      - text: Get my preferences for the keys {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new user preference
      effect: write
      questions:
      - How do I save a new preference for the current user?
      - Can I post a preference by name and value without knowing its id?
      instructions:
      - text: Save a preference named {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Store the setting {name} = {value} in my preferences.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/contact/salutation-and-names'].get
  update:
    x-apievangelist-phrasing:
      intent: Get salutation and name affix settings
      effect: read
      questions:
      - What salutations and name prefixes or suffixes are configured?
      - Which name affix settings apply to contacts?
      instructions:
      - text: Show the contact salutation and name affix settings.
      - text: List the configured salutations and name prefixes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/contact/salutation-and-names'].put
  update:
    x-apievangelist-phrasing:
      intent: Update salutation and name affix settings
      effect: write
      questions:
      - How do I change the list of salutations used for contacts?
      - Can I edit the allowed name prefixes and suffixes?
      instructions:
      - text: Update the contact salutation types to {salutationSettings}.
        slots:
          salutationSettings: requestBody.salutationSettings
      - text: Set the name affix settings to {nameAffixSettings}.
        slots:
          nameAffixSettings: requestBody.nameAffixSettings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get task preferences
      effect: read
      questions:
      - What are my current task and scheduling preferences?
      - Is activity conflict checking turned on?
      instructions:
      - text: Show my task preferences.
      - text: Tell me how task conflict checking and clearing are configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/tasks'].put
  update:
    x-apievangelist-phrasing:
      intent: Update task preferences
      effect: write
      questions:
      - How do I make new activities public by default?
      - Can I turn off conflict checking when scheduling tasks?
      instructions:
      - text: Set make-new-tasks-public to {makeNewTaskPublic}.
        slots:
          makeNewTaskPublic: requestBody.makeNewTaskPublic
      - text: Change task conflict checking to {taskConflictChecking}.
        slots:
          taskConflictChecking: requestBody.taskConflictChecking
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/tasks/color-palette'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the task color palette
      effect: read
      questions:
      - What colors are available for task types?
      - Which color palette is used for activities on the calendar?
      instructions:
      - text: Show the task color palette.
      - text: List the colors assigned to task types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/duplicates-checking/{recordType}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields usable for duplicate checking
      effect: read
      questions:
      - Which fields can I use to detect duplicate contacts?
      - What fields are available for duplicate checking on companies or groups?
      instructions:
      - text: List the fields available for duplicate checking on {recordType} records.
        slots:
          recordType: path.recordType
      - text: Show which {recordType} fields can be used to match duplicates.
        slots:
          recordType: path.recordType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/duplicates-checking/{recordType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get duplicate-checking settings
      effect: read
      questions:
      - Which fields are currently selected for duplicate checking?
      - How is duplicate detection configured for contacts?
      instructions:
      - text: Show the current duplicate-checking settings for {recordType}.
        slots:
          recordType: path.recordType
      - text: List the fields that are active for dup-checking on {recordType}.
        slots:
          recordType: path.recordType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/preferences/duplicates-checking/{recordType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update duplicate-checking settings
      effect: write
      questions:
      - How do I change which fields are used to catch duplicates?
      - Can I match duplicate companies on different fields?
      instructions:
      - text: Use fields {fields} for duplicate checking on {recordType}.
        slots:
          fields: requestBody.fields
          recordType: path.recordType
      - text: Update the {recordType} dup-check indexes to {fields}.
        slots:
          recordType: path.recordType
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'