@orangecheck/me-client / EventSubtypeMetadata
Interface: EventSubtypeMetadata
Defined in: me-client/src/subtypes.ts:29
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
<a id="property-class"></a> class | EventClass | - | me-client/src/subtypes.ts:31 |
<a id="property-common_use_cases"></a> common_use_cases | readonly string[] | Common use cases · lets integrators search their own product for matching flows. Two-three terms each, lowercase. | me-client/src/subtypes.ts:43 |
<a id="property-example"></a> example | string | A concrete example from a typical SaaS · helps integrators map an unfamiliar subtype name to a real flow they recognize. | me-client/src/subtypes.ts:40 |
<a id="property-fires_when"></a> fires_when | string | When this fires · imperative-mood plain English. The integrator reads this to know which event in their codebase should call oc.event.fire() with this subtype. | me-client/src/subtypes.ts:37 |
<a id="property-id"></a> id | EventSubtype | - | me-client/src/subtypes.ts:30 |
<a id="property-label"></a> label | string | Short label · matches SUBTYPE_LABELS on the server. | me-client/src/subtypes.ts:33 |
<a id="property-typical_price_hint"></a> typical_price_hint | string | What an integrator typically pays for this subtype, anchored at $1 ≈ 1052 sats. Returns null for percent-of-amount subtypes where the price scales with the underlying transaction. | me-client/src/subtypes.ts:47 |