API Evangelist conversational phrasing for Live Direct Marketing Online Admin RPA API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Admin RPA API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-admin-rpa-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['/api/admin/rpa'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the RPA admin overview
      effect: read
      questions:
      - Which RPA service keys and tenant opt-ins are configured right now?
      - Is there a single view of RPA queue readiness and legacy drain inventory?
      instructions:
      - text: Show the RPA admin overview.
      - text: List RPA service keys with tenant opt-ins and queue readiness.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an RPA service key
      effect: write
      questions:
      - How do I issue a dedicated key for an RPA worker?
      - Can I name a new RPA service key when I create it?
      instructions:
      - text: Create an RPA service key named {name}.
        slots:
          name: requestBody.name
      - text: Issue a new dedicated RPA key called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an RPA service key
      effect: destructive
      questions:
      - Can I rotate an RPA key's secret if it may have leaked?
      - Does rotating an RPA key stop the old secret from working?
      instructions:
      - text: Rotate RPA key {id}.
        slots:
          id: path.id
      - text: Issue a new secret for RPA key {id} and invalidate the old one.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/reveal'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal an RPA service key secret
      effect: read
      questions:
      - Can a super admin see the current secret of an RPA key again?
      - Why can't some older RPA keys be revealed?
      instructions:
      - text: Reveal the secret for RPA key {id}.
        slots:
          id: path.id
      - text: Show the current encrypted secret of RPA key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/global-access'].put
  update:
    x-apievangelist-phrasing:
      intent: Allow an RPA key to work for all tenants
      effect: write
      questions:
      - Can one RPA key claim work on behalf of every active tenant user?
      - How do I turn off global access for an RPA key?
      instructions:
      - text: Set global access for RPA key {id} to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      - text: Let RPA key {id} claim work for all active tenant users.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an RPA service key
      effect: destructive
      questions:
      - How do I cut off an RPA worker's access immediately?
      - What happens to sends already started when an RPA key is revoked?
      instructions:
      - text: Revoke RPA key {id}.
        slots:
          id: path.id
      - text: Cut off RPA service access for key {id} right now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/trace'].post
  update:
    x-apievangelist-phrasing:
      intent: Toggle detailed tracing for an RPA key
      effect: write
      questions:
      - Can I turn on detailed heartbeat and poll tracing for an RPA key while debugging?
      - How long does RPA key tracing stay on?
      instructions:
      - text: Set trace on RPA key {id} to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      - text: Enable one hour of heartbeat tracing for RPA key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/keys/{id}/grants'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant an RPA key to a tenant user
      effect: write
      questions:
      - How do I opt a specific tenant and user into an RPA service key?
      - Can I withdraw a user's opt-in for an RPA key?
      instructions:
      - text: Grant RPA key {id} to user {userId} in tenant {tenantId}, enabled {enabled}.
        slots:
          id: path.id
          userId: requestBody.userId
          tenantId: requestBody.tenantId
          enabled: requestBody.enabled
      - text: Opt tenant {tenantId} user {userId} into RPA key {id} with enabled {enabled}.
        slots:
          tenantId: requestBody.tenantId
          userId: requestBody.userId
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search correlated RPA logs
      effect: read
      questions:
      - Can I see the RPA log history for one tenant filtered by reason code?
      - What metadata shows up in the RPA admin logs?
      instructions:
      - text: Show RPA logs for tenant {tenantId} with reason code {reasonCode}.
        slots:
          tenantId: query.tenantId
          reasonCode: query.reasonCode
      - text: Search RPA logs for task {taskId}, {limit} entries.
        slots:
          taskId: query.taskId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/task-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cross-tenant RPA task history
      effect: read
      questions:
      - Is there a cross-tenant history of RPA tasks I can page through?
      - Can I look up the task history of one RPA task across tenants?
      instructions:
      - text: Show cross-tenant RPA task history for task {taskId}.
        slots:
          taskId: query.taskId
      - text: Page RPA task history for tenant {tenantId} after cursor {cursor}.
        slots:
          tenantId: query.tenantId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/rpa/protocol'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the RPA protocol rules
      effect: read
      questions:
      - What are the RPA protocol endpoints and lease rules?
      - How often should an RPA worker retry, and how long do leases last?
      instructions:
      - text: Show the RPA protocol endpoints and retry rules.
      - text: Describe the RPA lease and retry rules.
      method: generated
      generated: '2026-10-01'