# 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 Shipment Package Lines API
  version: 1.0.0
extends: openapi/optimizely-shipment-package-lines-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/ShipmentPackageLines'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipment package lines
      effect: read
      questions:
      - Which products were packed in each shipment package?
      - Can I filter shipment package lines to one package?
      instructions:
      - text: List all shipment package lines.
      - text: Show shipment package lines matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product line to a shipment package
      effect: write
      questions:
      - How do I record what was packed in a shipment package?
      - Can I note quantity shipped versus ordered on a package line?
      instructions:
      - text: Add {productName} ({productCode}, {productDescription}) to shipment package {shipmentPackageId}.
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          shipmentPackageId: requestBody.shipmentPackageId
      - text: Create a package line for {productCode} {productName}, {productDescription}, shipped qty {qtyShipped}.
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          qtyShipped: requestBody.qtyShipped
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipment package line
      effect: read
      questions:
      - How many units of a product shipped on a given package line?
      - Can I look up one shipment package line by ID?
      instructions:
      - text: Get shipment package line {id}.
        slots:
          id: path.id
      - text: Show quantities shipped on package line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a shipment package line
      effect: write
      questions:
      - How do I overwrite every field of a shipment package line?
      - Can I fully replace a package line record?
      instructions:
      - text: Replace package line {id} with {productName} ({productCode}), {productDescription}.
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          id: path.id
      - text: 'Overwrite all fields of shipment package line {id}: code {productCode}, name {productName}, description {productDescription}.'
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipment package line
      effect: destructive
      questions:
      - How do I remove one line from a shipment package?
      - Does deleting a package line honor an If-Match header?
      instructions:
      - text: Delete shipment package line {id}.
        slots:
          id: path.id
      - text: Remove package line {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct the shipped quantity on a package line
      effect: write
      questions:
      - How do I fix the quantity shipped on an existing package line?
      - Can I update the price recorded on a shipment package line?
      instructions:
      - text: Set qty shipped to {qtyShipped} on existing package line {id} ({productCode}, {productName}, {productDescription}).
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          id: path.id
          qtyShipped: requestBody.qtyShipped
      - text: Update the price on package line {id} to {price} for {productCode} {productName}, {productDescription}.
        slots:
          productName: requestBody.productName
          productDescription: requestBody.productDescription
          productCode: requestBody.productCode
          id: path.id
          price: requestBody.price
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackageLines/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new shipment package line
      effect: read
      questions:
      - What defaults does a new shipment package line start with?
      - Is there a blank package line template?
      instructions:
      - text: Get the default field values for a new shipment package line.
      - text: Show a blank shipment package line record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipmentpackagelines/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several shipment package lines
      effect: destructive
      questions:
      - How do I bulk delete shipment package lines?
      - Can I remove many package lines in one request?
      instructions:
      - text: Bulk delete shipment package lines {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every package line in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipmentpackagelines({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a package line
      effect: read
      questions:
      - How do I read a custom property on a shipment package line?
      - Can I fetch one custom field value from a package line?
      instructions:
      - text: Get custom property {custompropertyKey} of shipment package line {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on package line {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'