@outlit/tools 2.2.4 → 2.2.5

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.
Files changed (7) hide show
  1. package/dist/index.cjs +145 -3
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +95 -3
  4. package/dist/index.d.ts +95 -3
  5. package/dist/index.js +145 -3
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -244,7 +244,7 @@ declare const publicToolContracts: {
244
244
  readonly commandVersion: 1;
245
245
  readonly ownerDomain: "users";
246
246
  readonly title: "List Users";
247
- readonly description: "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info.";
247
+ readonly description: "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info and each user's sources: where Outlit found them (CRM, support tool, product analytics, Slack) and the calls, meetings, emails, tickets and Slack threads they took part in.";
248
248
  readonly annotations: {
249
249
  readonly readOnlyHint: true;
250
250
  readonly destructiveHint: false;
@@ -384,6 +384,52 @@ declare const publicToolContracts: {
384
384
  readonly type: "null";
385
385
  }];
386
386
  };
387
+ readonly sources: {
388
+ readonly type: "array";
389
+ readonly items: {
390
+ readonly type: "object";
391
+ readonly properties: {
392
+ readonly system: {
393
+ readonly type: "string";
394
+ readonly description: "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record).";
395
+ };
396
+ readonly kind: {
397
+ readonly type: "string";
398
+ readonly enum: readonly ["contact", "product_user", "chat_member", "billing_customer", "call", "meeting", "email", "support_ticket", "slack_thread"];
399
+ readonly description: "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread.";
400
+ };
401
+ readonly count: {
402
+ readonly anyOf: readonly [{
403
+ readonly type: "integer";
404
+ readonly minimum: 1;
405
+ readonly maximum: 9007199254740991;
406
+ }, {
407
+ readonly type: "null";
408
+ }];
409
+ readonly description: "How many conversations of this kind; null for records.";
410
+ };
411
+ readonly firstSeenAt: {
412
+ readonly anyOf: readonly [{
413
+ readonly type: "string";
414
+ }, {
415
+ readonly type: "null";
416
+ }];
417
+ readonly description: "When the record was created in the system (or first linked to this person), or the first conversation.";
418
+ };
419
+ readonly lastSeenAt: {
420
+ readonly anyOf: readonly [{
421
+ readonly type: "string";
422
+ }, {
423
+ readonly type: "null";
424
+ }];
425
+ readonly description: "The latest conversation; null for records.";
426
+ };
427
+ };
428
+ readonly required: readonly ["system", "kind", "count", "firstSeenAt", "lastSeenAt"];
429
+ readonly additionalProperties: false;
430
+ };
431
+ readonly description: "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it.";
432
+ };
387
433
  readonly relationshipRole: {
388
434
  readonly anyOf: readonly [{
389
435
  readonly type: "string";
@@ -600,7 +646,7 @@ declare const publicToolContracts: {
600
646
  readonly commandVersion: 1;
601
647
  readonly ownerDomain: "customers";
602
648
  readonly title: "Get Customer";
603
- readonly description: "Get full details for a single customer. Optionally include users, revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 × currentMrr in the same units.";
649
+ readonly description: "Get full details for a single customer. Optionally include users (each with their sources: where Outlit found them and the conversations they took part in), revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 × currentMrr in the same units.";
604
650
  readonly annotations: {
605
651
  readonly readOnlyHint: true;
606
652
  readonly destructiveHint: false;
@@ -738,6 +784,52 @@ declare const publicToolContracts: {
738
784
  readonly type: "null";
739
785
  }];
740
786
  };
787
+ readonly sources: {
788
+ readonly type: "array";
789
+ readonly items: {
790
+ readonly type: "object";
791
+ readonly properties: {
792
+ readonly system: {
793
+ readonly type: "string";
794
+ readonly description: "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record).";
795
+ };
796
+ readonly kind: {
797
+ readonly type: "string";
798
+ readonly enum: readonly ["contact", "product_user", "chat_member", "billing_customer", "call", "meeting", "email", "support_ticket", "slack_thread"];
799
+ readonly description: "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread.";
800
+ };
801
+ readonly count: {
802
+ readonly anyOf: readonly [{
803
+ readonly type: "integer";
804
+ readonly minimum: 1;
805
+ readonly maximum: 9007199254740991;
806
+ }, {
807
+ readonly type: "null";
808
+ }];
809
+ readonly description: "How many conversations of this kind; null for records.";
810
+ };
811
+ readonly firstSeenAt: {
812
+ readonly anyOf: readonly [{
813
+ readonly type: "string";
814
+ }, {
815
+ readonly type: "null";
816
+ }];
817
+ readonly description: "When the record was created in the system (or first linked to this person), or the first conversation.";
818
+ };
819
+ readonly lastSeenAt: {
820
+ readonly anyOf: readonly [{
821
+ readonly type: "string";
822
+ }, {
823
+ readonly type: "null";
824
+ }];
825
+ readonly description: "The latest conversation; null for records.";
826
+ };
827
+ };
828
+ readonly required: readonly ["system", "kind", "count", "firstSeenAt", "lastSeenAt"];
829
+ readonly additionalProperties: false;
830
+ };
831
+ readonly description: "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it.";
832
+ };
741
833
  readonly relationshipRole: {
742
834
  readonly anyOf: readonly [{
743
835
  readonly type: "string";
@@ -12619,7 +12711,7 @@ declare const userJourneyStages: readonly ["DISCOVERED", "SIGNED_UP", "ACTIVATED
12619
12711
  declare const userListOrderFields: readonly ["last_activity_at", "first_seen_at", "email"];
12620
12712
  declare const workspaceUserListOrderFields: readonly ["name", "email", "owned_customer_count"];
12621
12713
  declare const schemaTables: readonly ["activity", "customers", "users", "revenue"];
12622
- declare const sdkConsumerContractHash: "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
12714
+ declare const sdkConsumerContractHash: "2fa67b23109e55e6b48d9899d1cfd176784feadf1d052a30a218cb69a3b59cbb";
12623
12715
 
12624
12716
  type JsonSchema = Readonly<Record<string, unknown>>;
12625
12717
  type PublicToolName = (typeof publicToolNames)[number];
package/dist/index.d.ts CHANGED
@@ -244,7 +244,7 @@ declare const publicToolContracts: {
244
244
  readonly commandVersion: 1;
245
245
  readonly ownerDomain: "users";
246
246
  readonly title: "List Users";
247
- readonly description: "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info.";
247
+ readonly description: "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info and each user's sources: where Outlit found them (CRM, support tool, product analytics, Slack) and the calls, meetings, emails, tickets and Slack threads they took part in.";
248
248
  readonly annotations: {
249
249
  readonly readOnlyHint: true;
250
250
  readonly destructiveHint: false;
@@ -384,6 +384,52 @@ declare const publicToolContracts: {
384
384
  readonly type: "null";
385
385
  }];
386
386
  };
387
+ readonly sources: {
388
+ readonly type: "array";
389
+ readonly items: {
390
+ readonly type: "object";
391
+ readonly properties: {
392
+ readonly system: {
393
+ readonly type: "string";
394
+ readonly description: "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record).";
395
+ };
396
+ readonly kind: {
397
+ readonly type: "string";
398
+ readonly enum: readonly ["contact", "product_user", "chat_member", "billing_customer", "call", "meeting", "email", "support_ticket", "slack_thread"];
399
+ readonly description: "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread.";
400
+ };
401
+ readonly count: {
402
+ readonly anyOf: readonly [{
403
+ readonly type: "integer";
404
+ readonly minimum: 1;
405
+ readonly maximum: 9007199254740991;
406
+ }, {
407
+ readonly type: "null";
408
+ }];
409
+ readonly description: "How many conversations of this kind; null for records.";
410
+ };
411
+ readonly firstSeenAt: {
412
+ readonly anyOf: readonly [{
413
+ readonly type: "string";
414
+ }, {
415
+ readonly type: "null";
416
+ }];
417
+ readonly description: "When the record was created in the system (or first linked to this person), or the first conversation.";
418
+ };
419
+ readonly lastSeenAt: {
420
+ readonly anyOf: readonly [{
421
+ readonly type: "string";
422
+ }, {
423
+ readonly type: "null";
424
+ }];
425
+ readonly description: "The latest conversation; null for records.";
426
+ };
427
+ };
428
+ readonly required: readonly ["system", "kind", "count", "firstSeenAt", "lastSeenAt"];
429
+ readonly additionalProperties: false;
430
+ };
431
+ readonly description: "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it.";
432
+ };
387
433
  readonly relationshipRole: {
388
434
  readonly anyOf: readonly [{
389
435
  readonly type: "string";
@@ -600,7 +646,7 @@ declare const publicToolContracts: {
600
646
  readonly commandVersion: 1;
601
647
  readonly ownerDomain: "customers";
602
648
  readonly title: "Get Customer";
603
- readonly description: "Get full details for a single customer. Optionally include users, revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 × currentMrr in the same units.";
649
+ readonly description: "Get full details for a single customer. Optionally include users (each with their sources: where Outlit found them and the conversations they took part in), revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 × currentMrr in the same units.";
604
650
  readonly annotations: {
605
651
  readonly readOnlyHint: true;
606
652
  readonly destructiveHint: false;
@@ -738,6 +784,52 @@ declare const publicToolContracts: {
738
784
  readonly type: "null";
739
785
  }];
740
786
  };
787
+ readonly sources: {
788
+ readonly type: "array";
789
+ readonly items: {
790
+ readonly type: "object";
791
+ readonly properties: {
792
+ readonly system: {
793
+ readonly type: "string";
794
+ readonly description: "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record).";
795
+ };
796
+ readonly kind: {
797
+ readonly type: "string";
798
+ readonly enum: readonly ["contact", "product_user", "chat_member", "billing_customer", "call", "meeting", "email", "support_ticket", "slack_thread"];
799
+ readonly description: "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread.";
800
+ };
801
+ readonly count: {
802
+ readonly anyOf: readonly [{
803
+ readonly type: "integer";
804
+ readonly minimum: 1;
805
+ readonly maximum: 9007199254740991;
806
+ }, {
807
+ readonly type: "null";
808
+ }];
809
+ readonly description: "How many conversations of this kind; null for records.";
810
+ };
811
+ readonly firstSeenAt: {
812
+ readonly anyOf: readonly [{
813
+ readonly type: "string";
814
+ }, {
815
+ readonly type: "null";
816
+ }];
817
+ readonly description: "When the record was created in the system (or first linked to this person), or the first conversation.";
818
+ };
819
+ readonly lastSeenAt: {
820
+ readonly anyOf: readonly [{
821
+ readonly type: "string";
822
+ }, {
823
+ readonly type: "null";
824
+ }];
825
+ readonly description: "The latest conversation; null for records.";
826
+ };
827
+ };
828
+ readonly required: readonly ["system", "kind", "count", "firstSeenAt", "lastSeenAt"];
829
+ readonly additionalProperties: false;
830
+ };
831
+ readonly description: "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it.";
832
+ };
741
833
  readonly relationshipRole: {
742
834
  readonly anyOf: readonly [{
743
835
  readonly type: "string";
@@ -12619,7 +12711,7 @@ declare const userJourneyStages: readonly ["DISCOVERED", "SIGNED_UP", "ACTIVATED
12619
12711
  declare const userListOrderFields: readonly ["last_activity_at", "first_seen_at", "email"];
12620
12712
  declare const workspaceUserListOrderFields: readonly ["name", "email", "owned_customer_count"];
12621
12713
  declare const schemaTables: readonly ["activity", "customers", "users", "revenue"];
12622
- declare const sdkConsumerContractHash: "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
12714
+ declare const sdkConsumerContractHash: "2fa67b23109e55e6b48d9899d1cfd176784feadf1d052a30a218cb69a3b59cbb";
12623
12715
 
12624
12716
  type JsonSchema = Readonly<Record<string, unknown>>;
12625
12717
  type PublicToolName = (typeof publicToolNames)[number];
package/dist/index.js CHANGED
@@ -386,7 +386,7 @@ var publicToolContracts = {
386
386
  "commandVersion": 1,
387
387
  "ownerDomain": "users",
388
388
  "title": "List Users",
389
- "description": "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info.",
389
+ "description": "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info and each user's sources: where Outlit found them (CRM, support tool, product analytics, Slack) and the calls, meetings, emails, tickets and Slack threads they took part in.",
390
390
  "annotations": {
391
391
  "readOnlyHint": true,
392
392
  "destructiveHint": false
@@ -567,6 +567,77 @@ var publicToolContracts = {
567
567
  }
568
568
  ]
569
569
  },
570
+ "sources": {
571
+ "type": "array",
572
+ "items": {
573
+ "type": "object",
574
+ "properties": {
575
+ "system": {
576
+ "type": "string",
577
+ "description": "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record)."
578
+ },
579
+ "kind": {
580
+ "type": "string",
581
+ "enum": [
582
+ "contact",
583
+ "product_user",
584
+ "chat_member",
585
+ "billing_customer",
586
+ "call",
587
+ "meeting",
588
+ "email",
589
+ "support_ticket",
590
+ "slack_thread"
591
+ ],
592
+ "description": "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread."
593
+ },
594
+ "count": {
595
+ "anyOf": [
596
+ {
597
+ "type": "integer",
598
+ "minimum": 1,
599
+ "maximum": 9007199254740991
600
+ },
601
+ {
602
+ "type": "null"
603
+ }
604
+ ],
605
+ "description": "How many conversations of this kind; null for records."
606
+ },
607
+ "firstSeenAt": {
608
+ "anyOf": [
609
+ {
610
+ "type": "string"
611
+ },
612
+ {
613
+ "type": "null"
614
+ }
615
+ ],
616
+ "description": "When the record was created in the system (or first linked to this person), or the first conversation."
617
+ },
618
+ "lastSeenAt": {
619
+ "anyOf": [
620
+ {
621
+ "type": "string"
622
+ },
623
+ {
624
+ "type": "null"
625
+ }
626
+ ],
627
+ "description": "The latest conversation; null for records."
628
+ }
629
+ },
630
+ "required": [
631
+ "system",
632
+ "kind",
633
+ "count",
634
+ "firstSeenAt",
635
+ "lastSeenAt"
636
+ ],
637
+ "additionalProperties": false
638
+ },
639
+ "description": "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it."
640
+ },
570
641
  "relationshipRole": {
571
642
  "anyOf": [
572
643
  {
@@ -861,7 +932,7 @@ var publicToolContracts = {
861
932
  "commandVersion": 1,
862
933
  "ownerDomain": "customers",
863
934
  "title": "Get Customer",
864
- "description": "Get full details for a single customer. Optionally include users, revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 \xD7 currentMrr in the same units.",
935
+ "description": "Get full details for a single customer. Optionally include users (each with their sources: where Outlit found them and the conversations they took part in), revenue, recent activity, engagement metrics, or company enrichment. Revenue amounts (currentMrr, lifetimeRevenue) are in the billing provider's units for the customer's currency, which the result doesn't name. For USD, EUR, GBP and CAD these are cents: divide by 100 (e.g. 1234500 is $12,345, USD). Other currencies follow the provider's amount rules. ARR is 12 \xD7 currentMrr in the same units.",
865
936
  "annotations": {
866
937
  "readOnlyHint": true,
867
938
  "destructiveHint": false
@@ -1064,6 +1135,77 @@ var publicToolContracts = {
1064
1135
  }
1065
1136
  ]
1066
1137
  },
1138
+ "sources": {
1139
+ "type": "array",
1140
+ "items": {
1141
+ "type": "object",
1142
+ "properties": {
1143
+ "system": {
1144
+ "type": "string",
1145
+ "description": "Lowercase id of the system, such as hubspot, salesforce, attio, pylon, posthog, slack, stripe, google-mail, google-calendar, ergo, fireflies, gong, mixpanel, outlit (the Outlit SDK) or product-analytics (a product-analytics provider Outlit did not record)."
1146
+ },
1147
+ "kind": {
1148
+ "type": "string",
1149
+ "enum": [
1150
+ "contact",
1151
+ "product_user",
1152
+ "chat_member",
1153
+ "billing_customer",
1154
+ "call",
1155
+ "meeting",
1156
+ "email",
1157
+ "support_ticket",
1158
+ "slack_thread"
1159
+ ],
1160
+ "description": "Records: contact (a contact in a CRM or support tool), product_user (a user in product analytics or product sign-in), chat_member (a Slack member), billing_customer. Conversations the person took part in: call, meeting, email, support_ticket, slack_thread."
1161
+ },
1162
+ "count": {
1163
+ "anyOf": [
1164
+ {
1165
+ "type": "integer",
1166
+ "minimum": 1,
1167
+ "maximum": 9007199254740991
1168
+ },
1169
+ {
1170
+ "type": "null"
1171
+ }
1172
+ ],
1173
+ "description": "How many conversations of this kind; null for records."
1174
+ },
1175
+ "firstSeenAt": {
1176
+ "anyOf": [
1177
+ {
1178
+ "type": "string"
1179
+ },
1180
+ {
1181
+ "type": "null"
1182
+ }
1183
+ ],
1184
+ "description": "When the record was created in the system (or first linked to this person), or the first conversation."
1185
+ },
1186
+ "lastSeenAt": {
1187
+ "anyOf": [
1188
+ {
1189
+ "type": "string"
1190
+ },
1191
+ {
1192
+ "type": "null"
1193
+ }
1194
+ ],
1195
+ "description": "The latest conversation; null for records."
1196
+ }
1197
+ },
1198
+ "required": [
1199
+ "system",
1200
+ "kind",
1201
+ "count",
1202
+ "firstSeenAt",
1203
+ "lastSeenAt"
1204
+ ],
1205
+ "additionalProperties": false
1206
+ },
1207
+ "description": "Where Outlit found this person: the systems that hold a record of them and the conversations they took part in. Empty when Outlit has no source recorded; absent from servers that predate it."
1208
+ },
1067
1209
  "relationshipRole": {
1068
1210
  "anyOf": [
1069
1211
  {
@@ -17322,7 +17464,7 @@ var schemaTables = [
17322
17464
  "users",
17323
17465
  "revenue"
17324
17466
  ];
17325
- var sdkConsumerContractHash = "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
17467
+ var sdkConsumerContractHash = "2fa67b23109e55e6b48d9899d1cfd176784feadf1d052a30a218cb69a3b59cbb";
17326
17468
 
17327
17469
  // src/contracts.ts
17328
17470
  var publicToolNameSet = new Set(publicToolNames);