# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Merge Subpackage Attachments API
  version: 1.0.0
extends: openapi/merge-subpackage-attachments-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: 15
- target: $.paths['/accounting/v1/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting attachments
      effect: read
      questions:
      - Can I pull every file attached to records in a customer's accounting system?
      - Which accounting attachments were added after a certain date for one company?
      instructions:
      - text: List accounting attachments for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Get accounting attachments modified since {modified_after} on linked account {account_token}.
        slots:
          modified_after: query.modified_after
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an accounting attachment
      effect: write
      questions:
      - Can I push a receipt or document into a customer's accounting software?
      - Is it possible to create an accounting attachment asynchronously?
      instructions:
      - text: Create an accounting attachment {model} in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Attach document {model} to the books and run it async {run_async}.
        slots:
          model: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one accounting attachment
      effect: read
      questions:
      - What details come back for a single accounting attachment?
      - Can I see the raw third-party data behind one accounting attachment?
      instructions:
      - text: Get accounting attachment {id}.
        slots:
          id: path.id
      - text: Fetch accounting attachment {id} including remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/attachments/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating accounting attachments
      effect: read
      questions:
      - Which fields does a customer's accounting integration accept when uploading an attachment?
      - What do I need to send before creating an accounting attachment?
      instructions:
      - text: Show the accounting attachment POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe required fields for new accounting attachments.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List candidate attachments in the ATS
      effect: read
      questions:
      - Can I get all resumes and cover letters stored for a candidate?
      - Which ATS attachments were created within a date range?
      instructions:
      - text: List attachments for candidate {candidate_id}.
        slots:
          candidate_id: query.candidate_id
      - text: Get ATS attachments created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an attachment to a candidate
      effect: write
      questions:
      - Can I upload a resume to a candidate in a customer's ATS?
      - Which user does the ATS record as having added the attachment?
      instructions:
      - text: Add attachment {model} to the ATS as user {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      - text: Upload candidate file {model} on behalf of recruiter {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one candidate attachment
      effect: read
      questions:
      - What type of document is a given ATS attachment, resume or offer letter?
      - Can I expand the candidate on a single recruiting attachment?
      instructions:
      - text: Get ATS attachment {id}.
        slots:
          id: path.id
      - text: Fetch candidate attachment {id} with the candidate expanded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/attachments/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating ATS attachments
      effect: read
      questions:
      - Which fields does an ATS integration require when uploading a candidate file?
      - What attachment types can I post to a customer's recruiting system?
      instructions:
      - text: Show ATS attachment POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe what a new candidate attachment request needs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base attachments
      effect: read
      questions:
      - Can I list files embedded in help center or wiki articles?
      - Which knowledge base attachments were deleted in the source system?
      instructions:
      - text: List knowledge base attachments for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get wiki attachments modified before {modified_before}.
        slots:
          modified_before: query.modified_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one knowledge base attachment
      effect: read
      questions:
      - What metadata is stored for a single wiki article attachment?
      - Can I get the remote data for one knowledge base file?
      instructions:
      - text: Get knowledge base attachment {id}.
        slots:
          id: path.id
      - text: Fetch wiki attachment {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket attachments
      effect: read
      questions:
      - Can I get every file attached to a specific support ticket?
      - Which ticketing attachments were created in the remote system after a date?
      instructions:
      - text: List attachments on ticket {ticket_id}.
        slots:
          ticket_id: query.ticket_id
      - text: Get ticket attachments remotely created after {remote_created_after}.
        slots:
          remote_created_after: query.remote_created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an attachment to a ticket
      effect: write
      questions:
      - Can I upload a screenshot to a support ticket in a customer's helpdesk?
      - How do I attach a file to an existing ticket?
      instructions:
      - text: Attach file {model} to a ticket in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Create ticketing attachment {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ticket attachment's details
      effect: read
      questions:
      - What metadata is stored for a single ticket attachment?
      - Can I expand the ticket that a helpdesk attachment belongs to?
      instructions:
      - text: Get ticket attachment {id}.
        slots:
          id: path.id
      - text: Fetch ticketing attachment {id} with its ticket expanded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/attachments/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a ticket attachment's contents
      effect: read
      questions:
      - Can I download the actual bytes of a ticket attachment?
      - Is it possible to export a ticket attachment in a different file format?
      instructions:
      - text: Download ticket attachment {id}.
        slots:
          id: path.id
      - text: Download ticket attachment {id} as {mime_type}.
        slots:
          id: path.id
          mime_type: query.mime_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/attachments/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating ticket attachments
      effect: read
      questions:
      - Which fields does a helpdesk integration accept when uploading a ticket attachment?
      - What must a new ticketing attachment request include?
      instructions:
      - text: Show ticketing attachment POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for ticket attachments.
      method: generated
      generated: '2026-09-26'