# 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 Vmi Counts API
  version: 1.0.0
extends: openapi/optimizely-vmi-counts-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/VmiCounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List VMI bin counts
      effect: read
      questions:
      - What inventory counts have been recorded for vendor managed inventory bins in Optimizely commerce?
      - Can I filter VMI counts to one bin?
      instructions:
      - text: List all VMI counts.
      - text: List VMI counts matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a VMI bin count
      effect: write
      questions:
      - How do I record how many units of a product are in a VMI bin?
      - Can I log a new stock count for a vendor managed inventory bin?
      instructions:
      - text: Record a count of {count} for product {productId} in VMI bin {vmiBinId}.
        slots:
          count: requestBody.count
          productId: requestBody.productId
          vmiBinId: requestBody.vmiBinId
      - text: Log VMI bin {vmiBinId} count as {count}.
        slots:
          count: requestBody.count
          vmiBinId: requestBody.vmiBinId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VMI count
      effect: read
      questions:
      - What count was recorded in a specific VMI count record?
      - How do I fetch one VMI count by id?
      instructions:
      - text: Get VMI count {id}.
        slots:
          id: path.id
      - text: Show the bin, product and quantity of VMI count {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a VMI count record
      effect: write
      questions:
      - How do I overwrite a whole VMI count record?
      - Can I replace the bin, product and count of a VMI count together?
      instructions:
      - text: Replace VMI count {id} with bin {vmiBinId}, product {productId} and count {count}.
        slots:
          id: path.id
          vmiBinId: requestBody.vmiBinId
          productId: requestBody.productId
          count: requestBody.count
      - text: Fully overwrite VMI count record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VMI count
      effect: destructive
      questions:
      - How do I remove an incorrect VMI count?
      - Can I delete a VMI count only if its ETag matches?
      instructions:
      - text: Delete VMI count {id}.
        slots:
          id: path.id
      - text: Delete VMI count {id} if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct a VMI count quantity
      effect: write
      questions:
      - How do I fix the quantity on an existing VMI count?
      - Can I update just the count number without touching the bin?
      instructions:
      - text: Change VMI count {id} to {count} units.
        slots:
          id: path.id
          count: requestBody.count
      - text: Reassign VMI count {id} to product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiCounts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default VMI count
      effect: read
      questions:
      - What does an empty VMI count object look like?
      - Is there a template for a new VMI count?
      instructions:
      - text: Get the default template for a new VMI count.
      - text: Show the blank VMI count object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vmicounts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several VMI counts
      effect: destructive
      questions:
      - Can I delete multiple VMI counts at once?
      - How do I bulk-remove VMI counts by id?
      instructions:
      - text: Delete VMI counts {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove the VMI counts with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vmicounts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VMI count custom property
      effect: read
      questions:
      - How do I read a custom property on a VMI count?
      - Can VMI counts store custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of VMI count {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show VMI count {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'