Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Billing API

5 actions 5 updates phrasing extends openapi/gumlet-billing-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/mixed/billing/invoice/history'].get
$.paths['/mixed/billing/details'].get
$.paths['/mixed/billing/details'].post
$.paths['/mixed/billing/invoice/upcoming'].get

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 Gumlet Billing API
  version: 1.0.0
extends: openapi/gumlet-billing-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: 4
- target: $.paths['/mixed/billing/invoice/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List past invoices
      effect: read
      questions:
      - Where can I see all the invoices Gumlet has billed me so far?
      - Can I pull my full invoice history for accounting?
      instructions:
      - text: List every invoice generated for my account.
      - text: Show my past billing invoice history.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mixed/billing/details'].get
  update:
    x-apievangelist-phrasing:
      intent: View the organization's billing details
      effect: read
      questions:
      - What billing address and GST number are on file for my organization?
      - Which company name appears on my invoices right now?
      instructions:
      - text: Show the billing details on file for my organization.
      - text: Get my current billing address and tax info.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mixed/billing/details'].post
  update:
    x-apievangelist-phrasing:
      intent: Update billing address and tax details
      effect: write
      questions:
      - Can I change the company name and address printed on my invoices?
      - How do I add or correct the GST number on my billing profile?
      instructions:
      - text: Set my billing company name to {company_name} and GST number to {gst_number}.
        slots:
          company_name: requestBody.company_name
          gst_number: requestBody.gst_number
      - text: Change my billing address to {address_line}, {city}, {state_code} {postal}, {country_code}.
        slots:
          address_line: requestBody.address_line
          city: requestBody.city
          state_code: requestBody.state_code
          postal: requestBody.postal
          country_code: requestBody.country_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mixed/billing/invoice/upcoming'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview the upcoming invoice
      effect: read
      questions:
      - What will my next invoice look like before it's issued?
      - Is there a way to estimate my next bill in advance?
      instructions:
      - text: Show my upcoming invoice.
      - text: Get the details of the next invoice that hasn't been issued yet.
      method: generated
      generated: '2026-10-01'