Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Invoices API

7 actions 7 updates phrasing extends openapi/impact-invoices-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/Advertisers/{AccountSID}/Invoices'].get
$.paths['/Advertisers/{AccountSID}/Invoices/{InvoiceId}'].get
$.paths['/Advertisers/{AccountSID}/Invoices/{InvoiceId}/Download'].get
$.paths['/Mediapartners/{AccountSID}/Invoices'].get
$.paths['/Mediapartners/{AccountSID}/Invoices/{Id}'].get
$.paths['/Mediapartners/{AccountSID}/Invoices/{Id}/Download'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Impact Invoices API
  version: 1.0.0
extends: openapi/impact-invoices-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: 6
- target: $.paths['/Advertisers/{AccountSID}/Invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's partner invoices
      effect: read
      questions:
      - Which partner invoices has my brand received this quarter?
      - Can a brand filter partner invoices by creation date?
      instructions:
      - text: As brand account {account}, list partner invoices created between {start} and {end}.
        slots:
          account: path.AccountSID
          start: query.StartDate
          end: query.EndDate
      - text: Show brand account {account}'s most recent partner invoices.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Invoices/{InvoiceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's partner invoice details
      effect: read
      questions:
      - What's on a specific partner invoice my brand was billed?
      - Can a brand look up one partner invoice by ID?
      instructions:
      - text: As brand account {account}, get partner invoice {invoice}.
        slots:
          account: path.AccountSID
          invoice: path.InvoiceId
      - text: Show brand-side details for partner invoice {invoice} in account {account}.
        slots:
          account: path.AccountSID
          invoice: path.InvoiceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Invoices/{InvoiceId}/Download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a brand's partner invoice as PDF
      effect: read
      questions:
      - Can a brand get a PDF copy of a partner invoice for accounting?
      - Where does a brand download a partner invoice file?
      instructions:
      - text: As brand account {account}, download partner invoice {invoice} as a PDF.
        slots:
          account: path.AccountSID
          invoice: path.InvoiceId
      - text: Save the PDF of brand partner invoice {invoice} from account {account}.
        slots:
          account: path.AccountSID
          invoice: path.InvoiceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's invoices
      effect: read
      questions:
      - Which invoices have been issued to me as a partner?
      - Can a partner list only invoices created in a date range?
      instructions:
      - text: As partner account {account}, list invoices from {start} to {end}.
        slots:
          account: path.AccountSID
          start: query.StartDate
          end: query.EndDate
      - text: Show partner account {account}'s latest invoices.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Invoices/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a partner's invoice
      effect: read
      questions:
      - As a partner, can I look up one invoice from either invoicing method?
      - What details does a single partner invoice contain?
      instructions:
      - text: As partner account {account}, retrieve invoice {id}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Get partner invoice {id} in account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Invoices/{Id}/Download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a partner's invoice PDF
      effect: read
      questions:
      - How can a partner download one of their invoices as a PDF file?
      - Is a partner invoice downloadable for my records?
      instructions:
      - text: As partner account {account}, download invoice {id} as PDF.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Save partner invoice {id} file from account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'