@helmdesk/sdk 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -126,39 +126,6 @@ const { articles, total } = await helmdesk.articles.search({
|
|
|
126
126
|
});
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
### Customers
|
|
130
|
-
|
|
131
|
-
Track and manage customer profiles across tickets and emails.
|
|
132
|
-
|
|
133
|
-
**List customers**
|
|
134
|
-
|
|
135
|
-
```ts
|
|
136
|
-
const { customers, total } = await helmdesk.customers.list({
|
|
137
|
-
search: "jane",
|
|
138
|
-
plan: "pro",
|
|
139
|
-
page: 1,
|
|
140
|
-
limit: 25,
|
|
141
|
-
});
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
**Get a customer**
|
|
145
|
-
|
|
146
|
-
```ts
|
|
147
|
-
const customer = await helmdesk.customers.get("customer_id");
|
|
148
|
-
// Includes recentTickets array
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
**Upsert a customer**
|
|
152
|
-
|
|
153
|
-
```ts
|
|
154
|
-
const customer = await helmdesk.customers.upsert({
|
|
155
|
-
email: "jane@example.com",
|
|
156
|
-
name: "Jane Doe",
|
|
157
|
-
plan: "pro",
|
|
158
|
-
metadata: JSON.stringify({ companyId: "acme-123" }),
|
|
159
|
-
});
|
|
160
|
-
```
|
|
161
|
-
|
|
162
129
|
## Error Handling
|
|
163
130
|
|
|
164
131
|
All API errors throw a `HelmdeskError` with structured fields for programmatic handling.
|
|
@@ -247,7 +214,7 @@ Most helpdesk tools are built for sales teams, not developers. They charge per s
|
|
|
247
214
|
|
|
248
215
|
Intercom starts at $29/seat with an additional $0.99 per AI resolution. HelpScout charges $25/user plus $0.75 per AI interaction. Crisp costs $95/workspace for their business tier.
|
|
249
216
|
|
|
250
|
-
Helmdesk is $
|
|
217
|
+
Helmdesk is $29/month for up to 5 projects. AI features are included at every tier -- no per-resolution fees, no per-seat pricing. You get a helpdesk, transactional email gateway, and knowledge base in one platform with a full API and this SDK from day one.
|
|
251
218
|
|
|
252
219
|
## Links
|
|
253
220
|
|