@dispatchtickets/sdk 0.6.0 → 0.8.0

package/README.md

@@ -1,6 +1,9 @@
 # @dispatchtickets/sdk
 
-Official TypeScript SDK for the Dispatch Tickets API.
+[![npm version](https://img.shields.io/npm/v/@dispatchtickets/sdk.svg)](https://www.npmjs.com/package/@dispatchtickets/sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Official TypeScript SDK for the [Dispatch Tickets](https://dispatchtickets.com) API.
 
 ## Installation
 
@@ -37,6 +40,38 @@ await client.comments.create('ws_abc123', ticket.id, {
 });
 ```
 
+## Portal API (End-User Access)
+
+For customer-facing integrations, use `DispatchPortal` to let end-users view and manage their own tickets:
+
+```typescript
+import { DispatchTickets, DispatchPortal } from '@dispatchtickets/sdk';
+
+// 1. Backend: Generate a portal token for your user
+const admin = new DispatchTickets({ apiKey: 'sk_live_xxx' });
+const { token } = await admin.brands.generatePortalToken('br_xxx', {
+  email: user.email,
+  name: user.name,
+});
+
+// 2. Frontend: Use the token to access tickets
+const portal = new DispatchPortal({ token });
+
+// List user's tickets
+const { data: tickets } = await portal.tickets.list();
+
+// Create a new ticket
+const ticket = await portal.tickets.create({
+  title: 'Help with my order',
+  body: 'Order #12345 has not arrived...',
+});
+
+// Add a comment
+await portal.tickets.addComment(ticket.id, 'Here is more information...');
+```
+
+Portal tokens are scoped to a single customer and expire after 1 hour. See the [Integration Guide](https://dispatchtickets.com/docs/integration) for complete examples.
+
 ## Configuration
 
 ```typescript
@@ -477,6 +512,8 @@ This creates a `docs/` folder with HTML documentation for all exported types and
 
 ## Links
 
+- [Website](https://dispatchtickets.com)
+- [Integration Guide](https://dispatchtickets.com/docs/integration)
 - [API Reference (Swagger)](https://dispatch-tickets-api.onrender.com/docs)
 - [GitHub](https://github.com/Epic-Design-Labs/app-dispatchtickets-sdk)
 - [Changelog](./CHANGELOG.md)

package/dist/index.d.cts

@@ -346,6 +346,8 @@ interface Brand {
     autoresponseBody?: string;
     fromName?: string;
     fromEmail?: string;
+    /** Allowed origins for portal API CORS */
+    portalOrigins: string[];
     createdAt: string;
     updatedAt: string;
 }
@@ -376,6 +378,8 @@ interface UpdateBrandInput {
     autoresponseBody?: string;
     metadata?: Record<string, unknown>;
     ticketSchema?: Record<string, unknown>;
+    /** Allowed origins for portal API CORS. Empty array = block all cross-origin requests. */
+    portalOrigins?: string[];
 }
 /**
  * Brand deletion preview result

package/dist/index.d.ts

@@ -346,6 +346,8 @@ interface Brand {
     autoresponseBody?: string;
     fromName?: string;
     fromEmail?: string;
+    /** Allowed origins for portal API CORS */
+    portalOrigins: string[];
     createdAt: string;
     updatedAt: string;
 }
@@ -376,6 +378,8 @@ interface UpdateBrandInput {
     autoresponseBody?: string;
     metadata?: Record<string, unknown>;
     ticketSchema?: Record<string, unknown>;
+    /** Allowed origins for portal API CORS. Empty array = block all cross-origin requests. */
+    portalOrigins?: string[];
 }
 /**
  * Brand deletion preview result

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dispatchtickets/sdk",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Official TypeScript SDK for Dispatch Tickets API",
   "type": "module",
   "exports": {