# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gerencianet Recurring Pix API
  version: 1.0.0
extends: openapi/gerencianet-recurring-pix-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/pagamentos-recorrentes/pix'].get
  update:
    x-apievangelist-phrasing:
      intent: List Open Finance recurring Pix payments
      effect: read
      questions:
      - Which recurring Pix payments have I set up through Open Finance?
      - Can I see my Open Finance recurring payment series?
      instructions:
      - text: List my Open Finance recurring Pix payments.
      - text: Show recurring payments I initiated via Open Finance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-recorrentes/pix'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an Open Finance recurring Pix payment
      effect: write
      questions:
      - How do I set up a repeating Pix payment through Open Finance?
      - Can I initiate a series of recurring payments from the payer's bank?
      instructions:
      - text: Start an Open Finance recurring Pix payment.
      - text: Initiate a repeating payment series via Open Finance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-recorrentes/pix/{identificadorPagamento}/cancelar'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel an Open Finance recurring Pix payment
      effect: destructive
      questions:
      - Can I cancel a recurring Pix series I started through Open Finance?
      - What stops future installments of an Open Finance recurring payment?
      instructions:
      - text: Cancel Open Finance recurring payment {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      - text: Stop recurring Pix series {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-recorrentes/pix/{identificadorPagamento}/devolver'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund an Open Finance recurring Pix payment
      effect: write
      questions:
      - Can I refund a payment from an Open Finance recurring series?
      - What returns money on a recurring Pix I collected via Open Finance?
      instructions:
      - text: Refund recurring payment {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      - text: Return the money on Open Finance recurring series {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pagamentos-recorrentes/pix/{identificadorPagamento}/substituir/{endToEndId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace one installment of a recurring Pix
      effect: write
      questions:
      - Can I replace a single installment within an Open Finance recurring payment?
      - What swaps out one parcel of a recurring Pix series?
      instructions:
      - text: Replace parcel {endToEndId} of recurring payment {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
          endToEndId: path.endToEndId
      - text: Swap installment {endToEndId} in recurring series {identificadorPagamento}.
        slots:
          identificadorPagamento: path.identificadorPagamento
          endToEndId: path.endToEndId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/rec'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix Automático recurrences
      effect: read
      questions:
      - Which Pix Automático recurrences have I registered as a biller?
      - Can I see all my rec authorizations?
      instructions:
      - text: List my Pix Automático recurrences.
      - text: Show all recurrence authorizations I've created as a biller.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/rec'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix Automático recurrence
      effect: write
      questions:
      - How do I register a new Pix Automático recurrence for a customer?
      - Can I create a rec before sending the payer an authorization request?
      instructions:
      - text: Create a Pix Automático recurrence.
      - text: Register a new automatic Pix recurrence for a customer.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/rec/{idRec}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix Automático recurrence
      effect: read
      questions:
      - Can I check whether a payer has authorized a Pix Automático recurrence?
      - What status is a given rec in?
      instructions:
      - text: Show Pix Automático recurrence {idRec}.
        slots:
          idRec: path.idRec
      - text: Get the status of recurrence {idRec}.
        slots:
          idRec: path.idRec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/rec/{idRec}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Pix Automático recurrence
      effect: write
      questions:
      - Can I change a Pix Automático recurrence after it was created?
      - What edits an existing rec?
      instructions:
      - text: Update Pix Automático recurrence {idRec}.
        slots:
          idRec: path.idRec
      - text: Edit recurrence {idRec}.
        slots:
          idRec: path.idRec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/solicrec'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask a payer to authorize a recurrence
      effect: write
      questions:
      - How do I send a payer a request to approve Pix Automático?
      - Can I create a solicrec for an existing recurrence?
      instructions:
      - text: Create a recurrence authorization request.
      - text: Send the payer a request to approve their Pix Automático recurrence.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/solicrec/{idSolicRec}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recurrence authorization request
      effect: read
      questions:
      - Has the payer answered my Pix Automático authorization request?
      - Can I look up a solicrec by id?
      instructions:
      - text: Show recurrence request {idSolicRec}.
        slots:
          idSolicRec: path.idSolicRec
      - text: Get the status of authorization request {idSolicRec}.
        slots:
          idSolicRec: path.idSolicRec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/solicrec/{idSolicRec}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a recurrence authorization request
      effect: write
      questions:
      - Can I change or withdraw a Pix Automático authorization request I sent?
      - What edits an existing solicrec?
      instructions:
      - text: Update recurrence request {idSolicRec}.
        slots:
          idSolicRec: path.idSolicRec
      - text: Change authorization request {idSolicRec}.
        slots:
          idSolicRec: path.idSolicRec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/locrec'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix Automático recurrence locations
      effect: read
      questions:
      - Which locations have I created for Pix Automático recurrences?
      - Can I see all my locrec entries?
      instructions:
      - text: List my recurrence locations.
      - text: Show all locrec entries on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/locrec'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix Automático recurrence location
      effect: write
      questions:
      - How do I create a location for a Pix Automático recurrence QR code?
      - Can I reserve a locrec before creating the recurrence?
      instructions:
      - text: Create a recurrence location.
      - text: Reserve a new locrec for a Pix Automático recurrence.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/locrec/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix Automático recurrence location
      effect: read
      questions:
      - Can I see which recurrence a locrec is linked to?
      - What does a recurrence location contain?
      instructions:
      - text: Show recurrence location {id}.
        slots:
          id: path.id
      - text: Get the details of locrec {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/locrec/{id}/idRec'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a recurrence from its location
      effect: destructive
      questions:
      - Can I unlink a Pix Automático recurrence from its locrec?
      - What frees a recurrence location for reuse?
      instructions:
      - text: Unlink the recurrence from location {id}.
        slots:
          id: path.id
      - text: Detach the idRec bound to locrec {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'