# 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 Price Matrices API
  version: 1.0.0
extends: openapi/optimizely-price-matrices-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/PriceMatrices'].get
  update:
    x-apievangelist-phrasing:
      intent: List price matrices
      effect: read
      questions:
      - Which price matrix records are set up for customer and product pricing?
      - Can I filter price matrices by currency or warehouse?
      - How do I see only the price matrices that apply to one customer?
      instructions:
      - text: List all price matrix records.
      - text: Find price matrices matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} price matrices ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a price matrix
      effect: write
      questions:
      - How do I set up quantity break pricing for a product in a price matrix?
      - Can a new price matrix be scheduled to activate on a future date?
      instructions:
      - text: Create a price matrix for product {productId} and customer {customerId} in currency {currencyCode}.
        slots:
          productId: requestBody.productId
          customerId: requestBody.customerId
          currencyCode: requestBody.currencyCode
      - text: Add a price matrix with first break at quantity {breakQty01} priced {amount01}, active from {activateOn}.
        slots:
          breakQty01: requestBody.breakQty01
          amount01: requestBody.amount01
          activateOn: requestBody.activateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price matrix
      effect: read
      questions:
      - What quantity breaks and amounts does a particular price matrix define?
      - When does a specific price matrix activate and expire?
      instructions:
      - text: Get price matrix {id}.
        slots:
          id: path.id
      - text: Show the break quantities and amounts of price matrix {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a price matrix
      effect: write
      questions:
      - How do I overwrite an entire price matrix record at once?
      - Does replacing a price matrix reset break levels I do not send?
      instructions:
      - text: Replace price matrix {id} with a full record in currency {currencyCode}.
        slots:
          id: path.id
          currencyCode: requestBody.currencyCode
      - text: Overwrite price matrix {id} with record type {recordType} for product {productId}.
        slots:
          id: path.id
          recordType: requestBody.recordType
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a price matrix
      effect: destructive
      questions:
      - How do I permanently delete one price matrix?
      - Can I require an ETag match before a price matrix is deleted?
      instructions:
      - text: Delete price matrix {id}.
        slots:
          id: path.id
      - text: Delete price matrix {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price matrix
      effect: write
      questions:
      - Can I change the expiry date of a price matrix without resending it all?
      - How do I adjust just the first break amount on an existing price matrix?
      instructions:
      - text: Set price matrix {id} to deactivate on {deactivateOn}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
      - text: Change the first break amount on price matrix {id} to {amount01}.
        slots:
          id: path.id
          amount01: requestBody.amount01
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank price matrix template
      effect: read
      questions:
      - What default values does a new price matrix start with?
      - Is there an empty price matrix template I can fetch first?
      instructions:
      - text: Fetch the default price matrix template.
      - text: Show default field values for a new price matrix.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PriceMatrices/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive price matrices via the archive action
      effect: write
      questions:
      - How do I archive old price matrices using the OData archive action?
      - Can I archive price matrices with a POST instead of deleting them?
      instructions:
      - text: Run the archive action on price matrices {ids}.
        slots:
          ids: query.ids
      - text: Archive price matrices {ids} through the Default.archive action.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pricematrices/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive price matrices via the DELETE route
      effect: destructive
      questions:
      - Is there a DELETE archive route that takes price matrices out of use?
      - What happens when I call the price matrix archive route with a list of IDs?
      instructions:
      - text: Archive price matrices {ids} using the DELETE archive route.
        slots:
          ids: query.ids
      - text: Send price matrices {ids} to the archive route to retire them.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pricematrices/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete price matrices
      effect: destructive
      questions:
      - How do I permanently delete several price matrices at once?
      - Can I purge a batch of price matrices by ID rather than archive them?
      instructions:
      - text: Bulk delete price matrices {ids}.
        slots:
          ids: query.ids
      - text: 'Permanently remove these price matrices in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pricematrices({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a price matrix
      effect: read
      questions:
      - What value does a custom property hold on a specific price matrix?
      - Can I read one custom property from a price matrix record?
      instructions:
      - text: Get custom property {custompropertyKey} on price matrix {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show price matrix {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'