Skip to content

docs(sdk): sync me-client@0.23.0 #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xaxis merged 1 commit into from
Jul 5, 2026
Merged

docs(sdk): sync me-client@0.23.0 #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/pages/sdk/me-client/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export const metadata = {
- [ClassCSubtype](type-aliases/ClassCSubtype.mdx)
- [DropCadence](type-aliases/DropCadence.mdx)
- [EventClass](type-aliases/EventClass.mdx)
- [EventKey](type-aliases/EventKey.mdx)
- [EventSubtype](type-aliases/EventSubtype.mdx)
- [FamilyVerb](type-aliases/FamilyVerb.mdx)
- [FederationStatus](type-aliases/FederationStatus.mdx)
Expand Down
2 changes: 1 addition & 1 deletion src/pages/sdk/me-client/functions/computeFees.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function computeFees(
}): ComputedFees;
```

Defined in: [me-client/src/types.ts:156](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L156)
Defined in: [me-client/src/types.ts:168](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L168)

Compute the four-way fee split for an event given an integrator's
config and (for percent_of_amount events) the underlying payment
Expand Down
2 changes: 1 addition & 1 deletion src/pages/sdk/me-client/functions/validateIntegratorConfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const metadata = {
function validateIntegratorConfig(cfg: IntegratorPriceConfig): ValidationResult;
```

Defined in: [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205)
Defined in: [me-client/src/types.ts:217](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L217)

Validate an integrator's pricing config against the platform's
non-negotiable rules. Run client-side before posting; the server runs
Expand Down
8 changes: 4 additions & 4 deletions src/pages/sdk/me-client/interfaces/AgentClassOverride.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const metadata = {

# Interface: AgentClassOverride

Defined in: [me-client/src/types.ts:90](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L90)
Defined in: [me-client/src/types.ts:101](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L101)

Optional per-class pricing overrides · per OCHK-V3-PLAN §7 phase-1.
Agents acting under a scoped oc-agent delegation may bill
Expand All @@ -24,6 +24,6 @@ Optional per-class pricing overrides · per OCHK-V3-PLAN §7 phase-1.

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-refuse"></a> `refuse?` | `boolean` | When true, agent traffic is refused for this subtype. | [me-client/src/types.ts:96](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L96) |
| <a id="property-site_pays"></a> `site_pays?` | [`SiteFeeShape`](../type-aliases/SiteFeeShape.mdx) | Override site_pays for agent-fired events. | [me-client/src/types.ts:92](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L92) |
| <a id="property-user_share_pct"></a> `user_share_pct?` | `number` | Override user_share_pct. Same default-fallback as site_pays. | [me-client/src/types.ts:94](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L94) |
| <a id="property-refuse"></a> `refuse?` | `boolean` | When true, agent traffic is refused for this subtype. | [me-client/src/types.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L107) |
| <a id="property-site_pays"></a> `site_pays?` | [`SiteFeeShape`](../type-aliases/SiteFeeShape.mdx) | Override site_pays for agent-fired events. | [me-client/src/types.ts:103](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L103) |
| <a id="property-user_share_pct"></a> `user_share_pct?` | `number` | Override user_share_pct. Same default-fallback as site_pays. | [me-client/src/types.ts:105](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L105) |
30 changes: 15 additions & 15 deletions src/pages/sdk/me-client/interfaces/BillableEvent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const metadata = {

# Interface: BillableEvent

Defined in: [me-client/src/types.ts:248](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L248)
Defined in: [me-client/src/types.ts:260](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L260)

## Extended by

Expand All @@ -21,17 +21,17 @@ Defined in: [me-client/src/types.ts:248](https://github.com/orangecheck/oc-packa

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | - | [me-client/src/types.ts:251](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L251) |
| <a id="property-drop"></a> `drop?` | \| \{ `close_height_target`: `number` \| `null`; `window_id`: `string`; \} \| `null` | Drop-period stamp · present when the project covers this subtype with a drop schedule. The user-share of a stamped event MATURES until the window's boundary, then vests as one batch (the drop). Billing is untouched. Part of the SIGNED canonical bytes (encoder branches to v=4 when present). No clawback exists — vesting is unconditional, and an open window's boundary can only ever move earlier. | [me-client/src/types.ts:273](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L273) |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | [me-client/src/types.ts:254](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L254) |
| <a id="property-id"></a> `id` | `string` | - | [me-client/src/types.ts:249](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L249) |
| <a id="property-is_agent"></a> `is_agent?` | `boolean` | Per OCHK-V3-PLAN §7 phase-1 · true when the event was fired by an oc-agent delegation rather than a human session. The integrator's IntegratorEventConfig.agent block may price these differently or refuse them. Optional · canonical encoder branches to v=3 only when present, so legacy human-fired events keep their v=2 hash + signature. | [me-client/src/types.ts:265](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L265) |
| <a id="property-occurred_at"></a> `occurred_at` | `string` | - | [me-client/src/types.ts:250](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L250) |
| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | - | [me-client/src/types.ts:255](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L255) |
| <a id="property-site"></a> `site` | \{ `display_name`: `string`; `domain`: `string`; \} | - | [me-client/src/types.ts:253](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L253) |
| `site.display_name` | `string` | - | [me-client/src/types.ts:253](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L253) |
| `site.domain` | `string` | - | [me-client/src/types.ts:253](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L253) |
| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | - | [me-client/src/types.ts:257](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L257) |
| <a id="property-subtype"></a> `subtype` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | - | [me-client/src/types.ts:252](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L252) |
| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | - | [me-client/src/types.ts:256](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L256) |
| <a id="property-verify_url"></a> `verify_url` | `string` | - | [me-client/src/types.ts:258](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L258) |
| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | - | [me-client/src/types.ts:263](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L263) |
| <a id="property-drop"></a> `drop?` | \| \{ `close_height_target`: `number` \| `null`; `window_id`: `string`; \} \| `null` | Drop-period stamp · present when the project covers this subtype with a drop schedule. The user-share of a stamped event MATURES until the window's boundary, then vests as one batch (the drop). Billing is untouched. Part of the SIGNED canonical bytes (encoder branches to v=4 when present). No clawback exists — vesting is unconditional, and an open window's boundary can only ever move earlier. | [me-client/src/types.ts:285](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L285) |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | [me-client/src/types.ts:266](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L266) |
| <a id="property-id"></a> `id` | `string` | - | [me-client/src/types.ts:261](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L261) |
| <a id="property-is_agent"></a> `is_agent?` | `boolean` | Per OCHK-V3-PLAN §7 phase-1 · true when the event was fired by an oc-agent delegation rather than a human session. The integrator's IntegratorEventConfig.agent block may price these differently or refuse them. Optional · canonical encoder branches to v=3 only when present, so legacy human-fired events keep their v=2 hash + signature. | [me-client/src/types.ts:277](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L277) |
| <a id="property-occurred_at"></a> `occurred_at` | `string` | - | [me-client/src/types.ts:262](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L262) |
| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | - | [me-client/src/types.ts:267](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L267) |
| <a id="property-site"></a> `site` | \{ `display_name`: `string`; `domain`: `string`; \} | - | [me-client/src/types.ts:265](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L265) |
| `site.display_name` | `string` | - | [me-client/src/types.ts:265](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L265) |
| `site.domain` | `string` | - | [me-client/src/types.ts:265](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L265) |
| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | - | [me-client/src/types.ts:269](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L269) |
| <a id="property-subtype"></a> `subtype` | [`EventKey`](../type-aliases/EventKey.mdx) | - | [me-client/src/types.ts:264](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L264) |
| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | - | [me-client/src/types.ts:268](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L268) |
| <a id="property-verify_url"></a> `verify_url` | `string` | - | [me-client/src/types.ts:270](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L270) |
10 changes: 5 additions & 5 deletions src/pages/sdk/me-client/interfaces/ComputedFees.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const metadata = {

# Interface: ComputedFees

Defined in: [me-client/src/types.ts:130](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L130)
Defined in: [me-client/src/types.ts:142](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L142)

A computed fee breakdown for a single event. site_rebate_sats is what
flows back to the integrator's OC balance after OC's platform fee and
Expand All @@ -21,7 +21,7 @@ A computed fee breakdown for a single event. site_rebate_sats is what

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | [me-client/src/types.ts:131](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L131) |
| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | [me-client/src/types.ts:132](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L132) |
| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | [me-client/src/types.ts:134](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L134) |
| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | [me-client/src/types.ts:133](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L133) |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | [me-client/src/types.ts:143](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L143) |
| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | [me-client/src/types.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L144) |
| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | [me-client/src/types.ts:146](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L146) |
| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | [me-client/src/types.ts:145](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L145) |
30 changes: 15 additions & 15 deletions src/pages/sdk/me-client/interfaces/DropClosedWebhookPayload.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const metadata = {

# Interface: DropClosedWebhookPayload

Defined in: [me-client/src/types.ts:393](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L393)
Defined in: [me-client/src/types.ts:405](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L405)

The `drop.closed` system event — one per closed drop window. The
manifest is the signed, content-addressed record (Merkle commitments
Expand All @@ -32,17 +32,17 @@ The `drop.closed` system event — one per closed drop window. The

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-event_count"></a> `event_count` | `number` | - | - | [me-client/src/types.ts:402](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L402) |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | - | [me-client/src/types.ts:404](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L404) |
| <a id="property-kind"></a> `kind` | `"oc-system-event"` | - | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`kind`](SystemWebhookPayload.mdx#property-kind) | [me-client/src/types.ts:383](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L383) |
| <a id="property-label"></a> `label` | `string` | - | - | [me-client/src/types.ts:397](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L397) |
| <a id="property-manifest_id"></a> `manifest_id` | `string` | - | - | [me-client/src/types.ts:398](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L398) |
| <a id="property-project_key"></a> `project_key` | `string` | - | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`project_key`](SystemWebhookPayload.mdx#property-project_key) | [me-client/src/types.ts:385](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L385) |
| <a id="property-recipient_count"></a> `recipient_count` | `number` | - | - | [me-client/src/types.ts:403](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L403) |
| <a id="property-schedule_id"></a> `schedule_id` | `string` | - | - | [me-client/src/types.ts:396](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L396) |
| <a id="property-sealed_at"></a> `sealed_at` | `string` | - | - | [me-client/src/types.ts:400](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L400) |
| <a id="property-sealed_height"></a> `sealed_height` | `number` \| `null` | - | - | [me-client/src/types.ts:401](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L401) |
| <a id="property-subtype"></a> `subtype` | `"drop.closed"` | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`subtype`](SystemWebhookPayload.mdx#property-subtype) | - | [me-client/src/types.ts:394](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L394) |
| <a id="property-user_share_sats"></a> `user_share_sats` | `number` | - | - | [me-client/src/types.ts:405](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L405) |
| <a id="property-verify_url"></a> `verify_url` | `string` | - | - | [me-client/src/types.ts:399](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L399) |
| <a id="property-window_id"></a> `window_id` | `string` | - | - | [me-client/src/types.ts:395](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L395) |
| <a id="property-event_count"></a> `event_count` | `number` | - | - | [me-client/src/types.ts:414](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L414) |
| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | - | [me-client/src/types.ts:416](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L416) |
| <a id="property-kind"></a> `kind` | `"oc-system-event"` | - | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`kind`](SystemWebhookPayload.mdx#property-kind) | [me-client/src/types.ts:395](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L395) |
| <a id="property-label"></a> `label` | `string` | - | - | [me-client/src/types.ts:409](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L409) |
| <a id="property-manifest_id"></a> `manifest_id` | `string` | - | - | [me-client/src/types.ts:410](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L410) |
| <a id="property-project_key"></a> `project_key` | `string` | - | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`project_key`](SystemWebhookPayload.mdx#property-project_key) | [me-client/src/types.ts:397](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L397) |
| <a id="property-recipient_count"></a> `recipient_count` | `number` | - | - | [me-client/src/types.ts:415](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L415) |
| <a id="property-schedule_id"></a> `schedule_id` | `string` | - | - | [me-client/src/types.ts:408](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L408) |
| <a id="property-sealed_at"></a> `sealed_at` | `string` | - | - | [me-client/src/types.ts:412](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L412) |
| <a id="property-sealed_height"></a> `sealed_height` | `number` \| `null` | - | - | [me-client/src/types.ts:413](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L413) |
| <a id="property-subtype"></a> `subtype` | `"drop.closed"` | [`SystemWebhookPayload`](SystemWebhookPayload.mdx).[`subtype`](SystemWebhookPayload.mdx#property-subtype) | - | [me-client/src/types.ts:406](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L406) |
| <a id="property-user_share_sats"></a> `user_share_sats` | `number` | - | - | [me-client/src/types.ts:417](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L417) |
| <a id="property-verify_url"></a> `verify_url` | `string` | - | - | [me-client/src/types.ts:411](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L411) |
| <a id="property-window_id"></a> `window_id` | `string` | - | - | [me-client/src/types.ts:407](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L407) |
Loading