# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partner Tax Documents API
  version: 1.0.0
extends: openapi/impact-tax-documents-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: 5
- target: $.paths['/Mediapartners/{AccountSID}/TaxDocument'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner's latest tax document
      effect: read
      questions:
      - What's the most recent tax form I saved as a partner?
      - Can I check my latest tax document status?
      instructions:
      - text: Get the most recent tax document for partner account {account}.
        slots:
          account: path.AccountSID
      - text: Show account {account}'s newest saved tax form.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/TaxDocument'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new tax document submission
      effect: write
      questions:
      - How do I begin filling in a W-9 or W-8 form as a partner?
      - Does starting a tax document return a link to sign the form?
      instructions:
      - text: Start a {doctype} tax document for account {account} and return to {url} when done.
        slots:
          account: path.AccountSID
          doctype: requestBody.DocType
          url: requestBody.ReturnUrl
      - text: Create a new tax form submission with provider {provider} for account {account}.
        slots:
          account: path.AccountSID
          provider: requestBody.Provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/TaxDocument/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a specific tax document
      effect: read
      questions:
      - Can I look up one tax document I submitted by its ID?
      - What does a specific submitted tax form record contain?
      instructions:
      - text: Get tax document {id} in account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Show the tax form with ID {id} for account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/TaxDocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all of a partner's tax documents
      effect: read
      questions:
      - Which tax documents have ever been submitted for my partner account?
      - Can I see my full tax form history?
      instructions:
      - text: List every tax document submitted for account {account}.
        slots:
          account: path.AccountSID
      - text: Show all tax forms on partner account {account}.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/TaxDocument/Complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a completed tax form submission
      effect: write
      questions:
      - After a partner finishes the Comply Exchange iframe, how is the form marked as submitted?
      - Is completing a tax submission needed for DocuSign forms too?
      instructions:
      - text: Mark tax document {id} as completed with event {event} for account {account}.
        slots:
          account: path.AccountSID
          id: requestBody.id
          event: requestBody.event
      - text: Record the iframe outcome {event} for tax submission {id} in account {account}.
        slots:
          account: path.AccountSID
          id: requestBody.id
          event: requestBody.event
      method: generated
      generated: '2026-09-26'