# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 State Tax Exemptions API
  version: 1.0.0
extends: openapi/optimizely-state-tax-exemptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/StateTaxExemptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List state tax exemptions
      effect: read
      questions:
      - Which tax exemptions apply in which states?
      - Can I filter state tax exemptions to a single state?
      instructions:
      - text: List all state tax exemptions.
      - text: Find state tax exemptions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tax exemption to a state
      effect: write
      questions:
      - How do I make a tax exemption valid in a particular state?
      - Can I link a tax exemption to a state?
      instructions:
      - text: Apply tax exemption {taxExemptionId} to state {stateId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          stateId: requestBody.stateId
      - text: Link state {stateId} to exemption {taxExemptionId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          stateId: requestBody.stateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a state tax exemption
      effect: read
      questions:
      - Can I look up one state tax exemption link by ID?
      - Which state and exemption does a given record connect?
      instructions:
      - text: Show state tax exemption {id}.
        slots:
          id: path.id
      - text: Get the state and exemption for record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a state tax exemption
      effect: write
      questions:
      - How do I overwrite a state tax exemption record completely?
      - Can I replace a record with a different state and exemption pair?
      instructions:
      - text: Replace state tax exemption {id} with state {stateId} and exemption {taxExemptionId}.
        slots:
          id: path.id
          stateId: requestBody.stateId
          taxExemptionId: requestBody.taxExemptionId
      - text: Overwrite state exemption record {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a state tax exemption
      effect: destructive
      questions:
      - How do I stop a tax exemption applying in a state?
      - Can I delete a state tax exemption with an ETag check?
      instructions:
      - text: Delete state tax exemption {id}.
        slots:
          id: path.id
      - text: Remove state exemption {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a state tax exemption
      effect: write
      questions:
      - Can I move an existing exemption record to another state?
      - How do I swap the tax exemption on a state record?
      instructions:
      - text: Move state tax exemption {id} to state {stateId}.
        slots:
          id: path.id
          stateId: requestBody.stateId
      - text: Change the exemption on state record {id} to {taxExemptionId}.
        slots:
          id: path.id
          taxExemptionId: requestBody.taxExemptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StateTaxExemptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new state tax exemption
      effect: read
      questions:
      - What defaults does a new state tax exemption start with?
      - Is there an empty template for a state tax exemption?
      instructions:
      - text: Get the default state tax exemption template.
      - text: Show prefilled defaults for a new state tax exemption.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/statetaxexemptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove state tax exemptions
      effect: destructive
      questions:
      - Can I delete many state tax exemptions in one call?
      - How do I bulk remove exemptions from states by ID?
      instructions:
      - text: Bulk delete state tax exemptions {ids}.
        slots:
          ids: query.ids
      - text: Remove the state exemption records with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/statetaxexemptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a state tax exemption
      effect: read
      questions:
      - Can I read a custom property on a state tax exemption?
      - Where are extra fields for a state exemption kept?
      instructions:
      - text: Show custom property {property} on state tax exemption {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get state exemption {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'