@gravity-rail/sdk 0.8.0 → 0.10.1

package/README.md

@@ -366,6 +366,44 @@ const clientWs = await client.createClientWorkspace(workspaceId, {
 await client.provisionClientWorkspace(workspaceId, clientWs.id);
 ```
 
+## Helpers (`@gravity-rail/sdk/helpers`)
+
+Small compound operations built on the client methods, for the common
+"register → populate a form → enroll → verify webhooks" integration flow:
+
+```typescript
+import {
+  // member resolution + enrollment
+  resolveMemberId,          // { memberId | phone | externalId } → member id
+  findOrCreateMemberLabels, // idempotent label lookup/create → ids
+  upsertDataRecordForMember,// idempotent member-scoped record write
+  enrollMemberInJourney,    // resolve member → tag → enroll (409 = already enrolled)
+  // outbound calling
+  findMemberByPhone,
+  resolveOutboundPhoneNumberId,
+  resolveOutboundWorkflowId,
+  // webhook signatures (isomorphic HMAC-SHA256; verify the RAW body)
+  verifyWebhookSignature,
+  signWebhookPayload,
+  WEBHOOK_SIGNATURE_HEADER,
+} from '@gravity-rail/sdk/helpers';
+
+// Enroll into a journey by any identifier, applying cohort labels:
+await enrollMemberInJourney(client, workspaceUuid, {
+  externalId: 'patient-123',
+  journeyId,
+  labels: ['pilot-cohort'],
+});
+
+// Verify an inbound webhook in your POST handler:
+const result = await verifyWebhookSignature(
+  rawBody,
+  request.headers.get(WEBHOOK_SIGNATURE_HEADER),
+  signingSecret,
+);
+if (!result.ok) return new Response(result.reason, { status: 401 });
+```
+
 ## Type System
 
 Full TypeScript types for every API entity: