# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse CRM Public Payments API
  version: 1.0.0
extends: openapi/sendpulse-payments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/payments/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List all my payments
      effect: read
      questions:
      - What payments have been recorded across my whole account?
      - Can I export every payment, not just those for one deal?
      instructions:
      - text: List all payments on my account.
      - text: Show every payment I've received.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/deals/{dealId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments for a deal
      effect: read
      questions:
      - Which payments have been made against a particular deal?
      - Has a deal in my pipeline been paid yet?
      instructions:
      - text: List the payments for deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Show payment records attached to the deal.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/payments/contacts/{contactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments made by a contact
      effect: read
      questions:
      - What has a specific contact paid me?
      - Can I see a customer's payment history by their contact?
      instructions:
      - text: List the payments made by contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Show the payment history for the contact.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a manual payment
      effect: write
      questions:
      - How do I log a payment I received offline against a deal?
      - Can I add a manual payment with a price and currency?
      instructions:
      - text: Record a manual payment of {price} {currency} for deal {dealId}.
        slots:
          price: requestBody.price
          currency: requestBody.currency
          dealId: requestBody.dealId
      - text: Add a manual payment from contact {contactId} described as {description}.
        slots:
          contactId: requestBody.contactId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/{paymentId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a manual payment
      effect: write
      questions:
      - How do I mark a manually entered payment as approved?
      - Can I confirm a manual payment once the money arrives?
      instructions:
      - text: Approve manual payment {paymentId}.
        slots:
          paymentId: path.paymentId
      - text: Mark payment {paymentId} as approved.
        slots:
          paymentId: path.paymentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/{paymentId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a manual payment
      effect: destructive
      questions:
      - How do I cancel a manual payment that was entered by mistake?
      - Can I void a manually created payment?
      instructions:
      - text: Cancel manual payment {paymentId}.
        slots:
          paymentId: path.paymentId
      - text: Set payment {paymentId} to canceled.
        slots:
          paymentId: path.paymentId
      method: generated
      generated: '2026-10-01'