Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So Memberships API

12 actions 12 updates phrasing extends openapi/hilt-so-memberships-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 12

$.info
$.paths['/v1/memberships'].get
$.paths['/v1/memberships/lookup'].get
$.paths['/v1/memberships/renewal-intelligence'].get
$.paths['/v1/memberships/{membership_id}'].get
$.paths['/v1/memberships/{membership_id}/notes'].patch
$.paths['/v1/memberships/{membership_id}/profile'].patch
$.paths['/v1/memberships/{membership_id}/gift'].post
$.paths['/v1/memberships/{membership_id}/retry-delivery'].post
$.paths['/v1/memberships/{membership_id}/delivery-diagnostics'].get
$.paths['/v1/memberships/{membership_id}/delivery-support-ticket'].post
$.paths['/v1/memberships/{membership_id}/reactivation'].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 Hilt So Memberships API
  version: 1.0.0
extends: openapi/hilt-so-memberships-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: 11
- target: $.paths['/v1/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List memberships
      effect: read
      questions:
      - Which members currently have access to my products?
      - Can I filter memberships by status or platform?
      - How do I search my members by name or handle?
      instructions:
      - text: List memberships for product {product_id}.
        slots:
          product_id: query.product_id
      - text: Show {status} memberships on {platform}.
        slots:
          status: query.status
          platform: query.platform
      - text: Search memberships for {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up memberships by wallet or transaction
      effect: read
      questions:
      - Which membership belongs to this wallet address?
      - Can I find a membership from the transaction signature that paid for it?
      instructions:
      - text: Look up memberships for wallet {wallet}.
        slots:
          wallet: query.wallet
      - text: Find the membership paid by transaction {tx_signature}.
        slots:
          tx_signature: query.tx_signature
      - text: Look up memberships for identity {identity}.
        slots:
          identity: query.identity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/renewal-intelligence'].get
  update:
    x-apievangelist-phrasing:
      intent: Get renewal cohorts and reminders
      effect: read
      questions:
      - Which members are coming up for renewal soon?
      - What does my renewal reporting look like over the next few weeks?
      instructions:
      - text: Show members renewing within {window_days} days.
        slots:
          window_days: query.window_days
      - text: Give me the renewal intelligence report.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a membership
      effect: read
      questions:
      - What are the details of a specific membership?
      - When does this member's access expire?
      instructions:
      - text: Get membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Show expiry for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/notes'].patch
  update:
    x-apievangelist-phrasing:
      intent: Save notes on a membership
      effect: write
      questions:
      - Can I keep private merchant notes on a member?
      - Where do I record internal notes about a membership?
      instructions:
      - text: Save note {notes} on membership {membership_id}.
        slots:
          notes: requestBody.notes
          membership_id: path.membership_id
      - text: Update merchant notes for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/profile'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a member's display details
      effect: write
      questions:
      - Can I change how a member's platform name is displayed?
      - How do I correct a member's shown handle?
      instructions:
      - text: Set the platform display of membership {membership_id} to {platform_display}.
        slots:
          membership_id: path.membership_id
          platform_display: requestBody.platform_display
      - text: Update display details for member {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/gift'].post
  update:
    x-apievangelist-phrasing:
      intent: Gift extra access days to a member
      effect: write
      questions:
      - Can I give a member free extra days of access?
      - Is it possible to add a note when gifting a membership extension?
      instructions:
      - text: Gift {days} days to membership {membership_id}.
        slots:
          days: requestBody.days
          membership_id: path.membership_id
      - text: Extend member {membership_id} by {days} days with note {note}.
        slots:
          membership_id: path.membership_id
          days: requestBody.days
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/retry-delivery'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry access delivery for a member
      effect: write
      questions:
      - A member paid but never got into the group - can I retry delivery?
      - What do I do if a member's access delivery failed?
      instructions:
      - text: Retry access delivery for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Re-send access to member {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/delivery-diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: Diagnose Telegram or Discord delivery for a member
      effect: read
      questions:
      - Why wasn't a member added to my Telegram or Discord?
      - Can I inspect the bot automation for one membership?
      instructions:
      - text: Diagnose delivery for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Show the Telegram or Discord automation state for member {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/delivery-support-ticket'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a support ticket for a delivery issue
      effect: write
      questions:
      - Can I escalate a member's delivery problem to Hilt support?
      - Will it reuse an existing ticket if one is already open for that member?
      instructions:
      - text: Open a delivery support ticket for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Escalate member {membership_id}'s delivery issue to support.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memberships/{membership_id}/reactivation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get renewal and reactivation links for a member
      effect: read
      questions:
      - How do I get a link so a lapsed member can come back?
      - Where can I find a member's renewal link to send them?
      instructions:
      - text: Get reactivation links for membership {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Show the renewal link for member {membership_id}.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'