# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conversion Management UOM Conversion Admin API
  version: 1.0.0
extends: openapi/conga-uom-conversion-admin-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List unit of measure conversion rates
      effect: read
      questions:
      - What unit of measure conversion rates are set up, for example from Box to Each?
      - Can I filter conversion rates by source unit and sort them by modified date?
      instructions:
      - text: List all UOM conversion rates.
      - text: List UOM conversion rates where {criteria}, sorted by {sortField} {sortDirection}.
        slots:
          criteria: query.criteria
          sortField: query.sortField
          sortDirection: query.sortDirection
      - text: Show page {pageNumber} of conversion rates, {pageSize} per page.
        slots:
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a unit of measure conversion rate
      effect: write
      questions:
      - How do I define how many Each are in a Box for a product?
      - Can a single conversion rate apply to a whole product family?
      instructions:
      - text: Add a conversion rate of {ConversionRate} from {FromUOM} to {ToUOM}.
        slots:
          ConversionRate: requestBody.ConversionRate
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
      - text: Create a {FromUOM} to {ToUOM} rate of {ConversionRate} for product family {ProductFamily}.
        slots:
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
          ConversionRate: requestBody.ConversionRate
          ProductFamily: requestBody.ProductFamily
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many UOM conversion rates at once
      effect: write
      questions:
      - Can I change a whole batch of unit conversion rates in a single request?
      - Does a bulk update of conversion rates tell me the status of the request?
      instructions:
      - text: Bulk update these existing UOM conversion rates.
      - text: Apply new values to multiple unit conversion rates at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many UOM conversion rates at once
      effect: write
      questions:
      - Can I load a list of new unit conversion rates in one go?
      - Is there a bulk create for UOM conversion rates?
      instructions:
      - text: Bulk create these new UOM conversion rates.
      - text: Add this full list of unit conversion rates in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one UOM conversion rate
      effect: read
      questions:
      - Can I look up the details of one conversion rate record by its ID?
      - Which units and rate does a particular conversion rate record hold?
      instructions:
      - text: Get UOM conversion rate {id}.
        slots:
          id: path.id
      - text: Show the source unit, target unit and rate stored on {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one UOM conversion rate
      effect: write
      questions:
      - Can I correct the rate on a single unit conversion record?
      - Which call edits one conversion rate without touching the rest?
      instructions:
      - text: Update UOM conversion rate {id}.
        slots:
          id: path.id
      - text: Change the values on conversion rate record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/uom-conversion-rates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a UOM conversion rate
      effect: destructive
      questions:
      - Can I remove a unit conversion rate that's no longer valid?
      - What happens when I delete one conversion rate by its ID?
      instructions:
      - text: Delete UOM conversion rate {id}.
        slots:
          id: path.id
      - text: Remove the unit conversion record with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'