@outlit/tools 2.2.3 → 2.2.4
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 +226 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +144 -2
- package/dist/index.d.ts +144 -2
- package/dist/index.js +224 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -11711,6 +11711,146 @@ declare const apiKeyValidationFailureSchema: {
|
|
|
11711
11711
|
readonly required: readonly ["valid", "error"];
|
|
11712
11712
|
readonly additionalProperties: false;
|
|
11713
11713
|
};
|
|
11714
|
+
declare const apiKeyContractHeader: "Outlit-Api-Key-Contract";
|
|
11715
|
+
declare const apiKeyValidationSuccessSchemaV2: {
|
|
11716
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
11717
|
+
readonly type: "object";
|
|
11718
|
+
readonly properties: {
|
|
11719
|
+
readonly valid: {
|
|
11720
|
+
readonly type: "boolean";
|
|
11721
|
+
readonly const: true;
|
|
11722
|
+
};
|
|
11723
|
+
readonly organizationId: {
|
|
11724
|
+
readonly type: "string";
|
|
11725
|
+
};
|
|
11726
|
+
readonly createdById: {
|
|
11727
|
+
readonly anyOf: readonly [{
|
|
11728
|
+
readonly type: "string";
|
|
11729
|
+
}, {
|
|
11730
|
+
readonly type: "null";
|
|
11731
|
+
}];
|
|
11732
|
+
};
|
|
11733
|
+
readonly organization: {
|
|
11734
|
+
readonly type: "object";
|
|
11735
|
+
readonly properties: {
|
|
11736
|
+
readonly id: {
|
|
11737
|
+
readonly type: "string";
|
|
11738
|
+
};
|
|
11739
|
+
readonly name: {
|
|
11740
|
+
readonly anyOf: readonly [{
|
|
11741
|
+
readonly type: "string";
|
|
11742
|
+
}, {
|
|
11743
|
+
readonly type: "null";
|
|
11744
|
+
}];
|
|
11745
|
+
};
|
|
11746
|
+
readonly slug: {
|
|
11747
|
+
readonly anyOf: readonly [{
|
|
11748
|
+
readonly type: "string";
|
|
11749
|
+
}, {
|
|
11750
|
+
readonly type: "null";
|
|
11751
|
+
}];
|
|
11752
|
+
};
|
|
11753
|
+
};
|
|
11754
|
+
readonly required: readonly ["id", "name", "slug"];
|
|
11755
|
+
readonly additionalProperties: false;
|
|
11756
|
+
};
|
|
11757
|
+
readonly createdBy: {
|
|
11758
|
+
readonly anyOf: readonly [{
|
|
11759
|
+
readonly type: "object";
|
|
11760
|
+
readonly properties: {
|
|
11761
|
+
readonly id: {
|
|
11762
|
+
readonly type: "string";
|
|
11763
|
+
};
|
|
11764
|
+
readonly email: {
|
|
11765
|
+
readonly type: "string";
|
|
11766
|
+
};
|
|
11767
|
+
readonly name: {
|
|
11768
|
+
readonly anyOf: readonly [{
|
|
11769
|
+
readonly type: "string";
|
|
11770
|
+
}, {
|
|
11771
|
+
readonly type: "null";
|
|
11772
|
+
}];
|
|
11773
|
+
};
|
|
11774
|
+
};
|
|
11775
|
+
readonly required: readonly ["id", "email", "name"];
|
|
11776
|
+
readonly additionalProperties: false;
|
|
11777
|
+
}, {
|
|
11778
|
+
readonly type: "null";
|
|
11779
|
+
}];
|
|
11780
|
+
};
|
|
11781
|
+
readonly apiKey: {
|
|
11782
|
+
readonly type: "object";
|
|
11783
|
+
readonly properties: {
|
|
11784
|
+
readonly id: {
|
|
11785
|
+
readonly type: "string";
|
|
11786
|
+
};
|
|
11787
|
+
readonly name: {
|
|
11788
|
+
readonly type: "string";
|
|
11789
|
+
};
|
|
11790
|
+
readonly prefix: {
|
|
11791
|
+
readonly type: "string";
|
|
11792
|
+
};
|
|
11793
|
+
readonly keyType: {
|
|
11794
|
+
readonly type: "string";
|
|
11795
|
+
readonly enum: readonly ["api", "cli", "mcp", "ci"];
|
|
11796
|
+
};
|
|
11797
|
+
readonly grants: {
|
|
11798
|
+
readonly type: "array";
|
|
11799
|
+
readonly items: {
|
|
11800
|
+
readonly type: "string";
|
|
11801
|
+
readonly enum: readonly ["customer_intelligence:read", "workspace_members:read", "analytics:read", "destinations:manage", "behavior_metrics:manage", "integrations:connect_own", "integrations:manage", "activation:read", "activation:manage", "workspace_settings:read", "workspace_settings:manage", "customer_access:manage", "customer_identity:review", "customer_identity:merge"];
|
|
11802
|
+
};
|
|
11803
|
+
};
|
|
11804
|
+
readonly createdAt: {
|
|
11805
|
+
readonly type: "string";
|
|
11806
|
+
readonly format: "date-time";
|
|
11807
|
+
readonly 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))$";
|
|
11808
|
+
};
|
|
11809
|
+
readonly lastUsedAt: {
|
|
11810
|
+
readonly anyOf: readonly [{
|
|
11811
|
+
readonly type: "string";
|
|
11812
|
+
readonly format: "date-time";
|
|
11813
|
+
readonly 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))$";
|
|
11814
|
+
}, {
|
|
11815
|
+
readonly type: "null";
|
|
11816
|
+
}];
|
|
11817
|
+
};
|
|
11818
|
+
readonly totalRequests: {
|
|
11819
|
+
readonly type: "integer";
|
|
11820
|
+
readonly minimum: 0;
|
|
11821
|
+
readonly maximum: 9007199254740991;
|
|
11822
|
+
};
|
|
11823
|
+
readonly expiresAt: {
|
|
11824
|
+
readonly anyOf: readonly [{
|
|
11825
|
+
readonly type: "string";
|
|
11826
|
+
readonly format: "date-time";
|
|
11827
|
+
readonly 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))$";
|
|
11828
|
+
}, {
|
|
11829
|
+
readonly type: "null";
|
|
11830
|
+
}];
|
|
11831
|
+
};
|
|
11832
|
+
};
|
|
11833
|
+
readonly required: readonly ["id", "name", "prefix", "keyType", "grants", "createdAt", "lastUsedAt", "totalRequests", "expiresAt"];
|
|
11834
|
+
readonly additionalProperties: false;
|
|
11835
|
+
};
|
|
11836
|
+
readonly authorization: {
|
|
11837
|
+
readonly type: "object";
|
|
11838
|
+
readonly properties: {
|
|
11839
|
+
readonly grants: {
|
|
11840
|
+
readonly type: "array";
|
|
11841
|
+
readonly items: {
|
|
11842
|
+
readonly type: "string";
|
|
11843
|
+
readonly enum: readonly ["customer_intelligence:read", "workspace_members:read", "analytics:read", "destinations:manage", "behavior_metrics:manage", "integrations:connect_own", "integrations:manage", "activation:read", "activation:manage", "workspace_settings:read", "workspace_settings:manage", "customer_access:manage", "customer_identity:review", "customer_identity:merge"];
|
|
11844
|
+
};
|
|
11845
|
+
};
|
|
11846
|
+
};
|
|
11847
|
+
readonly required: readonly ["grants"];
|
|
11848
|
+
readonly additionalProperties: false;
|
|
11849
|
+
};
|
|
11850
|
+
};
|
|
11851
|
+
readonly required: readonly ["valid", "organizationId", "createdById", "authorization"];
|
|
11852
|
+
readonly additionalProperties: false;
|
|
11853
|
+
};
|
|
11714
11854
|
declare const toolGatewayErrorCodes: readonly ["INVALID_JSON", "INVALID_TOOL_CALL", "INVALID_TOOL_INPUT", "INVALID_CREDENTIALS", "TOOL_CALL_FORBIDDEN", "TOOL_BINDING_MISSING", "TOOL_IMPLEMENTATION_ERROR", "TOOL_OUTPUT_INVALID", "TOOL_RESOURCE_NOT_FOUND", "TOOL_RESULT_TOO_LARGE", "TOOL_GATEWAY_ERROR", "plan_api_limit_exceeded", "plan_billing_action_required"];
|
|
11715
11855
|
declare const toolGatewayErrorSchema: {
|
|
11716
11856
|
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
@@ -12479,7 +12619,7 @@ declare const userJourneyStages: readonly ["DISCOVERED", "SIGNED_UP", "ACTIVATED
|
|
|
12479
12619
|
declare const userListOrderFields: readonly ["last_activity_at", "first_seen_at", "email"];
|
|
12480
12620
|
declare const workspaceUserListOrderFields: readonly ["name", "email", "owned_customer_count"];
|
|
12481
12621
|
declare const schemaTables: readonly ["activity", "customers", "users", "revenue"];
|
|
12482
|
-
declare const sdkConsumerContractHash: "
|
|
12622
|
+
declare const sdkConsumerContractHash: "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
|
|
12483
12623
|
|
|
12484
12624
|
type JsonSchema = Readonly<Record<string, unknown>>;
|
|
12485
12625
|
type PublicToolName = (typeof publicToolNames)[number];
|
|
@@ -12553,6 +12693,8 @@ type JsonSchemaValue<TSchema> = TSchema extends {
|
|
|
12553
12693
|
} ? null : unknown;
|
|
12554
12694
|
type PublicToolResult<TToolName extends PublicToolName> = JsonSchemaValue<(typeof publicToolContracts)[TToolName]["outputSchema"]>;
|
|
12555
12695
|
type ApiKeyValidationSuccess = JsonSchemaValue<typeof apiKeyValidationSuccessSchema>;
|
|
12696
|
+
/** v2 adds `apiKey.expiresAt`; returned only to requests that send `apiKeyContractHeader: 2`. */
|
|
12697
|
+
type ApiKeyValidationSuccessV2 = JsonSchemaValue<typeof apiKeyValidationSuccessSchemaV2>;
|
|
12556
12698
|
type ApiKeyValidationFailure = JsonSchemaValue<typeof apiKeyValidationFailureSchema>;
|
|
12557
12699
|
type CustomerListResult = PublicToolResult<"outlit_list_customers">;
|
|
12558
12700
|
type CustomerListItem = CustomerListResult["items"][number];
|
|
@@ -12639,4 +12781,4 @@ type CliToolName = (typeof cliToolNames)[number];
|
|
|
12639
12781
|
type PiToolName = (typeof piToolNames)[number];
|
|
12640
12782
|
declare const sqlToolNames: ("outlit_list_customers" | "outlit_list_users" | "outlit_get_customer" | "outlit_get_timeline" | "outlit_list_facts" | "outlit_get_fact" | "outlit_get_source" | "outlit_list_sources" | "outlit_search_customer_context" | "outlit_query" | "outlit_schema")[];
|
|
12641
12783
|
|
|
12642
|
-
export { type ApiKeyValidationFailure, type ApiKeyValidationSuccess, type AttentionItem, type AttentionItemResult, type AttentionItemSummary, type AttentionListResult, type CliToolName, type CustomerAnalyticsRow, type CustomerContextSearchInput, type CustomerCredit, type CustomerCreditsResult, type CustomerDetail, type CustomerDetailResult, type CustomerFeature, type CustomerFeaturesResult, type CustomerListItem, type CustomerListResult, type CustomerRelationship, type CustomerRelationshipResult, type CustomerSourceType, type CustomerSourceTypeInput, DEFAULT_OUTLIT_API_URL, type Feature, type FeatureArchiveResult, type FeatureCreateResult, type FeatureDefinition, type FeatureListResult, type FeatureRef, type FeedbackSubmitResult, type JsonSchema, type JsonSchemaValue, OutlitToolsApiError, type OutlitToolsClient, type OutlitToolsClientOptions, type OutlitToolsFetch, type PiToolName, type PublicToolContract, type PublicToolName, type PublicToolResult, type RuntimeJsonSchema, type SearchArgsLike, type ToolGatewayErrorCode, type ToolGatewayErrorEnvelope, allPublicToolNames, analyticalToolNames, apiKeyGrants, apiKeyValidationFailureSchema, apiKeyValidationSuccessSchema, apiKeyValidationTransport, cliToolNames, consumerToolPolicies, contractVersion, createOutlitClient, customerActivityWindows, customerBillingStatuses, customerFactCategories, customerFactIncludes, customerFactStatuses, customerFactTypes, customerIncludeSections, customerListOrderFields, customerSourceTypeAliasMap, customerSourceTypeAliases, customerSourceTypeInputs, customerSourceTypes, customerTimeframes, defaultToolNames, getPublicToolContract, ingestTransport, isOutlitToolsApiError, isPublicToolName, matchesGeneratedJsonSchema, normalizeCustomerSourceType, piToolNames, publicOpenApiTransports, publicToolContracts, publicToolNames, resolveCustomerContextSearchInput, schemaTables, sdkConsumerContractHash, sqlToolNames, timelineChannels, timelineTimeframes, toolGatewayErrorCodes, toolGatewayErrorSchema, toolGatewayTransport, unsupportedCustomerFactTypes, userJourneyStages, userListOrderFields, workspaceUserListOrderFields };
|
|
12784
|
+
export { type ApiKeyValidationFailure, type ApiKeyValidationSuccess, type ApiKeyValidationSuccessV2, type AttentionItem, type AttentionItemResult, type AttentionItemSummary, type AttentionListResult, type CliToolName, type CustomerAnalyticsRow, type CustomerContextSearchInput, type CustomerCredit, type CustomerCreditsResult, type CustomerDetail, type CustomerDetailResult, type CustomerFeature, type CustomerFeaturesResult, type CustomerListItem, type CustomerListResult, type CustomerRelationship, type CustomerRelationshipResult, type CustomerSourceType, type CustomerSourceTypeInput, DEFAULT_OUTLIT_API_URL, type Feature, type FeatureArchiveResult, type FeatureCreateResult, type FeatureDefinition, type FeatureListResult, type FeatureRef, type FeedbackSubmitResult, type JsonSchema, type JsonSchemaValue, OutlitToolsApiError, type OutlitToolsClient, type OutlitToolsClientOptions, type OutlitToolsFetch, type PiToolName, type PublicToolContract, type PublicToolName, type PublicToolResult, type RuntimeJsonSchema, type SearchArgsLike, type ToolGatewayErrorCode, type ToolGatewayErrorEnvelope, allPublicToolNames, analyticalToolNames, apiKeyContractHeader, apiKeyGrants, apiKeyValidationFailureSchema, apiKeyValidationSuccessSchema, apiKeyValidationSuccessSchemaV2, apiKeyValidationTransport, cliToolNames, consumerToolPolicies, contractVersion, createOutlitClient, customerActivityWindows, customerBillingStatuses, customerFactCategories, customerFactIncludes, customerFactStatuses, customerFactTypes, customerIncludeSections, customerListOrderFields, customerSourceTypeAliasMap, customerSourceTypeAliases, customerSourceTypeInputs, customerSourceTypes, customerTimeframes, defaultToolNames, getPublicToolContract, ingestTransport, isOutlitToolsApiError, isPublicToolName, matchesGeneratedJsonSchema, normalizeCustomerSourceType, piToolNames, publicOpenApiTransports, publicToolContracts, publicToolNames, resolveCustomerContextSearchInput, schemaTables, sdkConsumerContractHash, sqlToolNames, timelineChannels, timelineTimeframes, toolGatewayErrorCodes, toolGatewayErrorSchema, toolGatewayTransport, unsupportedCustomerFactTypes, userJourneyStages, userListOrderFields, workspaceUserListOrderFields };
|
package/dist/index.d.ts
CHANGED
|
@@ -11711,6 +11711,146 @@ declare const apiKeyValidationFailureSchema: {
|
|
|
11711
11711
|
readonly required: readonly ["valid", "error"];
|
|
11712
11712
|
readonly additionalProperties: false;
|
|
11713
11713
|
};
|
|
11714
|
+
declare const apiKeyContractHeader: "Outlit-Api-Key-Contract";
|
|
11715
|
+
declare const apiKeyValidationSuccessSchemaV2: {
|
|
11716
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
11717
|
+
readonly type: "object";
|
|
11718
|
+
readonly properties: {
|
|
11719
|
+
readonly valid: {
|
|
11720
|
+
readonly type: "boolean";
|
|
11721
|
+
readonly const: true;
|
|
11722
|
+
};
|
|
11723
|
+
readonly organizationId: {
|
|
11724
|
+
readonly type: "string";
|
|
11725
|
+
};
|
|
11726
|
+
readonly createdById: {
|
|
11727
|
+
readonly anyOf: readonly [{
|
|
11728
|
+
readonly type: "string";
|
|
11729
|
+
}, {
|
|
11730
|
+
readonly type: "null";
|
|
11731
|
+
}];
|
|
11732
|
+
};
|
|
11733
|
+
readonly organization: {
|
|
11734
|
+
readonly type: "object";
|
|
11735
|
+
readonly properties: {
|
|
11736
|
+
readonly id: {
|
|
11737
|
+
readonly type: "string";
|
|
11738
|
+
};
|
|
11739
|
+
readonly name: {
|
|
11740
|
+
readonly anyOf: readonly [{
|
|
11741
|
+
readonly type: "string";
|
|
11742
|
+
}, {
|
|
11743
|
+
readonly type: "null";
|
|
11744
|
+
}];
|
|
11745
|
+
};
|
|
11746
|
+
readonly slug: {
|
|
11747
|
+
readonly anyOf: readonly [{
|
|
11748
|
+
readonly type: "string";
|
|
11749
|
+
}, {
|
|
11750
|
+
readonly type: "null";
|
|
11751
|
+
}];
|
|
11752
|
+
};
|
|
11753
|
+
};
|
|
11754
|
+
readonly required: readonly ["id", "name", "slug"];
|
|
11755
|
+
readonly additionalProperties: false;
|
|
11756
|
+
};
|
|
11757
|
+
readonly createdBy: {
|
|
11758
|
+
readonly anyOf: readonly [{
|
|
11759
|
+
readonly type: "object";
|
|
11760
|
+
readonly properties: {
|
|
11761
|
+
readonly id: {
|
|
11762
|
+
readonly type: "string";
|
|
11763
|
+
};
|
|
11764
|
+
readonly email: {
|
|
11765
|
+
readonly type: "string";
|
|
11766
|
+
};
|
|
11767
|
+
readonly name: {
|
|
11768
|
+
readonly anyOf: readonly [{
|
|
11769
|
+
readonly type: "string";
|
|
11770
|
+
}, {
|
|
11771
|
+
readonly type: "null";
|
|
11772
|
+
}];
|
|
11773
|
+
};
|
|
11774
|
+
};
|
|
11775
|
+
readonly required: readonly ["id", "email", "name"];
|
|
11776
|
+
readonly additionalProperties: false;
|
|
11777
|
+
}, {
|
|
11778
|
+
readonly type: "null";
|
|
11779
|
+
}];
|
|
11780
|
+
};
|
|
11781
|
+
readonly apiKey: {
|
|
11782
|
+
readonly type: "object";
|
|
11783
|
+
readonly properties: {
|
|
11784
|
+
readonly id: {
|
|
11785
|
+
readonly type: "string";
|
|
11786
|
+
};
|
|
11787
|
+
readonly name: {
|
|
11788
|
+
readonly type: "string";
|
|
11789
|
+
};
|
|
11790
|
+
readonly prefix: {
|
|
11791
|
+
readonly type: "string";
|
|
11792
|
+
};
|
|
11793
|
+
readonly keyType: {
|
|
11794
|
+
readonly type: "string";
|
|
11795
|
+
readonly enum: readonly ["api", "cli", "mcp", "ci"];
|
|
11796
|
+
};
|
|
11797
|
+
readonly grants: {
|
|
11798
|
+
readonly type: "array";
|
|
11799
|
+
readonly items: {
|
|
11800
|
+
readonly type: "string";
|
|
11801
|
+
readonly enum: readonly ["customer_intelligence:read", "workspace_members:read", "analytics:read", "destinations:manage", "behavior_metrics:manage", "integrations:connect_own", "integrations:manage", "activation:read", "activation:manage", "workspace_settings:read", "workspace_settings:manage", "customer_access:manage", "customer_identity:review", "customer_identity:merge"];
|
|
11802
|
+
};
|
|
11803
|
+
};
|
|
11804
|
+
readonly createdAt: {
|
|
11805
|
+
readonly type: "string";
|
|
11806
|
+
readonly format: "date-time";
|
|
11807
|
+
readonly 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))$";
|
|
11808
|
+
};
|
|
11809
|
+
readonly lastUsedAt: {
|
|
11810
|
+
readonly anyOf: readonly [{
|
|
11811
|
+
readonly type: "string";
|
|
11812
|
+
readonly format: "date-time";
|
|
11813
|
+
readonly 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))$";
|
|
11814
|
+
}, {
|
|
11815
|
+
readonly type: "null";
|
|
11816
|
+
}];
|
|
11817
|
+
};
|
|
11818
|
+
readonly totalRequests: {
|
|
11819
|
+
readonly type: "integer";
|
|
11820
|
+
readonly minimum: 0;
|
|
11821
|
+
readonly maximum: 9007199254740991;
|
|
11822
|
+
};
|
|
11823
|
+
readonly expiresAt: {
|
|
11824
|
+
readonly anyOf: readonly [{
|
|
11825
|
+
readonly type: "string";
|
|
11826
|
+
readonly format: "date-time";
|
|
11827
|
+
readonly 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))$";
|
|
11828
|
+
}, {
|
|
11829
|
+
readonly type: "null";
|
|
11830
|
+
}];
|
|
11831
|
+
};
|
|
11832
|
+
};
|
|
11833
|
+
readonly required: readonly ["id", "name", "prefix", "keyType", "grants", "createdAt", "lastUsedAt", "totalRequests", "expiresAt"];
|
|
11834
|
+
readonly additionalProperties: false;
|
|
11835
|
+
};
|
|
11836
|
+
readonly authorization: {
|
|
11837
|
+
readonly type: "object";
|
|
11838
|
+
readonly properties: {
|
|
11839
|
+
readonly grants: {
|
|
11840
|
+
readonly type: "array";
|
|
11841
|
+
readonly items: {
|
|
11842
|
+
readonly type: "string";
|
|
11843
|
+
readonly enum: readonly ["customer_intelligence:read", "workspace_members:read", "analytics:read", "destinations:manage", "behavior_metrics:manage", "integrations:connect_own", "integrations:manage", "activation:read", "activation:manage", "workspace_settings:read", "workspace_settings:manage", "customer_access:manage", "customer_identity:review", "customer_identity:merge"];
|
|
11844
|
+
};
|
|
11845
|
+
};
|
|
11846
|
+
};
|
|
11847
|
+
readonly required: readonly ["grants"];
|
|
11848
|
+
readonly additionalProperties: false;
|
|
11849
|
+
};
|
|
11850
|
+
};
|
|
11851
|
+
readonly required: readonly ["valid", "organizationId", "createdById", "authorization"];
|
|
11852
|
+
readonly additionalProperties: false;
|
|
11853
|
+
};
|
|
11714
11854
|
declare const toolGatewayErrorCodes: readonly ["INVALID_JSON", "INVALID_TOOL_CALL", "INVALID_TOOL_INPUT", "INVALID_CREDENTIALS", "TOOL_CALL_FORBIDDEN", "TOOL_BINDING_MISSING", "TOOL_IMPLEMENTATION_ERROR", "TOOL_OUTPUT_INVALID", "TOOL_RESOURCE_NOT_FOUND", "TOOL_RESULT_TOO_LARGE", "TOOL_GATEWAY_ERROR", "plan_api_limit_exceeded", "plan_billing_action_required"];
|
|
11715
11855
|
declare const toolGatewayErrorSchema: {
|
|
11716
11856
|
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
@@ -12479,7 +12619,7 @@ declare const userJourneyStages: readonly ["DISCOVERED", "SIGNED_UP", "ACTIVATED
|
|
|
12479
12619
|
declare const userListOrderFields: readonly ["last_activity_at", "first_seen_at", "email"];
|
|
12480
12620
|
declare const workspaceUserListOrderFields: readonly ["name", "email", "owned_customer_count"];
|
|
12481
12621
|
declare const schemaTables: readonly ["activity", "customers", "users", "revenue"];
|
|
12482
|
-
declare const sdkConsumerContractHash: "
|
|
12622
|
+
declare const sdkConsumerContractHash: "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
|
|
12483
12623
|
|
|
12484
12624
|
type JsonSchema = Readonly<Record<string, unknown>>;
|
|
12485
12625
|
type PublicToolName = (typeof publicToolNames)[number];
|
|
@@ -12553,6 +12693,8 @@ type JsonSchemaValue<TSchema> = TSchema extends {
|
|
|
12553
12693
|
} ? null : unknown;
|
|
12554
12694
|
type PublicToolResult<TToolName extends PublicToolName> = JsonSchemaValue<(typeof publicToolContracts)[TToolName]["outputSchema"]>;
|
|
12555
12695
|
type ApiKeyValidationSuccess = JsonSchemaValue<typeof apiKeyValidationSuccessSchema>;
|
|
12696
|
+
/** v2 adds `apiKey.expiresAt`; returned only to requests that send `apiKeyContractHeader: 2`. */
|
|
12697
|
+
type ApiKeyValidationSuccessV2 = JsonSchemaValue<typeof apiKeyValidationSuccessSchemaV2>;
|
|
12556
12698
|
type ApiKeyValidationFailure = JsonSchemaValue<typeof apiKeyValidationFailureSchema>;
|
|
12557
12699
|
type CustomerListResult = PublicToolResult<"outlit_list_customers">;
|
|
12558
12700
|
type CustomerListItem = CustomerListResult["items"][number];
|
|
@@ -12639,4 +12781,4 @@ type CliToolName = (typeof cliToolNames)[number];
|
|
|
12639
12781
|
type PiToolName = (typeof piToolNames)[number];
|
|
12640
12782
|
declare const sqlToolNames: ("outlit_list_customers" | "outlit_list_users" | "outlit_get_customer" | "outlit_get_timeline" | "outlit_list_facts" | "outlit_get_fact" | "outlit_get_source" | "outlit_list_sources" | "outlit_search_customer_context" | "outlit_query" | "outlit_schema")[];
|
|
12641
12783
|
|
|
12642
|
-
export { type ApiKeyValidationFailure, type ApiKeyValidationSuccess, type AttentionItem, type AttentionItemResult, type AttentionItemSummary, type AttentionListResult, type CliToolName, type CustomerAnalyticsRow, type CustomerContextSearchInput, type CustomerCredit, type CustomerCreditsResult, type CustomerDetail, type CustomerDetailResult, type CustomerFeature, type CustomerFeaturesResult, type CustomerListItem, type CustomerListResult, type CustomerRelationship, type CustomerRelationshipResult, type CustomerSourceType, type CustomerSourceTypeInput, DEFAULT_OUTLIT_API_URL, type Feature, type FeatureArchiveResult, type FeatureCreateResult, type FeatureDefinition, type FeatureListResult, type FeatureRef, type FeedbackSubmitResult, type JsonSchema, type JsonSchemaValue, OutlitToolsApiError, type OutlitToolsClient, type OutlitToolsClientOptions, type OutlitToolsFetch, type PiToolName, type PublicToolContract, type PublicToolName, type PublicToolResult, type RuntimeJsonSchema, type SearchArgsLike, type ToolGatewayErrorCode, type ToolGatewayErrorEnvelope, allPublicToolNames, analyticalToolNames, apiKeyGrants, apiKeyValidationFailureSchema, apiKeyValidationSuccessSchema, apiKeyValidationTransport, cliToolNames, consumerToolPolicies, contractVersion, createOutlitClient, customerActivityWindows, customerBillingStatuses, customerFactCategories, customerFactIncludes, customerFactStatuses, customerFactTypes, customerIncludeSections, customerListOrderFields, customerSourceTypeAliasMap, customerSourceTypeAliases, customerSourceTypeInputs, customerSourceTypes, customerTimeframes, defaultToolNames, getPublicToolContract, ingestTransport, isOutlitToolsApiError, isPublicToolName, matchesGeneratedJsonSchema, normalizeCustomerSourceType, piToolNames, publicOpenApiTransports, publicToolContracts, publicToolNames, resolveCustomerContextSearchInput, schemaTables, sdkConsumerContractHash, sqlToolNames, timelineChannels, timelineTimeframes, toolGatewayErrorCodes, toolGatewayErrorSchema, toolGatewayTransport, unsupportedCustomerFactTypes, userJourneyStages, userListOrderFields, workspaceUserListOrderFields };
|
|
12784
|
+
export { type ApiKeyValidationFailure, type ApiKeyValidationSuccess, type ApiKeyValidationSuccessV2, type AttentionItem, type AttentionItemResult, type AttentionItemSummary, type AttentionListResult, type CliToolName, type CustomerAnalyticsRow, type CustomerContextSearchInput, type CustomerCredit, type CustomerCreditsResult, type CustomerDetail, type CustomerDetailResult, type CustomerFeature, type CustomerFeaturesResult, type CustomerListItem, type CustomerListResult, type CustomerRelationship, type CustomerRelationshipResult, type CustomerSourceType, type CustomerSourceTypeInput, DEFAULT_OUTLIT_API_URL, type Feature, type FeatureArchiveResult, type FeatureCreateResult, type FeatureDefinition, type FeatureListResult, type FeatureRef, type FeedbackSubmitResult, type JsonSchema, type JsonSchemaValue, OutlitToolsApiError, type OutlitToolsClient, type OutlitToolsClientOptions, type OutlitToolsFetch, type PiToolName, type PublicToolContract, type PublicToolName, type PublicToolResult, type RuntimeJsonSchema, type SearchArgsLike, type ToolGatewayErrorCode, type ToolGatewayErrorEnvelope, allPublicToolNames, analyticalToolNames, apiKeyContractHeader, apiKeyGrants, apiKeyValidationFailureSchema, apiKeyValidationSuccessSchema, apiKeyValidationSuccessSchemaV2, apiKeyValidationTransport, cliToolNames, consumerToolPolicies, contractVersion, createOutlitClient, customerActivityWindows, customerBillingStatuses, customerFactCategories, customerFactIncludes, customerFactStatuses, customerFactTypes, customerIncludeSections, customerListOrderFields, customerSourceTypeAliasMap, customerSourceTypeAliases, customerSourceTypeInputs, customerSourceTypes, customerTimeframes, defaultToolNames, getPublicToolContract, ingestTransport, isOutlitToolsApiError, isPublicToolName, matchesGeneratedJsonSchema, normalizeCustomerSourceType, piToolNames, publicOpenApiTransports, publicToolContracts, publicToolNames, resolveCustomerContextSearchInput, schemaTables, sdkConsumerContractHash, sqlToolNames, timelineChannels, timelineTimeframes, toolGatewayErrorCodes, toolGatewayErrorSchema, toolGatewayTransport, unsupportedCustomerFactTypes, userJourneyStages, userListOrderFields, workspaceUserListOrderFields };
|
package/dist/index.js
CHANGED
|
@@ -16054,6 +16054,227 @@ var apiKeyValidationFailureSchema = {
|
|
|
16054
16054
|
],
|
|
16055
16055
|
"additionalProperties": false
|
|
16056
16056
|
};
|
|
16057
|
+
var apiKeyContractHeader = "Outlit-Api-Key-Contract";
|
|
16058
|
+
var apiKeyValidationSuccessSchemaV2 = {
|
|
16059
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
16060
|
+
"type": "object",
|
|
16061
|
+
"properties": {
|
|
16062
|
+
"valid": {
|
|
16063
|
+
"type": "boolean",
|
|
16064
|
+
"const": true
|
|
16065
|
+
},
|
|
16066
|
+
"organizationId": {
|
|
16067
|
+
"type": "string"
|
|
16068
|
+
},
|
|
16069
|
+
"createdById": {
|
|
16070
|
+
"anyOf": [
|
|
16071
|
+
{
|
|
16072
|
+
"type": "string"
|
|
16073
|
+
},
|
|
16074
|
+
{
|
|
16075
|
+
"type": "null"
|
|
16076
|
+
}
|
|
16077
|
+
]
|
|
16078
|
+
},
|
|
16079
|
+
"organization": {
|
|
16080
|
+
"type": "object",
|
|
16081
|
+
"properties": {
|
|
16082
|
+
"id": {
|
|
16083
|
+
"type": "string"
|
|
16084
|
+
},
|
|
16085
|
+
"name": {
|
|
16086
|
+
"anyOf": [
|
|
16087
|
+
{
|
|
16088
|
+
"type": "string"
|
|
16089
|
+
},
|
|
16090
|
+
{
|
|
16091
|
+
"type": "null"
|
|
16092
|
+
}
|
|
16093
|
+
]
|
|
16094
|
+
},
|
|
16095
|
+
"slug": {
|
|
16096
|
+
"anyOf": [
|
|
16097
|
+
{
|
|
16098
|
+
"type": "string"
|
|
16099
|
+
},
|
|
16100
|
+
{
|
|
16101
|
+
"type": "null"
|
|
16102
|
+
}
|
|
16103
|
+
]
|
|
16104
|
+
}
|
|
16105
|
+
},
|
|
16106
|
+
"required": [
|
|
16107
|
+
"id",
|
|
16108
|
+
"name",
|
|
16109
|
+
"slug"
|
|
16110
|
+
],
|
|
16111
|
+
"additionalProperties": false
|
|
16112
|
+
},
|
|
16113
|
+
"createdBy": {
|
|
16114
|
+
"anyOf": [
|
|
16115
|
+
{
|
|
16116
|
+
"type": "object",
|
|
16117
|
+
"properties": {
|
|
16118
|
+
"id": {
|
|
16119
|
+
"type": "string"
|
|
16120
|
+
},
|
|
16121
|
+
"email": {
|
|
16122
|
+
"type": "string"
|
|
16123
|
+
},
|
|
16124
|
+
"name": {
|
|
16125
|
+
"anyOf": [
|
|
16126
|
+
{
|
|
16127
|
+
"type": "string"
|
|
16128
|
+
},
|
|
16129
|
+
{
|
|
16130
|
+
"type": "null"
|
|
16131
|
+
}
|
|
16132
|
+
]
|
|
16133
|
+
}
|
|
16134
|
+
},
|
|
16135
|
+
"required": [
|
|
16136
|
+
"id",
|
|
16137
|
+
"email",
|
|
16138
|
+
"name"
|
|
16139
|
+
],
|
|
16140
|
+
"additionalProperties": false
|
|
16141
|
+
},
|
|
16142
|
+
{
|
|
16143
|
+
"type": "null"
|
|
16144
|
+
}
|
|
16145
|
+
]
|
|
16146
|
+
},
|
|
16147
|
+
"apiKey": {
|
|
16148
|
+
"type": "object",
|
|
16149
|
+
"properties": {
|
|
16150
|
+
"id": {
|
|
16151
|
+
"type": "string"
|
|
16152
|
+
},
|
|
16153
|
+
"name": {
|
|
16154
|
+
"type": "string"
|
|
16155
|
+
},
|
|
16156
|
+
"prefix": {
|
|
16157
|
+
"type": "string"
|
|
16158
|
+
},
|
|
16159
|
+
"keyType": {
|
|
16160
|
+
"type": "string",
|
|
16161
|
+
"enum": [
|
|
16162
|
+
"api",
|
|
16163
|
+
"cli",
|
|
16164
|
+
"mcp",
|
|
16165
|
+
"ci"
|
|
16166
|
+
]
|
|
16167
|
+
},
|
|
16168
|
+
"grants": {
|
|
16169
|
+
"type": "array",
|
|
16170
|
+
"items": {
|
|
16171
|
+
"type": "string",
|
|
16172
|
+
"enum": [
|
|
16173
|
+
"customer_intelligence:read",
|
|
16174
|
+
"workspace_members:read",
|
|
16175
|
+
"analytics:read",
|
|
16176
|
+
"destinations:manage",
|
|
16177
|
+
"behavior_metrics:manage",
|
|
16178
|
+
"integrations:connect_own",
|
|
16179
|
+
"integrations:manage",
|
|
16180
|
+
"activation:read",
|
|
16181
|
+
"activation:manage",
|
|
16182
|
+
"workspace_settings:read",
|
|
16183
|
+
"workspace_settings:manage",
|
|
16184
|
+
"customer_access:manage",
|
|
16185
|
+
"customer_identity:review",
|
|
16186
|
+
"customer_identity:merge"
|
|
16187
|
+
]
|
|
16188
|
+
}
|
|
16189
|
+
},
|
|
16190
|
+
"createdAt": {
|
|
16191
|
+
"type": "string",
|
|
16192
|
+
"format": "date-time",
|
|
16193
|
+
"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))$"
|
|
16194
|
+
},
|
|
16195
|
+
"lastUsedAt": {
|
|
16196
|
+
"anyOf": [
|
|
16197
|
+
{
|
|
16198
|
+
"type": "string",
|
|
16199
|
+
"format": "date-time",
|
|
16200
|
+
"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))$"
|
|
16201
|
+
},
|
|
16202
|
+
{
|
|
16203
|
+
"type": "null"
|
|
16204
|
+
}
|
|
16205
|
+
]
|
|
16206
|
+
},
|
|
16207
|
+
"totalRequests": {
|
|
16208
|
+
"type": "integer",
|
|
16209
|
+
"minimum": 0,
|
|
16210
|
+
"maximum": 9007199254740991
|
|
16211
|
+
},
|
|
16212
|
+
"expiresAt": {
|
|
16213
|
+
"anyOf": [
|
|
16214
|
+
{
|
|
16215
|
+
"type": "string",
|
|
16216
|
+
"format": "date-time",
|
|
16217
|
+
"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))$"
|
|
16218
|
+
},
|
|
16219
|
+
{
|
|
16220
|
+
"type": "null"
|
|
16221
|
+
}
|
|
16222
|
+
]
|
|
16223
|
+
}
|
|
16224
|
+
},
|
|
16225
|
+
"required": [
|
|
16226
|
+
"id",
|
|
16227
|
+
"name",
|
|
16228
|
+
"prefix",
|
|
16229
|
+
"keyType",
|
|
16230
|
+
"grants",
|
|
16231
|
+
"createdAt",
|
|
16232
|
+
"lastUsedAt",
|
|
16233
|
+
"totalRequests",
|
|
16234
|
+
"expiresAt"
|
|
16235
|
+
],
|
|
16236
|
+
"additionalProperties": false
|
|
16237
|
+
},
|
|
16238
|
+
"authorization": {
|
|
16239
|
+
"type": "object",
|
|
16240
|
+
"properties": {
|
|
16241
|
+
"grants": {
|
|
16242
|
+
"type": "array",
|
|
16243
|
+
"items": {
|
|
16244
|
+
"type": "string",
|
|
16245
|
+
"enum": [
|
|
16246
|
+
"customer_intelligence:read",
|
|
16247
|
+
"workspace_members:read",
|
|
16248
|
+
"analytics:read",
|
|
16249
|
+
"destinations:manage",
|
|
16250
|
+
"behavior_metrics:manage",
|
|
16251
|
+
"integrations:connect_own",
|
|
16252
|
+
"integrations:manage",
|
|
16253
|
+
"activation:read",
|
|
16254
|
+
"activation:manage",
|
|
16255
|
+
"workspace_settings:read",
|
|
16256
|
+
"workspace_settings:manage",
|
|
16257
|
+
"customer_access:manage",
|
|
16258
|
+
"customer_identity:review",
|
|
16259
|
+
"customer_identity:merge"
|
|
16260
|
+
]
|
|
16261
|
+
}
|
|
16262
|
+
}
|
|
16263
|
+
},
|
|
16264
|
+
"required": [
|
|
16265
|
+
"grants"
|
|
16266
|
+
],
|
|
16267
|
+
"additionalProperties": false
|
|
16268
|
+
}
|
|
16269
|
+
},
|
|
16270
|
+
"required": [
|
|
16271
|
+
"valid",
|
|
16272
|
+
"organizationId",
|
|
16273
|
+
"createdById",
|
|
16274
|
+
"authorization"
|
|
16275
|
+
],
|
|
16276
|
+
"additionalProperties": false
|
|
16277
|
+
};
|
|
16057
16278
|
var toolGatewayErrorCodes = [
|
|
16058
16279
|
"INVALID_JSON",
|
|
16059
16280
|
"INVALID_TOOL_CALL",
|
|
@@ -17101,7 +17322,7 @@ var schemaTables = [
|
|
|
17101
17322
|
"users",
|
|
17102
17323
|
"revenue"
|
|
17103
17324
|
];
|
|
17104
|
-
var sdkConsumerContractHash = "
|
|
17325
|
+
var sdkConsumerContractHash = "0bb35218a281339fd1668fe7e7b22eadde7abddc9dfd957d3d72aa8db0a1365a";
|
|
17105
17326
|
|
|
17106
17327
|
// src/contracts.ts
|
|
17107
17328
|
var publicToolNameSet = new Set(publicToolNames);
|
|
@@ -17307,9 +17528,11 @@ export {
|
|
|
17307
17528
|
OutlitToolsApiError,
|
|
17308
17529
|
allPublicToolNames,
|
|
17309
17530
|
analyticalToolNames,
|
|
17531
|
+
apiKeyContractHeader,
|
|
17310
17532
|
apiKeyGrants,
|
|
17311
17533
|
apiKeyValidationFailureSchema,
|
|
17312
17534
|
apiKeyValidationSuccessSchema,
|
|
17535
|
+
apiKeyValidationSuccessSchemaV2,
|
|
17313
17536
|
apiKeyValidationTransport,
|
|
17314
17537
|
cliToolNames,
|
|
17315
17538
|
consumerToolPolicies,
|