# 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 Charges API
  version: 1.0.0
extends: openapi/gerencianet-charges-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['/charge'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a charge
      effect: write
      questions:
      - How do I create a charge before choosing how the customer pays?
      - Can I register a charge first and add the payment method later?
      instructions:
      - text: Create a new charge.
      - text: Register a charge without a payment method yet.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/one-step'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and pay a charge in one step
      effect: write
      questions:
      - Can I create a charge and set its boleto or card payment in a single call?
      - What is the one-step way to issue a charge?
      instructions:
      - text: Create a one-step charge.
      - text: Issue a charge with its payment method in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a charge
      effect: read
      questions:
      - Can I look up a single charge and see whether it's paid?
      - What details does a charge return?
      instructions:
      - text: Show charge {id}.
        slots:
          id: path.id
      - text: Get the status of charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charges'].get
  update:
    x-apievangelist-phrasing:
      intent: List charges
      effect: read
      questions:
      - Which charges have I issued?
      - Is there a way to see all my boleto and card charges together?
      instructions:
      - text: List my charges.
      - text: Show all charges on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a charge
      effect: destructive
      questions:
      - Can I cancel a charge the customer hasn't paid?
      - What happens when a charge is cancelled?
      instructions:
      - text: Cancel charge {id}.
        slots:
          id: path.id
      - text: Void unpaid charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/pay'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the payment method on a charge
      effect: write
      questions:
      - How do I turn an existing charge into a boleto or card payment?
      - Can I pick the payment method after the charge was created?
      instructions:
      - text: Set the payment method for charge {id}.
        slots:
          id: path.id
      - text: Pay charge {id} by boleto or card.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/billet'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issued boleto
      effect: write
      questions:
      - Can I modify a boleto I already issued?
      - What updates an existing billet?
      instructions:
      - text: Update the boleto on charge {id}.
        slots:
          id: path.id
      - text: Modify the billet issued for charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/billet/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a boleto to the customer
      effect: write
      questions:
      - Can I resend a boleto to the customer by email?
      - What emails a billet again?
      instructions:
      - text: Resend the boleto for charge {id}.
        slots:
          id: path.id
      - text: Email the billet of charge {id} to the payer.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a charge's metadata
      effect: write
      questions:
      - Can I change the metadata stored on a charge?
      - What updates a charge's metadata?
      instructions:
      - text: Update the metadata of charge {id}.
        slots:
          id: path.id
      - text: Set new metadata on charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/history'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a charge's history
      effect: write
      questions:
      - Can I add my own note to a charge's history?
      - Where do I log a comment on a charge?
      instructions:
      - text: Add a history note to charge {id}.
        slots:
          id: path.id
      - text: Record a comment on charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/balance-sheet'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a balance sheet to a boleto
      effect: write
      questions:
      - Can I add a balance sheet to a boleto?
      - What adds a demonstrative table to a billet?
      instructions:
      - text: Define the balance sheet for charge {id}.
        slots:
          id: path.id
      - text: Attach a balance sheet to the boleto of charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/settle'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a charge as paid manually
      effect: write
      questions:
      - Can I mark a charge as paid if the customer paid another way?
      - How do I settle a charge manually?
      instructions:
      - text: Settle charge {id}.
        slots:
          id: path.id
      - text: Mark charge {id} as paid.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'