# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ticketing Subpackage Tickets API
  version: 1.0.0
extends: openapi/merge-subpackage-tickets-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: 9
- target: $.paths['/ticketing/v1/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickets
      effect: read
      questions:
      - How do I pull all open tickets from a customer's helpdesk?
      - Can I filter synced tickets by priority, status or assignee?
      - Which tickets are due before a given date?
      instructions:
      - text: List tickets with status {status} and priority {priority}.
        slots:
          status: query.status
          priority: query.priority
      - text: Show tickets assigned to {assignee_ids} that are due before {due_before}.
        slots:
          assignee_ids: query.assignee_ids
          due_before: query.due_before
      - text: List tickets for account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket
      effect: write
      questions:
      - Can I open a new ticket in a customer's helpdesk through one API?
      - Is there a debug mode when creating tickets so I can see log links?
      instructions:
      - text: Create a ticket with these details {ticket}.
        slots:
          ticket: requestBody.model
      - text: Open a new ticket {ticket} and run the third-party write asynchronously {run_async}.
        slots:
          ticket: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket
      effect: read
      questions:
      - Can I fetch the full details of one ticket by its ID?
      - What does a single synced ticket record contain?
      instructions:
      - text: Get ticket {id}.
        slots:
          id: path.id
      - text: Show me the details of ticket {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a ticket
      effect: write
      questions:
      - Can I change the status or assignee on an existing ticket?
      - How do I edit a ticket that is already in the helpdesk?
      instructions:
      - text: Update ticket {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.model
      - text: Patch ticket {id} to {changes} and return debug fields {is_debug_mode}.
        slots:
          id: path.id
          changes: requestBody.model
          is_debug_mode: query.is_debug_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/{ticket_id}/viewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List who can view a ticket
      effect: read
      questions:
      - Who are the users and teams that can see a particular ticket?
      - Can I list the viewers and assignees on a ticket?
      instructions:
      - text: List viewers of ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      - text: Show which users or teams can see ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/live-search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search tickets live in the helpdesk
      effect: read
      questions:
      - Can I search tickets directly in the third-party helpdesk instead of synced data?
      - Is there a live search for tickets by assignee name or collection name?
      instructions:
      - text: Live-search tickets named {name} in the helpdesk.
        slots:
          name: query.name
      - text: Search the helpdesk live for tickets assigned to {assignees} in collections {collections}.
        slots:
          assignees: query.assignees
          collections: query.collections
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields allowed when updating a ticket
      effect: read
      questions:
      - Which ticket fields can I change when updating a specific ticket?
      - What does the helpdesk allow me to edit on an existing ticket?
      instructions:
      - text: Show the editable fields for ticket {id}.
        slots:
          id: path.id
      - text: Get update metadata for ticket {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create a ticket
      effect: read
      questions:
      - Which fields are required to create a ticket in this helpdesk?
      - Do the ticket creation fields change by ticket type or collection?
      instructions:
      - text: Show ticket creation fields for ticket type {ticket_type}.
        slots:
          ticket_type: query.ticket_type
      - text: Get the create-ticket metadata for collection {collection_id}.
        slots:
          collection_id: query.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tickets/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for tickets
      effect: read
      questions:
      - What custom fields does the helpdesk define on tickets?
      - Can I list only the custom remote field classes for tickets?
      instructions:
      - text: List ticket remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show ticket field classes with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'