# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Management Store budgets API
  version: 1.0.0
extends: openapi/talon-one-store-budgets-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['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's per-store budget limits
      effect: read
      questions:
      - What budget limit does each store have in a campaign?
      - Can I see store limits for just one action and period?
      instructions:
      - text: List the store budget limits for campaign {campaignId} in application {applicationId}.
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Show store limits for action {action} and period {period} in campaign {campaignId}, application {applicationId}.
        slots:
          action: query.action
          period: query.period
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Set per-store budgets for a campaign
      effect: write
      questions:
      - How do I cap how many redemptions each store can give in a campaign?
      - Can per-store budgets reset every period?
      instructions:
      - text: Create a store budget for action {action} with limits {storeLimits} in campaign {campaignId}, application {applicationId}.
        slots:
          action: requestBody.action
          storeLimits: requestBody.storeLimits
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Set store limits {storeLimits} for {action} per {period} in campaign {campaignId} of application {applicationId}.
        slots:
          storeLimits: requestBody.storeLimits
          action: requestBody.action
          period: requestBody.period
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a campaign's store budgets
      effect: destructive
      questions:
      - How do I remove all per-store limits from a campaign?
      - Can I delete only the store budgets for one action?
      instructions:
      - text: Delete the store budgets of campaign {campaignId} in application {applicationId}.
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Remove store budgets for action {action} in campaign {campaignId}, application {applicationId}.
        slots:
          action: query.action
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize a campaign's store budgets
      effect: read
      questions:
      - What's the overall picture of store budget usage in a campaign?
      - Is there a summary view of every store budget in a campaign?
      instructions:
      - text: Summarize the store budgets for campaign {campaignId} in application {applicationId}.
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Give me a store budget overview of campaign {campaignId} (application {applicationId}).
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import store budgets from a CSV
      effect: write
      questions:
      - How do I upload store budget limits for hundreds of stores at once?
      - Does a store budget import replace the existing limits?
      instructions:
      - text: Import store budgets from {upFile} into campaign {campaignId} of application {applicationId}.
        slots:
          upFile: requestBody.upFile
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Upload store limit CSV {upFile} for action {action} and period {period} in campaign {campaignId}, application {applicationId}.
        slots:
          upFile: requestBody.upFile
          action: query.action
          period: query.period
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a campaign's store budgets to CSV
      effect: read
      questions:
      - Can I download each store's budget limit for a campaign as a spreadsheet?
      - What columns are in the store budget export?
      instructions:
      - text: Export the store budgets of campaign {campaignId} in application {applicationId}.
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Download store budget CSV for action {action} in campaign {campaignId}, application {applicationId}.
        slots:
          action: query.action
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'