@outlit/tools 2.2.3 → 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.
- package/dist/index.cjs +370 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +238 -4
- package/dist/index.d.ts +238 -4
- package/dist/index.js +368 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -24,9 +24,11 @@ __export(src_exports, {
|
|
|
24
24
|
OutlitToolsApiError: () => OutlitToolsApiError,
|
|
25
25
|
allPublicToolNames: () => allPublicToolNames,
|
|
26
26
|
analyticalToolNames: () => analyticalToolNames,
|
|
27
|
+
apiKeyContractHeader: () => apiKeyContractHeader,
|
|
27
28
|
apiKeyGrants: () => apiKeyGrants,
|
|
28
29
|
apiKeyValidationFailureSchema: () => apiKeyValidationFailureSchema,
|
|
29
30
|
apiKeyValidationSuccessSchema: () => apiKeyValidationSuccessSchema,
|
|
31
|
+
apiKeyValidationSuccessSchemaV2: () => apiKeyValidationSuccessSchemaV2,
|
|
30
32
|
apiKeyValidationTransport: () => apiKeyValidationTransport,
|
|
31
33
|
cliToolNames: () => cliToolNames,
|
|
32
34
|
consumerToolPolicies: () => consumerToolPolicies,
|
|
@@ -460,7 +462,7 @@ var publicToolContracts = {
|
|
|
460
462
|
"commandVersion": 1,
|
|
461
463
|
"ownerDomain": "users",
|
|
462
464
|
"title": "List Users",
|
|
463
|
-
"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.",
|
|
465
|
+
"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.",
|
|
464
466
|
"annotations": {
|
|
465
467
|
"readOnlyHint": true,
|
|
466
468
|
"destructiveHint": false
|
|
@@ -641,6 +643,77 @@ var publicToolContracts = {
|
|
|
641
643
|
}
|
|
642
644
|
]
|
|
643
645
|
},
|
|
646
|
+
"sources": {
|
|
647
|
+
"type": "array",
|
|
648
|
+
"items": {
|
|
649
|
+
"type": "object",
|
|
650
|
+
"properties": {
|
|
651
|
+
"system": {
|
|
652
|
+
"type": "string",
|
|
653
|
+
"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)."
|
|
654
|
+
},
|
|
655
|
+
"kind": {
|
|
656
|
+
"type": "string",
|
|
657
|
+
"enum": [
|
|
658
|
+
"contact",
|
|
659
|
+
"product_user",
|
|
660
|
+
"chat_member",
|
|
661
|
+
"billing_customer",
|
|
662
|
+
"call",
|
|
663
|
+
"meeting",
|
|
664
|
+
"email",
|
|
665
|
+
"support_ticket",
|
|
666
|
+
"slack_thread"
|
|
667
|
+
],
|
|
668
|
+
"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."
|
|
669
|
+
},
|
|
670
|
+
"count": {
|
|
671
|
+
"anyOf": [
|
|
672
|
+
{
|
|
673
|
+
"type": "integer",
|
|
674
|
+
"minimum": 1,
|
|
675
|
+
"maximum": 9007199254740991
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
"type": "null"
|
|
679
|
+
}
|
|
680
|
+
],
|
|
681
|
+
"description": "How many conversations of this kind; null for records."
|
|
682
|
+
},
|
|
683
|
+
"firstSeenAt": {
|
|
684
|
+
"anyOf": [
|
|
685
|
+
{
|
|
686
|
+
"type": "string"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"type": "null"
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"description": "When the record was created in the system (or first linked to this person), or the first conversation."
|
|
693
|
+
},
|
|
694
|
+
"lastSeenAt": {
|
|
695
|
+
"anyOf": [
|
|
696
|
+
{
|
|
697
|
+
"type": "string"
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"type": "null"
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"description": "The latest conversation; null for records."
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"required": [
|
|
707
|
+
"system",
|
|
708
|
+
"kind",
|
|
709
|
+
"count",
|
|
710
|
+
"firstSeenAt",
|
|
711
|
+
"lastSeenAt"
|
|
712
|
+
],
|
|
713
|
+
"additionalProperties": false
|
|
714
|
+
},
|
|
715
|
+
"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."
|
|
716
|
+
},
|
|
644
717
|
"relationshipRole": {
|
|
645
718
|
"anyOf": [
|
|
646
719
|
{
|
|
@@ -935,7 +1008,7 @@ var publicToolContracts = {
|
|
|
935
1008
|
"commandVersion": 1,
|
|
936
1009
|
"ownerDomain": "customers",
|
|
937
1010
|
"title": "Get Customer",
|
|
938
|
-
"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.",
|
|
1011
|
+
"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.",
|
|
939
1012
|
"annotations": {
|
|
940
1013
|
"readOnlyHint": true,
|
|
941
1014
|
"destructiveHint": false
|
|
@@ -1138,6 +1211,77 @@ var publicToolContracts = {
|
|
|
1138
1211
|
}
|
|
1139
1212
|
]
|
|
1140
1213
|
},
|
|
1214
|
+
"sources": {
|
|
1215
|
+
"type": "array",
|
|
1216
|
+
"items": {
|
|
1217
|
+
"type": "object",
|
|
1218
|
+
"properties": {
|
|
1219
|
+
"system": {
|
|
1220
|
+
"type": "string",
|
|
1221
|
+
"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)."
|
|
1222
|
+
},
|
|
1223
|
+
"kind": {
|
|
1224
|
+
"type": "string",
|
|
1225
|
+
"enum": [
|
|
1226
|
+
"contact",
|
|
1227
|
+
"product_user",
|
|
1228
|
+
"chat_member",
|
|
1229
|
+
"billing_customer",
|
|
1230
|
+
"call",
|
|
1231
|
+
"meeting",
|
|
1232
|
+
"email",
|
|
1233
|
+
"support_ticket",
|
|
1234
|
+
"slack_thread"
|
|
1235
|
+
],
|
|
1236
|
+
"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."
|
|
1237
|
+
},
|
|
1238
|
+
"count": {
|
|
1239
|
+
"anyOf": [
|
|
1240
|
+
{
|
|
1241
|
+
"type": "integer",
|
|
1242
|
+
"minimum": 1,
|
|
1243
|
+
"maximum": 9007199254740991
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"type": "null"
|
|
1247
|
+
}
|
|
1248
|
+
],
|
|
1249
|
+
"description": "How many conversations of this kind; null for records."
|
|
1250
|
+
},
|
|
1251
|
+
"firstSeenAt": {
|
|
1252
|
+
"anyOf": [
|
|
1253
|
+
{
|
|
1254
|
+
"type": "string"
|
|
1255
|
+
},
|
|
1256
|
+
{
|
|
1257
|
+
"type": "null"
|
|
1258
|
+
}
|
|
1259
|
+
],
|
|
1260
|
+
"description": "When the record was created in the system (or first linked to this person), or the first conversation."
|
|
1261
|
+
},
|
|
1262
|
+
"lastSeenAt": {
|
|
1263
|
+
"anyOf": [
|
|
1264
|
+
{
|
|
1265
|
+
"type": "string"
|
|
1266
|
+
},
|
|
1267
|
+
{
|
|
1268
|
+
"type": "null"
|
|
1269
|
+
}
|
|
1270
|
+
],
|
|
1271
|
+
"description": "The latest conversation; null for records."
|
|
1272
|
+
}
|
|
1273
|
+
},
|
|
1274
|
+
"required": [
|
|
1275
|
+
"system",
|
|
1276
|
+
"kind",
|
|
1277
|
+
"count",
|
|
1278
|
+
"firstSeenAt",
|
|
1279
|
+
"lastSeenAt"
|
|
1280
|
+
],
|
|
1281
|
+
"additionalProperties": false
|
|
1282
|
+
},
|
|
1283
|
+
"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."
|
|
1284
|
+
},
|
|
1141
1285
|
"relationshipRole": {
|
|
1142
1286
|
"anyOf": [
|
|
1143
1287
|
{
|
|
@@ -16128,6 +16272,227 @@ var apiKeyValidationFailureSchema = {
|
|
|
16128
16272
|
],
|
|
16129
16273
|
"additionalProperties": false
|
|
16130
16274
|
};
|
|
16275
|
+
var apiKeyContractHeader = "Outlit-Api-Key-Contract";
|
|
16276
|
+
var apiKeyValidationSuccessSchemaV2 = {
|
|
16277
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
16278
|
+
"type": "object",
|
|
16279
|
+
"properties": {
|
|
16280
|
+
"valid": {
|
|
16281
|
+
"type": "boolean",
|
|
16282
|
+
"const": true
|
|
16283
|
+
},
|
|
16284
|
+
"organizationId": {
|
|
16285
|
+
"type": "string"
|
|
16286
|
+
},
|
|
16287
|
+
"createdById": {
|
|
16288
|
+
"anyOf": [
|
|
16289
|
+
{
|
|
16290
|
+
"type": "string"
|
|
16291
|
+
},
|
|
16292
|
+
{
|
|
16293
|
+
"type": "null"
|
|
16294
|
+
}
|
|
16295
|
+
]
|
|
16296
|
+
},
|
|
16297
|
+
"organization": {
|
|
16298
|
+
"type": "object",
|
|
16299
|
+
"properties": {
|
|
16300
|
+
"id": {
|
|
16301
|
+
"type": "string"
|
|
16302
|
+
},
|
|
16303
|
+
"name": {
|
|
16304
|
+
"anyOf": [
|
|
16305
|
+
{
|
|
16306
|
+
"type": "string"
|
|
16307
|
+
},
|
|
16308
|
+
{
|
|
16309
|
+
"type": "null"
|
|
16310
|
+
}
|
|
16311
|
+
]
|
|
16312
|
+
},
|
|
16313
|
+
"slug": {
|
|
16314
|
+
"anyOf": [
|
|
16315
|
+
{
|
|
16316
|
+
"type": "string"
|
|
16317
|
+
},
|
|
16318
|
+
{
|
|
16319
|
+
"type": "null"
|
|
16320
|
+
}
|
|
16321
|
+
]
|
|
16322
|
+
}
|
|
16323
|
+
},
|
|
16324
|
+
"required": [
|
|
16325
|
+
"id",
|
|
16326
|
+
"name",
|
|
16327
|
+
"slug"
|
|
16328
|
+
],
|
|
16329
|
+
"additionalProperties": false
|
|
16330
|
+
},
|
|
16331
|
+
"createdBy": {
|
|
16332
|
+
"anyOf": [
|
|
16333
|
+
{
|
|
16334
|
+
"type": "object",
|
|
16335
|
+
"properties": {
|
|
16336
|
+
"id": {
|
|
16337
|
+
"type": "string"
|
|
16338
|
+
},
|
|
16339
|
+
"email": {
|
|
16340
|
+
"type": "string"
|
|
16341
|
+
},
|
|
16342
|
+
"name": {
|
|
16343
|
+
"anyOf": [
|
|
16344
|
+
{
|
|
16345
|
+
"type": "string"
|
|
16346
|
+
},
|
|
16347
|
+
{
|
|
16348
|
+
"type": "null"
|
|
16349
|
+
}
|
|
16350
|
+
]
|
|
16351
|
+
}
|
|
16352
|
+
},
|
|
16353
|
+
"required": [
|
|
16354
|
+
"id",
|
|
16355
|
+
"email",
|
|
16356
|
+
"name"
|
|
16357
|
+
],
|
|
16358
|
+
"additionalProperties": false
|
|
16359
|
+
},
|
|
16360
|
+
{
|
|
16361
|
+
"type": "null"
|
|
16362
|
+
}
|
|
16363
|
+
]
|
|
16364
|
+
},
|
|
16365
|
+
"apiKey": {
|
|
16366
|
+
"type": "object",
|
|
16367
|
+
"properties": {
|
|
16368
|
+
"id": {
|
|
16369
|
+
"type": "string"
|
|
16370
|
+
},
|
|
16371
|
+
"name": {
|
|
16372
|
+
"type": "string"
|
|
16373
|
+
},
|
|
16374
|
+
"prefix": {
|
|
16375
|
+
"type": "string"
|
|
16376
|
+
},
|
|
16377
|
+
"keyType": {
|
|
16378
|
+
"type": "string",
|
|
16379
|
+
"enum": [
|
|
16380
|
+
"api",
|
|
16381
|
+
"cli",
|
|
16382
|
+
"mcp",
|
|
16383
|
+
"ci"
|
|
16384
|
+
]
|
|
16385
|
+
},
|
|
16386
|
+
"grants": {
|
|
16387
|
+
"type": "array",
|
|
16388
|
+
"items": {
|
|
16389
|
+
"type": "string",
|
|
16390
|
+
"enum": [
|
|
16391
|
+
"customer_intelligence:read",
|
|
16392
|
+
"workspace_members:read",
|
|
16393
|
+
"analytics:read",
|
|
16394
|
+
"destinations:manage",
|
|
16395
|
+
"behavior_metrics:manage",
|
|
16396
|
+
"integrations:connect_own",
|
|
16397
|
+
"integrations:manage",
|
|
16398
|
+
"activation:read",
|
|
16399
|
+
"activation:manage",
|
|
16400
|
+
"workspace_settings:read",
|
|
16401
|
+
"workspace_settings:manage",
|
|
16402
|
+
"customer_access:manage",
|
|
16403
|
+
"customer_identity:review",
|
|
16404
|
+
"customer_identity:merge"
|
|
16405
|
+
]
|
|
16406
|
+
}
|
|
16407
|
+
},
|
|
16408
|
+
"createdAt": {
|
|
16409
|
+
"type": "string",
|
|
16410
|
+
"format": "date-time",
|
|
16411
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
16412
|
+
},
|
|
16413
|
+
"lastUsedAt": {
|
|
16414
|
+
"anyOf": [
|
|
16415
|
+
{
|
|
16416
|
+
"type": "string",
|
|
16417
|
+
"format": "date-time",
|
|
16418
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
16419
|
+
},
|
|
16420
|
+
{
|
|
16421
|
+
"type": "null"
|
|
16422
|
+
}
|
|
16423
|
+
]
|
|
16424
|
+
},
|
|
16425
|
+
"totalRequests": {
|
|
16426
|
+
"type": "integer",
|
|
16427
|
+
"minimum": 0,
|
|
16428
|
+
"maximum": 9007199254740991
|
|
16429
|
+
},
|
|
16430
|
+
"expiresAt": {
|
|
16431
|
+
"anyOf": [
|
|
16432
|
+
{
|
|
16433
|
+
"type": "string",
|
|
16434
|
+
"format": "date-time",
|
|
16435
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
16436
|
+
},
|
|
16437
|
+
{
|
|
16438
|
+
"type": "null"
|
|
16439
|
+
}
|
|
16440
|
+
]
|
|
16441
|
+
}
|
|
16442
|
+
},
|
|
16443
|
+
"required": [
|
|
16444
|
+
"id",
|
|
16445
|
+
"name",
|
|
16446
|
+
"prefix",
|
|
16447
|
+
"keyType",
|
|
16448
|
+
"grants",
|
|
16449
|
+
"createdAt",
|
|
16450
|
+
"lastUsedAt",
|
|
16451
|
+
"totalRequests",
|
|
16452
|
+
"expiresAt"
|
|
16453
|
+
],
|
|
16454
|
+
"additionalProperties": false
|
|
16455
|
+
},
|
|
16456
|
+
"authorization": {
|
|
16457
|
+
"type": "object",
|
|
16458
|
+
"properties": {
|
|
16459
|
+
"grants": {
|
|
16460
|
+
"type": "array",
|
|
16461
|
+
"items": {
|
|
16462
|
+
"type": "string",
|
|
16463
|
+
"enum": [
|
|
16464
|
+
"customer_intelligence:read",
|
|
16465
|
+
"workspace_members:read",
|
|
16466
|
+
"analytics:read",
|
|
16467
|
+
"destinations:manage",
|
|
16468
|
+
"behavior_metrics:manage",
|
|
16469
|
+
"integrations:connect_own",
|
|
16470
|
+
"integrations:manage",
|
|
16471
|
+
"activation:read",
|
|
16472
|
+
"activation:manage",
|
|
16473
|
+
"workspace_settings:read",
|
|
16474
|
+
"workspace_settings:manage",
|
|
16475
|
+
"customer_access:manage",
|
|
16476
|
+
"customer_identity:review",
|
|
16477
|
+
"customer_identity:merge"
|
|
16478
|
+
]
|
|
16479
|
+
}
|
|
16480
|
+
}
|
|
16481
|
+
},
|
|
16482
|
+
"required": [
|
|
16483
|
+
"grants"
|
|
16484
|
+
],
|
|
16485
|
+
"additionalProperties": false
|
|
16486
|
+
}
|
|
16487
|
+
},
|
|
16488
|
+
"required": [
|
|
16489
|
+
"valid",
|
|
16490
|
+
"organizationId",
|
|
16491
|
+
"createdById",
|
|
16492
|
+
"authorization"
|
|
16493
|
+
],
|
|
16494
|
+
"additionalProperties": false
|
|
16495
|
+
};
|
|
16131
16496
|
var toolGatewayErrorCodes = [
|
|
16132
16497
|
"INVALID_JSON",
|
|
16133
16498
|
"INVALID_TOOL_CALL",
|
|
@@ -17175,7 +17540,7 @@ var schemaTables = [
|
|
|
17175
17540
|
"users",
|
|
17176
17541
|
"revenue"
|
|
17177
17542
|
];
|
|
17178
|
-
var sdkConsumerContractHash = "
|
|
17543
|
+
var sdkConsumerContractHash = "2fa67b23109e55e6b48d9899d1cfd176784feadf1d052a30a218cb69a3b59cbb";
|
|
17179
17544
|
|
|
17180
17545
|
// src/contracts.ts
|
|
17181
17546
|
var publicToolNameSet = new Set(publicToolNames);
|
|
@@ -17382,9 +17747,11 @@ var sqlToolNames = analyticalToolNames.filter(
|
|
|
17382
17747
|
OutlitToolsApiError,
|
|
17383
17748
|
allPublicToolNames,
|
|
17384
17749
|
analyticalToolNames,
|
|
17750
|
+
apiKeyContractHeader,
|
|
17385
17751
|
apiKeyGrants,
|
|
17386
17752
|
apiKeyValidationFailureSchema,
|
|
17387
17753
|
apiKeyValidationSuccessSchema,
|
|
17754
|
+
apiKeyValidationSuccessSchemaV2,
|
|
17388
17755
|
apiKeyValidationTransport,
|
|
17389
17756
|
cliToolNames,
|
|
17390
17757
|
consumerToolPolicies,
|