# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Settings Multicurrency Exchange rates API
  version: 1.0.0
extends: openapi/hubspot-exchange-rates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/settings/currencies/2026-09/exchange-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List exchange rates
      effect: read
      questions:
      - What exchange rate history do I have for euros to dollars?
      - Can I filter exchange rates by the currency I'm converting from?
      instructions:
      - text: List exchange rates from {fromCurrencyCode} to {toCurrencyCode}.
        slots:
          fromCurrencyCode: query.fromCurrencyCode
          toCurrencyCode: query.toCurrencyCode
      - text: Page through all exchange rate records, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/currencies/2026-09/exchange-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an exchange rate
      effect: write
      questions:
      - How do I add a new conversion rate for a currency?
      - Can I set the date a new exchange rate takes effect?
      instructions:
      - text: Add an exchange rate of {conversionRate} for {fromCurrencyCode}.
        slots:
          conversionRate: requestBody.conversionRate
          fromCurrencyCode: requestBody.fromCurrencyCode
      - text: Create a {fromCurrencyCode} rate of {conversionRate} effective {effectiveAt}.
        slots:
          fromCurrencyCode: requestBody.fromCurrencyCode
          conversionRate: requestBody.conversionRate
          effectiveAt: requestBody.effectiveAt
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/currencies/2026-09/exchange-rates/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current exchange rates
      effect: read
      questions:
      - What are today's conversion rates for every currency pair in my account?
      - Which rate is currently in effect for each currency pair?
      instructions:
      - text: Show the current exchange rate for every currency pair.
      - text: Get all rates in effect right now.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/currencies/2026-09/exchange-rates/update-visibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Show or hide a currency pair
      effect: write
      questions:
      - Can I hide a currency pair from users in the multi-currency settings?
      - How do I make a hidden currency pair visible again?
      instructions:
      - text: 'Set the {fromCurrencyCode} to {toCurrencyCode} pair visible in the app: {visibleInUI}.'
        slots:
          fromCurrencyCode: requestBody.fromCurrencyCode
          toCurrencyCode: requestBody.toCurrencyCode
          visibleInUI: requestBody.visibleInUI
      - text: Show currency pair {fromCurrencyCode}/{toCurrencyCode} in the app.
        slots:
          fromCurrencyCode: requestBody.fromCurrencyCode
          toCurrencyCode: requestBody.toCurrencyCode
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/currencies/2026-09/exchange-rates/{exchangeRateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one exchange rate
      effect: read
      questions:
      - How do I look up a single exchange rate record by its ID?
      - When did a specific exchange rate take effect?
      instructions:
      - text: Get exchange rate {exchangeRateId}.
        slots:
          exchangeRateId: path.exchangeRateId
      - text: Show the details of rate record {exchangeRateId}.
        slots:
          exchangeRateId: path.exchangeRateId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/currencies/2026-09/exchange-rates/{exchangeRateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing conversion rate
      effect: write
      questions:
      - Can I correct a conversion rate I already entered?
      - How do I change the effective date on an existing exchange rate?
      instructions:
      - text: Change exchange rate {exchangeRateId} to {conversionRate}.
        slots:
          exchangeRateId: path.exchangeRateId
          conversionRate: requestBody.conversionRate
      - text: Update rate {exchangeRateId} to {conversionRate} effective {effectiveAt}.
        slots:
          exchangeRateId: path.exchangeRateId
          conversionRate: requestBody.conversionRate
          effectiveAt: requestBody.effectiveAt
      method: generated
      generated: '2026-09-24'