# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MOVEit Transfer REST Mailboxes API
  version: 1.0.0
extends: openapi/progress-software-mailboxes-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['/api/v1/mailboxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List my mailboxes
      effect: read
      questions:
      - Which MOVEit Transfer mailboxes do I have, like inbox, sent and trash?
      - What mailboxes can I see for my user account?
      instructions:
      - text: List my mailboxes.
      - text: Show all the mailboxes on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one mailbox
      effect: read
      questions:
      - What information is available about a single mailbox?
      - Can I look up one mailbox by its ID?
      instructions:
      - text: Show mailbox {Id}.
        slots:
          Id: path.Id
      - text: Get the details of mailbox {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}/packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List the packages in a mailbox
      effect: read
      questions:
      - What packages are sitting in my inbox?
      - Can I see everything stored in one mailbox?
      instructions:
      - text: List the packages in mailbox {Id}.
        slots:
          Id: path.Id
      - text: Show the contents of mailbox {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}/packages'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a package to another mailbox
      effect: write
      questions:
      - How do I move a package from my inbox into another mailbox?
      - Can I file a received package into a different folder?
      instructions:
      - text: Move package {packageId} from mailbox {Id} to mailbox {mailboxId}.
        slots:
          packageId: requestBody.packageId
          Id: path.Id
          mailboxId: requestBody.mailboxId
      - text: Refile package {packageId} out of mailbox {Id}.
        slots:
          packageId: requestBody.packageId
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}/packages/{PackageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's details
      effect: read
      questions:
      - What files and message does a specific package contain?
      - Can I open a single package from a mailbox by its ID?
      instructions:
      - text: Show package {packageId} in mailbox {Id}.
        slots:
          packageId: query.packageId
          Id: path.Id
      - text: Get package {packageId} from mailbox {Id} with action {action}.
        slots:
          packageId: query.packageId
          Id: path.Id
          action: query.action
      - text: Open package {PackageId} in mailbox {Id} to prepare a reply or forward.
        slots:
          PackageId: path.PackageId
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}/packages/{packageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a package from a mailbox
      effect: destructive
      questions:
      - How do I delete a package from my mailbox?
      - Can I remove one package without emptying the whole trash?
      instructions:
      - text: Remove package {packageId} from mailbox {Id}.
        slots:
          packageId: path.packageId
          Id: path.Id
      - text: Delete package {packageId} in mailbox {Id}.
        slots:
          packageId: path.packageId
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/{Id}/packages/{packageId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Recall a package or mark it read or unread
      effect: write
      questions:
      - How do I recall a package I already sent?
      - Can I mark a package as new again so it shows as unread?
      instructions:
      - text: Recall package {packageId} in mailbox {Id}.
        slots:
          packageId: path.packageId
          Id: path.Id
      - text: Set package {packageId} in mailbox {Id} to isNew={isNew}.
        slots:
          packageId: path.packageId
          Id: path.Id
          isNew: requestBody.isNew
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/mailboxes/trash'].delete
  update:
    x-apievangelist-phrasing:
      intent: Empty the trash mailbox
      effect: destructive
      questions:
      - How do I permanently empty my trash?
      - Can I clear every package out of the trash in one step?
      instructions:
      - text: Empty my trash.
      - text: Permanently delete everything in the trash mailbox.
      method: generated
      generated: '2026-10-01'