# 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 Country Vat Rates API
  version: 1.0.0
extends: openapi/optimizely-country-vat-rates-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/CountryVatRates'].get
  update:
    x-apievangelist-phrasing:
      intent: List country VAT rates
      effect: read
      questions:
      - How do I see the VAT rates configured per country in Optimizely Configured Commerce?
      - Can I filter VAT rates to a single country or VAT code?
      instructions:
      - text: List all country VAT rates.
      - text: List country VAT rates matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CountryVatRates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a VAT rate for a country
      effect: write
      questions:
      - How can I set up a new VAT rate for a country and VAT code?
      - Can I mark a country VAT rate as non-taxable when creating it?
      instructions:
      - text: Create a VAT rate of {taxRate} for country {countryId} and VAT code {vatCodeId}.
        slots:
          taxRate: requestBody.taxRate
          countryId: requestBody.countryId
          vatCodeId: requestBody.vatCodeId
      - text: Add a country VAT rate for {countryId} with taxable set to {taxable}.
        slots:
          countryId: requestBody.countryId
          taxable: requestBody.taxable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CountryVatRates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one country VAT rate
      effect: read
      questions:
      - What rate is stored on a particular country VAT rate record?
      - Can I expand the country when fetching a single VAT rate?
      instructions:
      - text: Show country VAT rate {id}.
        slots:
          id: path.id
      - text: Get country VAT rate {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CountryVatRates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a country VAT rate
      effect: write
      questions:
      - Can I overwrite a country VAT rate record with all new values?
      - What's the call to fully replace a VAT rate entry?
      instructions:
      - text: Replace country VAT rate {id} with rate {taxRate} for country {countryId}.
        slots:
          id: path.id
          taxRate: requestBody.taxRate
          countryId: requestBody.countryId
      - text: Overwrite VAT rate record {id} entirely, using VAT code {vatCodeId}.
        slots:
          id: path.id
          vatCodeId: requestBody.vatCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CountryVatRates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a country VAT rate
      effect: destructive
      questions:
      - How do I remove one country's VAT rate record?
      - Can I delete a VAT rate only if nobody has changed it?
      instructions:
      - text: Delete country VAT rate {id}.
        slots:
          id: path.id
      - text: Delete country VAT rate {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/CountryVatRates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a country VAT rate
      effect: write
      questions:
      - The VAT rate changed in a country, can I update just the percentage?
      - How do I toggle whether a country VAT rate is taxable?
      instructions:
      - text: Patch country VAT rate {id} to a rate of {taxRate}.
        slots:
          id: path.id
          taxRate: requestBody.taxRate
      - text: Update country VAT rate {id} so taxable is {taxable}.
        slots:
          id: path.id
          taxable: requestBody.taxable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CountryVatRates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a VAT rate
      effect: read
      questions:
      - What defaults are pre-filled for a new country VAT rate?
      - Is there a blank VAT rate template?
      instructions:
      - text: Get the default country VAT rate template.
      - text: Show pre-filled values for a new country VAT rate.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/countryvatrates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several country VAT rates
      effect: destructive
      questions:
      - Can I bulk delete a set of country VAT rates?
      - How do I remove many VAT rate records in one call?
      instructions:
      - text: Bulk delete country VAT rates {ids}.
        slots:
          ids: query.ids
      - text: Remove every VAT rate record in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/countryvatrates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a VAT rate
      effect: read
      questions:
      - Can I read a custom property on a country VAT rate?
      - Where are custom attributes on a VAT rate stored?
      instructions:
      - text: Get custom property {custompropertyKey} on country VAT rate {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show VAT rate {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'