# 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 Currencies API
  version: 1.0.0
extends: openapi/optimizely-currencies-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: 11
- target: $.paths['/api/v1/admin/Currencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List currencies
      effect: read
      questions:
      - Which currencies are configured in my Optimizely commerce admin?
      - Can I find which currency is set as the default?
      instructions:
      - text: List all configured currencies.
      - text: List currencies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a currency
      effect: write
      questions:
      - How do I add a new currency like EUR with its symbol?
      - Can I make a newly added currency the default one?
      instructions:
      - text: Add currency {currencyCode} described as {description} with symbol {currencySymbol}.
        slots:
          currencyCode: requestBody.currencyCode
          description: requestBody.description
          currencySymbol: requestBody.currencySymbol
      - text: Create currency {currencyCode} ({description}, {currencySymbol}) with isDefault {isDefault}.
        slots:
          currencyCode: requestBody.currencyCode
          description: requestBody.description
          currencySymbol: requestBody.currencySymbol
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a currency
      effect: read
      questions:
      - What symbol and code does a given currency record use?
      - Can I look up one currency by its id?
      instructions:
      - text: Get currency {id}.
        slots:
          id: path.id
      - text: Show the code and symbol of currency record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a currency record
      effect: write
      questions:
      - How do I overwrite a whole currency definition?
      - Can I replace a currency's code, description and symbol together?
      instructions:
      - text: Replace currency {id} with code {currencyCode}, description {description} and symbol {currencySymbol}.
        slots:
          id: path.id
          currencyCode: requestBody.currencyCode
          description: requestBody.description
          currencySymbol: requestBody.currencySymbol
      - text: Fully overwrite currency record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a currency
      effect: destructive
      questions:
      - How do I remove a currency we no longer sell in?
      - Can I make a currency deletion conditional on its ETag?
      instructions:
      - text: Delete currency {id}.
        slots:
          id: path.id
      - text: Delete currency {id} only if the ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a currency
      effect: write
      questions:
      - How do I change just the symbol of a currency?
      - Can I switch which currency is the default with a partial update?
      instructions:
      - text: Change currency {id}'s symbol to {currencySymbol}.
        slots:
          id: path.id
          currencySymbol: requestBody.currencySymbol
      - text: Set isDefault to {isDefault} on currency {id}.
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Currencies/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default currency
      effect: read
      questions:
      - What does a blank currency object look like before I create one?
      - Is there a starter template for a new currency?
      instructions:
      - text: Get the default template for a new currency.
      - text: Show the blank currency object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencies/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several currencies
      effect: destructive
      questions:
      - Can I delete multiple currencies in one call?
      - How do I bulk-remove currencies by id?
      instructions:
      - text: Delete currencies {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove the currencies with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencies({key})/currencyrates({currencyrateKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exchange rate for a currency
      effect: read
      questions:
      - How do I read one exchange rate record attached to a currency?
      - What conversion rate is stored for a currency?
      instructions:
      - text: Get currency rate {currencyrateKey} for currency {key}.
        slots:
          currencyrateKey: path.currencyrateKey
          key: path.key
      - text: Show exchange rate record {currencyrateKey} of currency {key}.
        slots:
          currencyrateKey: path.currencyrateKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencies({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a currency custom property
      effect: read
      questions:
      - Can I read a custom property stored on a currency?
      - How do I fetch extra custom data attached to a currency?
      instructions:
      - text: Get custom property {custompropertyKey} of currency {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show currency {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/currencies({key})/websitecurrencies({websitecurrencyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's use of a currency
      effect: read
      questions:
      - Is a currency enabled on a particular website?
      - How do I fetch the website-currency link for a currency?
      instructions:
      - text: Get website currency {websitecurrencyKey} for currency {key}.
        slots:
          websitecurrencyKey: path.websitecurrencyKey
          key: path.key
      - text: Show the website assignment {websitecurrencyKey} of currency {key}.
        slots:
          websitecurrencyKey: path.websitecurrencyKey
          key: path.key
      method: generated
      generated: '2026-09-26'