# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Algovoi Co Uk Recurring API
  version: 1.0.0
extends: openapi/algovoi-co-uk-recurring-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: 8
- target: $.paths['/v1/recurring/authorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List standing payment authorities
      effect: read
      questions:
      - Which standing payment authorities exist for my subscriptions?
      - Can I filter authorities by subscription or status?
      instructions:
      - text: List my standing authorities.
      - text: Show {status} authorities for subscription {subscription_id}.
        slots:
          status: query.status
          subscription_id: query.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a standing authority for a subscription
      effect: write
      questions:
      - How do I set up an on-chain spending authority so a subscription can pull payments?
      - Can I cap how much an authority can pull per period?
      instructions:
      - text: Create an authority on subscription {subscription_id} for wallet {customer_wallet_address} on {chain}, {per_cycle_amount_minor} per cycle.
        slots:
          subscription_id: requestBody.subscription_id
          customer_wallet_address: requestBody.customer_wallet_address
          chain: requestBody.chain
          per_cycle_amount_minor: requestBody.per_cycle_amount_minor
      - text: Set a cap of {cap_amount_minor} every {cap_period_seconds} seconds on a new authority for {subscription_id}.
        slots:
          cap_amount_minor: requestBody.cap_amount_minor
          cap_period_seconds: requestBody.cap_period_seconds
          subscription_id: requestBody.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities/{authority_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a standing authority
      effect: read
      questions:
      - What is the status of a standing payment authority?
      - Can I look up one authority's caps by its id?
      instructions:
      - text: Get authority {authority_id}.
        slots:
          authority_id: path.authority_id
      - text: Show the caps and status of authority {authority_id}.
        slots:
          authority_id: path.authority_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities/{authority_id}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an authority after it lands on-chain
      effect: write
      questions:
      - How do I mark a pending authority active once the customer's transaction lands?
      - Can I set when the first cycle is due when activating an authority?
      instructions:
      - text: Confirm authority {authority_id} at on-chain address {on_chain_address}.
        slots:
          authority_id: path.authority_id
          on_chain_address: requestBody.on_chain_address
      - text: Activate authority {authority_id} with first cycle due {first_cycle_due_at}.
        slots:
          authority_id: path.authority_id
          first_cycle_due_at: requestBody.first_cycle_due_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities/{authority_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a standing authority
      effect: destructive
      questions:
      - How do I permanently revoke a customer's standing payment authority?
      - Can a revoked authority still pull funds?
      instructions:
      - text: Revoke authority {authority_id}.
        slots:
          authority_id: path.authority_id
      - text: Permanently withdraw pull rights on authority {authority_id}.
        slots:
          authority_id: path.authority_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities/{authority_id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a standing authority
      effect: write
      questions:
      - Can I temporarily stop pulls on a standing authority without revoking it?
      - How do I put an authority on hold?
      instructions:
      - text: Pause authority {authority_id}.
        slots:
          authority_id: path.authority_id
      - text: Hold pulls on authority {authority_id} for now.
        slots:
          authority_id: path.authority_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/authorities/{authority_id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused standing authority
      effect: write
      questions:
      - How do I restart pulls on a paused authority?
      - Can I choose when the next cycle is due when resuming an authority?
      instructions:
      - text: Resume authority {authority_id}.
        slots:
          authority_id: path.authority_id
      - text: Resume authority {authority_id} with next cycle due {next_cycle_due_at}.
        slots:
          authority_id: path.authority_id
          next_cycle_due_at: requestBody.next_cycle_due_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/pulls'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a manual pull on an authority
      effect: write
      questions:
      - Can I trigger a payment pull now instead of waiting for the next cycle?
      - Does a manual pull happen immediately or on the next reaper sweep?
      instructions:
      - text: Pull {amount_minor} now on authority {authority_id}.
        slots:
          amount_minor: requestBody.amount_minor
          authority_id: requestBody.authority_id
      - text: Request a manual pull of {amount_minor} on {authority_id} with note {note}.
        slots:
          amount_minor: requestBody.amount_minor
          authority_id: requestBody.authority_id
          note: requestBody.note
      method: generated
      generated: '2026-10-01'