@insurup/sdk 0.1.1 → 0.1.2

package/README.md

@@ -5,7 +5,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Zero Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen.svg)](package.json)
 
-Type-safe TypeScript SDK for the InsurUp insurance platform. Zero dependencies, tree-shakeable, works everywhere.
+Type-safe TypeScript SDK for the InsurUp insurance platform with GraphQL support. Zero dependencies, tree-shakeable, works everywhere.
 
 ---
 
@@ -15,6 +15,7 @@ Type-safe TypeScript SDK for the InsurUp insurance platform. Zero dependencies,
 - [Quick Start](#quick-start)
 - [Architecture](#architecture)
 - [Result Handling](#result-handling)
+- [GraphQL Queries](#graphql-queries)
 - [Configuration](#configuration)
 - [Interceptors](#interceptors)
 - [API Clients](#api-clients)
@@ -64,6 +65,7 @@ graph TB
     subgraph SDK[DefaultInsurUpClient]
         direction TB
         HTTP[HttpTransport]
+        GQL[GraphQLTransport]
         
         subgraph Clients[Specialized Clients]
             direction LR
@@ -81,14 +83,17 @@ graph TB
     end
     
     App[Your Application] --> SDK
-    HTTP --> API[InsurUp API]
+    HTTP --> API[InsurUp REST API]
+    GQL --> GQLAPI[InsurUp GraphQL API]
     Clients --> HTTP
+    Clients --> GQL
 ```
 
 The SDK uses a **compositional architecture**:
 
 - `DefaultInsurUpClient` aggregates 17 specialized clients
-- All clients share a single `HttpTransport` instance
+- All clients share `HttpTransport` and `GraphQLTransport` instances
+- GraphQL queries support filtering, searching, sorting, and type-safe field selection
 - Request/response interceptors hook into the transport layer
 - Results use discriminated unions for type-safe error handling
 
@@ -133,6 +138,100 @@ const customer = getDataOrThrow(await client.customers.getCustomer('id'));
 
 ---
 
+## GraphQL Queries
+
+The SDK includes built-in GraphQL support for querying entities with advanced filtering, searching, sorting, and type-safe field selection.
+
+### Available GraphQL Methods
+
+| Client | Method | Description |
+|--------|--------|-------------|
+| `customers` | `getCustomers()` | Query customers with filters |
+| `policies` | `getPolicies()` | Query policies with filters |
+| `policies` | `getPolicyTransfers()` | Query policy transfers |
+| `policies` | `getFilePolicyTransfers()` | Query file-based policy transfers |
+| `proposals` | `getProposals()` | Query proposals with filters |
+| `cases` | `getCases()` | Query cases with filters |
+| `agentUsers` | `getAgentUsers()` | Query agent users with filters |
+| `webhooks` | `getWebhookDeliveries()` | Query webhook deliveries |
+
+### Basic Usage
+
+```typescript
+// Query with pagination
+const result = await client.customers.getCustomers({
+  first: 10,
+  after: 'cursor-string',
+});
+
+if (result.isSuccess) {
+  console.log(result.data.nodes);      // Customer[]
+  console.log(result.data.totalCount); // Total count
+  console.log(result.data.pageInfo);   // Pagination info
+}
+```
+
+### Type-Safe Field Selection
+
+Select only the fields you need — the return type automatically narrows:
+
+```typescript
+const result = await client.policies.getPolicies({
+  select: ['id', 'productBranch', 'grossPremium', 'state'] as const,
+  first: 10,
+});
+
+// result.data.nodes[0] is typed as:
+// { id: string; productBranch: ProductBranch; grossPremium: number | null; state: PolicyState }
+```
+
+### Filtering
+
+```typescript
+import { ProductBranch, PolicyState } from '@insurup/sdk';
+
+const result = await client.policies.getPolicies({
+  first: 20,
+  filter: {
+    productBranch: { eq: ProductBranch.Traffic },
+    state: { eq: PolicyState.Active },
+    grossPremium: { gte: 1000 },
+  },
+});
+```
+
+### Searching
+
+Full-text search with score boosting:
+
+```typescript
+const result = await client.customers.getCustomers({
+  first: 10,
+  search: {
+    name: { 
+      text: { value: 'John' },
+      score: { boost: 2 },
+    },
+  },
+});
+```
+
+### Sorting
+
+```typescript
+import { SortEnumType } from '@insurup/sdk';
+
+const result = await client.cases.getCases({
+  first: 20,
+  order: [
+    { priorityScore: SortEnumType.Desc },
+    { createdAt: SortEnumType.Desc },
+  ],
+});
+```
+
+---
+
 ## Configuration
 
 ```typescript