# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio - Events Sinks API
  version: 1.0.0
extends: openapi/twilio-sinks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/Sinks/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one event streams sink
      effect: read
      questions:
      - What type and status does a specific event sink have?
      - Can I see how one of my sinks is configured?
      instructions:
      - text: Get sink {sink}.
        slots:
          sink: path.Sid
      - text: Show the configuration and status of event sink {sink}.
        slots:
          sink: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a sink
      effect: write
      questions:
      - How do I change the description on an existing event sink?
      - Can I relabel a sink without recreating it?
      instructions:
      - text: Change the description of sink {sink} to {description}.
        slots:
          sink: path.Sid
          description: requestBody.Description
      - text: Relabel existing event sink {sink} as {description}.
        slots:
          sink: path.Sid
          description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sink
      effect: destructive
      questions:
      - How do I get rid of an event streams destination I no longer use?
      - Can I permanently delete a sink?
      instructions:
      - text: Delete sink {sink}.
        slots:
          sink: path.Sid
      - text: Permanently remove event destination {sink}.
        slots:
          sink: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my event streams sinks
      effect: read
      questions:
      - Which of my event sinks have failed validation?
      - Are there sinks that no subscription is using anymore?
      - What destinations are my event streams set up to deliver to?
      instructions:
      - text: List all my event sinks.
      - text: List sinks with status {status}.
        slots:
          status: query.Status
      - text: List the sinks where in-use is {in_use}.
        slots:
          in_use: query.InUse
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event streams sink
      effect: write
      questions:
      - How do I send event stream data to a destination of my own?
      - Can I set up a new destination for events with its connection details as JSON?
      instructions:
      - text: Create a {sink_type} sink described as {description} with configuration {configuration}.
        slots:
          sink_type: requestBody.SinkType
          description: requestBody.Description
          configuration: requestBody.SinkConfiguration
      - text: Set up a new event destination {description} of type {sink_type} using connection settings {configuration}.
        slots:
          description: requestBody.Description
          sink_type: requestBody.SinkType
          configuration: requestBody.SinkConfiguration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks/{Sid}/Test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a sink
      effect: write
      questions:
      - How do I check that my sink can actually receive events?
      - Can I fire a sample event at a destination before subscribing it to real traffic?
      instructions:
      - text: Send a test event to sink {sink}.
        slots:
          sink: path.Sid
      - text: Fire a sample event at destination {sink} so I can confirm delivery.
        slots:
          sink: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Sinks/{Sid}/Validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a sink received its test event
      effect: write
      questions:
      - Once the test event arrives, how do I mark my sink as validated?
      - What do I do with the test ID my sink received?
      instructions:
      - text: Validate sink {sink} with test ID {test_id}.
        slots:
          sink: path.Sid
          test_id: requestBody.TestId
      - text: Confirm that destination {sink} received test event {test_id}.
        slots:
          sink: path.Sid
          test_id: requestBody.TestId
      method: generated
      generated: '2026-09-26'