# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tapfiliate REST Programs API
  version: 1.0.0
extends: openapi/tapfiliate-programs-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: 11
- target: $.paths['/programs/{program_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an affiliate program
      effect: read
      questions:
      - Can I look up the settings of one affiliate program?
      - What details does a single program record include?
      instructions:
      - text: Get program {program_id}.
        slots:
          program_id: path.program_id
      - text: Show me affiliate program {program_id}.
        slots:
          program_id: path.program_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate programs
      effect: read
      questions:
      - Which affiliate programs do I run in Tapfiliate?
      - Can I page through my programs?
      instructions:
      - text: List all my affiliate programs.
      - text: Show page {page} of programs, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliates in a program
      effect: read
      questions:
      - Who is enrolled in a particular affiliate program?
      - Can I page through the members of one program?
      instructions:
      - text: List the affiliates in program {program_id}.
        slots:
          program_id: path.program_id
      - text: Show page {page} of program {program_id}'s affiliates, {limit} per page.
        slots:
          program_id: path.program_id
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll an affiliate in a program
      effect: write
      questions:
      - How do I add an existing affiliate to another program?
      - Can I enroll an affiliate and pre-approve them at the same time?
      instructions:
      - text: Add affiliate {affiliate} to program {program_id}.
        slots:
          program_id: path.program_id
          affiliate: requestBody.affiliate
      - text: Enroll {affiliate} in program {program_id} with approved set to {approved}.
        slots:
          program_id: path.program_id
          affiliate: requestBody.affiliate
          approved: requestBody.approved
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/{affiliate_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an affiliate's program enrollment
      effect: read
      questions:
      - What are an affiliate's coupon and referral link in a given program?
      - Can I see one affiliate's enrollment details for a specific program?
      instructions:
      - text: Get affiliate {affiliate_id}'s enrollment in program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      - text: Show how affiliate {affiliate_id} is set up in program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/{affiliate_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an affiliate's program enrollment
      effect: write
      questions:
      - Can I assign a coupon code to an affiliate within a program?
      - How do I change an affiliate's referral link in one program?
      instructions:
      - text: Set the coupon for affiliate {affiliate_id} in program {program_id} to {coupon}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
          coupon: requestBody.coupon
      - text: Change affiliate {affiliate_id}'s referral link in program {program_id} to {referral_link}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
          referral_link: requestBody.referral_link
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/{affiliate_id}/approved/'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve an affiliate in a program
      effect: write
      questions:
      - How do I approve an affiliate who applied to my program?
      - Can I accept an affiliate's pending enrollment?
      instructions:
      - text: Approve affiliate {affiliate_id} in program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      - text: Accept affiliate {affiliate_id}'s enrollment in program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/affiliates/{affiliate_id}/approved/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disapprove an affiliate in a program
      effect: destructive
      questions:
      - Can I reject or revoke an affiliate's place in a program?
      - What does disapproving an affiliate's enrollment do?
      instructions:
      - text: Disapprove affiliate {affiliate_id} in program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      - text: Revoke affiliate {affiliate_id}'s approval for program {program_id}.
        slots:
          program_id: path.program_id
          affiliate_id: path.affiliate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/commission-types/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's commission types
      effect: read
      questions:
      - Which commission types are available in a program?
      - What commission structures can I apply to conversions in this program?
      instructions:
      - text: List commission types for program {program_id}.
        slots:
          program_id: path.program_id
      - text: Show the commission types defined in program {program_id}.
        slots:
          program_id: path.program_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/levels/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's MLM levels
      effect: read
      questions:
      - How many multi-level marketing tiers does a program have?
      - What MLM levels are configured for this program?
      instructions:
      - text: List the MLM levels of program {program_id}.
        slots:
          program_id: path.program_id
      - text: Show multi-level commission tiers for program {program_id}.
        slots:
          program_id: path.program_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{program_id}/bonuses/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's bonuses
      effect: read
      questions:
      - Which bonus tiers can affiliates earn in a program?
      - Does this program offer any performance bonuses?
      instructions:
      - text: List bonuses for program {program_id}.
        slots:
          program_id: path.program_id
      - text: Show the bonus tiers set up in program {program_id}.
        slots:
          program_id: path.program_id
      method: generated
      generated: '2026-10-01'