# 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 Product Tax Exemptions API
  version: 1.0.0
extends: openapi/optimizely-product-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/ProductTaxExemptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List product tax exemptions
      effect: read
      questions:
      - Which products carry a tax exemption in Optimizely Commerce?
      - Can I filter tax exemptions to a single product?
      instructions:
      - text: List all product tax exemptions.
      - text: Show product tax exemptions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductTaxExemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Exempt a product from a tax
      effect: write
      questions:
      - How do I make a product exempt from a particular tax?
      - What two ids link a product to a tax exemption?
      instructions:
      - text: Apply tax exemption {taxExemptionId} to product {productId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          productId: requestBody.productId
      - text: Exempt product {productId} using exemption {taxExemptionId}.
        slots:
          productId: requestBody.productId
          taxExemptionId: requestBody.taxExemptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductTaxExemptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product tax exemption
      effect: read
      questions:
      - Which product and exemption does a given exemption link connect?
      - Can I look up one product tax exemption by id?
      instructions:
      - text: Fetch product tax exemption {id}.
        slots:
          id: path.id
      - text: Show the product and exemption behind link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductTaxExemptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product tax exemption link
      effect: write
      questions:
      - Can I overwrite a product tax exemption record entirely?
      - Does a full replace of an exemption link need both product and exemption ids?
      instructions:
      - text: Replace product tax exemption {id} with product {productId} and exemption {taxExemptionId}.
        slots:
          id: path.id
          productId: requestBody.productId
          taxExemptionId: requestBody.taxExemptionId
      - text: Overwrite the full record of product tax exemption {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductTaxExemptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product's tax exemption
      effect: destructive
      questions:
      - How do I make a product taxable again by removing its exemption?
      - Can removing a product tax exemption be guarded by an ETag?
      instructions:
      - text: Delete product tax exemption {id}.
        slots:
          id: path.id
      - text: Delete product tax 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/ProductTaxExemptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch a product exemption to another tax
      effect: write
      questions:
      - Can I point an existing product exemption at a different tax exemption?
      - Is it possible to move an exemption link onto another product?
      instructions:
      - text: Change product tax exemption {id} to use exemption {taxExemptionId}.
        slots:
          id: path.id
          taxExemptionId: requestBody.taxExemptionId
      - text: Move exemption link {id} onto product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductTaxExemptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a product exemption
      effect: read
      questions:
      - What defaults does a new product tax exemption start with?
      - Is there a blank product tax exemption template?
      instructions:
      - text: Get the default field values for a new product tax exemption.
      - text: Show the empty product exemption template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/producttaxexemptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete product tax exemptions
      effect: destructive
      questions:
      - Can I remove many product tax exemptions at once?
      - Is there a batch delete for product exemptions by id list?
      instructions:
      - text: Bulk delete product tax exemptions {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every product exemption in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/producttaxexemptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a product exemption
      effect: read
      questions:
      - How can I read a custom property stored on a product tax exemption?
      - Can I fetch one custom field value from a product exemption record?
      instructions:
      - text: Get custom property {custompropertyKey} of product tax exemption {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on product exemption {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'