# 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 Vat Codes API
  version: 1.0.0
extends: openapi/optimizely-vat-codes-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: 10
- target: $.paths['/api/v1/admin/VatCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List VAT codes
      effect: read
      questions:
      - How do I list every VAT code configured in the commerce admin?
      - Can I filter VAT codes by name?
      - How many VAT codes are defined?
      instructions:
      - text: List all VAT codes.
      - text: Find VAT codes matching {filter}.
        slots:
          filter: query.$filter
      - text: Count the VAT codes that match {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VatCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a VAT code
      effect: write
      questions:
      - How do I add a new VAT code for taxing products?
      - What does a VAT code need besides a name?
      instructions:
      - text: Create a VAT code named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add VAT code {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VatCodes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VAT code
      effect: read
      questions:
      - How do I look up a single VAT code by ID?
      - Can I expand a VAT code to include its country rates?
      instructions:
      - text: Get VAT code {id}.
        slots:
          id: path.id
      - text: Show VAT code {id} expanded with {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VatCodes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a VAT code
      effect: write
      questions:
      - How do I overwrite a VAT code record in full?
      - Does replacing a VAT code require both name and description?
      instructions:
      - text: Replace VAT code {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite every field of VAT code {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VatCodes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VAT code
      effect: destructive
      questions:
      - How do I delete one VAT code?
      - Can I delete a VAT code only if it hasn't changed since I read it?
      instructions:
      - text: Delete VAT code {id}.
        slots:
          id: path.id
      - text: Delete VAT code {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/VatCodes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a VAT code
      effect: write
      questions:
      - How do I rename an existing VAT code?
      - Can I change just a VAT code's description?
      instructions:
      - text: Rename VAT code {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the description of VAT code {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VatCodes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default VAT code template
      effect: read
      questions:
      - What default values does a new VAT code start with?
      - Can I fetch a blank VAT code template?
      instructions:
      - text: Fetch the default VAT code template.
      - text: Show me the defaults for a new VAT code.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vatcodes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete VAT codes
      effect: destructive
      questions:
      - How do I delete several VAT codes at once?
      - Can I remove VAT codes by passing a list of IDs?
      instructions:
      - text: Bulk delete the VAT codes {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these VAT codes in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vatcodes({key})/countryvatrates({countryvatrateKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a country VAT rate for a VAT code
      effect: read
      questions:
      - What VAT rate applies to a VAT code in a particular country?
      - Can I look up one country rate under a VAT code?
      instructions:
      - text: Get country VAT rate {countryvatrateKey} for VAT code {key}.
        slots:
          countryvatrateKey: path.countryvatrateKey
          key: path.key
      - text: Show the country rate {countryvatrateKey} under VAT code {key}.
        slots:
          countryvatrateKey: path.countryvatrateKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vatcodes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a VAT code
      effect: read
      questions:
      - How do I read a custom property stored on a VAT code?
      - Can I fetch one extra property from a VAT code record?
      instructions:
      - text: Get custom property {custompropertyKey} on VAT code {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show VAT code {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'