# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Impact Deals API
  version: 1.0.0
extends: openapi/impact-deals-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: 7
- target: $.paths['/Advertisers/{AccountSID}/Deals'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's deals
      effect: read
      questions:
      - Which deals has my brand set up across programs?
      - Can a brand filter its deals by scope, state or type?
      instructions:
      - text: As brand account {account}, list all deals in program {campaign}.
        slots:
          account: path.AccountSID
          campaign: query.CampaignId
      - text: Show brand account {account}'s deals with state {state} and type {type}.
        slots:
          account: path.AccountSID
          state: query.State
          type: query.Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Deals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deal
      effect: write
      questions:
      - How do I set up a percent-off or BOGO deal for my partners to promote?
      - Can a new deal be restricted to certain partners or partner groups?
      - What fields are required when creating a deal?
      instructions:
      - text: In account {account}, create deal {name} in program {campaign} with scope {scope} and type {type}.
        slots:
          account: path.AccountSID
          name: requestBody.Name
          campaign: requestBody.CampaignId
          scope: requestBody.Scope
          type: requestBody.Type
      - text: Create a {percent}% off deal named {name} for program {campaign}, scope {scope}, type {type}, in account {account}.
        slots:
          account: path.AccountSID
          percent: requestBody.DiscountPercent
          name: requestBody.Name
          campaign: requestBody.CampaignId
          scope: requestBody.Scope
          type: requestBody.Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Deals/{DealId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's deal details
      effect: read
      questions:
      - What are the terms of one of my brand's deals?
      - Can a brand pull a single deal by its ID?
      instructions:
      - text: As brand account {account}, get deal {deal}.
        slots:
          account: path.AccountSID
          deal: path.DealId
      - text: Show the brand-side details of deal {deal} in account {account}.
        slots:
          account: path.AccountSID
          deal: path.DealId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Deals/{DealId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a deal
      effect: write
      questions:
      - Can I extend a deal's end date or change its discount after it's live?
      - Are fields I leave out of a deal update left unchanged?
      instructions:
      - text: Change the end date of deal {deal} in account {account} to {end}.
        slots:
          account: path.AccountSID
          deal: path.DealId
          end: requestBody.EndDate
      - text: Update deal {deal} in account {account} to a discount of {percent} percent.
        slots:
          account: path.AccountSID
          deal: path.DealId
          percent: requestBody.DiscountPercent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Deals/{DealId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal permanently
      effect: destructive
      questions:
      - Can a deal I no longer run be removed entirely?
      - Is deleting a deal reversible?
      instructions:
      - text: Delete deal {deal} from account {account}.
        slots:
          account: path.AccountSID
          deal: path.DealId
      - text: Permanently remove deal {deal} in brand account {account}.
        slots:
          account: path.AccountSID
          deal: path.DealId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Deals'].get
  update:
    x-apievangelist-phrasing:
      intent: List deals in a program a partner joined
      effect: read
      questions:
      - Which deals can I promote as a partner in a given program?
      - Can a partner filter a program's deals by type or state?
      instructions:
      - text: As partner account {account}, list the deals in program {campaign}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      - text: Show partner account {account} the active deals of type {type} in program {campaign}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
          type: query.Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Deals/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a deal in a partner's program
      effect: read
      questions:
      - As a partner, where do I see the full terms of one deal in a program?
      - What discount and dates does a specific program deal carry for partners?
      instructions:
      - text: As partner account {account}, retrieve deal {deal} in program {campaign}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
          deal: path.Id
      - text: Get partner-side deal {deal} from program {campaign} in account {account}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
          deal: path.Id
      method: generated
      generated: '2026-09-26'