# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Affiliates API
  version: 1.0.0
extends: openapi/appwrite-affiliates-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: 7
- target: $.paths['/affiliates/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List my affiliate links
      effect: read
      questions:
      - Which affiliate links have I created for my Appwrite account?
      - Can I filter my shareable referral links with queries?
      instructions:
      - text: Show all of my affiliate links.
      - text: List my affiliate links matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable affiliate link
      effect: write
      questions:
      - How do I get a referral link to share so I earn affiliate rewards?
      - Do I need to join a program before creating an affiliate link, or am I already in it?
      instructions:
      - text: Create a new affiliate link with ID {linkId}.
        slots:
          linkId: requestBody.linkId
      - text: Make an affiliate link {linkId} labelled {name} for my newsletter.
        slots:
          linkId: requestBody.linkId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/links/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one affiliate link
      effect: read
      questions:
      - What are the details of a single affiliate link I own?
      - Can I look up one referral link by its ID to copy the share URL?
      instructions:
      - text: Show the details of affiliate link {linkId}.
        slots:
          linkId: path.linkId
      - text: Fetch my referral link {linkId}.
        slots:
          linkId: path.linkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/links/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an affiliate link
      effect: destructive
      questions:
      - If I delete an affiliate link, do the referrals and rewards it already earned stay in my history?
      - How can I retire a referral link I no longer share?
      instructions:
      - text: Delete affiliate link {linkId}.
        slots:
          linkId: path.linkId
      - text: Remove the referral link {linkId} from my account.
        slots:
          linkId: path.linkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: List referrals from my affiliate links
      effect: read
      questions:
      - Who has signed up through my affiliate links so far?
      - Does the referral list show referred users' emails, or only a truncated ID and signup country?
      instructions:
      - text: List the signups attributed to my affiliate links.
      - text: Show my affiliate referrals matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: List rewards earned from affiliate conversions
      effect: read
      questions:
      - What rewards have I earned from affiliate conversions?
      - Are any of my affiliate rewards still pending and waiting to be claimed?
      instructions:
      - text: List the rewards I have earned as an affiliate.
      - text: Show my affiliate rewards filtered by {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/affiliates/rewards/{rewardId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Claim an affiliate reward as organization credits
      effect: write
      questions:
      - How do I turn a pending affiliate reward into credits for one of my organizations?
      - Must I be an owner of the organization that receives my claimed reward credits?
      instructions:
      - text: Claim reward {rewardId} by setting its status to {status} and credit organization {organizationId}.
        slots:
          rewardId: path.rewardId
          status: requestBody.status
          organizationId: requestBody.organizationId
      - text: Mark affiliate reward {rewardId} as {status} for org {organizationId}.
        slots:
          rewardId: path.rewardId
          status: requestBody.status
          organizationId: requestBody.organizationId
      method: generated
      generated: '2026-09-26'