# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Credit Notes API
  version: 1.0.0
extends: openapi/drippay-credit-notes-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['/v1/credit-notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit notes
      effect: read
      questions:
      - Which credit notes have been created against my invoices?
      - Can I see all my draft and issued credit notes?
      instructions:
      - text: List my credit notes.
      - text: Show every credit note on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit-notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft credit note on an invoice
      effect: write
      questions:
      - How do I correct an invoice that was already issued without voiding it?
      - Does creating a credit note apply it to the invoice right away?
      instructions:
      - text: Draft a credit note against this invoice for a correction.
      - text: Create a draft credit note to refund part of an issued invoice.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit-notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credit note
      effect: read
      questions:
      - What is the status of one specific credit note?
      - Can I retrieve a credit note by its ID?
      instructions:
      - text: Get credit note {id}.
        slots:
          id: path.id
      - text: Show me the details of credit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit-notes/{id}/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a draft credit note to its invoice
      effect: write
      questions:
      - How do I apply a draft credit note to its invoice?
      - What happens if I try to issue a credit note that isn't a draft?
      instructions:
      - text: Issue draft credit note {id}.
        slots:
          id: path.id
      - text: Apply credit note {id} to its invoice.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit-notes/{id}/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void a credit note
      effect: destructive
      questions:
      - Can I reverse a credit note that was already issued?
      - Is a reason required to void a credit note?
      instructions:
      - text: Void credit note {id}.
        slots:
          id: path.id
      - text: Reverse issued credit note {id} on its invoice.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'