API Evangelist conversational phrasing for Cart - V1 Ramp Line Items API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cart - V1 Ramp Line Items API
  version: 1.0.0
extends: openapi/conga-ramplineitems-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: 9
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramp-lines'].put
  update:
    x-apievangelist-phrasing:
      intent: Update all ramp lines in a cart
      effect: write
      questions:
      - Can I update every ramp line in a quote cart at once?
      - Can I change the ramp lines across a whole cart in one request?
      instructions:
      - text: Update the ramp line items across cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Save my edits to all ramp lines in cart {cartId} together.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramp-lines'].post
  update:
    x-apievangelist-phrasing:
      intent: Mass-create ramp lines in a cart
      effect: write
      questions:
      - How do I create ramp lines for many cart line items in one go?
      - Can I mass-ramp several products in a cart across the same ramp periods?
      instructions:
      - text: Mass-create ramp lines in cart {cartId} for line items {lineItems}.
        slots:
          cartId: path.cartId
          lineItems: requestBody.lineItems
      - text: Create ramp lines in cart {cartId} using ramp periods {rampPeriods}.
        slots:
          cartId: path.cartId
          rampPeriods: requestBody.rampPeriods
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramp-lines'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the ramp lines in a cart
      effect: destructive
      questions:
      - Is there a way to remove all the ramp lines from a cart?
      - What happens to a cart's ramped pricing when I clear its ramp lines?
      instructions:
      - text: Delete the ramp line items from cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Clear every ramp line out of cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/auto-ramps'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-generate ramps for a cart line item
      effect: write
      questions:
      - Can Conga generate ramp periods automatically for a single line item by frequency?
      - How do I auto-ramp a product line over a set number of periods?
      instructions:
      - text: Auto-ramp line item {itemId} in cart {cartId} into {noOfPeriods} periods.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          noOfPeriods: requestBody.noOfPeriods
      - text: Auto-create {frequency} ramps for line {itemId} of cart {cartId} starting {startDate}.
        slots:
          frequency: requestBody.frequency
          itemId: path.itemId
          cartId: path.cartId
          startDate: requestBody.startDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/ramp-lines'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one line item's ramp line
      effect: write
      questions:
      - What's the way to edit the ramp line on one specific cart line item?
      - Can I rename a single ramp line without touching the rest of the cart?
      instructions:
      - text: Update the ramp line on item {itemId} in cart {cartId}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Rename the ramp line for line {itemId} of cart {cartId} to {name}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/ramp-lines'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a ramp line to a cart line item
      effect: write
      questions:
      - How do I add another ramp period line to a product in my cart?
      - Can I set a different quantity and dates on a new ramp line for one product?
      instructions:
      - text: Add a ramp line to item {itemId} in cart {cartId} with quantity {quantity}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          quantity: requestBody.quantity
      - text: Add a ramp line to line {itemId} of cart {cartId} running {startDate} to {endDate}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/ramp-lines'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one line item's ramp line
      effect: destructive
      questions:
      - Can I delete the ramp line from just one product in a cart?
      - Can I remove a single ramp line by its ID?
      instructions:
      - text: Delete the ramp line on item {itemId} in cart {cartId}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Remove ramp line {id} from line {itemId} of cart {cartId}.
        slots:
          id: requestBody.id
          itemId: path.itemId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/ramp-lines/split'].put
  update:
    x-apievangelist-phrasing:
      intent: Split a ramp line into periods
      effect: write
      questions:
      - How do I split one ramp line into several shorter periods?
      - Can I break a yearly ramp line into quarterly splits?
      instructions:
      - text: Split the ramp line on item {itemId} of cart {cartId} into {noOfSplits} periods.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          noOfSplits: requestBody.noOfSplits
      - text: Split ramp line {itemId} in cart {cartId} using periods {splitPeriods}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
          splitPeriods: requestBody.splitPeriods
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/ramp-periods'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate ramp periods for a cart
      effect: write
      questions:
      - What ramp periods would a cart get for a given term and frequency?
      - Is there a way to generate the ramp schedule for a cart from a start and end date?
      instructions:
      - text: Generate {frequency} ramp periods for cart {cartId}.
        slots:
          frequency: requestBody.frequency
          cartId: path.cartId
      - text: Generate ramp periods for cart {cartId} from {startDate} to {endDate}.
        slots:
          cartId: path.cartId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'