# 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 Order History Taxes API
  version: 1.0.0
extends: openapi/optimizely-order-history-taxes-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/OrderHistoryTaxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List order history tax lines
      effect: read
      questions:
      - Which tax lines are recorded on historical orders?
      - Can I filter order history taxes by tax code?
      instructions:
      - text: List all order history tax lines.
      - text: Find order history taxes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tax line to order history
      effect: write
      questions:
      - How do I record a tax line on an imported historical order?
      - What's required for an order history tax, like code and description?
      instructions:
      - text: Add tax {taxCode} ({taxDescription}) to order history {orderHistoryId}.
        slots:
          taxCode: requestBody.taxCode
          taxDescription: requestBody.taxDescription
          orderHistoryId: requestBody.orderHistoryId
      - text: Record a {taxRate} rate tax of {taxAmount} with code {taxCode}.
        slots:
          taxRate: requestBody.taxRate
          taxAmount: requestBody.taxAmount
          taxCode: requestBody.taxCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order history tax line
      effect: read
      questions:
      - Can I look up one historical order tax line by ID?
      - What rate and amount were charged on a given order history tax?
      instructions:
      - text: Show order history tax {id}.
        slots:
          id: path.id
      - text: Get the rate and amount for order history tax {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order history tax line
      effect: write
      questions:
      - How do I overwrite a historical order tax line completely?
      - Does replacing an order history tax need the code and description again?
      instructions:
      - text: Replace order history tax {id} with code {taxCode} and description {taxDescription}.
        slots:
          id: path.id
          taxCode: requestBody.taxCode
          taxDescription: requestBody.taxDescription
      - text: Overwrite all fields of order history tax {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order history tax line
      effect: destructive
      questions:
      - How do I remove a tax line from a historical order?
      - Can an order history tax delete require a matching ETag?
      instructions:
      - text: Delete order history tax {id}.
        slots:
          id: path.id
      - text: Delete order history tax {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct an order history tax line
      effect: write
      questions:
      - Can I fix only the tax amount on a historical order line?
      - How do I change the sort order of an order history tax?
      instructions:
      - text: Set the tax amount on order history tax {id} to {taxAmount}.
        slots:
          id: path.id
          taxAmount: requestBody.taxAmount
      - text: Change the rate of order history tax {id} to {taxRate}.
        slots:
          id: path.id
          taxRate: requestBody.taxRate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryTaxes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new order history tax
      effect: read
      questions:
      - What defaults does a new order history tax line start with?
      - Is there an empty template for an order history tax?
      instructions:
      - text: Get the default order history tax template.
      - text: Show prefilled defaults for a new order history tax line.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderhistorytaxes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order history tax lines
      effect: destructive
      questions:
      - Can I delete many historical order tax lines at once?
      - How do I bulk remove order history taxes by ID?
      instructions:
      - text: Bulk delete order history taxes {ids}.
        slots:
          ids: query.ids
      - text: Remove the order history tax lines with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderhistorytaxes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an order history tax
      effect: read
      questions:
      - Can I read a custom property on an order history tax line?
      - Where are extra fields for a historical tax line stored?
      instructions:
      - text: Show custom property {property} on order history tax {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get tax line {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'