# 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 Currency Rates API
  version: 1.0.0
extends: openapi/optimizely-currency-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/CurrencyRates'].get
  update:
    x-apievangelist-phrasing:
      intent: List currency conversion rates
      effect: read
      questions:
      - What currency conversion rates are configured in my commerce store?
      - Can I filter currency rates to one currency or effective date?
      - Which exchange rates will take effect soonest?
      instructions:
      - text: List all currency rates.
      - text: List currency rates matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} currency rates ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a currency conversion rate
      effect: write
      questions:
      - How do I add a new exchange rate for a currency?
      - Can I schedule a conversion rate to start on a future effective date?
      instructions:
      - text: Add a conversion rate of {conversionRate} for currency {currencyId} effective {effectiveDate}.
        slots:
          conversionRate: requestBody.conversionRate
          currencyId: requestBody.currencyId
          effectiveDate: requestBody.effectiveDate
      - text: Create a new currency rate record for currency {currencyId}.
        slots:
          currencyId: requestBody.currencyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one currency rate
      effect: read
      questions:
      - What conversion rate and effective date does a specific currency rate record hold?
      - Can I fetch a single exchange rate entry by its ID?
      instructions:
      - text: Get currency rate {id}.
        slots:
          id: path.id
      - text: Show currency rate {id} with only fields {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a currency rate record
      effect: write
      questions:
      - Is there a way to overwrite a whole currency rate record at once?
      - What call fully replaces an existing exchange rate entry?
      instructions:
      - text: Replace currency rate {id} with rate {conversionRate} effective {effectiveDate}.
        slots:
          id: path.id
          conversionRate: requestBody.conversionRate
          effectiveDate: requestBody.effectiveDate
      - text: Overwrite the full currency rate record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one currency rate
      effect: destructive
      questions:
      - How do I remove an exchange rate that was entered by mistake?
      - Can I delete a single currency rate by ID?
      instructions:
      - text: Delete currency rate {id}.
        slots:
          id: path.id
      - text: Remove currency rate record {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a currency conversion rate
      effect: write
      questions:
      - Can I change just the conversion rate value of an existing currency rate?
      - How do I move the effective date of an exchange rate already on file?
      instructions:
      - text: Change the conversion rate on currency rate {id} to {conversionRate}.
        slots:
          id: path.id
          conversionRate: requestBody.conversionRate
      - text: Patch currency rate {id} so it takes effect on {effectiveDate}.
        slots:
          id: path.id
          effectiveDate: requestBody.effectiveDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CurrencyRates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on currency rates
      effect: read
      questions:
      - What does the Default function on the currency rates entity set return?
      - Is there a Default operation exposed for currency rates?
      instructions:
      - text: Call the Default function on currency rates.
      - text: Run the currency rates Default operation and show what it returns.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencyrates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete currency rates by ID
      effect: destructive
      questions:
      - Can I delete many currency rates in one call?
      - How do I clear out a batch of outdated exchange rates by ID?
      instructions:
      - text: Delete the currency rates with IDs {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove currency rates {ids} together.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencyrates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a currency rate
      effect: read
      questions:
      - How can I read a custom property attached to a currency rate?
      - Do currency rate records support custom properties I can look up by key?
      instructions:
      - text: Get custom property {custompropertyKey} of currency rate {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} on currency rate {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'