# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Fax API
  version: 1.0.0
extends: openapi/zoom-phone-fax-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: 8
- target: $.paths['/fax/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to send as a fax
      effect: write
      questions:
      - How do I upload a document before sending it as a fax?
      - What file format and size limit apply to fax uploads?
      instructions:
      - text: Upload {file} as a fax file.
        slots:
          file: requestBody.file
      - text: Upload fax file {file} that expires after {expire}.
        slots:
          file: requestBody.file
          expire: query.expire
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/extension/{extensionId}/fax/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List one extension's fax logs
      effect: read
      questions:
      - Which faxes has a particular extension sent or received?
      - Can I filter an extension's fax history by sender number?
      instructions:
      - text: List the fax logs for extension {extensionId}.
        slots:
          extensionId: path.extensionId
      - text: List extension {extensionId}'s faxes from {from} to {to}.
        slots:
          extensionId: path.extensionId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a fax
      effect: write
      questions:
      - How do I send a fax from a Zoom Phone number?
      - Can one fax be sent to several receivers at once?
      instructions:
      - text: Send fax file {file_id} from {sender_number} to {receivers}.
        slots:
          file_id: requestBody.file_id
          sender_number: requestBody.sender_number
          receivers: requestBody.receivers
      - text: Fax {file_id} to {receivers} from {sender_number} as {sender_name}.
        slots:
          file_id: requestBody.file_id
          receivers: requestBody.receivers
          sender_number: requestBody.sender_number
          sender_name: requestBody.sender_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List fax logs across the account
      effect: read
      questions:
      - What faxes were sent and received across the whole account last week?
      - Can I filter account-wide fax logs by site or receiver number?
      instructions:
      - text: List all fax logs on the account.
      - text: List account fax logs for site {site_id} from {from} to {to}.
        slots:
          site_id: query.site_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/logs/{faxLogId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fax log's details
      effect: read
      questions:
      - What are the details of one specific fax?
      - Where do I see the status of a single fax log entry?
      instructions:
      - text: Show fax log {faxLogId}.
        slots:
          faxLogId: path.faxLogId
      - text: Get the details of fax {faxLogId}.
        slots:
          faxLogId: path.faxLogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/logs/{faxLogId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fax log
      effect: destructive
      questions:
      - Can I delete a fax record from the logs?
      - What permanently removes one fax log?
      instructions:
      - text: Delete fax log {faxLogId}.
        slots:
          faxLogId: path.faxLogId
      - text: Remove fax record {faxLogId}.
        slots:
          faxLogId: path.faxLogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/logs/{faxLogId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a fax as read or unread
      effect: write
      questions:
      - How do I mark a received fax as read?
      - Can I flip a fax back to unread?
      instructions:
      - text: Mark fax log {faxLogId} as {read_status}.
        slots:
          faxLogId: path.faxLogId
          read_status: query.read_status
      - text: Set the read status of fax {faxLogId} to {read_status}.
        slots:
          faxLogId: path.faxLogId
          read_status: query.read_status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/fax/logs/{faxLogId}/file/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a fax document
      effect: read
      questions:
      - How do I download the actual document of a fax I received?
      - Can I get the file attached to a fax log?
      instructions:
      - text: Download file {fileId} from fax log {faxLogId}.
        slots:
          fileId: path.fileId
          faxLogId: path.faxLogId
      - text: Save the fax document {fileId} of fax {faxLogId}.
        slots:
          fileId: path.fileId
          faxLogId: path.faxLogId
      method: generated
      generated: '2026-10-01'