# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Gift Card Activities API
  version: 1.0.0
extends: openapi/square-giftcardactivities-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: 2
- target: $.paths['/v2/gift-cards/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift card activities
      effect: read
      questions:
      - What loads, redemptions and adjustments happened on a gift card?
      - Can I filter gift card activity by type and date range?
      instructions:
      - text: List activities for gift card {gift_card_id}.
        slots:
          gift_card_id: query.gift_card_id
      - text: List {type} gift card activities between {begin_time} and {end_time}.
        slots:
          type: query.type
          begin_time: query.begin_time
          end_time: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/gift-cards/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate, load or redeem a gift card
      effect: write
      questions:
      - How do I activate a gift card with a starting balance?
      - Can I add money to or redeem value from an existing gift card?
      instructions:
      - text: Create gift card activity {gift_card_activity}.
        slots:
          gift_card_activity: requestBody.gift_card_activity
      - text: Record activity {gift_card_activity} with key {idempotency_key} to change the balance.
        slots:
          gift_card_activity: requestBody.gift_card_activity
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'