Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So Account API

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

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v1/account/me'].get
$.paths['/v1/account/me'].patch
$.paths['/v1/account/summary'].get
$.paths['/v1/account/analytics'].get
$.paths['/v1/account/me/security'].patch
$.paths['/v1/account/delivery/readiness'].get
$.paths['/v1/account/delivery/test'].post
$.paths['/v1/account/account'].delete

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 Hilt So Account API
  version: 1.0.0
extends: openapi/hilt-so-account-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v1/account/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my full merchant profile
      effect: read
      questions:
      - Where can I load everything about my signed-in Hilt profile at once?
      - What profile data does the dashboard pull when I first log in?
      instructions:
      - text: Fetch my full account profile.
      - text: Show me the profile the dashboard bootstraps from.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/me'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update my profile settings
      effect: write
      questions:
      - Can I change my display name or timezone on my merchant profile?
      - How do I adjust my notification preferences?
      instructions:
      - text: Change my display name to {display_name}.
        slots:
          display_name: requestBody.display_name
      - text: Set my profile timezone to {timezone}.
        slots:
          timezone: requestBody.timezone
      - text: Update my notification preferences to {notification_prefs}.
        slots:
          notification_prefs: requestBody.notification_prefs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my merchant dashboard summary
      effect: read
      questions:
      - What are my totals so far, split by USDC and SOL?
      - Is there an overview of my sales grouped per asset for the sidebar?
      instructions:
      - text: Show my merchant account summary by asset.
      - text: Give me the dashboard overview totals.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: View account analytics over a date range
      effect: read
      questions:
      - Can I see my account analytics between two dates?
      - How has my revenue trended day by day over the last month?
      instructions:
      - text: Show my account analytics from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Chart my daily account activity for the past {daily_days} days.
        slots:
          daily_days: query.daily_days
      - text: Summarize my analytics over a {window_days}-day window.
        slots:
          window_days: query.window_days
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/me/security'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change my sign-in email or password
      effect: write
      questions:
      - How do I change the password I use to sign in to hilt.so?
      - Can I switch the email address on my merchant login?
      instructions:
      - text: Change my sign-in email to {email}.
        slots:
          email: requestBody.email
      - text: Change my password from {current_password} to {new_password}.
        slots:
          current_password: requestBody.current_password
          new_password: requestBody.new_password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/delivery/readiness'].get
  update:
    x-apievangelist-phrasing:
      intent: Check delivery setup readiness
      effect: read
      questions:
      - Is my account ready to deliver access to buyers after they pay?
      - Which delivery integrations still need configuring on my account?
      instructions:
      - text: Check whether my delivery setup is ready.
      - text: Show my delivery readiness status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/delivery/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a delivery test for a provider
      effect: write
      questions:
      - Can I test that access delivery works before a real customer buys?
      - How do I run a test delivery through a specific provider?
      instructions:
      - text: Run a delivery test through {provider}.
        slots:
          provider: requestBody.provider
      - text: Send a test delivery using the {provider} integration.
        slots:
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/account'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete my merchant account
      effect: destructive
      questions:
      - How do I close and delete my Hilt account?
      - Is my data hard-deleted when I delete my account, or pseudonymised?
      instructions:
      - text: Delete my merchant account.
      - text: Close my account and pseudonymise my data.
      method: generated
      generated: '2026-09-26'