# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Efí Pay Cobranças Carnets API
  version: 1.0.0
extends: openapi/gerencianet-carnets-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: 12
- target: $.paths['/carnet'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a carnet of installment boletos
      effect: write
      questions:
      - How do I issue a carnê so a customer pays in monthly boletos?
      - Can I create an installment booklet through the API?
      instructions:
      - text: Create a new carnet.
      - text: Issue an installment booklet of boletos for a customer.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a carnet
      effect: read
      questions:
      - Can I look up a carnet and see its installments?
      - What is the status of each parcel in a carnê?
      instructions:
      - text: Show carnet {id}.
        slots:
          id: path.id
      - text: Get the details of carnet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/parcels'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several carnet parcels at once
      effect: write
      questions:
      - Can I update several parcels of a carnet at once?
      - How do I reschedule the installments of a carnê in one call?
      instructions:
      - text: Update the parcels of carnet {id}.
        slots:
          id: path.id
      - text: Change multiple installments on carnet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/parcel/{parcel}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one carnet parcel
      effect: write
      questions:
      - Can I change just one installment of a carnet?
      - What do I call to edit a single parcel of a carnê?
      instructions:
      - text: Update parcel {parcel} of carnet {id}.
        slots:
          id: path.id
          parcel: path.parcel
      - text: Edit installment {parcel} on carnet {id}.
        slots:
          id: path.id
          parcel: path.parcel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/parcel/{parcel}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel one carnet parcel
      effect: destructive
      questions:
      - Can I cancel a single installment without cancelling the whole carnet?
      - What happens if I cancel one parcel of a carnê?
      instructions:
      - text: Cancel parcel {parcel} of carnet {id}.
        slots:
          id: path.id
          parcel: path.parcel
      - text: Void installment {parcel} on carnet {id}.
        slots:
          id: path.id
          parcel: path.parcel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/parcel/{parcel}/settle'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark one carnet parcel as paid
      effect: write
      questions:
      - Can I mark a carnet installment as paid when the customer paid outside the system?
      - Is there a way to settle a single parcel manually?
      instructions:
      - text: Settle parcel {parcel} of carnet {id}.
        slots:
          id: path.id
          parcel: path.parcel
      - text: Mark installment {parcel} on carnet {id} as paid.
        slots:
          id: path.id
          parcel: path.parcel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/parcel/{parcel}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email one carnet parcel to the customer
      effect: write
      questions:
      - Can I resend just one installment's boleto by email?
      - What do I call to email a single carnet parcel again?
      instructions:
      - text: Resend parcel {parcel} of carnet {id} by email.
        slots:
          id: path.id
          parcel: path.parcel
      - text: Email installment {parcel} of carnet {id} to the payer.
        slots:
          id: path.id
          parcel: path.parcel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a whole carnet
      effect: destructive
      questions:
      - Can I cancel an entire carnê and all its open installments?
      - What cancels a carnet the customer no longer needs?
      instructions:
      - text: Cancel carnet {id}.
        slots:
          id: path.id
      - text: Void the whole carnet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/settle'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a whole carnet as paid
      effect: write
      questions:
      - Can I mark an entire carnê as paid in one step?
      - How do I manually settle every installment of a carnet?
      instructions:
      - text: Settle carnet {id}.
        slots:
          id: path.id
      - text: Mark all of carnet {id} as paid.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/history'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a carnet's history
      effect: write
      questions:
      - Can I add a custom note to a carnet's history?
      - Where do I record a comment on a carnê?
      instructions:
      - text: Add a history note to carnet {id}.
        slots:
          id: path.id
      - text: Record a comment on carnet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a carnet's metadata
      effect: write
      questions:
      - Can I change the metadata stored on a carnet?
      - What updates the metadata of a carnê?
      instructions:
      - text: Update the metadata of carnet {id}.
        slots:
          id: path.id
      - text: Set new metadata on carnet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/carnet/{id}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email the whole carnet to the customer
      effect: write
      questions:
      - Can I resend an entire carnê to the customer by email?
      - What emails the full carnet again?
      instructions:
      - text: Resend carnet {id} by email.
        slots:
          id: path.id
      - text: Email the full carnet {id} to the customer.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'