# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Impact Exception Lists API
  version: 1.0.0
extends: openapi/impact-exception-lists-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}/ExceptionLists'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's exception lists
      effect: read
      questions:
      - Which commission exception lists exist on my campaigns?
      - Can I filter exception lists by type or state?
      instructions:
      - text: List exception lists in brand account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show exception lists of type {type} for campaign {campaign}.
        slots:
          type: query.Type
          campaign: query.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an exception list
      effect: write
      questions:
      - How do I set up an alternate commission list for certain SKUs?
      - What's needed to create a new, empty exception list for a campaign?
      instructions:
      - text: Create exception list {name} of type {type} on campaign {campaign} for tracker {tracker} in account {sid}.
        slots:
          sid: path.AccountSID
          name: requestBody.Name
          type: requestBody.Type
          campaign: requestBody.CampaignId
          tracker: requestBody.ActionTrackerId
      - text: Start a new {type} exception list called {name} in campaign {campaign}, tracker {tracker}.
        slots:
          type: requestBody.Type
          name: requestBody.Name
          campaign: requestBody.CampaignId
          tracker: requestBody.ActionTrackerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exception list as a brand
      effect: read
      questions:
      - What's configured on one of my brand's exception lists?
      - Can a brand look up an exception list by its ID?
      instructions:
      - text: Get brand exception list {list} in account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ExceptionListId
      - text: Show the advertiser settings for exception list {list}.
        slots:
          list: path.ExceptionListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exception list
      effect: write
      questions:
      - Can I rename an exception list or change its type?
      - How do I change which action trackers an exception list applies to?
      instructions:
      - text: Rename exception list {list} in account {sid} to {name}.
        slots:
          sid: path.AccountSID
          list: path.ExceptionListId
          name: requestBody.Name
      - text: Point exception list {list} at action tracker {tracker}.
        slots:
          list: path.ExceptionListId
          tracker: requestBody.ActionTrackerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an exception list as a partner
      effect: read
      questions:
      - As a partner, how do I see an exception list referenced in my contract?
      - What does a partner see about a brand's exception list?
      instructions:
      - text: Retrieve exception list {list} for partner account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ExceptionListId
      - text: Show the partner view of exception list {list} from my contract.
        slots:
          list: path.ExceptionListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in an exception list
      effect: read
      questions:
      - Which SKUs or categories trigger an alternate commission rate?
      - What entries does a given exception list contain?
      instructions:
      - text: List items in exception list {list} for account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ExceptionListId
      - text: Show the categories and SKUs in exception list {list}.
        slots:
          list: path.ExceptionListId
      method: generated
      generated: '2026-09-26'