API Evangelist conversational phrasing for Cart - V1 Cart Actions 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 Cart Actions API
  version: 1.0.0
extends: openapi/conga-cart-actions-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: 24
- target: $.paths['/api/cart/v1/carts/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest active cart
      effect: read
      questions:
      - Which cart is currently active for my quote?
      - How do I find the newest New or Saved cart for a quote?
      instructions:
      - text: Get the latest active cart.
      - text: Find the active cart matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/abandon'].post
  update:
    x-apievangelist-phrasing:
      intent: Abandon a cart
      effect: destructive
      questions:
      - How do I abandon a cart I no longer need?
      - Can an abandoned cart be used again afterwards?
      instructions:
      - text: Abandon cart {cart}.
        slots:
          cart: path.cartId
      - text: Mark cart {cart} as abandoned.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a cart
      effect: write
      questions:
      - Which cart statuses are allowed to be activated?
      - How do I make a saved cart the active one?
      instructions:
      - text: Activate cart {cart}.
        slots:
          cart: path.cartId
      - text: Activate cart {cart} in the {flow} flow.
        slots:
          cart: path.cartId
          flow: header.FlowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applied-rule-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule actions applied to a cart
      effect: read
      questions:
      - Which constraint rule actions have already been applied to my cart?
      - Can I see applied rule actions for one primary line of a cart?
      instructions:
      - text: List the applied rule actions on cart {cart}.
        slots:
          cart: path.cartId
      - text: Show rule actions applied to line {line} of cart {cart}.
        slots:
          line: query.primarylineNumber
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a whole cart into a new cart
      effect: write
      questions:
      - How do I make a copy of an existing cart as a new cart?
      - Can I clone a cart and keep its approvals?
      instructions:
      - text: Clone cart {cart} into a new cart.
        slots:
          cart: path.cartId
      - text: Copy cart {cart} as a new cart named {name}.
        slots:
          cart: path.cartId
          name: requestBody.name
      - text: Duplicate only lines {lines} of cart {cart} into a fresh cart.
        slots:
          lines: requestBody.lineNumbers
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/clone-lines'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy lines from another cart into a cart
      effect: write
      questions:
      - Can I pull line items from a different cart into the cart I'm working on?
      - How do I copy specific lines into an existing cart without adjustments?
      instructions:
      - text: Copy lines {lines} from cart {source} into cart {cart}.
        slots:
          lines: requestBody.lineNumbers
          source: query.sourceCartId
          cart: path.cartId
      - text: Bring lines from source cart {source} into existing cart {cart}.
        slots:
          source: query.sourceCartId
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/configstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart's configuration status
      effect: read
      questions:
      - Is the product configuration on my cart complete?
      - Can I check configuration status for only certain primary lines?
      instructions:
      - text: Get the configuration status of cart {cart}.
        slots:
          cart: path.cartId
      - text: Check config status for primary lines {lines} in cart {cart}.
        slots:
          lines: query.primaryLineNumbers
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/displayAction'].get
  update:
    x-apievangelist-phrasing:
      intent: Get display actions for a cart
      effect: read
      questions:
      - Which display actions are available on a cart in a given flow?
      - How do I find out what buttons a cart should show in a flow?
      instructions:
      - text: Get display actions for cart {cart} in flow {flow}.
        slots:
          cart: path.cartId
          flow: query.flowName
      - text: List the display action details of cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/finalize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get finalized cart details
      effect: read
      questions:
      - What does my cart look like after it was finalized?
      - How do I read back the finalized details of a cart?
      instructions:
      - text: Show the finalized details of cart {cart}.
        slots:
          cart: path.cartId
      - text: Get what was finalized on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/finalize'].post
  update:
    x-apievangelist-phrasing:
      intent: Finalize a cart
      effect: write
      questions:
      - How do I finalize a cart once products and pricing are settled?
      - Can I finalize a cart while accepting its warnings?
      instructions:
      - text: Finalize cart {cart}.
        slots:
          cart: path.cartId
      - text: 'Finalize cart {cart} and accept warnings: {accepted}.'
        slots:
          cart: path.cartId
          accepted: requestBody.hasAcceptedWarning
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/group/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get line item group metadata for a cart
      effect: read
      questions:
      - How are line items grouped on a cart and what is each group's status?
      - Can I get group metadata for cart line items by a grouping field?
      instructions:
      - text: Get the line item group status of cart {cart} grouped by {group}.
        slots:
          cart: path.cartId
          group: query.group
      - text: Show group metadata for cart {cart} using group {group}.
        slots:
          cart: path.cartId
          group: query.group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/line-numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart's line numbers
      effect: read
      questions:
      - What line numbers exist on a cart?
      - Can I filter which line numbers a cart returns?
      instructions:
      - text: List the line numbers on cart {cart}.
        slots:
          cart: path.cartId
      - text: Get cart {cart} line numbers matching {filter}.
        slots:
          cart: path.cartId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/migrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate a cart
      effect: write
      questions:
      - Can I migrate a cart that has been abandoned or superseded?
      - How do I migrate a cart to the current flow?
      instructions:
      - text: Migrate cart {cart}.
        slots:
          cart: path.cartId
      - text: Migrate cart {cart} using flow {flow}.
        slots:
          cart: path.cartId
          flow: header.FlowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/order'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a cart out into an order
      effect: write
      questions:
      - How do I turn a cart into an order with order line items?
      - Can cart checkout to an order run asynchronously?
      instructions:
      - text: Check out cart {cart} to create an order.
        slots:
          cart: path.cartId
      - text: 'Create an order from cart {cart} asynchronously: {async}.'
        slots:
          cart: path.cartId
          async: query.isAsync
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/promotion'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a promotion to a cart
      effect: write
      questions:
      - How do I add a promotion discount to a cart?
      - Does applying a promotion validate the cart first?
      instructions:
      - text: Apply the promotion to cart {cart}.
        slots:
          cart: path.cartId
      - text: Validate and add a promotion on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/quote'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a cart out into a new quote
      effect: write
      questions:
      - How do I create a quote or proposal from a finalized cart?
      - Can I set the bill-to and ship-to accounts when making a quote from a cart?
      instructions:
      - text: Create a quote from cart {cart}.
        slots:
          cart: path.cartId
      - text: Check out cart {cart} to a proposal named {name}.
        slots:
          cart: path.cartId
          name: requestBody.name
      - text: Make a quote from cart {cart} with primary contact {contact}.
        slots:
          cart: path.cartId
          contact: requestBody.primaryContact
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/revalidation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get revalidation details for a cart
      effect: read
      questions:
      - Does my cart need revalidation after product or price changes?
      - What revalidation details are pending on a cart?
      instructions:
      - text: Get the revalidation details for cart {cart}.
        slots:
          cart: path.cartId
      - text: Show what needs revalidating on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/revalidation'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply revalidation to a cart
      effect: write
      questions:
      - How do I apply pending revalidation to a cart?
      - Can I accept the revalidation changes on my cart?
      instructions:
      - text: Apply revalidation to cart {cart}.
        slots:
          cart: path.cartId
      - text: Run and accept the pending revalidation on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/rule-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all config rules for a cart
      effect: read
      questions:
      - Which configuration rules apply to my cart overall?
      - Can I page through every config rule action on a cart?
      instructions:
      - text: List all config rule actions for cart {cart}.
        slots:
          cart: path.cartId
      - text: Show page {page} of config rules on cart {cart}.
        slots:
          page: query.pagenumber
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/rule-actions/{ruleActionId}/ignore'].post
  update:
    x-apievangelist-phrasing:
      intent: Ignore a rule action on a cart
      effect: write
      questions:
      - How do I dismiss a constraint rule recommendation on my cart?
      - Can I ignore one rule action without changing the cart?
      instructions:
      - text: Ignore rule action {action} on cart {cart}.
        slots:
          action: path.ruleActionId
          cart: path.cartId
      - text: Dismiss rule action {action} for cart {cart}.
        slots:
          action: path.ruleActionId
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart's status
      effect: read
      questions:
      - What is the current status of my cart?
      - Can I check cart status filtered to certain line numbers?
      instructions:
      - text: Get the status of cart {cart}.
        slots:
          cart: path.cartId
      - text: Show cart {cart} status for lines {lines}.
        slots:
          cart: path.cartId
          lines: query.lineNumbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/totals'].post
  update:
    x-apievangelist-phrasing:
      intent: Process cart totals
      effect: write
      questions:
      - How do I recalculate the totals on a cart?
      - Is there a way to process summary totals for a cart?
      instructions:
      - text: Process the totals for cart {cart}.
        slots:
          cart: path.cartId
      - text: Recalculate the summary totals of cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/triggered-rule-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule actions triggered on a cart
      effect: read
      questions:
      - Which rule actions were triggered by the products on my cart?
      - Can I see triggered rule actions for a single primary line?
      instructions:
      - text: List triggered rule actions on cart {cart}.
        slots:
          cart: path.cartId
      - text: Show rule actions triggered by line {line} of cart {cart}.
        slots:
          line: query.primarylineNumber
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a cart for an action
      effect: read
      questions:
      - Is my cart valid for a particular action before I run it?
      - How do I validate a cart against an action name?
      instructions:
      - text: Validate cart {cart}.
        slots:
          cart: path.cartId
      - text: Check whether cart {cart} is valid for action {action}.
        slots:
          cart: path.cartId
          action: query.actionName
      method: generated
      generated: '2026-10-01'