Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Extratos (Statements) Statement Schedules API

4 actions 4 updates phrasing extends openapi/gerencianet-statement-schedules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/extrato-cnab/agendamentos'].get
$.paths['/extrato-cnab/agendar'].post
$.paths['/extrato-cnab/agendar/{identificador}'].patch

OpenAPI Overlay

Raw ↑ 
# 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 Extratos (Statements) Statement Schedules API
  version: 1.0.0
extends: openapi/gerencianet-statement-schedules-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: 3
- target: $.paths['/extrato-cnab/agendamentos'].get
  update:
    x-apievangelist-phrasing:
      intent: List statement delivery schedules
      effect: read
      questions:
      - Which recurring CNAB statement deliveries have I scheduled?
      - Can I see my statement schedules?
      instructions:
      - text: List my statement schedules.
      - text: Show the recurring CNAB statement deliveries.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/extrato-cnab/agendar'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule recurring CNAB statements
      effect: write
      questions:
      - How do I schedule CNAB statements to be generated regularly?
      - Can I set up a recurring statement delivery?
      instructions:
      - text: Create a statement schedule.
      - text: Schedule recurring CNAB statement generation.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/extrato-cnab/agendar/{identificador}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a statement delivery schedule
      effect: write
      questions:
      - Can I change a statement schedule I set up?
      - What edits an existing CNAB statement schedule?
      instructions:
      - text: Update statement schedule {identificador}.
        slots:
          identificador: path.identificador
      - text: Change the CNAB schedule {identificador}.
        slots:
          identificador: path.identificador
      method: generated
      generated: '2026-10-01'