# 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 Connections API
  version: 1.0.0
extends: openapi/sendcloud-connections-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/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List event notification connections
      effect: read
      questions:
      - Which external endpoints are set up to receive my Sendcloud event notifications?
      - Can I list only connections of a certain type?
      instructions:
      - text: List all my event connections.
      - text: List event connections of type {connection_type}.
        slots:
          connection_type: query.connection_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event notification connection
      effect: write
      questions:
      - How do I add a new endpoint where shipping events get delivered?
      - What configuration does a new event connection need?
      instructions:
      - text: Create a {type} connection with configuration {configuration}.
        slots:
          type: requestBody.type
          configuration: requestBody.configuration
      - text: Set up a new event delivery connection of type {type}.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/connections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one event connection
      effect: read
      questions:
      - How do I look up the details of a single event connection?
      - What is configured on one particular connection?
      instructions:
      - text: Show event connection {id}.
        slots:
          id: path.id
      - text: Get the configuration of connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/connections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event connection
      effect: destructive
      questions:
      - What happens to my subscriptions if I delete a connection?
      - How do I remove an event connection I no longer use?
      instructions:
      - text: Delete event connection {id} and its subscriptions.
        slots:
          id: path.id
      - text: Remove connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/connections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event connection
      effect: write
      questions:
      - Can I change the endpoint configuration of an existing connection?
      - Is it possible to update only some fields of a connection?
      instructions:
      - text: Update connection {id} with configuration {configuration}.
        slots:
          id: path.id
          configuration: requestBody.configuration
      - text: Change the type of existing connection {id} to {type}.
        slots:
          id: path.id
          type: requestBody.type
      method: generated
      generated: '2026-10-01'