# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform Functions Social Cause Campaigns API
  version: 1.0.0
extends: openapi/punchh-social-cause-campaigns-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: 3
- target: $.paths['/api2/dashboard/social_cause_campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a social cause campaign
      effect: write
      questions:
      - How do I set up a charity campaign that loyalty guests can support?
      - Can an admin create a social cause campaign by API?
      instructions:
      - text: Create social cause campaign {campaign}.
        slots:
          campaign: requestBody.social_cause_campaign
      - text: Set up a new charity campaign with details {campaign}.
        slots:
          campaign: requestBody.social_cause_campaign
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/social_cause_campaigns/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate a social cause campaign
      effect: write
      questions:
      - How do I make a social cause campaign live for guests?
      - Does a new charity campaign need to be activated before guests can enroll?
      instructions:
      - text: Activate social cause campaign {social_cause_id}.
        slots:
          social_cause_id: requestBody.social_cause_id
      - text: Turn on charity campaign {social_cause_id} so guests can join.
        slots:
          social_cause_id: requestBody.social_cause_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/social_cause_campaigns/deactivate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a social cause campaign
      effect: write
      questions:
      - How do I end a charity campaign once the fundraising period is over?
      - Can a social cause campaign be switched off without deleting it?
      instructions:
      - text: Deactivate social cause campaign {social_cause_id}.
        slots:
          social_cause_id: requestBody.social_cause_id
      - text: Stop charity campaign {social_cause_id} from accepting guests.
        slots:
          social_cause_id: requestBody.social_cause_id
      method: generated
      generated: '2026-10-01'