# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Campaigns Campaign Plans API
  version: 1.0.0
extends: openapi/mediamath-campaign-plans-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: 4
- target: $.paths['/campaign_plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaign plans
      effect: read
      questions:
      - Which campaign plans have been drafted so far?
      - Where can I see all my media campaign plans?
      instructions:
      - text: List all campaign plans.
      - text: Show every campaign plan I have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign plan
      effect: write
      questions:
      - How do I draft a campaign plan with a budget and duration?
      - What do I need to start planning a campaign for an advertiser?
      instructions:
      - text: Create campaign plan {name} for advertiser {advertiser_id} with budget {budget}, duration {duration} in time zone {zone_name}.
        slots:
          name: requestBody.name
          advertiser_id: requestBody.advertiser_id
          budget: requestBody.budget
          duration: requestBody.duration
          zone_name: requestBody.zone_name
      - text: Plan a {duration} campaign called {name} for advertiser {advertiser_id}, budget {budget}, zone {zone_name}.
        slots:
          duration: requestBody.duration
          name: requestBody.name
          advertiser_id: requestBody.advertiser_id
          budget: requestBody.budget
          zone_name: requestBody.zone_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_plans/{campaign_plan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign plan
      effect: read
      questions:
      - How do I look up one campaign plan by ID?
      - What budget and duration does a given campaign plan have?
      instructions:
      - text: Get campaign plan {campaign_plan_id}.
        slots:
          campaign_plan_id: path.campaign_plan_id
      - text: Show the budget and dates on campaign plan {campaign_plan_id}.
        slots:
          campaign_plan_id: path.campaign_plan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_plans/{campaign_plan_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a campaign plan
      effect: write
      questions:
      - How do I change the budget or duration of an existing campaign plan?
      - Can I rename a campaign plan?
      instructions:
      - text: Update campaign plan {campaign_plan_id} to {name}, budget {budget}, duration {duration}, zone {zone_name}.
        slots:
          campaign_plan_id: path.campaign_plan_id
          name: requestBody.name
          budget: requestBody.budget
          duration: requestBody.duration
          zone_name: requestBody.zone_name
      - text: Change campaign plan {campaign_plan_id}'s budget to {budget}, keeping name {name}, duration {duration} and zone {zone_name}.
        slots:
          campaign_plan_id: path.campaign_plan_id
          budget: requestBody.budget
          name: requestBody.name
          duration: requestBody.duration
          zone_name: requestBody.zone_name
      method: generated
      generated: '2026-10-01'