# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Settings API
  version: 1.0.0
extends: openapi/avalara-settings-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['/api/v2/companies/{companyId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's settings
      effect: read
      questions:
      - Which custom settings are stored on my company?
      - Can I filter a company's settings by set or name?
      instructions:
      - text: List settings for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show settings for company {companyId} matching {filter}.
        slots:
          companyId: path.companyId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create company settings
      effect: write
      questions:
      - How do I store preference data for my integration on a company?
      - Can I create several setting objects for a company at once?
      instructions:
      - text: Create settings for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Store new setting values on company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single company setting
      effect: read
      questions:
      - Can I fetch one stored setting by its ID?
      - What value does a specific company setting hold?
      instructions:
      - text: Get setting {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show company setting {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company setting
      effect: write
      questions:
      - How do I change the value of a stored company setting?
      - Does replacing a setting overwrite the whole object?
      instructions:
      - text: Update setting {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace company setting {id} with a new value.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company setting
      effect: destructive
      questions:
      - How do I remove a setting my connector no longer needs?
      - Can I delete a single company setting?
      instructions:
      - text: Delete setting {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark company setting {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Search settings across all companies
      effect: read
      questions:
      - Which settings are stored across every company in my account?
      - Can I query settings without choosing a single company?
      instructions:
      - text: List settings across all my companies.
      - text: Query every company's stored settings in the account.
      method: generated
      generated: '2026-10-01'