Skip to content

feat(payments): payment orders, checkout and order events #98

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
Domantas merged 2 commits into from
Oct 19, 2026
Merged

feat(payments): payment orders, checkout and order events #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1f4af5
feat(payments): payment orders and checkout on the Api client, regene…
Domantas Oct 19, 2026
2cf2a9b
feat(payments): typed payments.order.* webhooks and asPaymentOrder() …
Domantas Oct 19, 2026
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
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ integration guides live under `integrations/`.

| Surface | Modules | Description |
| ------------------------ | -------------------------: | ------------------------------------------------------------------------------------------------ |
| [`API`](./api/_index.md) | 10 modules · 112 endpoints | Project-scoped data operations: database collections, users, AI chat, auth, API keys. |
| [`Hub`](./hub/_index.md) | 27 modules · 575 endpoints | Project & account configuration: schemas, integrations, team management, billing, observability. |
| [`API`](./api/_index.md) | 11 modules · 120 endpoints | Project-scoped data operations: database collections, users, AI chat, auth, API keys. |
| [`Hub`](./hub/_index.md) | 27 modules · 582 endpoints | Project & account configuration: schemas, integrations, team management, billing, observability. |

## Integration guides

Expand Down
5 changes: 3 additions & 2 deletions docs/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Project-scoped data operations: database collections, users, AI chat, auth, API keys.

**112 endpoints across 10 modules.** Click a module
**120 endpoints across 11 modules.** Click a module
name for the full method reference and TypeScript examples.

| Module | Endpoints | Description |
Expand All @@ -17,5 +17,6 @@ name for the full method reference and TypeScript examples.
| [`echo`](./echo.md) | 1 | Echo helpers used by the gateway smoke checks. |
| [`files`](./files.md) | 14 | File storage integrations and triggers. Upload + download is in `api.database` (FileResource fields). |
| [`membership`](./membership.md) | 43 | Roles, policies, and user preferences (Hub side). For user CRUD and registration see `api.membership`. |
| [`notifications`](./notifications.md) | 7 | Email and push templates, integrations, campaigns, devices, signatures, footers, and one-click unsubscribe. |
| [`notifications`](./notifications.md) | 11 | Email and push templates, integrations, campaigns, devices, signatures, footers, and one-click unsubscribe. |
| [`payments`](./payments.md) | 4 | Payment provider integrations and triggers (Stripe, etc.). |
| [`public`](./public.md) | 3 | |
107 changes: 98 additions & 9 deletions docs/api/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,19 @@ Accessed as `norbix.api.notifications` on the [`Norbix`](../../README.md#authent

## Endpoints

| Method | Verb | Path | Scope |
| ----------------------------------------------------------- | -------- | -------------------------------------------------- | --------- |
| [`registerOwnPushDevice`](#registerownpushdevice) | `POST` | `/{version}/notifications/push/devices` | `project` |
| [`getOwnPushDevices`](#getownpushdevices) | `GET` | `/{version}/notifications/push/devices` | `project` |
| [`deleteOwnPushDevice`](#deleteownpushdevice) | `DELETE` | `/{version}/notifications/push/devices/{Id}` | `project` |
| [`deleteOwnPushDeviceByToken`](#deleteownpushdevicebytoken) | `DELETE` | `/{version}/notifications/push/devices` | `project` |
| [`getOwnPushMessages`](#getownpushmessages) | `GET` | `/{version}/notifications/push/messages` | `project` |
| [`markOwnPushMessageRead`](#markownpushmessageread) | `POST` | `/{version}/notifications/push/messages/{Id}/read` | `project` |
| [`markAllOwnPushMessagesRead`](#markallownpushmessagesread) | `POST` | `/{version}/notifications/push/messages/read` | `project` |
| Method | Verb | Path | Scope |
| ----------------------------------------------------------- | -------- | ------------------------------------------------------ | --------- |
| [`registerOwnPushDevice`](#registerownpushdevice) | `POST` | `/{version}/notifications/push/devices` | `project` |
| [`getOwnPushDevices`](#getownpushdevices) | `GET` | `/{version}/notifications/push/devices` | `project` |
| [`deleteOwnPushDevice`](#deleteownpushdevice) | `DELETE` | `/{version}/notifications/push/devices/{Id}` | `project` |
| [`deleteOwnPushDeviceByToken`](#deleteownpushdevicebytoken) | `DELETE` | `/{version}/notifications/push/devices` | `project` |
| [`getOwnPushMessages`](#getownpushmessages) | `GET` | `/{version}/notifications/push/messages` | `project` |
| [`markOwnPushMessageRead`](#markownpushmessageread) | `POST` | `/{version}/notifications/push/messages/{Id}/read` | `project` |
| [`markAllOwnPushMessagesRead`](#markallownpushmessagesread) | `POST` | `/{version}/notifications/push/messages/read` | `project` |
| [`getNotificationInbox`](#getnotificationinbox) | `GET` | `/{version}/notifications/inbox` | `project` |
| [`getUnreadCount`](#getunreadcount) | `GET` | `/{version}/notifications/inbox/unread-count` | `project` |
| [`markNotificationRead`](#marknotificationread) | `POST` | `/{version}/notifications/inbox/{notificationId}/read` | `project` |
| [`markAllNotificationsRead`](#markallnotificationsread) | `POST` | `/{version}/notifications/inbox/read-all` | `project` |

## Reference

Expand Down Expand Up @@ -171,3 +175,88 @@ const result = await norbix.api.notifications.markAllOwnPushMessagesRead({
```

[↑ Top](#endpoints)

### getNotificationInbox

`GET` `/{version}/notifications/inbox`

Fetch a single item by ID.

**Request DTO**: `CodeMashApi2.GetNotificationInboxRequest`
**Response**: `CodeMashApi2.GetNotificationInboxResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.notifications.getNotificationInbox({
// See CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.GetNotificationInboxResponse
```

[↑ Top](#endpoints)

### getUnreadCount

`GET` `/{version}/notifications/inbox/unread-count`

Fetch a single item by ID.

**Request DTO**: `CodeMashApi2.GetUnreadCountRequest`
**Response**: `CodeMashApi2.GetUnreadCountResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.notifications.getUnreadCount({
// See CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.GetUnreadCountResponse
```

[↑ Top](#endpoints)

### markNotificationRead

`POST` `/{version}/notifications/inbox/{notificationId}/read`

**Request DTO**: `CodeMashApi2.MarkNotificationReadRequest`
**Response**: `CodeMashApi2.MarkNotificationReadResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.notifications.markNotificationRead({
notificationId: 'notificationId-here',
// Other fields: see CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.MarkNotificationReadResponse
```

[↑ Top](#endpoints)

### markAllNotificationsRead

`POST` `/{version}/notifications/inbox/read-all`

**Request DTO**: `CodeMashApi2.MarkAllNotificationsReadRequest`
**Response**: `CodeMashApi2.MarkAllNotificationsReadResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.notifications.markAllNotificationsRead({
// See CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.MarkAllNotificationsReadResponse
```

[↑ Top](#endpoints)
106 changes: 106 additions & 0 deletions docs/api/payments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# API · Payments

[← Back to API index](./_index.md) · [↑ Back to project README](../../README.md)

Payment provider integrations and triggers (Stripe, etc.).

Accessed as `norbix.api.payments` on the [`Norbix`](../../README.md#authentication) client.

## Endpoints

| Method | Verb | Path | Scope |
| ----------------------------------------------- | ------ | ------------------------------------------ | --------- |
| [`createPaymentOrder`](#createpaymentorder) | `POST` | `/{version}/payments/orders` | `project` |
| [`getPaymentOrder`](#getpaymentorder) | `GET` | `/{version}/payments/orders/{Id}` | `project` |
| [`getPaymentOrders`](#getpaymentorders) | `GET` | `/{version}/payments/orders` | `project` |
| [`startPaymentCheckout`](#startpaymentcheckout) | `POST` | `/{version}/payments/orders/{Id}/checkout` | `project` |

## Reference

### createPaymentOrder

`POST` `/{version}/payments/orders`

Create a new item.

**Request DTO**: `CodeMashApi2.CreatePaymentOrderRequest`
**Response**: `CodeMashApi2.IdResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.payments.createPaymentOrder({
// See CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.IdResponse
```

[↑ Top](#endpoints)

### getPaymentOrder

`GET` `/{version}/payments/orders/{Id}`

Fetch a single item by ID.

**Request DTO**: `CodeMashApi2.GetPaymentOrderRequest`
**Response**: `CodeMashApi2.GetPaymentOrderResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.payments.getPaymentOrder({
Id: 'Id-here',
// Other fields: see CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.GetPaymentOrderResponse
```

[↑ Top](#endpoints)

### getPaymentOrders

`GET` `/{version}/payments/orders`

Fetch a single item by ID.

**Request DTO**: `CodeMashApi2.GetPaymentOrdersRequest`
**Response**: `CodeMashApi2.GetPaymentOrdersResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.payments.getPaymentOrders({
// See CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.GetPaymentOrdersResponse
```

[↑ Top](#endpoints)

### startPaymentCheckout

`POST` `/{version}/payments/orders/{Id}/checkout`

**Request DTO**: `CodeMashApi2.StartPaymentCheckoutRequest`
**Response**: `CodeMashApi2.StartPaymentCheckoutResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.api.payments.startPaymentCheckout({
Id: 'Id-here',
// Other fields: see CodeMash type for the full request shape.
});
// → typed as CodeMashApi2.StartPaymentCheckoutResponse
```

[↑ Top](#endpoints)
8 changes: 4 additions & 4 deletions docs/hub/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Project & account configuration: schemas, integrations, team management, billing, observability.

**575 endpoints across 27 modules.** Click a module
**582 endpoints across 27 modules.** Click a module
name for the full method reference and TypeScript examples.

| Module | Endpoints | Description |
| ------------------------------------- | --------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
| [`accessToken`](./access_token.md) | 1 | Refresh-token exchange to get a new bearer token. |
| [`account`](./account.md) | 121 | Account profile, status, verification, team invites, and Stripe billing portal. Most write endpoints require `accountId` on the client. |
| [`account`](./account.md) | 122 | Account profile, status, verification, team invites, and Stripe billing portal. Most write endpoints require `accountId` on the client. |
| [`ai`](./ai.md) | 26 | |
| [`apikeys`](./apikeys.md) | 2 | List and regenerate per-environment API keys for service auth. |
| [`auth`](./auth.md) | 5 | Sign-in / sign-out and federated provider flows. Most apps prefer `norbix.login(...)` over calling these directly. |
Expand All @@ -25,14 +25,14 @@ name for the full method reference and TypeScript examples.
| [`licensing`](./licensing.md) | 3 | |
| [`logs`](./logs.md) | 14 | Logging integrations and module on/off switches. |
| [`membership`](./membership.md) | 48 | Roles, policies, and user preferences (Hub side). For user CRUD and registration see `api.membership`. |
| [`notifications`](./notifications.md) | 124 | Email and push templates, integrations, campaigns, devices, signatures, footers, and one-click unsubscribe. |
| [`notifications`](./notifications.md) | 128 | Email and push templates, integrations, campaigns, devices, signatures, footers, and one-click unsubscribe. |
| [`oauth`](./oauth.md) | 6 | |
| [`payments`](./payments.md) | 17 | Payment provider integrations and triggers (Stripe, etc.). |
| [`projects`](./projects.md) | 5 | |
| [`public`](./public.md) | 3 | |
| [`resources`](./resources.md) | 1 | |
| [`scheduler`](./scheduler.md) | 9 | |
| [`support`](./support.md) | 7 | |
| [`triggers`](./triggers.md) | 1 | |
| [`triggers`](./triggers.md) | 3 | |
| [`webhooks`](./webhooks.md) | 9 | |
| [`wellKnown`](./well_known.md) | 2 | |
24 changes: 24 additions & 0 deletions docs/hub/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Accessed as `norbix.hub.account` on the [`Norbix`](../../README.md#authenticatio
| [`listAiServiceUsers`](#listaiserviceusers) | `GET` | `/{version}/account/ai/service-users` | `project` |
| [`rotateAiServiceUserKey`](#rotateaiserviceuserkey) | `POST` | `/{version}/account/ai/service-users/{Id}/keys` | `project` |
| [`revokeAiServiceUserKey`](#revokeaiserviceuserkey) | `DELETE` | `/{version}/account/ai/service-users/{Id}/keys/{KeyId}` | `project` |
| [`updateAiServiceUser`](#updateaiserviceuser) | `PUT` | `/{version}/account/ai/service-users/{Id}` | `project` |
| [`deleteAiServiceUser`](#deleteaiserviceuser) | `DELETE` | `/{version}/account/ai/service-users/{Id}` | `project` |
| [`getAgentOnboarding`](#getagentonboarding) | `GET` | `/{version}/account/agent/onboarding` | `project` |
| [`getAiContext`](#getaicontext) | `GET` | `/{version}/account/ai/context` | `project` |
Expand Down Expand Up @@ -2279,6 +2280,29 @@ const result = await norbix.hub.account.revokeAiServiceUserKey({

[↑ Top](#endpoints)

### updateAiServiceUser

`PUT` `/{version}/account/ai/service-users/{Id}`

Update an existing item.

**Request DTO**: `CodeMashHub2.UpdateAiServiceUserRequest`
**Response**: `CodeMashHub2.EmptyResponse`

```ts
import { Norbix } from '@norbix.ai/ts';

const norbix = new Norbix();

const result = await norbix.hub.account.updateAiServiceUser({
Id: 'Id-here',
// Other fields: see CodeMash type for the full request shape.
});
// → typed as CodeMashHub2.EmptyResponse
```

[↑ Top](#endpoints)

### deleteAiServiceUser

`DELETE` `/{version}/account/ai/service-users/{Id}`
Expand Down
Loading
Loading