# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sendpulse Subscribers API
  version: 1.0.0
extends: openapi/sendpulse-subscribers-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: 6
- target: $.paths['/public/api/subscribers/get/{subscriberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pop-up subscriber's details
      effect: read
      questions:
      - What information do I have about one pop-up subscriber?
      - Can I look up a subscriber collected by my pop-ups by ID?
      instructions:
      - text: Show pop-up subscriber {subscriberId}.
        slots:
          subscriberId: path.subscriberId
      - text: Get details for subscriber {subscriberId}.
        slots:
          subscriberId: path.subscriberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/subscribers/by-popup/{popupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers collected by a pop-up
      effect: read
      questions:
      - Who signed up through a particular pop-up?
      - Can I export the leads one pop-up form captured?
      instructions:
      - text: List subscribers from pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Show the leads captured by pop-up {popupId}.
        slots:
          popupId: path.popupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/subscribers/by-project/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List pop-up subscribers in a project
      effect: read
      questions:
      - Which subscribers did all the pop-ups in one project collect?
      - Can I list every pop-up lead for a website project?
      instructions:
      - text: List pop-up subscribers for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show all leads collected in pop-up project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites/{id}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List web push subscribers of a website
      effect: read
      questions:
      - Who has subscribed to push notifications on my website?
      - Can I list push subscribers who joined between two dates?
      instructions:
      - text: List web push subscribers of website {id}.
        slots:
          id: path.id
      - text: Show push subscribers of site {id} who joined between {subscription_date_from} and {subscription_date_to}.
        slots:
          id: path.id
          subscription_date_from: query.subscription_date_from
          subscription_date_to: query.subscription_date_to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites/{id}/subscriptions/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Count web push subscribers of a website
      effect: read
      questions:
      - How many push notification subscribers does my website have?
      - What is the total subscriber count for one push-enabled site?
      instructions:
      - text: Count the web push subscribers of website {id}.
        slots:
          id: path.id
      - text: Give me the total push subscriber number for site {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/subscriptions/state'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate a web push subscriber
      effect: write
      questions:
      - Can I pause push notifications for one subscriber?
      - How do I reactivate a deactivated web push subscriber?
      instructions:
      - text: Set web push subscriber {id} to state {state}.
        slots:
          id: requestBody.id
          state: requestBody.state
      - text: Deactivate push subscriber {id} by setting state {state}.
        slots:
          id: requestBody.id
          state: requestBody.state
      method: generated
      generated: '2026-10-01'