# 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 Packages API
  version: 1.0.0
extends: openapi/progress-software-packages-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: 10
- target: $.paths['/api/v1/packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List packages I can view
      effect: read
      questions:
      - Which secure packages have been sent to me or that I've sent?
      - Can I list only new packages received from a particular sender?
      - How do I see the packages in one specific mailbox?
      instructions:
      - text: List the packages I can view.
      - text: Show packages I received from {receivedFrom}.
        slots:
          receivedFrom: query.receivedFrom
      - text: 'List packages in mailbox {mailboxId} that are new only: {newOnly}.'
        slots:
          mailboxId: query.mailboxId
          newOnly: query.newOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send or save a secure package
      effect: write
      questions:
      - How do I send a secure package with file attachments to a recipient?
      - Can I make a package expire after a set number of hours or limit attachment downloads?
      - Is it possible to save a package as a draft instead of sending it?
      instructions:
      - text: Send a package to {recipToList} with subject {subject} and attachments {attachments}.
        slots:
          recipToList: requestBody.recipToList
          subject: requestBody.subject
          attachments: requestBody.attachments
      - text: Send package {subject} to {recipToList} that expires in {expirationHours} hours.
        slots:
          subject: requestBody.subject
          recipToList: requestBody.recipToList
          expirationHours: requestBody.expirationHours
      - text: Save a package with subject {subject} as type {type} without sending.
        slots:
          subject: requestBody.subject
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the rules a new package must meet
      effect: read
      questions:
      - What requirements must a package satisfy before I can send it?
      - Are there limits on packages I should check before composing one?
      instructions:
      - text: Show the package sending requirements.
      - text: Get the constraints that apply to composing a package.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/{Id}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's recipients
      effect: read
      questions:
      - Who was a package sent to?
      - Can I see recipient info for a package within a specific mailbox?
      instructions:
      - text: List the recipients of package {Id}.
        slots:
          Id: path.Id
      - text: Show recipient info for package {Id} in mailbox {mailboxId}.
        slots:
          Id: path.Id
          mailboxId: query.mailboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's details
      effect: read
      questions:
      - How do I open a package and see its subject, note and attachments?
      - Can I fetch a package prepared for a reply or forward?
      instructions:
      - text: Show package {Id}.
        slots:
          Id: path.Id
      - text: Get package {Id} prepared for action {action}.
        slots:
          Id: path.Id
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a package from my mailboxes
      effect: destructive
      questions:
      - How do I delete a package from my mailbox?
      - Can I remove a package from just one of my mailboxes?
      instructions:
      - text: Remove package {Id} from my mailboxes.
        slots:
          Id: path.Id
      - text: Delete package {Id} from mailbox {mailboxId}.
        slots:
          Id: path.Id
          mailboxId: query.mailboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Recall a package or change its new flag
      effect: write
      questions:
      - Can I recall a package I sent by mistake?
      - How do I mark a received package as read?
      instructions:
      - text: Recall package {Id}, recalled {recalled}.
        slots:
          Id: path.Id
          recalled: requestBody.recalled
      - text: Set package {Id}'s new flag to {isNew}.
        slots:
          Id: path.Id
          isNew: requestBody.isNew
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/{Id}/notification'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's notification message
      effect: read
      questions:
      - What does the notification email for a package look like?
      - Can I get a package notification with its images included?
      instructions:
      - text: Show the notification message for package {Id}.
        slots:
          Id: path.Id
      - text: Get package {Id}'s notification with includeImages {includeImages}.
        slots:
          Id: path.Id
          includeImages: query.includeImages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a package attachment
      effect: write
      questions:
      - How do I upload a file to attach to a package I'm composing?
      - Can I send a hash along with an attachment upload for integrity checking?
      instructions:
      - text: Upload {file} as a package attachment.
        slots:
          file: requestBody.file
      - text: Upload attachment {file} with {hashtype} hash {hash}.
        slots:
          file: requestBody.file
          hashtype: requestBody.hashtype
          hash: requestBody.hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/packages/attachments/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded package attachment
      effect: destructive
      questions:
      - How do I remove an attachment I uploaded to a package by mistake?
      - Can I delete a package attachment by its ID?
      instructions:
      - text: Delete package attachment {Id}.
        slots:
          Id: path.Id
      - text: Remove the uploaded attachment {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'