Cloud API from your server · Node 20+, Bun, Deno, Workers

@openseat/node

Server client for the OpenSeat Cloud API: hold, book, release and block seats with your secret key, create events from your own platform, and verify OpenSeat webhooks. Zero dependencies.

The OpenSeat Cloud API from your server. Hold, book, release and block seats with your secret key, create events from your own ticketing platform, mint embeddable-designer sessions, and verify OpenSeat webhooks.

1 function
3 classes
32 interfaces
16 types
4 constants
MIT

npm i @openseat/node

first npm release pending

Install commands show the public npm names. The first npm release is pending; the packages are free and MIT licensed.

/

Import

import {
  OpenSeat,
  OpenSeatError,
  verifyWebhook,
} from "@openseat/node";
import type {
  OpenSeatWebhookEvent,
  ServerHoldInput,
} from "@openseat/node";

Functions1

function

verifyWebhook

Verifies an OpenSeat webhook and returns its parsed body. Pass the RAW request body (the exact bytes OpenSeat sent: express.raw({ type: "application/json" }), or await request.text()), never re-serialised JSON. During a secret rotation pass both secrets; any one matching any v1 is enough. Throws OpenSeatWebhookError.

function verifyWebhook(
  rawBody: string | Uint8Array,
  signatureHeader: string | null | undefined,
  secret: string | readonly string[],
  o?: VerifyWebhookOptions,
): Promise<OpenSeatWebhookEvent>;

Parameters

Parameter	Type	Description
`rawBody`	`string \| Uint8Array`
`signatureHeader`	`string \| null \| undefined`
`secret`	`string \| readonly string[]`
`o`optional	`VerifyWebhookOptions`	Default `{}`

Returns

Promise<OpenSeatWebhookEvent>

@openseat/node/src/webhooks.ts

Classes3

class

OpenSeat

The OpenSeat Cloud API from your server, with your secret key. Never construct it in a browser.

class OpenSeat

Members

Member	Type	Description
`constructor`constructor	`(o: OpenSeatOptions)`
`me`method	`() => Promise<MeResponse>`	Who this key is: answers "is my key working?".
`holds`	`{ create: (i: { eventKey: string; } & ServerHoldInput & { idempotencyKey?: string; }) => Promise<ServerHold>; retrieve: (holdToken: string) => Promise<HoldDetails>; attachOrder: (holdToken: string, orderId: string) => Promise<HoldDetails>; extend: (holdToken: string, i: { seconds: number; }) => Promise<HoldDetails>; release: (holdToken: string) => Promise<HoldDetails>; }`
`events`	`{ list: () => AsyncIterable<EventSummary>; retrieve: (eventKey: string) => Promise<EventDetails>; objects: (eventKey: string, q?: { status?: SeatStatus; }) => AsyncIterable<SeatObject>; categories: (eventKey: string) => Promise<CategoryInfo[]>; create: (i: CreateEventInput & { idempotencyKey?: string; }) => Promise<CreatedEvent>; update: (eventKey: string, i: UpdateEventInput) => Promise<EventDetails>; changeLayout: …`
`bookings`	`{ list: (q?: BookingListQuery) => AsyncIterable<Booking>; retrieve: (id: string) => Promise<Booking>; byOrder: (eventKey: string, orderId: string) => Promise<Booking \| null>; eraseExtraData: (id: string) => Promise<void>; }`
`webhookEndpoints`	`{ list: () => Promise<WebhookEndpoint[]>; create: (i: CreateWebhookEndpointInput) => Promise<WebhookEndpoint & { secret: string; }>; retrieve: (id: string) => Promise<WebhookEndpoint>; update: (id: string, i: UpdateWebhookEndpointInput) => Promise<WebhookEndpoint>; delete: (id: string) => Promise<void>; rotateSecret: (id: string, i?: { overlapHours?: number; }) => Promise<{ secret: string; }>; test: (id: string) => P …`
`layouts`	`{ list: () => AsyncIterable<LayoutSummary>; retrieve: (layoutKey: string) => Promise<LayoutDetails>; }`
`designerSessions`	`{ create: (i: CreateDesignerSessionInput) => Promise<DesignerSessionCreated>; retrieve: (id: string) => Promise<DesignerSessionInfo>; revoke: (id: string) => Promise<void>; }`

Every member is readonly.

@openseat/node/src/client.ts

class

OpenSeatError

A failed OpenSeat call. Switch on code (and reason for the detail); check refundRequired after book.

class OpenSeatError extends Error

Extends Error: its public members apply here too.

Members

Member	Type	Description
`name`	`unknown`
`code`	`OpenSeatErrorCode`
`reason`optional	`OpenSeatErrorReason`
`status`optional	`number`	The HTTP status, when the server answered.
`requestId`optional	`string`	`OpenSeat-Request-Id` of the failed response; quote it in support requests.
`retryable`	`boolean`	True when the same call may succeed later (network errors, timeouts, 429 and 5xx).
`retryAfterMs`optional	`number`	From `Retry-After` on 429 and 503 responses.
`unavailableSeatIds`optional	`readonly string[]`
`unavailableAreaIds`optional	`readonly string[]`
`details`optional	`readonly { path: string; message: string; }[]`	Field-level problems of a 422 VALIDATION refusal.
`refundRequired`	`boolean`	True when the booking can never succeed for this payment: refund the buyer.
`constructor`constructor	`(code: OpenSeatErrorCode, message: string, o?: OpenSeatErrorOptions)`

Every member is readonly.

@openseat/node/src/errors.ts

class

OpenSeatWebhookError

class OpenSeatWebhookError extends Error

Extends Error: its public members apply here too.

Members

Member	Type	Description
`name`	`unknown`
`code`	`OpenSeatWebhookErrorCode`
`constructor`constructor	`(code: OpenSeatWebhookErrorCode, message: string)`

Every member is readonly.

@openseat/node/src/webhooks.ts

Interfaces32

interface

AreaQuantity

interface AreaQuantity

Members

Member	Type	Description
`inventoryId`	`string`
`quantity`	`number`

@openseat/node/src/cloud-wire.ts

interface

AreaRecord

interface AreaRecord

Members

Member	Type	Description
`inventoryId`	`string`
`status`	`SeatStatus`
`remaining`	`number`
`capacity`	`number`
`version`	`number`

@openseat/node/src/cloud-wire.ts

interface

BlockResult

interface BlockResult

Members

Member	Type	Description
`blocked`	`string[]`
`notBlocked`	`{ objectId: string; reason: "held" \| "booked" \| "unknown" \| "already_blocked"; }[]`

@openseat/node/src/client.ts

interface

BookingListQuery

interface BookingListQuery

Members

Member	Type	Description
`eventKey`optional	`string`
`orderId`optional	`string`
`status`optional	`"confirmed" \| "cancelled"`
`source`optional	`"hosted" \| "api"`

@openseat/node/src/client.ts

interface

BookInput

interface BookInput

Members

Member	Type	Description
`eventKey`	`string`
`holdToken`	`string`
`orderId`	`string`	Your order ID. It is attached to the hold if it isn't already.
`seatIds`optional	`readonly string[]`	When sent, must equal the hold's seats (as sets), else 409 HOLD_MISMATCH and nothing is booked.
`areas`optional	`AreaQuantity[]`
`extraData`optional	`Record<string, unknown>`
`seatExtraData`optional	`Record<string, Record<string, unknown>>`
`amountPaise`optional	`number`	What you charged, for your own records. Informational.
`idempotencyKey`optional	`string`	Default `book:<eventKey>:<orderId>`, so a retry after a crash replays the same booking.

@openseat/node/src/client.ts

interface

CategoryInfo

One ticket type (category) of the layout the event was published with (events.categories).

interface CategoryInfo

Members

Member	Type	Description
`categoryId`	`string`
`name`	`string`
`colour`	`string \| null`
`seats`	`number`
`places`	`number`
`booths`	`number`
`priceLabel`	`string \| null`
`sellable`	`boolean`

@openseat/node/src/cloud-wire.ts

interface

CreateDesignerSessionInput

interface CreateDesignerSessionInput

Members

Member	Type	Description
`layoutKey`optional	`string`	Edit this existing layout. Leave out (with or without `create`) for a session that creates one.
`create`optional	`{ name: string; layoutKey?: string; }`	Let the session create a new layout with this name (and optional key).
`permissions`optional	`DesignerPermission[]`	Default both `layout:read` and `layout:write`.
`origin`	`string`	The exact origin of the page that embeds the designer; it must be one of your allowed designer origins.
`expiresIn`optional	`number`	Seconds. Default 1800. Default `1800`
`user`optional	`{ id?: string; name?: string; }`	Your admin user, shown in OpenSeat's activity log (display only).

@openseat/node/src/client.ts

interface

CreateEventInput

What events.create sends to POST /server/events.

interface CreateEventInput

Members

Member	Type	Description
`eventKey`	`string`
`layoutKey`	`string`
`name`	`string`
`startsAt`	`string`
`venue`optional	`string`
`maxTicketsPerBooking`optional	`number`
`holdSeconds`optional	`number`
`categoryPriceLabels`optional	`Record<string, string>`

@openseat/node/src/cloud-wire.ts

interface

CreateWebhookEndpointInput

interface CreateWebhookEndpointInput

Members

Member	Type	Description
`url`	`string`
`description`optional	`string`
`eventTypes`	`string[]`
`eventKeys`optional	`string[]`
`includeExtraData`optional	`boolean`

@openseat/node/src/client.ts

interface

DesignerExternalUser

The platform's own user, as it passed it when minting (display only, never authorization).

interface DesignerExternalUser

Members

Member	Type	Description
`id`	`string \| null`
`name`	`string \| null`

@openseat/node/src/designer-wire.ts

interface

DesignerSessionCreated

A new designer session (designerSessions.create). The token is shown once; embedUrl carries it in the fragment.

interface DesignerSessionCreated

Members

Member	Type	Description
`id`	`string`
`token`	`string`
`embedUrl`	`string`
`expiresAt`	`string`
`mode`	`Mode`
`layoutKey`	`string \| null`
`permissions`	`DesignerPermission[]`
`origin`	`string`

@openseat/node/src/designer-wire.ts

interface

DesignerSessionInfo

A designer session as designerSessions.retrieve and the dashboard's session list show it (never its token).

interface DesignerSessionInfo

Members

Member	Type	Description
`id`	`string`
`mode`	`Mode`
`layoutKey`	`string \| null`
`permissions`	`DesignerPermission[]`
`origin`	`string`
`createdAt`	`string`
`expiresAt`	`string`
`lastUsedAt`	`string \| null`
`closedAt`	`string \| null`
`revokedAt`	`string \| null`
`status`	`DesignerSessionStatus`
`saves`	`number`
`externalUser`	`DesignerExternalUser \| null`
`createdBy`	`{ userId: string; name: string \| null; } \| null`	The dashboard user who opened a preview session; null for API-minted sessions.

@openseat/node/src/designer-wire.ts

interface

EventDetails

interface EventDetails extends EventSummary

Extends EventSummary

Members

Member	Type	Description
`counts`	`{ available: number; held: number; booked: number; blocked: number; }`	Seats; an expired hold counts as available.
`areas`	`(AreaRecord & { label: string; held: number; sold: number; blocked: boolean; })[]`
`priceLabels`	`Record<string, string>`
`eventKey`	`string`	From `EventSummary`
`name`	`string`	From `EventSummary`
`startsAt`	`string`	From `EventSummary`
`venue`	`string`	From `EventSummary`
`mode`	`Mode`	From `EventSummary`
`status`	`"published" \| "archived"`	From `EventSummary`
`saleOpen`	`boolean`	From `EventSummary`
`hostedPage`	`boolean`	From `EventSummary`
`apiAccess`	`boolean`	From `EventSummary`
`layoutRevision`	`number`	From `EventSummary`
`holdSeconds`	`number`	From `EventSummary`
`maxTicketsPerBooking`	`number`	From `EventSummary`

@openseat/node/src/cloud-wire.ts

interface

EventSummary

interface EventSummary

Members

Member	Type	Description
`eventKey`	`string`
`name`	`string`
`startsAt`	`string`
`venue`	`string`
`mode`	`Mode`
`status`	`"published" \| "archived"`
`saleOpen`	`boolean`
`hostedPage`	`boolean`
`apiAccess`	`boolean`
`layoutRevision`	`number`
`holdSeconds`	`number`
`maxTicketsPerBooking`	`number`

@openseat/node/src/cloud-wire.ts

interface

LayoutDetails

interface LayoutDetails extends LayoutSummary

Extends LayoutSummary

Members

Member	Type	Description
`layout`	`unknown`
`layoutKey`	`string`	From `LayoutSummary`
`name`	`string`	From `LayoutSummary`
`revision`	`number`	From `LayoutSummary`
`seatCount`	`number`	From `LayoutSummary`
`placeCount`	`number`	From `LayoutSummary`
`categories`	`{ id: string; name: string; }[]`	From `LayoutSummary`
`updatedAt`	`string`	From `LayoutSummary`

@openseat/node/src/cloud-wire.ts

interface

LayoutSummary

interface LayoutSummary

Members

Member	Type	Description
`layoutKey`	`string`
`name`	`string`
`revision`	`number`
`seatCount`	`number`
`placeCount`	`number`
`categories`	`{ id: string; name: string; }[]`
`updatedAt`	`string`

@openseat/node/src/cloud-wire.ts

interface

MeResponse

interface MeResponse

Members

Member	Type	Description
`ownerId`	`string`
`mode`	`Mode`
`kind`	`"secret"`
`scopes`	`string[]`
`last4`	`string`
`keyName`	`string`

@openseat/node/src/client.ts

interface

OpenSeatErrorOptions

interface OpenSeatErrorOptions

Members

Member	Type	Description
`reason`optional	`OpenSeatErrorReason`
`status`optional	`number`
`requestId`optional	`string`
`retryable`optional	`boolean`
`retryAfterMs`optional	`number`
`unavailableSeatIds`optional	`readonly string[]`
`unavailableAreaIds`optional	`readonly string[]`
`details`optional	`readonly { path: string; message: string; }[]`
`cause`optional	`unknown`

@openseat/node/src/errors.ts

interface

OpenSeatOptions

interface OpenSeatOptions

Members

Member	Type	Description
`secretKey`	`string`	`os_sk_live_…` or `os_sk_test_…`. Keep it in your server's environment (OPENSEAT_SECRET_KEY).
`baseUrl`	`string`	Your OpenSeat address, for example `https://openseat.example.com` (a trailing `/api` is accepted).
`timeoutMs`optional	`number`	Per attempt. Default 15000. Default `15000`
`maxRetries`optional	`number`	Extra attempts after the first for retryable failures. Default 2. Default `2`
`fetch`optional	`typeof fetch`	Defaults to the global fetch.
`allowInsecureHttp`optional	`boolean`	Allows a plain `http://` baseUrl on a host other than localhost. Off by default: the secret key travels in every request, so only use this on a private network you control.

@openseat/node/src/client.ts

interface

OpenSeatWebhookEvent

A verified webhook delivery. Deduplicate on id: a delivery can arrive more than once.

interface OpenSeatWebhookEvent<T extends string = string>

Members

Member	Type	Description
`id`	`string`
`type`	`T`
`apiVersion`	`string`
`createdAt`	`string`
`mode`	`Mode`
`sequence`	`number`
`data`	`Record<string, unknown>`

@openseat/node/src/webhooks.ts

interface

ReleaseInput

What events.release sends. Omitting both seatIds and areas releases the whole booking.

interface ReleaseInput

Members

Member	Type	Description
`bookingId`optional	`string`
`orderId`optional	`string`
`seatIds`optional	`string[]`
`areas`optional	`AreaQuantity[]`
`block`optional	`boolean`
`note`optional	`string`

@openseat/node/src/cloud-wire.ts

interface

ReleaseResult

interface ReleaseResult

Members

Member	Type	Description
`releasedSeatIds`	`string[]`
`releasedAreas`	`AreaQuantity[]`
`booking`	`{ bookingId: string; status: "confirmed" \| "cancelled"; }`
`notReleased`	`{ seatId?: string; inventoryId?: string; reason: "not_in_booking" \| "already_released" \| "quantity_exceeds"; }[]`

@openseat/node/src/cloud-wire.ts

interface

ServerHoldInput

What holds.create sends to POST /server/events/:eventKey/holds (the event key is in the path).

interface ServerHoldInput

Members

Member	Type	Description
`buyerRef`	`string`
`seatIds`optional	`string[]`
`areas`optional	`AreaQuantity[]`
`holdToken`optional	`string`

@openseat/node/src/cloud-wire.ts

interface

UnblockResult

interface UnblockResult

Members

Member	Type	Description
`unblocked`	`string[]`
`notUnblocked`	`{ objectId: string; reason: "not_blocked" \| "not_for_sale"; }[]`

@openseat/node/src/client.ts

interface

UpdateEventInput

interface UpdateEventInput

Members

Member	Type	Description
`name`optional	`string`
`startsAt`optional	`string`
`venue`optional	`string`
`saleOpen`optional	`boolean`
`maxTicketsPerBooking`optional	`number`
`holdSeconds`optional	`number`
`categoryPriceLabels`optional	`Record<string, string>`

@openseat/node/src/client.ts

interface

VerifyWebhookOptions

interface VerifyWebhookOptions

Members

Member	Type	Description
`toleranceSec`optional	`number`	Maximum age (and clock skew) of the signature timestamp, in seconds. Default 300. Default `300`
`now`optional	`() => number`	Current time in milliseconds. Default Date.now.

@openseat/node/src/webhooks.ts

interface

WebhookDelivery

interface WebhookDelivery

Members

Member	Type	Description
`id`	`string`
`eventId`	`string`
`eventType`	`string`
`status`	`"pending" \| "succeeded" \| "failed"`
`attempts`	`number`
`nextAttemptAt`	`string \| null`
`lastAttemptAt`	`string \| null`
`lastStatusCode`	`number \| null`
`lastError`	`string \| null`
`lastDurationMs`	`number \| null`
`createdAt`	`string`

@openseat/node/src/cloud-wire.ts

interface

WebhookEndpoint

interface WebhookEndpoint

Members

Member	Type	Description
`id`	`string`
`url`	`string`
`description`	`string`
`mode`	`Mode`
`eventTypes`	`string[]`
`eventKeys`	`string[] \| null`
`includeExtraData`	`boolean`
`enabled`	`boolean`
`disabledReason`	`string \| null`
`failingSince`	`string \| null`
`secretPrefix`	`string`
`createdAt`	`string`
`updatedAt`	`string`
`createdBy`	`{ userId: string; name: string \| null; } \| null`
`successRate24h`	`number \| null`	Succeeded / finished deliveries in the last 24 h, 0..1; null when there were none.

@openseat/node/src/cloud-wire.ts

interface

WireBooking

A booking, as events.book, bookings.list and bookings.retrieve return it.

interface WireBooking

Members

Member	Type	Description
`bookingId`	`string`
`reference`	`string`
`eventKey`	`string`
`orderId`	`string \| null`
`holdId`	`string`
`source`	`"hosted" \| "api"`
`status`	`"confirmed" \| "cancelled"`
`late`	`boolean`
`bookedAt`	`string`
`amountPaise`	`number \| null`	api: what the customer said it charged; hosted: null.
`seats`	`{ seatId: string; label: string; categoryId: string \| null; active: boolean; extraData?: Record<string, unknown>; }[]`
`areas`	`{ inventoryId: string; label: string; categoryId: string \| null; quantity: number; active: boolean; }[]`
`extraData`optional	`Record<string, unknown>`
`replayed`optional	`boolean`

@openseat/node/src/cloud-wire.ts

interface

WireError

interface WireError

Members

Member	Type	Description
`error`	`{ code: string; message: string; reason?: OpenSeatErrorReason; unavailableSeatIds?: string[]; unavailableAreaIds?: string[]; maxExpiresAt?: string; minimumSdk?: string; details?: { path: string; message: string; }[]; }`

@openseat/node/src/cloud-wire.ts

interface

WireHoldDetails

A hold as holds.retrieve, attachOrder, extend and release return it.

interface WireHoldDetails

Members

Member	Type	Description
`eventKey`	`string`
`status`	`"active" \| "expired" \| "released" \| "booked" \| "failed"`
`locked`	`boolean`
`holdId`	`string \| null`
`orderId`	`string \| null`
`bookingId`	`string \| null`
`seats`	`{ seatId: string; label: string; categoryId: string \| null; pricePaise: number \| null; }[]`
`areas`	`{ inventoryId: string; label: string; categoryId: string \| null; quantity: number; pricePaise: number \| null; }[]`
`ticketCount`	`number`
`createdAt`	`string`
`firstHeldAt`	`string \| null`
`expiresAt`	`string`
`maxExpiresAt`	`string`
`serverTime`	`string`

@openseat/node/src/cloud-wire.ts

interface

WireObject

One seat, place or booth of an event and its status (events.objects).

interface WireObject

Members

Member	Type	Description
`objectId`	`string`
`label`	`string`
`status`	`SeatStatus`
`categoryId`	`string \| null`
`tableKey`	`string \| null`
`holdId`optional	`string`
`holdExpiresAt`optional	`string`
`orderId`optional	`string`
`bookingId`optional	`string`
`bookedAt`optional	`string`
`source`optional	`"hosted" \| "api"`
`blockNote`optional	`string`

@openseat/node/src/cloud-wire.ts

Types16

type

Booking

type Booking = WireBooking;

Members

Member	Type	Description
`bookingId`	`string`
`reference`	`string`
`eventKey`	`string`
`orderId`	`string \| null`
`holdId`	`string`
`source`	`"hosted" \| "api"`
`status`	`"confirmed" \| "cancelled"`
`late`	`boolean`
`bookedAt`	`string`
`amountPaise`	`number \| null`	api: what the customer said it charged; hosted: null.
`seats`	`{ seatId: string; label: string; categoryId: string \| null; active: boolean; extraData?: Record<string, unknown>; }[]`
`areas`	`{ inventoryId: string; label: string; categoryId: string \| null; quantity: number; active: boolean; }[]`
`extraData`optional	`Record<string, unknown>`
`replayed`optional	`boolean`

@openseat/node/src/client.ts

type

CreatedEvent

type CreatedEvent = EventDetails & {
  layoutKey: string;
  created: boolean;
};

Members

Member	Type	Description
`counts`	`{ available: number; held: number; booked: number; blocked: number; }`	Seats; an expired hold counts as available.
`areas`	`(AreaRecord & { label: string; held: number; sold: number; blocked: boolean; })[]`
`priceLabels`	`Record<string, string>`
`eventKey`	`string`
`name`	`string`
`startsAt`	`string`
`venue`	`string`
`mode`	`Mode`
`status`	`"published" \| "archived"`
`saleOpen`	`boolean`
`hostedPage`	`boolean`
`apiAccess`	`boolean`
`layoutRevision`	`number`
`holdSeconds`	`number`
`maxTicketsPerBooking`	`number`
`layoutKey`	`string`
`created`	`boolean`

@openseat/node/src/cloud-wire.ts

type

DesignerPermission

type DesignerPermission = "layout:read" | "layout:write";

@openseat/node/src/designer-wire.ts

type

DesignerSessionStatus

type DesignerSessionStatus = "active" | "expired" | "closed" | "revoked";

@openseat/node/src/designer-wire.ts

type

HoldDetails

type HoldDetails = WireHoldDetails;

Members

Member	Type	Description
`eventKey`	`string`
`status`	`"active" \| "expired" \| "released" \| "booked" \| "failed"`
`locked`	`boolean`
`holdId`	`string \| null`
`orderId`	`string \| null`
`bookingId`	`string \| null`
`seats`	`{ seatId: string; label: string; categoryId: string \| null; pricePaise: number \| null; }[]`
`areas`	`{ inventoryId: string; label: string; categoryId: string \| null; quantity: number; pricePaise: number \| null; }[]`
`ticketCount`	`number`
`createdAt`	`string`
`firstHeldAt`	`string \| null`
`expiresAt`	`string`
`maxExpiresAt`	`string`
`serverTime`	`string`

@openseat/node/src/client.ts

type

HoldStatus

type HoldStatus = "active" | "expired" | "released" | "booked";

@openseat/node/src/cloud-wire.ts

type

Mode

Same union as Mode in wire.ts; repeated here so this file stands alone.

type Mode = "live" | "test";

@openseat/node/src/cloud-wire.ts

type

OpenSeatErrorCode

Every error code a call can fail with: the server's error.code values plus NETWORK and TIMEOUT.

type OpenSeatErrorCode =
  | "SEATS_UNAVAILABLE"
  | "AREA_SOLD_OUT"
  | "LIMIT_EXCEEDED"
  | "HOLD_EXPIRED"
  | "HOLD_NOT_FOUND"
  | "CONFLICT"
  | "UNAUTHORIZED"
  | "FORBIDDEN"
  | "VALIDATION"
  | "RATE_LIMITED"
  | "NOT_FOUND"
  | "SERVER"
  | "NETWORK"
  | "TIMEOUT";

@openseat/node/src/errors.ts

type

OpenSeatErrorReason

Every reason the Cloud API gives when it refuses a request (the reason of an error response).

type OpenSeatErrorReason =
  | "KEY_INVALID"
  | "WRONG_KEY_KIND"
  | "KEY_MISUSE"
  | "KEY_IN_URL"
  | "ORIGIN_NOT_ALLOWED"
  | "INSUFFICIENT_SCOPE"
  | "REAUTH_REQUIRED"
  | "KEY_LIMIT"
  | "EVENT_NOT_API_ENABLED"
  | "EVENT_MODE_MISMATCH"
  | "EVENT_NOT_PUBLISHED"
  | "EVENT_KEY_TAKEN"
  | "EVENT_KEY_LOCKED"
  | "HOSTED_PAGE_OFF"
  | "PRICES_REQUIRED"
  | "SALE_CLOSED"
  | "SDK_TOO_OLD"
  | "HOLD_TOKEN_IN_URL"
  | "HOLD_LOCKED"
  | "HOLD_MISMATCH"
  | "HOLD_ALREADY_BOOKED"
  | "EXTENSION_LIMIT"
  | "EXPIRED"
  | "RELEASED"
  | "SEATS_TAKEN"
  | "ORDER_ID_IN_USE"
  | "HOSTED_BOOKING"
// … 17 more lines (type truncated)

This type is long; its declaration is shortened here.

@openseat/node/src/cloud-wire.ts

type

OpenSeatWebhookErrorCode

Why a delivery was refused. Answer 400 and do nothing; never act on an unverified body.

type OpenSeatWebhookErrorCode =
  | "MISSING_HEADER"
  | "HEADER_TOO_LARGE"
  | "MALFORMED_HEADER"
  | "TIMESTAMP_OUT_OF_RANGE"
  | "SIGNATURE_MISMATCH"
  | "INVALID_PAYLOAD"
  | "INVALID_SECRET";

@openseat/node/src/webhooks.ts

type

ReleaseBookingInput

type ReleaseBookingInput = ReleaseInput & {
  idempotencyKey?: string;
};

Members

Member	Type	Description
`bookingId`optional	`string`
`orderId`optional	`string`
`seatIds`optional	`string[]`
`areas`optional	`AreaQuantity[]`
`block`optional	`boolean`
`note`optional	`string`
`idempotencyKey`optional	`string`

@openseat/node/src/client.ts

type

SeatObject

type SeatObject = WireObject;

Members

Member	Type	Description
`objectId`	`string`
`label`	`string`
`status`	`SeatStatus`
`categoryId`	`string \| null`
`tableKey`	`string \| null`
`holdId`optional	`string`
`holdExpiresAt`optional	`string`
`orderId`optional	`string`
`bookingId`optional	`string`
`bookedAt`optional	`string`
`source`optional	`"hosted" \| "api"`
`blockNote`optional	`string`

@openseat/node/src/client.ts

type

SeatStatus

type SeatStatus = "available" | "held" | "booked" | "blocked";

@openseat/node/src/cloud-wire.ts

type

ServerHold

type ServerHold = WireHoldDetails & {
  holdToken: string;
};

Members

Member	Type	Description
`eventKey`	`string`
`status`	`"active" \| "expired" \| "released" \| "booked" \| "failed"`
`locked`	`boolean`
`holdId`	`string \| null`
`orderId`	`string \| null`
`bookingId`	`string \| null`
`seats`	`{ seatId: string; label: string; categoryId: string \| null; pricePaise: number \| null; }[]`
`areas`	`{ inventoryId: string; label: string; categoryId: string \| null; quantity: number; pricePaise: number \| null; }[]`
`ticketCount`	`number`
`createdAt`	`string`
`firstHeldAt`	`string \| null`
`expiresAt`	`string`
`maxExpiresAt`	`string`
`serverTime`	`string`
`holdToken`	`string`

@openseat/node/src/cloud-wire.ts

type

UpdateWebhookEndpointInput

type UpdateWebhookEndpointInput = Partial<{
  url: string;
  description: string;
  eventTypes: string[];
  eventKeys: string[] | null;
  includeExtraData: boolean;
  enabled: boolean;
}>;

Members

Member	Type	Description
`url`optional	`string`
`description`optional	`string`
`eventTypes`optional	`string[]`
`eventKeys`optional	`string[] \| null`
`includeExtraData`optional	`boolean`
`enabled`optional	`boolean`

@openseat/node/src/client.ts

type

WebhookType

type WebhookType =
  | "booking.created"
  | "booking.released"
  | "hold.expired"
  | "hold.released"
  | "seats.blocked"
  | "seats.unblocked"
  | "event.updated"
  | "layout.updated"
  | "webhook_endpoint.test";

@openseat/node/src/cloud-wire.ts

Constants4

const

MAX_SIGNATURE_HEADER_LENGTH

Hostile-input caps, all checked before any HMAC work.

const MAX_SIGNATURE_HEADER_LENGTH = 8192

@openseat/node/src/webhooks.ts

const

MAX_SIGNATURES

const MAX_SIGNATURES = 8

@openseat/node/src/webhooks.ts

const

OPEN_SEAT_ERROR_REASONS

The reasons as a runtime list, so an unknown reason from a newer server is dropped rather than typed as one it isn't. The check below fails to compile if this list and the OpenSeatErrorReason union differ.

const OPEN_SEAT_ERROR_REASONS: readonly [
  "KEY_INVALID",
  "WRONG_KEY_KIND",
  "KEY_MISUSE",
  "KEY_IN_URL",
  "ORIGIN_NOT_ALLOWED",
  "INSUFFICIENT_SCOPE",
  "REAUTH_REQUIRED",
  "KEY_LIMIT",
  "EVENT_NOT_API_ENABLED",
  "EVENT_MODE_MISMATCH",
  "EVENT_NOT_PUBLISHED",
  "EVENT_KEY_TAKEN",
  "EVENT_KEY_LOCKED",
  "HOSTED_PAGE_OFF",
  "PRICES_REQUIRED",
  "SALE_CLOSED",
  "SDK_TOO_OLD",
  "HOLD_TOKEN_IN_URL",
  "HOLD_LOCKED",
  "HOLD_MISMATCH",
  "HOLD_ALREADY_BOOKED",
  "EXTENSION_LIMIT",
  "EXPIRED",
  "RELEASED",
  "SEATS_TAKEN",
  "ORDER_ID_IN_USE",
  "HOSTED_BOOKING",
// … 18 more lines (type truncated)

This type is long; its declaration is shortened here.

@openseat/node/src/errors.ts

const

VERSION

This package's version, sent as OpenSeat-Client: node/<version>. A test keeps it equal to package.json.

const VERSION = "0.1.0"

@openseat/node/src/version.ts