@masonlandcattle/servicetitan-sdk 0.1.0 → 0.3.0

package/README.md

@@ -25,29 +25,41 @@ Set env vars or pass options:
 - `SECRET_KEY`
 - Optional: `ENVIRONMENT` = `production` | `development`
 
-### Usage
+### Usage (namespaced client)
 
 ```ts
-import { ServiceTitanClient, Jobs, Materials, Accounting } from "@masonlandcattle/servicetitan-sdk";
+import { createClient } from "@masonlandcattle/servicetitan-sdk";
 
-const st = new ServiceTitanClient({
-  tenantId: process.env.TENANT_ID,
-  appKey: process.env.APP_KEY,
-  clientId: process.env.CLIENT_ID,
-  clientSecret: process.env.SECRET_KEY,
+const st = createClient({
+  tenantId: process.env.TENANT_ID!,
+  appKey: process.env.APP_KEY!,
+  clientId: process.env.CLIENT_ID!,
+  clientSecret: process.env.SECRET_KEY!,
   environment: (process.env.ENVIRONMENT as any) || "production",
   retries: 3,
   maxConcurrent: 5,
   minTimeMs: 100,
 });
 
-const jobs = await Jobs.listJobs(st, { page: 1, pageSize: 100 });
-await Jobs.createJobNote(st, 123456, "Hello from SDK", true);
+// List jobs (single page)
+const page = await st.jpm.listJobs({ page: 1, pageSize: 100 });
 
-const mats = await Materials.listMaterials(st, { page: 1, pageSize: 200 });
-await Materials.createMaterial(st, { name: "Widget", code: "W-1" });
+// List all jobs server-side (aggregates pages)
+const allJobs = await st.jpm.listJobs({ status: "Open" }, { all: true, pageSize: 500 });
 
-const allInvoices = await Accounting.getAllInvoices(st, { customerId: 42 }, 500);
+// Create a job note
+await st.jpm.createJobNote(123456, { text: "Hello from SDK", pinToTop: true });
+
+// Materials (with get-all)
+const materials = await st.pricebook.listMaterials({}, { all: true, pageSize: 500 });
+```
+
+### Alternate import style (functional)
+
+```ts
+import { ServiceTitanClient, CRM } from "@masonlandcattle/servicetitan-sdk";
+const st = new ServiceTitanClient({ /* creds */ });
+const customers = await CRM.listCustomers(st, { updatedAfter: "2024-01-01" }, { all: true });
 ```
 
 ### Local development / testing without publishing
@@ -74,7 +86,7 @@ These scripts import from `../src`, so there's no need to publish/install.
 
 `/{category}/v2/tenant/{TENANT_ID}/{subject}`
 
-Use `client.buildPath({ category, subject, idOrSubpath })` and `client.request(method, path, { params, data })`.
+Use `client.buildPath({ category, subject, idOrSubpath })` and `client.request(method, path, { params, data })`. To fetch every page server-side, pass `{ all: true, pageSize?: number }` to supported list functions.
 
 ### Publish