tako-sdk 1.0.7 → 1.0.8
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 +4 -8
- package/dist/index.d.cts +14 -21
- package/dist/index.d.ts +14 -21
- package/dist/index.js +4 -8
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -1898,7 +1898,6 @@ function EntityClassNameToJSONTyped(value, ignoreDiscriminator) {
|
|
|
1898
1898
|
|
|
1899
1899
|
// src/generated/models/GraphNodeType.ts
|
|
1900
1900
|
var GraphNodeType = {
|
|
1901
|
-
Source: "source",
|
|
1902
1901
|
Metric: "metric",
|
|
1903
1902
|
Entity: "entity"
|
|
1904
1903
|
};
|
|
@@ -1998,7 +1997,6 @@ function RelationGroupToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1998
1997
|
|
|
1999
1998
|
// src/generated/models/RelatedGroups.ts
|
|
2000
1999
|
function instanceOfRelatedGroups(value) {
|
|
2001
|
-
if (!("sources" in value) || value["sources"] === void 0) return false;
|
|
2002
2000
|
if (!("metrics" in value) || value["metrics"] === void 0) return false;
|
|
2003
2001
|
if (!("entities" in value) || value["entities"] === void 0) return false;
|
|
2004
2002
|
return true;
|
|
@@ -2011,7 +2009,6 @@ function RelatedGroupsFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
2011
2009
|
return json;
|
|
2012
2010
|
}
|
|
2013
2011
|
return {
|
|
2014
|
-
"sources": RelationGroupFromJSON(json["sources"]),
|
|
2015
2012
|
"metrics": RelationGroupFromJSON(json["metrics"]),
|
|
2016
2013
|
"entities": RelationGroupFromJSON(json["entities"])
|
|
2017
2014
|
};
|
|
@@ -2024,7 +2021,6 @@ function RelatedGroupsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
2024
2021
|
return value;
|
|
2025
2022
|
}
|
|
2026
2023
|
return {
|
|
2027
|
-
"sources": RelationGroupToJSON(value["sources"]),
|
|
2028
2024
|
"metrics": RelationGroupToJSON(value["metrics"]),
|
|
2029
2025
|
"entities": RelationGroupToJSON(value["entities"])
|
|
2030
2026
|
};
|
|
@@ -2507,7 +2503,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2507
2503
|
};
|
|
2508
2504
|
}
|
|
2509
2505
|
/**
|
|
2510
|
-
* Explore what a node connects to: a
|
|
2506
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2511
2507
|
* Get a graph node\'s related nodes
|
|
2512
2508
|
*/
|
|
2513
2509
|
async graphRelatedRaw(requestParameters, initOverrides) {
|
|
@@ -2516,7 +2512,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2516
2512
|
return new JSONApiResponse(response, (jsonValue) => GraphRelatedResponseFromJSON(jsonValue));
|
|
2517
2513
|
}
|
|
2518
2514
|
/**
|
|
2519
|
-
* Explore what a node connects to: a
|
|
2515
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2520
2516
|
* Get a graph node\'s related nodes
|
|
2521
2517
|
*/
|
|
2522
2518
|
async graphRelated(requestParameters, initOverrides) {
|
|
@@ -2556,7 +2552,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2556
2552
|
};
|
|
2557
2553
|
}
|
|
2558
2554
|
/**
|
|
2559
|
-
* Resolve a
|
|
2555
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2560
2556
|
* Search the data graph
|
|
2561
2557
|
*/
|
|
2562
2558
|
async graphSearchRaw(requestParameters, initOverrides) {
|
|
@@ -2565,7 +2561,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2565
2561
|
return new JSONApiResponse(response, (jsonValue) => GraphSearchResponseFromJSON(jsonValue));
|
|
2566
2562
|
}
|
|
2567
2563
|
/**
|
|
2568
|
-
* Resolve a
|
|
2564
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2569
2565
|
* Search the data graph
|
|
2570
2566
|
*/
|
|
2571
2567
|
async graphSearch(requestParameters, initOverrides) {
|
package/dist/index.d.cts
CHANGED
|
@@ -1930,7 +1930,6 @@ declare function EntityClassNameToJSONTyped(value: any, ignoreDiscriminator: boo
|
|
|
1930
1930
|
* @export
|
|
1931
1931
|
*/
|
|
1932
1932
|
declare const GraphNodeType: {
|
|
1933
|
-
readonly Source: "source";
|
|
1934
1933
|
readonly Metric: "metric";
|
|
1935
1934
|
readonly Entity: "entity";
|
|
1936
1935
|
};
|
|
@@ -2063,12 +2062,6 @@ declare function RelationGroupToJSONTyped(value?: RelationGroup | null, ignoreDi
|
|
|
2063
2062
|
* @interface RelatedGroups
|
|
2064
2063
|
*/
|
|
2065
2064
|
interface RelatedGroups {
|
|
2066
|
-
/**
|
|
2067
|
-
*
|
|
2068
|
-
* @type {RelationGroup}
|
|
2069
|
-
* @memberof RelatedGroups
|
|
2070
|
-
*/
|
|
2071
|
-
sources: RelationGroup;
|
|
2072
2065
|
/**
|
|
2073
2066
|
*
|
|
2074
2067
|
* @type {RelationGroup}
|
|
@@ -2707,8 +2700,8 @@ interface TakoApiInterface {
|
|
|
2707
2700
|
createCard(requestParameters: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ThinVizCard>;
|
|
2708
2701
|
/**
|
|
2709
2702
|
* Creates request options for graphRelated without sending the request
|
|
2710
|
-
* @param {string} nodeId Opaque public id of the node
|
|
2711
|
-
* @param {string} [relationType] Paginate one facet:
|
|
2703
|
+
* @param {string} nodeId Opaque public id of the node.
|
|
2704
|
+
* @param {string} [relationType] Paginate one facet: metric or entity.
|
|
2712
2705
|
* @param {string} [q] Optional case-insensitive substring filter on the related nodes\' name/aliases. Filters every facet of the overview, or the single paginated facet when relation_type is set.
|
|
2713
2706
|
* @param {string} [cursor] Opaque pagination cursor.
|
|
2714
2707
|
* @param {number} [limit] Page size (default 50, max 100).
|
|
@@ -2717,10 +2710,10 @@ interface TakoApiInterface {
|
|
|
2717
2710
|
*/
|
|
2718
2711
|
graphRelatedRequestOpts(requestParameters: GraphRelatedRequest): Promise<RequestOpts>;
|
|
2719
2712
|
/**
|
|
2720
|
-
* Explore what a node connects to: a
|
|
2713
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2721
2714
|
* @summary Get a graph node\'s related nodes
|
|
2722
|
-
* @param {string} nodeId Opaque public id of the node
|
|
2723
|
-
* @param {string} [relationType] Paginate one facet:
|
|
2715
|
+
* @param {string} nodeId Opaque public id of the node.
|
|
2716
|
+
* @param {string} [relationType] Paginate one facet: metric or entity.
|
|
2724
2717
|
* @param {string} [q] Optional case-insensitive substring filter on the related nodes\' name/aliases. Filters every facet of the overview, or the single paginated facet when relation_type is set.
|
|
2725
2718
|
* @param {string} [cursor] Opaque pagination cursor.
|
|
2726
2719
|
* @param {number} [limit] Page size (default 50, max 100).
|
|
@@ -2730,14 +2723,14 @@ interface TakoApiInterface {
|
|
|
2730
2723
|
*/
|
|
2731
2724
|
graphRelatedRaw(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphRelatedResponse>>;
|
|
2732
2725
|
/**
|
|
2733
|
-
* Explore what a node connects to: a
|
|
2726
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2734
2727
|
* Get a graph node\'s related nodes
|
|
2735
2728
|
*/
|
|
2736
2729
|
graphRelated(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphRelatedResponse>;
|
|
2737
2730
|
/**
|
|
2738
2731
|
* Creates request options for graphSearch without sending the request
|
|
2739
2732
|
* @param {string} q Search text (min 2 chars).
|
|
2740
|
-
* @param {string} [types] Comma-separated facets:
|
|
2733
|
+
* @param {string} [types] Comma-separated facets: metric,entity.
|
|
2741
2734
|
* @param {number} [limit] Max results (default 20, max 50).
|
|
2742
2735
|
* @param {'Companies' | 'Cryptocurrencies' | 'Financial Instruments' | 'Internet Browsers' | 'Commodities' | 'People' | 'Currencies' | 'Stock Exchanges' | 'Securities' | 'IPOs' | 'Government Debt Instruments' | 'Treasury Securities' | 'Airports' | 'Airlines' | 'Vehicle Types' | 'Transportation Modes' | 'Drugs' | 'Drug Categories' | 'Diseases' | 'Chemical Elements' | 'Chemical Compounds' | 'Celestial Bodies' | 'Occupations' | 'Social Media Platforms' | 'Operating Systems' | 'Search Engines' | 'Device Types' | 'LLMs' | 'LLM Families' | 'LLM Benchmarks' | 'Industries' | 'NAICS Industries' | 'BLS Industries' | 'PSC Categories' | 'Federal Contractors' | 'Federal Agencies' | 'Federal Subagencies' | 'ICE Contracts' | 'ICE Contractors' | 'Elections' | 'Political Offices' | 'Pollsters' | 'Agricultural Products' | 'Tobacco Products' | 'Prediction Markets' | 'Prediction Events' | 'Real Estate Property Types' | 'Continents' | 'World Regions' | 'Countries' | 'States' | 'Counties' | 'Metro Areas' | 'Cities' | 'F1 Drivers' | 'F1 Teams' | 'F1 Circuits' | 'F1 Events' | 'NASCAR Drivers' | 'NASCAR Teams' | 'NASCAR Tracks' | 'NASCAR Events' | 'NASCAR Races' | 'NASCAR Owners' | 'NASCAR Manufacturers' | 'Soccer Teams' | 'Soccer Players' | 'Soccer Competitions' | 'Soccer Conferences' | 'Basketball Teams' | 'Basketball Players' | 'Basketball Conferences' | 'Basketball Divisions' | 'Baseball Teams' | 'Baseball Players' | 'Baseball Conferences' | 'Baseball Divisions' | 'Baseball Competitions' | 'Football Teams' | 'Football Players' | 'Football Conferences' | 'Football Divisions' | 'Sports' | 'Sports Leagues'} [subtype] Filter to a single entity class (e.g. Countries, Companies). Implies entity-only results; an explicit non-entity \'types\' is a 400. Note: results are drawn from a bounded candidate window (min(limit*5, 200)) before filtering, so a response shorter than `limit` does not imply no further matches exist.
|
|
2743
2736
|
* @throws {RequiredError}
|
|
@@ -2745,10 +2738,10 @@ interface TakoApiInterface {
|
|
|
2745
2738
|
*/
|
|
2746
2739
|
graphSearchRequestOpts(requestParameters: GraphSearchRequest): Promise<RequestOpts>;
|
|
2747
2740
|
/**
|
|
2748
|
-
* Resolve a
|
|
2741
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2749
2742
|
* @summary Search the data graph
|
|
2750
2743
|
* @param {string} q Search text (min 2 chars).
|
|
2751
|
-
* @param {string} [types] Comma-separated facets:
|
|
2744
|
+
* @param {string} [types] Comma-separated facets: metric,entity.
|
|
2752
2745
|
* @param {number} [limit] Max results (default 20, max 50).
|
|
2753
2746
|
* @param {'Companies' | 'Cryptocurrencies' | 'Financial Instruments' | 'Internet Browsers' | 'Commodities' | 'People' | 'Currencies' | 'Stock Exchanges' | 'Securities' | 'IPOs' | 'Government Debt Instruments' | 'Treasury Securities' | 'Airports' | 'Airlines' | 'Vehicle Types' | 'Transportation Modes' | 'Drugs' | 'Drug Categories' | 'Diseases' | 'Chemical Elements' | 'Chemical Compounds' | 'Celestial Bodies' | 'Occupations' | 'Social Media Platforms' | 'Operating Systems' | 'Search Engines' | 'Device Types' | 'LLMs' | 'LLM Families' | 'LLM Benchmarks' | 'Industries' | 'NAICS Industries' | 'BLS Industries' | 'PSC Categories' | 'Federal Contractors' | 'Federal Agencies' | 'Federal Subagencies' | 'ICE Contracts' | 'ICE Contractors' | 'Elections' | 'Political Offices' | 'Pollsters' | 'Agricultural Products' | 'Tobacco Products' | 'Prediction Markets' | 'Prediction Events' | 'Real Estate Property Types' | 'Continents' | 'World Regions' | 'Countries' | 'States' | 'Counties' | 'Metro Areas' | 'Cities' | 'F1 Drivers' | 'F1 Teams' | 'F1 Circuits' | 'F1 Events' | 'NASCAR Drivers' | 'NASCAR Teams' | 'NASCAR Tracks' | 'NASCAR Events' | 'NASCAR Races' | 'NASCAR Owners' | 'NASCAR Manufacturers' | 'Soccer Teams' | 'Soccer Players' | 'Soccer Competitions' | 'Soccer Conferences' | 'Basketball Teams' | 'Basketball Players' | 'Basketball Conferences' | 'Basketball Divisions' | 'Baseball Teams' | 'Baseball Players' | 'Baseball Conferences' | 'Baseball Divisions' | 'Baseball Competitions' | 'Football Teams' | 'Football Players' | 'Football Conferences' | 'Football Divisions' | 'Sports' | 'Sports Leagues'} [subtype] Filter to a single entity class (e.g. Countries, Companies). Implies entity-only results; an explicit non-entity \'types\' is a 400. Note: results are drawn from a bounded candidate window (min(limit*5, 200)) before filtering, so a response shorter than `limit` does not imply no further matches exist.
|
|
2754
2747
|
* @param {*} [options] Override http request option.
|
|
@@ -2757,7 +2750,7 @@ interface TakoApiInterface {
|
|
|
2757
2750
|
*/
|
|
2758
2751
|
graphSearchRaw(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphSearchResponse>>;
|
|
2759
2752
|
/**
|
|
2760
|
-
* Resolve a
|
|
2753
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2761
2754
|
* Search the data graph
|
|
2762
2755
|
*/
|
|
2763
2756
|
graphSearch(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphSearchResponse>;
|
|
@@ -2832,12 +2825,12 @@ declare class TakoApi extends BaseAPI implements TakoApiInterface {
|
|
|
2832
2825
|
*/
|
|
2833
2826
|
graphRelatedRequestOpts(requestParameters: GraphRelatedRequest): Promise<RequestOpts>;
|
|
2834
2827
|
/**
|
|
2835
|
-
* Explore what a node connects to: a
|
|
2828
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2836
2829
|
* Get a graph node\'s related nodes
|
|
2837
2830
|
*/
|
|
2838
2831
|
graphRelatedRaw(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphRelatedResponse>>;
|
|
2839
2832
|
/**
|
|
2840
|
-
* Explore what a node connects to: a
|
|
2833
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2841
2834
|
* Get a graph node\'s related nodes
|
|
2842
2835
|
*/
|
|
2843
2836
|
graphRelated(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphRelatedResponse>;
|
|
@@ -2846,12 +2839,12 @@ declare class TakoApi extends BaseAPI implements TakoApiInterface {
|
|
|
2846
2839
|
*/
|
|
2847
2840
|
graphSearchRequestOpts(requestParameters: GraphSearchRequest): Promise<RequestOpts>;
|
|
2848
2841
|
/**
|
|
2849
|
-
* Resolve a
|
|
2842
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2850
2843
|
* Search the data graph
|
|
2851
2844
|
*/
|
|
2852
2845
|
graphSearchRaw(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphSearchResponse>>;
|
|
2853
2846
|
/**
|
|
2854
|
-
* Resolve a
|
|
2847
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2855
2848
|
* Search the data graph
|
|
2856
2849
|
*/
|
|
2857
2850
|
graphSearch(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphSearchResponse>;
|
package/dist/index.d.ts
CHANGED
|
@@ -1930,7 +1930,6 @@ declare function EntityClassNameToJSONTyped(value: any, ignoreDiscriminator: boo
|
|
|
1930
1930
|
* @export
|
|
1931
1931
|
*/
|
|
1932
1932
|
declare const GraphNodeType: {
|
|
1933
|
-
readonly Source: "source";
|
|
1934
1933
|
readonly Metric: "metric";
|
|
1935
1934
|
readonly Entity: "entity";
|
|
1936
1935
|
};
|
|
@@ -2063,12 +2062,6 @@ declare function RelationGroupToJSONTyped(value?: RelationGroup | null, ignoreDi
|
|
|
2063
2062
|
* @interface RelatedGroups
|
|
2064
2063
|
*/
|
|
2065
2064
|
interface RelatedGroups {
|
|
2066
|
-
/**
|
|
2067
|
-
*
|
|
2068
|
-
* @type {RelationGroup}
|
|
2069
|
-
* @memberof RelatedGroups
|
|
2070
|
-
*/
|
|
2071
|
-
sources: RelationGroup;
|
|
2072
2065
|
/**
|
|
2073
2066
|
*
|
|
2074
2067
|
* @type {RelationGroup}
|
|
@@ -2707,8 +2700,8 @@ interface TakoApiInterface {
|
|
|
2707
2700
|
createCard(requestParameters: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ThinVizCard>;
|
|
2708
2701
|
/**
|
|
2709
2702
|
* Creates request options for graphRelated without sending the request
|
|
2710
|
-
* @param {string} nodeId Opaque public id of the node
|
|
2711
|
-
* @param {string} [relationType] Paginate one facet:
|
|
2703
|
+
* @param {string} nodeId Opaque public id of the node.
|
|
2704
|
+
* @param {string} [relationType] Paginate one facet: metric or entity.
|
|
2712
2705
|
* @param {string} [q] Optional case-insensitive substring filter on the related nodes\' name/aliases. Filters every facet of the overview, or the single paginated facet when relation_type is set.
|
|
2713
2706
|
* @param {string} [cursor] Opaque pagination cursor.
|
|
2714
2707
|
* @param {number} [limit] Page size (default 50, max 100).
|
|
@@ -2717,10 +2710,10 @@ interface TakoApiInterface {
|
|
|
2717
2710
|
*/
|
|
2718
2711
|
graphRelatedRequestOpts(requestParameters: GraphRelatedRequest): Promise<RequestOpts>;
|
|
2719
2712
|
/**
|
|
2720
|
-
* Explore what a node connects to: a
|
|
2713
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2721
2714
|
* @summary Get a graph node\'s related nodes
|
|
2722
|
-
* @param {string} nodeId Opaque public id of the node
|
|
2723
|
-
* @param {string} [relationType] Paginate one facet:
|
|
2715
|
+
* @param {string} nodeId Opaque public id of the node.
|
|
2716
|
+
* @param {string} [relationType] Paginate one facet: metric or entity.
|
|
2724
2717
|
* @param {string} [q] Optional case-insensitive substring filter on the related nodes\' name/aliases. Filters every facet of the overview, or the single paginated facet when relation_type is set.
|
|
2725
2718
|
* @param {string} [cursor] Opaque pagination cursor.
|
|
2726
2719
|
* @param {number} [limit] Page size (default 50, max 100).
|
|
@@ -2730,14 +2723,14 @@ interface TakoApiInterface {
|
|
|
2730
2723
|
*/
|
|
2731
2724
|
graphRelatedRaw(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphRelatedResponse>>;
|
|
2732
2725
|
/**
|
|
2733
|
-
* Explore what a node connects to: a
|
|
2726
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2734
2727
|
* Get a graph node\'s related nodes
|
|
2735
2728
|
*/
|
|
2736
2729
|
graphRelated(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphRelatedResponse>;
|
|
2737
2730
|
/**
|
|
2738
2731
|
* Creates request options for graphSearch without sending the request
|
|
2739
2732
|
* @param {string} q Search text (min 2 chars).
|
|
2740
|
-
* @param {string} [types] Comma-separated facets:
|
|
2733
|
+
* @param {string} [types] Comma-separated facets: metric,entity.
|
|
2741
2734
|
* @param {number} [limit] Max results (default 20, max 50).
|
|
2742
2735
|
* @param {'Companies' | 'Cryptocurrencies' | 'Financial Instruments' | 'Internet Browsers' | 'Commodities' | 'People' | 'Currencies' | 'Stock Exchanges' | 'Securities' | 'IPOs' | 'Government Debt Instruments' | 'Treasury Securities' | 'Airports' | 'Airlines' | 'Vehicle Types' | 'Transportation Modes' | 'Drugs' | 'Drug Categories' | 'Diseases' | 'Chemical Elements' | 'Chemical Compounds' | 'Celestial Bodies' | 'Occupations' | 'Social Media Platforms' | 'Operating Systems' | 'Search Engines' | 'Device Types' | 'LLMs' | 'LLM Families' | 'LLM Benchmarks' | 'Industries' | 'NAICS Industries' | 'BLS Industries' | 'PSC Categories' | 'Federal Contractors' | 'Federal Agencies' | 'Federal Subagencies' | 'ICE Contracts' | 'ICE Contractors' | 'Elections' | 'Political Offices' | 'Pollsters' | 'Agricultural Products' | 'Tobacco Products' | 'Prediction Markets' | 'Prediction Events' | 'Real Estate Property Types' | 'Continents' | 'World Regions' | 'Countries' | 'States' | 'Counties' | 'Metro Areas' | 'Cities' | 'F1 Drivers' | 'F1 Teams' | 'F1 Circuits' | 'F1 Events' | 'NASCAR Drivers' | 'NASCAR Teams' | 'NASCAR Tracks' | 'NASCAR Events' | 'NASCAR Races' | 'NASCAR Owners' | 'NASCAR Manufacturers' | 'Soccer Teams' | 'Soccer Players' | 'Soccer Competitions' | 'Soccer Conferences' | 'Basketball Teams' | 'Basketball Players' | 'Basketball Conferences' | 'Basketball Divisions' | 'Baseball Teams' | 'Baseball Players' | 'Baseball Conferences' | 'Baseball Divisions' | 'Baseball Competitions' | 'Football Teams' | 'Football Players' | 'Football Conferences' | 'Football Divisions' | 'Sports' | 'Sports Leagues'} [subtype] Filter to a single entity class (e.g. Countries, Companies). Implies entity-only results; an explicit non-entity \'types\' is a 400. Note: results are drawn from a bounded candidate window (min(limit*5, 200)) before filtering, so a response shorter than `limit` does not imply no further matches exist.
|
|
2743
2736
|
* @throws {RequiredError}
|
|
@@ -2745,10 +2738,10 @@ interface TakoApiInterface {
|
|
|
2745
2738
|
*/
|
|
2746
2739
|
graphSearchRequestOpts(requestParameters: GraphSearchRequest): Promise<RequestOpts>;
|
|
2747
2740
|
/**
|
|
2748
|
-
* Resolve a
|
|
2741
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2749
2742
|
* @summary Search the data graph
|
|
2750
2743
|
* @param {string} q Search text (min 2 chars).
|
|
2751
|
-
* @param {string} [types] Comma-separated facets:
|
|
2744
|
+
* @param {string} [types] Comma-separated facets: metric,entity.
|
|
2752
2745
|
* @param {number} [limit] Max results (default 20, max 50).
|
|
2753
2746
|
* @param {'Companies' | 'Cryptocurrencies' | 'Financial Instruments' | 'Internet Browsers' | 'Commodities' | 'People' | 'Currencies' | 'Stock Exchanges' | 'Securities' | 'IPOs' | 'Government Debt Instruments' | 'Treasury Securities' | 'Airports' | 'Airlines' | 'Vehicle Types' | 'Transportation Modes' | 'Drugs' | 'Drug Categories' | 'Diseases' | 'Chemical Elements' | 'Chemical Compounds' | 'Celestial Bodies' | 'Occupations' | 'Social Media Platforms' | 'Operating Systems' | 'Search Engines' | 'Device Types' | 'LLMs' | 'LLM Families' | 'LLM Benchmarks' | 'Industries' | 'NAICS Industries' | 'BLS Industries' | 'PSC Categories' | 'Federal Contractors' | 'Federal Agencies' | 'Federal Subagencies' | 'ICE Contracts' | 'ICE Contractors' | 'Elections' | 'Political Offices' | 'Pollsters' | 'Agricultural Products' | 'Tobacco Products' | 'Prediction Markets' | 'Prediction Events' | 'Real Estate Property Types' | 'Continents' | 'World Regions' | 'Countries' | 'States' | 'Counties' | 'Metro Areas' | 'Cities' | 'F1 Drivers' | 'F1 Teams' | 'F1 Circuits' | 'F1 Events' | 'NASCAR Drivers' | 'NASCAR Teams' | 'NASCAR Tracks' | 'NASCAR Events' | 'NASCAR Races' | 'NASCAR Owners' | 'NASCAR Manufacturers' | 'Soccer Teams' | 'Soccer Players' | 'Soccer Competitions' | 'Soccer Conferences' | 'Basketball Teams' | 'Basketball Players' | 'Basketball Conferences' | 'Basketball Divisions' | 'Baseball Teams' | 'Baseball Players' | 'Baseball Conferences' | 'Baseball Divisions' | 'Baseball Competitions' | 'Football Teams' | 'Football Players' | 'Football Conferences' | 'Football Divisions' | 'Sports' | 'Sports Leagues'} [subtype] Filter to a single entity class (e.g. Countries, Companies). Implies entity-only results; an explicit non-entity \'types\' is a 400. Note: results are drawn from a bounded candidate window (min(limit*5, 200)) before filtering, so a response shorter than `limit` does not imply no further matches exist.
|
|
2754
2747
|
* @param {*} [options] Override http request option.
|
|
@@ -2757,7 +2750,7 @@ interface TakoApiInterface {
|
|
|
2757
2750
|
*/
|
|
2758
2751
|
graphSearchRaw(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphSearchResponse>>;
|
|
2759
2752
|
/**
|
|
2760
|
-
* Resolve a
|
|
2753
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2761
2754
|
* Search the data graph
|
|
2762
2755
|
*/
|
|
2763
2756
|
graphSearch(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphSearchResponse>;
|
|
@@ -2832,12 +2825,12 @@ declare class TakoApi extends BaseAPI implements TakoApiInterface {
|
|
|
2832
2825
|
*/
|
|
2833
2826
|
graphRelatedRequestOpts(requestParameters: GraphRelatedRequest): Promise<RequestOpts>;
|
|
2834
2827
|
/**
|
|
2835
|
-
* Explore what a node connects to: a
|
|
2828
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2836
2829
|
* Get a graph node\'s related nodes
|
|
2837
2830
|
*/
|
|
2838
2831
|
graphRelatedRaw(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphRelatedResponse>>;
|
|
2839
2832
|
/**
|
|
2840
|
-
* Explore what a node connects to: a
|
|
2833
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2841
2834
|
* Get a graph node\'s related nodes
|
|
2842
2835
|
*/
|
|
2843
2836
|
graphRelated(requestParameters: GraphRelatedRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphRelatedResponse>;
|
|
@@ -2846,12 +2839,12 @@ declare class TakoApi extends BaseAPI implements TakoApiInterface {
|
|
|
2846
2839
|
*/
|
|
2847
2840
|
graphSearchRequestOpts(requestParameters: GraphSearchRequest): Promise<RequestOpts>;
|
|
2848
2841
|
/**
|
|
2849
|
-
* Resolve a
|
|
2842
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2850
2843
|
* Search the data graph
|
|
2851
2844
|
*/
|
|
2852
2845
|
graphSearchRaw(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<GraphSearchResponse>>;
|
|
2853
2846
|
/**
|
|
2854
|
-
* Resolve a
|
|
2847
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2855
2848
|
* Search the data graph
|
|
2856
2849
|
*/
|
|
2857
2850
|
graphSearch(requestParameters: GraphSearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<GraphSearchResponse>;
|
package/dist/index.js
CHANGED
|
@@ -1508,7 +1508,6 @@ function EntityClassNameToJSONTyped(value, ignoreDiscriminator) {
|
|
|
1508
1508
|
|
|
1509
1509
|
// src/generated/models/GraphNodeType.ts
|
|
1510
1510
|
var GraphNodeType = {
|
|
1511
|
-
Source: "source",
|
|
1512
1511
|
Metric: "metric",
|
|
1513
1512
|
Entity: "entity"
|
|
1514
1513
|
};
|
|
@@ -1608,7 +1607,6 @@ function RelationGroupToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1608
1607
|
|
|
1609
1608
|
// src/generated/models/RelatedGroups.ts
|
|
1610
1609
|
function instanceOfRelatedGroups(value) {
|
|
1611
|
-
if (!("sources" in value) || value["sources"] === void 0) return false;
|
|
1612
1610
|
if (!("metrics" in value) || value["metrics"] === void 0) return false;
|
|
1613
1611
|
if (!("entities" in value) || value["entities"] === void 0) return false;
|
|
1614
1612
|
return true;
|
|
@@ -1621,7 +1619,6 @@ function RelatedGroupsFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1621
1619
|
return json;
|
|
1622
1620
|
}
|
|
1623
1621
|
return {
|
|
1624
|
-
"sources": RelationGroupFromJSON(json["sources"]),
|
|
1625
1622
|
"metrics": RelationGroupFromJSON(json["metrics"]),
|
|
1626
1623
|
"entities": RelationGroupFromJSON(json["entities"])
|
|
1627
1624
|
};
|
|
@@ -1634,7 +1631,6 @@ function RelatedGroupsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1634
1631
|
return value;
|
|
1635
1632
|
}
|
|
1636
1633
|
return {
|
|
1637
|
-
"sources": RelationGroupToJSON(value["sources"]),
|
|
1638
1634
|
"metrics": RelationGroupToJSON(value["metrics"]),
|
|
1639
1635
|
"entities": RelationGroupToJSON(value["entities"])
|
|
1640
1636
|
};
|
|
@@ -2117,7 +2113,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2117
2113
|
};
|
|
2118
2114
|
}
|
|
2119
2115
|
/**
|
|
2120
|
-
* Explore what a node connects to: a
|
|
2116
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2121
2117
|
* Get a graph node\'s related nodes
|
|
2122
2118
|
*/
|
|
2123
2119
|
async graphRelatedRaw(requestParameters, initOverrides) {
|
|
@@ -2126,7 +2122,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2126
2122
|
return new JSONApiResponse(response, (jsonValue) => GraphRelatedResponseFromJSON(jsonValue));
|
|
2127
2123
|
}
|
|
2128
2124
|
/**
|
|
2129
|
-
* Explore what a node connects to: a
|
|
2125
|
+
* Explore what a node connects to: a metric\'s entities (the things it\'s tracked for), or an entity\'s available metrics. Use it to find which entity + metric combinations Tako covers, then query /v3/search or /v1/answer for that combination. Pass relation_type + cursor to paginate one facet, and the optional q to narrow that facet by a case-insensitive substring on name/aliases (e.g. metrics for an entity matching \'gdp\'). Public and unauthenticated.
|
|
2130
2126
|
* Get a graph node\'s related nodes
|
|
2131
2127
|
*/
|
|
2132
2128
|
async graphRelated(requestParameters, initOverrides) {
|
|
@@ -2166,7 +2162,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2166
2162
|
};
|
|
2167
2163
|
}
|
|
2168
2164
|
/**
|
|
2169
|
-
* Resolve a
|
|
2165
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2170
2166
|
* Search the data graph
|
|
2171
2167
|
*/
|
|
2172
2168
|
async graphSearchRaw(requestParameters, initOverrides) {
|
|
@@ -2175,7 +2171,7 @@ var TakoApi = class extends BaseAPI {
|
|
|
2175
2171
|
return new JSONApiResponse(response, (jsonValue) => GraphSearchResponseFromJSON(jsonValue));
|
|
2176
2172
|
}
|
|
2177
2173
|
/**
|
|
2178
|
-
* Resolve a
|
|
2174
|
+
* Resolve a metric or entity in Tako\'s data graph by name. Use this to discover and confirm what data exists before querying — e.g. resolve the metric and the entity you care about here, then ask /v3/search or /v1/answer for that specific entity + metric combination. Public and unauthenticated. Note: results are not yet filtered to the production-ready inventory, so a returned metric or entity that is not backed by a production fact table may 404 when passed to /beta/graph/related. Pass subtype to scope results to one entity class (see the subtype enum).
|
|
2179
2175
|
* Search the data graph
|
|
2180
2176
|
*/
|
|
2181
2177
|
async graphSearch(requestParameters, initOverrides) {
|