API Evangelist conversational phrasing for Brand API - Product Catalogs Catalog 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 Brand API - Product Catalogs Catalog Items API
  version: 1.0.0
extends: openapi/impact-catalog-items-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: 6
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search items in a product catalog
      effect: read
      questions:
      - Which products are in one of my brand's catalogs?
      - Can I keyword-search catalog items and sort the results?
      - Is there a cap on how many catalog items I can page through?
      instructions:
      - text: List items in catalog {catalog} for account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
      - text: Search catalog {catalog} in account {account} for keyword {keyword}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          keyword: query.Keyword
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a catalog
      effect: write
      questions:
      - How do I add a new product to a catalog so partners can promote it?
      - Can I set price, stock and images when adding a catalog item?
      instructions:
      - text: Add product {name} at price {price} to catalog {catalog} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          name: requestBody.Name
          price: requestBody.CurrentPrice
      - text: Create a new catalog item {item} with URL {url} in catalog {catalog}, account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: requestBody.CatalogItemId
          url: requestBody.Url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog item's details
      effect: read
      questions:
      - What price and stock status does one catalog product currently have?
      - Can I fetch a single catalog item by its ID?
      instructions:
      - text: Get item {item} from catalog {catalog} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
      - text: Show the details of catalog product {item} in catalog {catalog}, account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single catalog item
      effect: write
      questions:
      - Can I change the price or stock availability of one product in my catalog?
      - What happens to fields I don't send when updating one catalog item?
      instructions:
      - text: Set the current price of item {item} in catalog {catalog} to {price} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
          price: requestBody.CurrentPrice
      - text: Mark catalog item {item} in catalog {catalog} as {stock} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
          stock: requestBody.StockAvailability
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog item
      effect: destructive
      questions:
      - Can I remove a discontinued product from a catalog?
      - Is deleting a catalog item permanent?
      instructions:
      - text: Delete item {item} from catalog {catalog} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
      - text: Permanently remove product {item} from catalog {catalog}, account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
          item: path.CatalogItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Catalogs/{CatalogId}/BulkUpdate'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update up to 500 catalog items
      effect: write
      questions:
      - How do I update prices on hundreds of catalog products in one request?
      - What is the maximum number of items a bulk catalog update accepts?
      instructions:
      - text: Bulk update the items in catalog {catalog} for account {account} from my list.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
      - text: Push a batch of up to 500 product changes to catalog {catalog} in account {account}.
        slots:
          account: path.AccountSID
          catalog: path.CatalogId
      method: generated
      generated: '2026-09-26'