# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Event Subscriptions API
  version: 1.0.0
extends: openapi/sendcloud-subscriptions-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: 5
- target: $.paths['/event-subscriptions/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List event subscriptions
      effect: read
      questions:
      - Which shipping events am I subscribed to?
      - Can I see only active subscriptions for a certain event type?
      instructions:
      - text: List my event subscriptions.
      - text: List subscriptions for event type {event_type} where active is {is_active}.
        slots:
          event_type: query.event_type
          is_active: query.is_active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a connection to an event type
      effect: write
      questions:
      - How do I start receiving a specific event at one of my connections?
      - Can I create a subscription that starts inactive?
      instructions:
      - text: Subscribe connection {connection_id} to {event_type} events.
        slots:
          connection_id: requestBody.connection_id
          event_type: requestBody.event_type
      - text: Create an inactive subscription for {event_type} on connection {connection_id}.
        slots:
          connection_id: requestBody.connection_id
          event_type: requestBody.event_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event subscription
      effect: read
      questions:
      - Which connection and event does a given subscription route?
      - Is a particular subscription currently active?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Get the details of event subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event subscription
      effect: destructive
      questions:
      - What's the way to stop receiving an event type for good?
      - Does deleting a subscription stop deliveries right away?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe and remove event subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/subscriptions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event subscription
      effect: write
      questions:
      - Can I pause a subscription without deleting it?
      - How do I move a subscription to a different connection?
      instructions:
      - text: Set subscription {id} active to {is_active}.
        slots:
          id: path.id
          is_active: requestBody.is_active
      - text: Route subscription {id} to connection {connection_id}.
        slots:
          id: path.id
          connection_id: requestBody.connection_id
      method: generated
      generated: '2026-10-01'