@masonlandcattle/servicetitan-sdk 0.2.0 → 0.4.0

package/README.md

@@ -54,6 +54,162 @@ await st.jpm.createJobNote(123456, { text: "Hello from SDK", pinToTop: true });
 const materials = await st.pricebook.listMaterials({}, { all: true, pageSize: 500 });
 ```
 
+### Resources and quick examples
+
+Below is a brief tour of the main resource namespaces. Each list function supports `{ all?: boolean; pageSize?: number }` to fetch all pages server‑side.
+
+Initialize once and reuse:
+```ts
+import { createClient } from "@masonlandcattle/servicetitan-sdk";
+const st = createClient({
+  tenantId: process.env.TENANT_ID!,
+  appKey: process.env.APP_KEY!,
+  clientId: process.env.CLIENT_ID!,
+  clientSecret: process.env.SECRET_KEY!,
+});
+```
+
+#### Accounting (`st.accounting`)
+- Invoices, Payments, GL Accounts, Inventory Bills, AP Credits/Payments, Tax Zones, etc.
+```ts
+const invoices = await st.accounting.listInvoices({ customerId: 1234 }, { all: true });
+await st.accounting.markInvoicesAsExported([111, 222]);
+const gl = await st.accounting.listGlAccounts({ type: "Asset" }, { all: true });
+```
+
+#### CRM (`st.crm`)
+- Customers, Contacts, Locations, Leads, Bookings.
+```ts
+const customers = await st.crm.listCustomers({ search: "Acme" }, { all: true });
+const contacts = await st.crm.listContacts({ updatedAfter: "2024-01-01" }, { all: true });
+const locations = await st.crm.listLocations({ customerId: 1234 }, { all: true });
+```
+
+#### Dispatch (`st.dispatch`)
+- Teams, Zones, Arrival Windows, Technician Shifts, Appointment Assignments.
+```ts
+const teams = await st.dispatch.listTeams({}, { all: true });
+const windows = await st.dispatch.listArrivalWindows({ date: "2025-01-01" }, { all: true });
+```
+
+#### Equipment Systems (`st.equipmentSystems`)
+- Installed Equipment and metadata.
+```ts
+const eq = await st.equipmentSystems.listInstalledEquipment({ search: "Carrier" }, { all: true });
+```
+
+#### Forms (`st.forms`)
+- Forms, Jobs + Forms, Submissions.
+```ts
+const forms = await st.forms.listForms({}, { all: true });
+```
+
+#### Inventory (`st.inventory`)
+- Purchase Orders (+ types/markups/requests), Receipts, Transfers, Returns, Trucks, Vendors, Warehouses.
+```ts
+const pos = await st.inventory.listPurchaseOrders({ status: "Open" }, { all: true });
+const receipts = await st.inventory.listReceipts({ dateFrom: "2025-01-01" }, { all: true });
+```
+
+#### JPM (Jobs/Projects) (`st.jpm`)
+- Jobs, Appointments, Projects, WBS, types/statuses.
+```ts
+const jobs = await st.jpm.listJobs({ status: "Open" }, { all: true });
+const appts = await st.jpm.listAppointments({ scheduledOnOrAfter: "2025-01-01" }, { all: true });
+```
+
+#### Marketing (`st.marketing`) and Marketing Ads (`st.marketingAds`)
+- Campaigns/Categories/Costs/Suppressions; Ads Attributions and Performance.
+```ts
+const campaigns = await st.marketing.listCampaigns({}, { all: true });
+const webLead = await st.marketingAds.createWebLeadFormAttribution({ webSessionData: {}, leadId: 42 });
+```
+
+#### Marketing Reputation (`st.marketingReputation`)
+- Reviews.
+```ts
+const reviews = await st.marketingReputation.listReviews({ createdOnOrAfter: "2025-01-01" }, { all: true });
+```
+
+#### Memberships (`st.memberships`)
+- Memberships, Types, Recurring Service Types/Events/Services, Invoice Templates.
+```ts
+const memberships = await st.memberships.listMemberships({ customerId: 1234 }, { all: true });
+```
+
+#### Payroll (`st.payroll`)
+- Timesheets (+ non-job, per-job), Timesheet Codes, Payrolls, Adjustments, Job Splits, Location Labor Rates.
+```ts
+const codes = await st.payroll.listTimesheetCodes({}, { all: true });
+const payrolls = await st.payroll.listPayrolls({ createdOnOrAfter: "2025-01-01" }, { all: true });
+```
+
+#### Pricebook (`st.pricebook`)
+- Materials, Services, Equipment, Images, Discounts & Fees, Categories, Client-Specific Pricing.
+```ts
+const materials = await st.pricebook.listMaterials({ updatedAfter: "2025-01-01" }, { all: true });
+```
+
+#### Reporting (`st.reporting`)
+- Report Categories and mappings, Dynamic Value Sets.
+```ts
+const cats = await st.reporting.listReportCategories({}, { all: true });
+```
+
+#### Sales Estimates (`st.salesEstimates`)
+- Estimates and Estimate Items.
+```ts
+const ests = await st.salesEstimates.listEstimates({ jobNumber: "131179" }, { all: true });
+```
+
+#### Scheduling Pro (`st.schedulingPro`)
+- Routers, Schedulers.
+```ts
+const schedulers = await st.schedulingPro.listSchedulers({}, { all: true });
+```
+
+#### Service Agreements (`st.serviceAgreements`)
+- Agreements and export endpoints.
+```ts
+const agreements = await st.serviceAgreements.listServiceAgreements({}, { all: true });
+```
+
+#### Settings (`st.settings`)
+- Employees, Technicians, Business Units, Tag Types, User Roles.
+```ts
+const techs = await st.settings.listTechnicians({}, { all: true });
+```
+
+#### Task Management (`st.taskManagement`)
+- Tasks and Client-Side Data.
+```ts
+const tasks = await st.taskManagement.listTasks({ status: "Open" }, { all: true });
+```
+
+#### Telecom (`st.telecom`)
+- Calls + media.
+```ts
+const calls = await st.telecom.listCalls({ createdOnOrAfter: "2025-01-01" }, { all: true });
+```
+
+#### Timesheets V2 (`st.timesheetsV2`)
+- Activities, Types, Categories.
+```ts
+const activities = await st.timesheetsV2.listActivities({}, { all: true });
+```
+
+#### Job Bookings (`st.jbce`)
+- Call Reasons.
+```ts
+const reasons = await st.jbce.listCallReasons({}, { all: true });
+```
+
+#### Customer Interactions (`st.customerInteractions`)
+- Technician Ratings.
+```ts
+const ratings = await st.customerInteractions.listTechnicianRatings({ createdOnOrAfter: "2025-01-01" }, { all: true });
+```
+
 ### Alternate import style (functional)
 
 ```ts