@graph8/sdk 0.262.0 → 0.264.0

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.
@@ -5,6 +5,6 @@
5
5
  * both together (the version-parity gate already pins package.json, the
6
6
  * lockfile and the CHANGELOG to each other).
7
7
  */
8
- export declare const SDK_VERSION = "0.262.0";
8
+ export declare const SDK_VERSION = "0.264.0";
9
9
  /** Value of the `X-G8-Client` header every SDK request carries (I-13). */
10
- export declare const SDK_CLIENT_ID = "js-sdk/0.262.0";
10
+ export declare const SDK_CLIENT_ID = "js-sdk/0.264.0";
@@ -65,7 +65,7 @@ export interface ClickhouseMashupRequest {
65
65
  limit?: number;
66
66
  /** Which mashup PK to filter by. */
67
67
  mode: "by_upid" | "by_hem" | "by_domain";
68
- /** Which mashup table to read. 'joined' returns the lighter denormalized mashup_new with both profiles partially populated. */
68
+ /** Which mashup table to read. 'joined' returns the denormalized contact+company record from the current mashup build (mashup.v3_enriched_for_os); by_domain mode only. */
69
69
  profile?: "b2b" | "b2c" | "joined";
70
70
  /** Up to 100 key values (UP_IDs, HEMs, or domains). */
71
71
  values: Array<string>;
@@ -58,7 +58,7 @@ Body fields (`ClickhouseMashupRequest`):
58
58
  | `body.mode` | `"by_upid" \| "by_hem" \| "by_domain"` | yes | Which mashup PK to filter by. |
59
59
  | `body.values` | `Array<string>` | yes | Up to 100 key values (UP_IDs, HEMs, or domains). min items 1, max items 100 |
60
60
  | `body.limit` | `integer` | no | default `1000`, min 1, max 1000 |
61
- | `body.profile` | `"b2b" \| "b2c" \| "joined"` | no | Which mashup table to read. 'joined' returns the lighter denormalized mashup_new with both profiles partially populated. default `"b2b"` |
61
+ | `body.profile` | `"b2b" \| "b2c" \| "joined"` | no | Which mashup table to read. 'joined' returns the denormalized contact+company record from the current mashup build (mashup.v3_enriched_for_os); by_domain mode only. default `"b2b"` |
62
62
 
63
63
  **Returns** `ApiResponse_ClickhouseMashupResponse_`: the envelope `{ data: ClickhouseMashupResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
64
64
 
@@ -203,6 +203,8 @@ export interface PaginationMeta {
203
203
  export interface WebhookCreateRequest {
204
204
  /** Event types to subscribe to */
205
205
  events: Array<string>;
206
+ /** Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. */
207
+ field_filters?: Record<string, Array<string>> | null;
206
208
  /** Human-readable name */
207
209
  name?: string | null;
208
210
  /** Target URL for webhook delivery */
@@ -230,6 +232,8 @@ export interface WebhookEventResponse {
230
232
  export interface WebhookResponse {
231
233
  created_at?: string | null;
232
234
  events?: Array<string>;
235
+ /** Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. */
236
+ field_filters?: Record<string, Array<string>> | null;
233
237
  id: string;
234
238
  is_active?: boolean;
235
239
  name?: string | null;
@@ -242,6 +246,8 @@ export interface WebhookResponse {
242
246
  export interface WebhookUpdateRequest {
243
247
  /** Event types to subscribe to */
244
248
  events?: Array<string> | null;
249
+ /** Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. */
250
+ field_filters?: Record<string, Array<string>> | null;
245
251
  /** Whether the webhook is active */
246
252
  is_active?: boolean | null;
247
253
  /** Human-readable name */
@@ -58,6 +58,7 @@ Body fields (`WebhookCreateRequest`):
58
58
  |---|---|---|---|
59
59
  | `body.events` | `Array<string>` | yes | Event types to subscribe to |
60
60
  | `body.url` | `string` | yes | Target URL for webhook delivery |
61
+ | `body.field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
61
62
  | `body.name` | `string \| null` | no | Human-readable name |
62
63
 
63
64
  **Returns** `ApiResponse_WebhookResponse_`: the envelope `{ data: WebhookResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -72,6 +73,7 @@ Other envelope fields: `pagination` (PaginationMeta).
72
73
  | `url` | `string` | yes | |
73
74
  | `created_at` | `string \| null` | no | |
74
75
  | `events` | `Array<string>` | no | default `[]` |
76
+ | `field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
75
77
  | `is_active` | `boolean` | no | default `true` |
76
78
  | `name` | `string \| null` | no | |
77
79
  | `secret` | `string \| null` | no | Only returned on create and rotate-secret |
@@ -147,6 +149,7 @@ Other envelope fields: `pagination` (PaginationMeta).
147
149
  | `url` | `string` | yes | |
148
150
  | `created_at` | `string \| null` | no | |
149
151
  | `events` | `Array<string>` | no | default `[]` |
152
+ | `field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
150
153
  | `is_active` | `boolean` | no | default `true` |
151
154
  | `name` | `string \| null` | no | |
152
155
  | `secret` | `string \| null` | no | Only returned on create and rotate-secret |
@@ -274,6 +277,7 @@ Other envelope fields: `pagination` (PaginationMeta).
274
277
  | `url` | `string` | yes | |
275
278
  | `created_at` | `string \| null` | no | |
276
279
  | `events` | `Array<string>` | no | default `[]` |
280
+ | `field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
277
281
  | `is_active` | `boolean` | no | default `true` |
278
282
  | `name` | `string \| null` | no | |
279
283
  | `secret` | `string \| null` | no | Only returned on create and rotate-secret |
@@ -318,6 +322,7 @@ Other envelope fields: `pagination` (PaginationMeta).
318
322
  | `url` | `string` | yes | |
319
323
  | `created_at` | `string \| null` | no | |
320
324
  | `events` | `Array<string>` | no | default `[]` |
325
+ | `field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
321
326
  | `is_active` | `boolean` | no | default `true` |
322
327
  | `name` | `string \| null` | no | |
323
328
  | `secret` | `string \| null` | no | Only returned on create and rotate-secret |
@@ -357,6 +362,7 @@ Body fields (`WebhookUpdateRequest`):
357
362
  | Field | Type | Required | Description |
358
363
  |---|---|---|---|
359
364
  | `body.events` | `Array<string> \| null` | no | Event types to subscribe to |
365
+ | `body.field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
360
366
  | `body.is_active` | `boolean \| null` | no | Whether the webhook is active |
361
367
  | `body.name` | `string \| null` | no | Human-readable name |
362
368
  | `body.url` | `string \| null` | no | Target URL for webhook delivery |
@@ -373,6 +379,7 @@ Other envelope fields: `pagination` (PaginationMeta).
373
379
  | `url` | `string` | yes | |
374
380
  | `created_at` | `string \| null` | no | |
375
381
  | `events` | `Array<string>` | no | default `[]` |
382
+ | `field_filters` | `Record<string, Array<string>> \| null` | no | Per-object field filter for crm.record.updated: {object_slug: [field_slug]}. When set for an object, an update delivery fires only if a watched field's value changed. Omit or leave empty to fire on any change. Ignored for events other than crm.record.updated. |
376
383
  | `is_active` | `boolean` | no | default `true` |
377
384
  | `name` | `string \| null` | no | |
378
385
  | `secret` | `string \| null` | no | Only returned on create and rotate-secret |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@graph8/sdk",
3
- "version": "0.262.0",
3
+ "version": "0.264.0",
4
4
  "description": "graph8 SDK - CRM, enrichment, sequences, campaigns, and tracking for B2B",
5
5
  "license": "MIT",
6
6
  "author": "graph8 <support@graph8.com> (https://graph8.com)",