@gooddata/api-client-tiger 11.30.0-alpha.3 → 11.30.0-alpha.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/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +1470 -304
- package/esm/generated/afm-rest-api/api.d.ts +172 -2
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +160 -0
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +37 -4
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +26 -1
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +26 -1
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +1175 -281
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +1034 -126
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +181 -2
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +160 -0
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/package.json +4 -4
|
@@ -32,6 +32,10 @@ export interface AFM {
|
|
|
32
32
|
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
33
33
|
*/
|
|
34
34
|
'auxMeasures'?: Array<MeasureItem>;
|
|
35
|
+
/**
|
|
36
|
+
* (EXPERIMENTAL) Parameter values to use for this execution.
|
|
37
|
+
*/
|
|
38
|
+
'parameters'?: Array<ParameterItem>;
|
|
35
39
|
/**
|
|
36
40
|
* (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
|
|
37
41
|
*/
|
|
@@ -119,6 +123,17 @@ export interface AfmObjectIdentifierLabelIdentifier {
|
|
|
119
123
|
'id': string;
|
|
120
124
|
}
|
|
121
125
|
export type AfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
126
|
+
/**
|
|
127
|
+
* Reference to the parameter.
|
|
128
|
+
*/
|
|
129
|
+
export interface AfmObjectIdentifierParameter {
|
|
130
|
+
'identifier': AfmObjectIdentifierParameterIdentifier;
|
|
131
|
+
}
|
|
132
|
+
export interface AfmObjectIdentifierParameterIdentifier {
|
|
133
|
+
'id': string;
|
|
134
|
+
'type': AfmObjectIdentifierParameterIdentifierTypeEnum;
|
|
135
|
+
}
|
|
136
|
+
export type AfmObjectIdentifierParameterIdentifierTypeEnum = 'parameter';
|
|
122
137
|
export interface AlertAfm {
|
|
123
138
|
/**
|
|
124
139
|
* Attributes to be used in the computation.
|
|
@@ -460,6 +475,29 @@ export interface ColumnOverride {
|
|
|
460
475
|
}
|
|
461
476
|
export type ColumnOverrideLdmTypeOverrideEnum = 'FACT' | 'LABEL';
|
|
462
477
|
export type ColumnOverrideLabelTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
478
|
+
export interface ColumnStatisticsEntry {
|
|
479
|
+
'columnName': string;
|
|
480
|
+
/**
|
|
481
|
+
* NDV (Number of Distinct Values) — approximate cardinality of the column.
|
|
482
|
+
*/
|
|
483
|
+
'ndv'?: number;
|
|
484
|
+
/**
|
|
485
|
+
* Number of NULL values in the column.
|
|
486
|
+
*/
|
|
487
|
+
'nullCount'?: number;
|
|
488
|
+
/**
|
|
489
|
+
* Minimum value in the column (string-encoded).
|
|
490
|
+
*/
|
|
491
|
+
'min'?: string;
|
|
492
|
+
/**
|
|
493
|
+
* Maximum value in the column (string-encoded).
|
|
494
|
+
*/
|
|
495
|
+
'max'?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Total data size of the column in bytes.
|
|
498
|
+
*/
|
|
499
|
+
'dataSize'?: number;
|
|
500
|
+
}
|
|
463
501
|
export interface Comparison {
|
|
464
502
|
'operator': ComparisonOperatorEnum;
|
|
465
503
|
'left': LocalIdentifier;
|
|
@@ -749,6 +787,12 @@ export interface DataSourcePermissionAssignment {
|
|
|
749
787
|
'permissions': Array<DataSourcePermissionAssignmentPermissionsEnum>;
|
|
750
788
|
}
|
|
751
789
|
export type DataSourcePermissionAssignmentPermissionsEnum = 'MANAGE' | 'USE';
|
|
790
|
+
export interface DataSourceStatisticsRequest {
|
|
791
|
+
'tables': Array<TableStatisticsEntry>;
|
|
792
|
+
}
|
|
793
|
+
export interface DataSourceStatisticsResponse {
|
|
794
|
+
'tables': Array<TableStatisticsEntry>;
|
|
795
|
+
}
|
|
752
796
|
/**
|
|
753
797
|
* An id of the table. Including ID of data source.
|
|
754
798
|
*/
|
|
@@ -803,6 +847,69 @@ export type DateFilter = AbsoluteDateFilter | AllTimeDateFilter | RelativeDateFi
|
|
|
803
847
|
export interface DateValue {
|
|
804
848
|
'value': string;
|
|
805
849
|
}
|
|
850
|
+
/**
|
|
851
|
+
* A declarative form of an AI agent configuration.
|
|
852
|
+
*/
|
|
853
|
+
export interface DeclarativeAgent {
|
|
854
|
+
/**
|
|
855
|
+
* Identifier of an agent.
|
|
856
|
+
*/
|
|
857
|
+
'id': string;
|
|
858
|
+
/**
|
|
859
|
+
* Whether the agent is enabled.
|
|
860
|
+
*/
|
|
861
|
+
'enabled'?: boolean;
|
|
862
|
+
/**
|
|
863
|
+
* Name of the agent.
|
|
864
|
+
*/
|
|
865
|
+
'name'?: string;
|
|
866
|
+
/**
|
|
867
|
+
* Description of the agent.
|
|
868
|
+
*/
|
|
869
|
+
'description'?: string;
|
|
870
|
+
/**
|
|
871
|
+
* Personality instructions for the agent.
|
|
872
|
+
*/
|
|
873
|
+
'personality'?: string;
|
|
874
|
+
/**
|
|
875
|
+
* Skills mode: ALL or CUSTOM.
|
|
876
|
+
*/
|
|
877
|
+
'skillsMode'?: DeclarativeAgentSkillsModeEnum;
|
|
878
|
+
/**
|
|
879
|
+
* List of custom skills when skillsMode is CUSTOM.
|
|
880
|
+
*/
|
|
881
|
+
'customSkills'?: Array<DeclarativeAgentCustomSkillsEnum | null> | null;
|
|
882
|
+
/**
|
|
883
|
+
* Whether AI knowledge is enabled.
|
|
884
|
+
*/
|
|
885
|
+
'aiKnowledge'?: boolean;
|
|
886
|
+
/**
|
|
887
|
+
* Whether the agent is available to all users.
|
|
888
|
+
*/
|
|
889
|
+
'availableToAll'?: boolean;
|
|
890
|
+
/**
|
|
891
|
+
* User groups this agent is assigned to.
|
|
892
|
+
*/
|
|
893
|
+
'userGroups'?: Array<DeclarativeUserGroupIdentifier>;
|
|
894
|
+
/**
|
|
895
|
+
* Time of the entity creation.
|
|
896
|
+
*/
|
|
897
|
+
'createdAt'?: string | null;
|
|
898
|
+
'createdBy'?: DeclarativeUserIdentifier;
|
|
899
|
+
/**
|
|
900
|
+
* Time of the last entity modification.
|
|
901
|
+
*/
|
|
902
|
+
'modifiedAt'?: string | null;
|
|
903
|
+
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
904
|
+
}
|
|
905
|
+
export type DeclarativeAgentSkillsModeEnum = 'all' | 'custom';
|
|
906
|
+
export type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'what_if_analysis' | 'knowledge';
|
|
907
|
+
/**
|
|
908
|
+
* AI agent configurations.
|
|
909
|
+
*/
|
|
910
|
+
export interface DeclarativeAgents {
|
|
911
|
+
'agents': Array<DeclarativeAgent>;
|
|
912
|
+
}
|
|
806
913
|
/**
|
|
807
914
|
* A dataset fact.
|
|
808
915
|
*/
|
|
@@ -837,7 +944,7 @@ export interface DeclarativeAggregatedFact {
|
|
|
837
944
|
*/
|
|
838
945
|
'nullValue'?: string;
|
|
839
946
|
}
|
|
840
|
-
export type DeclarativeAggregatedFactSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
947
|
+
export type DeclarativeAggregatedFactSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
841
948
|
export interface DeclarativeAnalyticalDashboard {
|
|
842
949
|
/**
|
|
843
950
|
* Analytical dashboard ID.
|
|
@@ -1059,7 +1166,7 @@ export interface DeclarativeAttribute {
|
|
|
1059
1166
|
'nullValue'?: string;
|
|
1060
1167
|
}
|
|
1061
1168
|
export type DeclarativeAttributeSortDirectionEnum = 'ASC' | 'DESC';
|
|
1062
|
-
export type DeclarativeAttributeSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
1169
|
+
export type DeclarativeAttributeSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1063
1170
|
export interface DeclarativeAttributeHierarchy {
|
|
1064
1171
|
/**
|
|
1065
1172
|
* Attribute hierarchy object ID.
|
|
@@ -1185,7 +1292,7 @@ export interface DeclarativeColumn {
|
|
|
1185
1292
|
*/
|
|
1186
1293
|
'isNullable'?: boolean;
|
|
1187
1294
|
}
|
|
1188
|
-
export type DeclarativeColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
1295
|
+
export type DeclarativeColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1189
1296
|
export interface DeclarativeCspDirective {
|
|
1190
1297
|
'directive': string;
|
|
1191
1298
|
'sources': Array<string>;
|
|
@@ -1407,7 +1514,12 @@ export interface DeclarativeDataset {
|
|
|
1407
1514
|
* Precedence used in aggregate awareness.
|
|
1408
1515
|
*/
|
|
1409
1516
|
'precedence'?: number;
|
|
1517
|
+
/**
|
|
1518
|
+
* Dataset type
|
|
1519
|
+
*/
|
|
1520
|
+
'type'?: DeclarativeDatasetTypeEnum;
|
|
1410
1521
|
}
|
|
1522
|
+
export type DeclarativeDatasetTypeEnum = 'NORMAL' | 'AUXILIARY';
|
|
1411
1523
|
/**
|
|
1412
1524
|
* A dataset extension properties.
|
|
1413
1525
|
*/
|
|
@@ -1570,7 +1682,7 @@ export interface DeclarativeFact {
|
|
|
1570
1682
|
*/
|
|
1571
1683
|
'nullValue'?: string;
|
|
1572
1684
|
}
|
|
1573
|
-
export type DeclarativeFactSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
1685
|
+
export type DeclarativeFactSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1574
1686
|
export interface DeclarativeFilterContext {
|
|
1575
1687
|
/**
|
|
1576
1688
|
* Filter Context ID.
|
|
@@ -1748,7 +1860,7 @@ export interface DeclarativeLabel {
|
|
|
1748
1860
|
*/
|
|
1749
1861
|
'nullValue'?: string;
|
|
1750
1862
|
}
|
|
1751
|
-
export type DeclarativeLabelSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
1863
|
+
export type DeclarativeLabelSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1752
1864
|
export type DeclarativeLabelValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
1753
1865
|
/**
|
|
1754
1866
|
* A label translation.
|
|
@@ -1967,6 +2079,7 @@ export interface DeclarativeOrganization {
|
|
|
1967
2079
|
'notificationChannels'?: Array<DeclarativeNotificationChannel>;
|
|
1968
2080
|
'exportTemplates'?: Array<DeclarativeExportTemplate>;
|
|
1969
2081
|
'customGeoCollections'?: Array<DeclarativeCustomGeoCollection>;
|
|
2082
|
+
'agents'?: Array<DeclarativeAgent>;
|
|
1970
2083
|
}
|
|
1971
2084
|
/**
|
|
1972
2085
|
* Information available about an organization.
|
|
@@ -2077,7 +2190,7 @@ export interface DeclarativeReference {
|
|
|
2077
2190
|
*/
|
|
2078
2191
|
'sources'?: Array<DeclarativeReferenceSource>;
|
|
2079
2192
|
}
|
|
2080
|
-
export type DeclarativeReferenceSourceColumnDataTypesEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
2193
|
+
export type DeclarativeReferenceSourceColumnDataTypesEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
2081
2194
|
/**
|
|
2082
2195
|
* A dataset reference source column description.
|
|
2083
2196
|
*/
|
|
@@ -2100,7 +2213,7 @@ export interface DeclarativeReferenceSource {
|
|
|
2100
2213
|
*/
|
|
2101
2214
|
'nullValue'?: string;
|
|
2102
2215
|
}
|
|
2103
|
-
export type DeclarativeReferenceSourceDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
2216
|
+
export type DeclarativeReferenceSourceDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
2104
2217
|
/**
|
|
2105
2218
|
* Declarative specification of the cryptographic key.
|
|
2106
2219
|
*/
|
|
@@ -2513,7 +2626,7 @@ export interface DeclarativeWorkspaceDataFilterColumn {
|
|
|
2513
2626
|
*/
|
|
2514
2627
|
'dataType': DeclarativeWorkspaceDataFilterColumnDataTypeEnum;
|
|
2515
2628
|
}
|
|
2516
|
-
export type DeclarativeWorkspaceDataFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
2629
|
+
export type DeclarativeWorkspaceDataFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
2517
2630
|
export interface DeclarativeWorkspaceDataFilterReferences {
|
|
2518
2631
|
'filterId': DatasetWorkspaceDataFilterIdentifier;
|
|
2519
2632
|
/**
|
|
@@ -2525,7 +2638,7 @@ export interface DeclarativeWorkspaceDataFilterReferences {
|
|
|
2525
2638
|
*/
|
|
2526
2639
|
'filterColumnDataType': DeclarativeWorkspaceDataFilterReferencesFilterColumnDataTypeEnum;
|
|
2527
2640
|
}
|
|
2528
|
-
export type DeclarativeWorkspaceDataFilterReferencesFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
2641
|
+
export type DeclarativeWorkspaceDataFilterReferencesFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
2529
2642
|
/**
|
|
2530
2643
|
* Workspace Data Filters serving the filtering of what data users can see in workspaces.
|
|
2531
2644
|
*/
|
|
@@ -2610,7 +2723,7 @@ export interface DependentEntitiesNode {
|
|
|
2610
2723
|
'type': DependentEntitiesNodeTypeEnum;
|
|
2611
2724
|
'title'?: string;
|
|
2612
2725
|
}
|
|
2613
|
-
export type DependentEntitiesNodeTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'automation' | 'memoryItem' | 'knowledgeRecommendation' | 'visualizationObject' | 'filterContext' | 'filterView';
|
|
2726
|
+
export type DependentEntitiesNodeTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'automation' | 'memoryItem' | 'knowledgeRecommendation' | 'visualizationObject' | 'filterContext' | 'filterView';
|
|
2614
2727
|
export interface DependentEntitiesRequest {
|
|
2615
2728
|
'identifiers': Array<EntityIdentifier>;
|
|
2616
2729
|
/**
|
|
@@ -2876,7 +2989,7 @@ export interface IdentifierRefIdentifier {
|
|
|
2876
2989
|
'id': string;
|
|
2877
2990
|
'type': IdentifierRefIdentifierTypeEnum;
|
|
2878
2991
|
}
|
|
2879
|
-
export type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | '
|
|
2992
|
+
export type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView';
|
|
2880
2993
|
/**
|
|
2881
2994
|
* Export request object describing the export properties and metadata for image exports.
|
|
2882
2995
|
*/
|
|
@@ -2970,9 +3083,9 @@ export interface JsonApiAgentIn {
|
|
|
2970
3083
|
export type JsonApiAgentInTypeEnum = 'agent';
|
|
2971
3084
|
export interface JsonApiAgentInAttributes {
|
|
2972
3085
|
'enabled'?: boolean;
|
|
2973
|
-
'name'?: string;
|
|
2974
|
-
'description'?: string;
|
|
2975
|
-
'personality'?: string;
|
|
3086
|
+
'name'?: string | null;
|
|
3087
|
+
'description'?: string | null;
|
|
3088
|
+
'personality'?: string | null;
|
|
2976
3089
|
'skillsMode'?: JsonApiAgentInAttributesSkillsModeEnum;
|
|
2977
3090
|
'customSkills'?: Array<JsonApiAgentInAttributesCustomSkillsEnum> | null;
|
|
2978
3091
|
'aiKnowledge'?: boolean;
|
|
@@ -3001,9 +3114,9 @@ export interface JsonApiAgentOut {
|
|
|
3001
3114
|
export type JsonApiAgentOutTypeEnum = 'agent';
|
|
3002
3115
|
export interface JsonApiAgentOutAttributes {
|
|
3003
3116
|
'enabled'?: boolean;
|
|
3004
|
-
'name'?: string;
|
|
3005
|
-
'description'?: string;
|
|
3006
|
-
'personality'?: string;
|
|
3117
|
+
'name'?: string | null;
|
|
3118
|
+
'description'?: string | null;
|
|
3119
|
+
'personality'?: string | null;
|
|
3007
3120
|
'skillsMode'?: JsonApiAgentOutAttributesSkillsModeEnum;
|
|
3008
3121
|
'customSkills'?: Array<JsonApiAgentOutAttributesCustomSkillsEnum> | null;
|
|
3009
3122
|
'aiKnowledge'?: boolean;
|
|
@@ -3116,7 +3229,7 @@ export interface JsonApiAggregatedFactOutAttributes {
|
|
|
3116
3229
|
'isNullable'?: boolean;
|
|
3117
3230
|
'nullValue'?: string;
|
|
3118
3231
|
}
|
|
3119
|
-
export type JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
3232
|
+
export type JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
3120
3233
|
export type JsonApiAggregatedFactOutAttributesOperationEnum = 'SUM' | 'MIN' | 'MAX' | 'APPROXIMATE_COUNT';
|
|
3121
3234
|
export interface JsonApiAggregatedFactOutDocument {
|
|
3122
3235
|
'data': JsonApiAggregatedFactOut;
|
|
@@ -3667,7 +3780,7 @@ export interface JsonApiAttributeOutAttributes {
|
|
|
3667
3780
|
}
|
|
3668
3781
|
export type JsonApiAttributeOutAttributesGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
3669
3782
|
export type JsonApiAttributeOutAttributesSortDirectionEnum = 'ASC' | 'DESC';
|
|
3670
|
-
export type JsonApiAttributeOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
3783
|
+
export type JsonApiAttributeOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
3671
3784
|
export interface JsonApiAttributeOutDocument {
|
|
3672
3785
|
'data': JsonApiAttributeOut;
|
|
3673
3786
|
'links'?: ObjectLinks;
|
|
@@ -4176,9 +4289,12 @@ export interface JsonApiCspDirectiveIn {
|
|
|
4176
4289
|
* API identifier of an object
|
|
4177
4290
|
*/
|
|
4178
4291
|
'id': string;
|
|
4179
|
-
'attributes':
|
|
4292
|
+
'attributes': JsonApiCspDirectiveInAttributes;
|
|
4180
4293
|
}
|
|
4181
4294
|
export type JsonApiCspDirectiveInTypeEnum = 'cspDirective';
|
|
4295
|
+
export interface JsonApiCspDirectiveInAttributes {
|
|
4296
|
+
'sources': Array<string>;
|
|
4297
|
+
}
|
|
4182
4298
|
export interface JsonApiCspDirectiveInDocument {
|
|
4183
4299
|
'data': JsonApiCspDirectiveIn;
|
|
4184
4300
|
}
|
|
@@ -4194,12 +4310,9 @@ export interface JsonApiCspDirectiveOut {
|
|
|
4194
4310
|
* API identifier of an object
|
|
4195
4311
|
*/
|
|
4196
4312
|
'id': string;
|
|
4197
|
-
'attributes':
|
|
4313
|
+
'attributes': JsonApiCspDirectiveInAttributes;
|
|
4198
4314
|
}
|
|
4199
4315
|
export type JsonApiCspDirectiveOutTypeEnum = 'cspDirective';
|
|
4200
|
-
export interface JsonApiCspDirectiveOutAttributes {
|
|
4201
|
-
'sources': Array<string>;
|
|
4202
|
-
}
|
|
4203
4316
|
export interface JsonApiCspDirectiveOutDocument {
|
|
4204
4317
|
'data': JsonApiCspDirectiveOut;
|
|
4205
4318
|
'links'?: ObjectLinks;
|
|
@@ -4221,7 +4334,7 @@ export interface JsonApiCspDirectiveOutWithLinks {
|
|
|
4221
4334
|
* API identifier of an object
|
|
4222
4335
|
*/
|
|
4223
4336
|
'id': string;
|
|
4224
|
-
'attributes':
|
|
4337
|
+
'attributes': JsonApiCspDirectiveInAttributes;
|
|
4225
4338
|
'links'?: ObjectLinks;
|
|
4226
4339
|
}
|
|
4227
4340
|
export type JsonApiCspDirectiveOutWithLinksTypeEnum = 'cspDirective';
|
|
@@ -4258,7 +4371,7 @@ export interface JsonApiCustomApplicationSettingIn {
|
|
|
4258
4371
|
* API identifier of an object
|
|
4259
4372
|
*/
|
|
4260
4373
|
'id': string;
|
|
4261
|
-
'attributes':
|
|
4374
|
+
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4262
4375
|
}
|
|
4263
4376
|
export type JsonApiCustomApplicationSettingInTypeEnum = 'customApplicationSetting';
|
|
4264
4377
|
export interface JsonApiCustomApplicationSettingInDocument {
|
|
@@ -4277,9 +4390,16 @@ export interface JsonApiCustomApplicationSettingOut {
|
|
|
4277
4390
|
*/
|
|
4278
4391
|
'id': string;
|
|
4279
4392
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
4280
|
-
'attributes':
|
|
4393
|
+
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4281
4394
|
}
|
|
4282
4395
|
export type JsonApiCustomApplicationSettingOutTypeEnum = 'customApplicationSetting';
|
|
4396
|
+
export interface JsonApiCustomApplicationSettingOutAttributes {
|
|
4397
|
+
'applicationName': string;
|
|
4398
|
+
/**
|
|
4399
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
4400
|
+
*/
|
|
4401
|
+
'content': object;
|
|
4402
|
+
}
|
|
4283
4403
|
export interface JsonApiCustomApplicationSettingOutDocument {
|
|
4284
4404
|
'data': JsonApiCustomApplicationSettingOut;
|
|
4285
4405
|
'links'?: ObjectLinks;
|
|
@@ -4302,7 +4422,7 @@ export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
4302
4422
|
*/
|
|
4303
4423
|
'id': string;
|
|
4304
4424
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
4305
|
-
'attributes':
|
|
4425
|
+
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4306
4426
|
'links'?: ObjectLinks;
|
|
4307
4427
|
}
|
|
4308
4428
|
export type JsonApiCustomApplicationSettingOutWithLinksTypeEnum = 'customApplicationSetting';
|
|
@@ -4343,16 +4463,9 @@ export interface JsonApiCustomApplicationSettingPostOptionalId {
|
|
|
4343
4463
|
* API identifier of an object
|
|
4344
4464
|
*/
|
|
4345
4465
|
'id'?: string;
|
|
4346
|
-
'attributes':
|
|
4466
|
+
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4347
4467
|
}
|
|
4348
4468
|
export type JsonApiCustomApplicationSettingPostOptionalIdTypeEnum = 'customApplicationSetting';
|
|
4349
|
-
export interface JsonApiCustomApplicationSettingPostOptionalIdAttributes {
|
|
4350
|
-
'applicationName': string;
|
|
4351
|
-
/**
|
|
4352
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
4353
|
-
*/
|
|
4354
|
-
'content': object;
|
|
4355
|
-
}
|
|
4356
4469
|
export interface JsonApiCustomApplicationSettingPostOptionalIdDocument {
|
|
4357
4470
|
'data': JsonApiCustomApplicationSettingPostOptionalId;
|
|
4358
4471
|
}
|
|
@@ -4368,13 +4481,9 @@ export interface JsonApiCustomGeoCollectionIn {
|
|
|
4368
4481
|
* API identifier of an object
|
|
4369
4482
|
*/
|
|
4370
4483
|
'id': string;
|
|
4371
|
-
'attributes'?:
|
|
4484
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4372
4485
|
}
|
|
4373
4486
|
export type JsonApiCustomGeoCollectionInTypeEnum = 'customGeoCollection';
|
|
4374
|
-
export interface JsonApiCustomGeoCollectionInAttributes {
|
|
4375
|
-
'name'?: string | null;
|
|
4376
|
-
'description'?: string | null;
|
|
4377
|
-
}
|
|
4378
4487
|
export interface JsonApiCustomGeoCollectionInDocument {
|
|
4379
4488
|
'data': JsonApiCustomGeoCollectionIn;
|
|
4380
4489
|
}
|
|
@@ -4390,9 +4499,13 @@ export interface JsonApiCustomGeoCollectionOut {
|
|
|
4390
4499
|
* API identifier of an object
|
|
4391
4500
|
*/
|
|
4392
4501
|
'id': string;
|
|
4393
|
-
'attributes'?:
|
|
4502
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4394
4503
|
}
|
|
4395
4504
|
export type JsonApiCustomGeoCollectionOutTypeEnum = 'customGeoCollection';
|
|
4505
|
+
export interface JsonApiCustomGeoCollectionOutAttributes {
|
|
4506
|
+
'name'?: string | null;
|
|
4507
|
+
'description'?: string | null;
|
|
4508
|
+
}
|
|
4396
4509
|
export interface JsonApiCustomGeoCollectionOutDocument {
|
|
4397
4510
|
'data': JsonApiCustomGeoCollectionOut;
|
|
4398
4511
|
'links'?: ObjectLinks;
|
|
@@ -4414,7 +4527,7 @@ export interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
|
4414
4527
|
* API identifier of an object
|
|
4415
4528
|
*/
|
|
4416
4529
|
'id': string;
|
|
4417
|
-
'attributes'?:
|
|
4530
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4418
4531
|
'links'?: ObjectLinks;
|
|
4419
4532
|
}
|
|
4420
4533
|
export type JsonApiCustomGeoCollectionOutWithLinksTypeEnum = 'customGeoCollection';
|
|
@@ -4430,7 +4543,7 @@ export interface JsonApiCustomGeoCollectionPatch {
|
|
|
4430
4543
|
* API identifier of an object
|
|
4431
4544
|
*/
|
|
4432
4545
|
'id': string;
|
|
4433
|
-
'attributes'?:
|
|
4546
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4434
4547
|
}
|
|
4435
4548
|
export type JsonApiCustomGeoCollectionPatchTypeEnum = 'customGeoCollection';
|
|
4436
4549
|
export interface JsonApiCustomGeoCollectionPatchDocument {
|
|
@@ -4700,7 +4813,7 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4700
4813
|
/**
|
|
4701
4814
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4702
4815
|
*/
|
|
4703
|
-
'parameters'?: Array<
|
|
4816
|
+
'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
|
|
4704
4817
|
/**
|
|
4705
4818
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4706
4819
|
*/
|
|
@@ -4712,6 +4825,10 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4712
4825
|
}
|
|
4713
4826
|
export type JsonApiDataSourceInAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
|
|
4714
4827
|
export type JsonApiDataSourceInAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4828
|
+
export interface JsonApiDataSourceInAttributesParametersInner {
|
|
4829
|
+
'name': string;
|
|
4830
|
+
'value': string;
|
|
4831
|
+
}
|
|
4715
4832
|
export interface JsonApiDataSourceInDocument {
|
|
4716
4833
|
'data': JsonApiDataSourceIn;
|
|
4717
4834
|
}
|
|
@@ -4759,11 +4876,11 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4759
4876
|
/**
|
|
4760
4877
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4761
4878
|
*/
|
|
4762
|
-
'parameters'?: Array<
|
|
4879
|
+
'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
|
|
4763
4880
|
/**
|
|
4764
4881
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
4765
4882
|
*/
|
|
4766
|
-
'decodedParameters'?: Array<
|
|
4883
|
+
'decodedParameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
|
|
4767
4884
|
/**
|
|
4768
4885
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4769
4886
|
*/
|
|
@@ -4780,10 +4897,6 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4780
4897
|
export type JsonApiDataSourceOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
|
|
4781
4898
|
export type JsonApiDataSourceOutAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4782
4899
|
export type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'ACCESS_TOKEN';
|
|
4783
|
-
export interface JsonApiDataSourceOutAttributesParametersInner {
|
|
4784
|
-
'name': string;
|
|
4785
|
-
'value': string;
|
|
4786
|
-
}
|
|
4787
4900
|
export interface JsonApiDataSourceOutDocument {
|
|
4788
4901
|
'data': JsonApiDataSourceOut;
|
|
4789
4902
|
'links'?: ObjectLinks;
|
|
@@ -4873,7 +4986,7 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
4873
4986
|
/**
|
|
4874
4987
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4875
4988
|
*/
|
|
4876
|
-
'parameters'?: Array<
|
|
4989
|
+
'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
|
|
4877
4990
|
/**
|
|
4878
4991
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4879
4992
|
*/
|
|
@@ -4931,7 +5044,7 @@ export interface JsonApiDatasetOutAttributes {
|
|
|
4931
5044
|
'workspaceDataFilterColumns'?: Array<JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner>;
|
|
4932
5045
|
'workspaceDataFilterReferences'?: Array<JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner>;
|
|
4933
5046
|
}
|
|
4934
|
-
export type JsonApiDatasetOutAttributesTypeEnum = 'NORMAL' | 'DATE';
|
|
5047
|
+
export type JsonApiDatasetOutAttributesTypeEnum = 'NORMAL' | 'DATE' | 'AUXILIARY';
|
|
4935
5048
|
export interface JsonApiDatasetOutAttributesGrainInner {
|
|
4936
5049
|
'id': string;
|
|
4937
5050
|
'type': JsonApiDatasetOutAttributesGrainInnerTypeEnum;
|
|
@@ -4944,7 +5057,7 @@ export interface JsonApiDatasetOutAttributesReferencePropertiesInner {
|
|
|
4944
5057
|
'sourceColumns'?: Array<string>;
|
|
4945
5058
|
'sourceColumnDataTypes'?: Array<JsonApiDatasetOutAttributesReferencePropertiesInnerSourceColumnDataTypesEnum>;
|
|
4946
5059
|
}
|
|
4947
|
-
export type JsonApiDatasetOutAttributesReferencePropertiesInnerSourceColumnDataTypesEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
5060
|
+
export type JsonApiDatasetOutAttributesReferencePropertiesInnerSourceColumnDataTypesEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
4948
5061
|
export interface JsonApiDatasetOutAttributesSql {
|
|
4949
5062
|
'statement': string;
|
|
4950
5063
|
'dataSourceId': string;
|
|
@@ -4953,7 +5066,7 @@ export interface JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInner {
|
|
|
4953
5066
|
'name': string;
|
|
4954
5067
|
'dataType': JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInnerDataTypeEnum;
|
|
4955
5068
|
}
|
|
4956
|
-
export type JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInnerDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
5069
|
+
export type JsonApiDatasetOutAttributesWorkspaceDataFilterColumnsInnerDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
4957
5070
|
/**
|
|
4958
5071
|
* Workspace data filter reference.
|
|
4959
5072
|
*/
|
|
@@ -4962,7 +5075,7 @@ export interface JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInner {
|
|
|
4962
5075
|
'filterColumn': string;
|
|
4963
5076
|
'filterColumnDataType': JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInnerFilterColumnDataTypeEnum;
|
|
4964
5077
|
}
|
|
4965
|
-
export type JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInnerFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
5078
|
+
export type JsonApiDatasetOutAttributesWorkspaceDataFilterReferencesInnerFilterColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
4966
5079
|
export interface JsonApiDatasetOutDocument {
|
|
4967
5080
|
'data': JsonApiDatasetOut;
|
|
4968
5081
|
'links'?: ObjectLinks;
|
|
@@ -5275,7 +5388,7 @@ export interface JsonApiExportTemplateIn {
|
|
|
5275
5388
|
* API identifier of an object
|
|
5276
5389
|
*/
|
|
5277
5390
|
'id': string;
|
|
5278
|
-
'attributes':
|
|
5391
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
5279
5392
|
}
|
|
5280
5393
|
export type JsonApiExportTemplateInTypeEnum = 'exportTemplate';
|
|
5281
5394
|
export interface JsonApiExportTemplateInDocument {
|
|
@@ -5293,9 +5406,42 @@ export interface JsonApiExportTemplateOut {
|
|
|
5293
5406
|
* API identifier of an object
|
|
5294
5407
|
*/
|
|
5295
5408
|
'id': string;
|
|
5296
|
-
'attributes':
|
|
5409
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
5297
5410
|
}
|
|
5298
5411
|
export type JsonApiExportTemplateOutTypeEnum = 'exportTemplate';
|
|
5412
|
+
export interface JsonApiExportTemplateOutAttributes {
|
|
5413
|
+
/**
|
|
5414
|
+
* User-facing name of the Slides template.
|
|
5415
|
+
*/
|
|
5416
|
+
'name': string;
|
|
5417
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5418
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5419
|
+
}
|
|
5420
|
+
/**
|
|
5421
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5422
|
+
*/
|
|
5423
|
+
export interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
5424
|
+
/**
|
|
5425
|
+
* Export types this template applies to.
|
|
5426
|
+
*/
|
|
5427
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5428
|
+
'coverSlide'?: CoverSlideTemplate | null;
|
|
5429
|
+
'introSlide'?: IntroSlideTemplate | null;
|
|
5430
|
+
'sectionSlide'?: SectionSlideTemplate | null;
|
|
5431
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
5432
|
+
}
|
|
5433
|
+
export type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5434
|
+
/**
|
|
5435
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5436
|
+
*/
|
|
5437
|
+
export interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
5438
|
+
/**
|
|
5439
|
+
* Export types this template applies to.
|
|
5440
|
+
*/
|
|
5441
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5442
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
5443
|
+
}
|
|
5444
|
+
export type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5299
5445
|
export interface JsonApiExportTemplateOutDocument {
|
|
5300
5446
|
'data': JsonApiExportTemplateOut;
|
|
5301
5447
|
'links'?: ObjectLinks;
|
|
@@ -5317,7 +5463,7 @@ export interface JsonApiExportTemplateOutWithLinks {
|
|
|
5317
5463
|
* API identifier of an object
|
|
5318
5464
|
*/
|
|
5319
5465
|
'id': string;
|
|
5320
|
-
'attributes':
|
|
5466
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
5321
5467
|
'links'?: ObjectLinks;
|
|
5322
5468
|
}
|
|
5323
5469
|
export type JsonApiExportTemplateOutWithLinksTypeEnum = 'exportTemplate';
|
|
@@ -5341,8 +5487,8 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
5341
5487
|
* User-facing name of the Slides template.
|
|
5342
5488
|
*/
|
|
5343
5489
|
'name'?: string;
|
|
5344
|
-
'dashboardSlidesTemplate'?:
|
|
5345
|
-
'widgetSlidesTemplate'?:
|
|
5490
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5491
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5346
5492
|
}
|
|
5347
5493
|
export interface JsonApiExportTemplatePatchDocument {
|
|
5348
5494
|
'data': JsonApiExportTemplatePatch;
|
|
@@ -5359,42 +5505,9 @@ export interface JsonApiExportTemplatePostOptionalId {
|
|
|
5359
5505
|
* API identifier of an object
|
|
5360
5506
|
*/
|
|
5361
5507
|
'id'?: string;
|
|
5362
|
-
'attributes':
|
|
5508
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
5363
5509
|
}
|
|
5364
5510
|
export type JsonApiExportTemplatePostOptionalIdTypeEnum = 'exportTemplate';
|
|
5365
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributes {
|
|
5366
|
-
/**
|
|
5367
|
-
* User-facing name of the Slides template.
|
|
5368
|
-
*/
|
|
5369
|
-
'name': string;
|
|
5370
|
-
'dashboardSlidesTemplate'?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
5371
|
-
'widgetSlidesTemplate'?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
5372
|
-
}
|
|
5373
|
-
/**
|
|
5374
|
-
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5375
|
-
*/
|
|
5376
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate {
|
|
5377
|
-
/**
|
|
5378
|
-
* Export types this template applies to.
|
|
5379
|
-
*/
|
|
5380
|
-
'appliedOn': Array<JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5381
|
-
'coverSlide'?: CoverSlideTemplate | null;
|
|
5382
|
-
'introSlide'?: IntroSlideTemplate | null;
|
|
5383
|
-
'sectionSlide'?: SectionSlideTemplate | null;
|
|
5384
|
-
'contentSlide'?: ContentSlideTemplate | null;
|
|
5385
|
-
}
|
|
5386
|
-
export type JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5387
|
-
/**
|
|
5388
|
-
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5389
|
-
*/
|
|
5390
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate {
|
|
5391
|
-
/**
|
|
5392
|
-
* Export types this template applies to.
|
|
5393
|
-
*/
|
|
5394
|
-
'appliedOn': Array<JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5395
|
-
'contentSlide'?: ContentSlideTemplate | null;
|
|
5396
|
-
}
|
|
5397
|
-
export type JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5398
5511
|
export interface JsonApiExportTemplatePostOptionalIdDocument {
|
|
5399
5512
|
'data': JsonApiExportTemplatePostOptionalId;
|
|
5400
5513
|
}
|
|
@@ -5434,7 +5547,7 @@ export interface JsonApiFactOutAttributes {
|
|
|
5434
5547
|
'isNullable'?: boolean;
|
|
5435
5548
|
'nullValue'?: string;
|
|
5436
5549
|
}
|
|
5437
|
-
export type JsonApiFactOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
5550
|
+
export type JsonApiFactOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
5438
5551
|
export interface JsonApiFactOutDocument {
|
|
5439
5552
|
'data': JsonApiFactOut;
|
|
5440
5553
|
'links'?: ObjectLinks;
|
|
@@ -6379,7 +6492,7 @@ export interface JsonApiLabelOutAttributes {
|
|
|
6379
6492
|
'isNullable'?: boolean;
|
|
6380
6493
|
'nullValue'?: string;
|
|
6381
6494
|
}
|
|
6382
|
-
export type JsonApiLabelOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
6495
|
+
export type JsonApiLabelOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
6383
6496
|
export type JsonApiLabelOutAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
6384
6497
|
/**
|
|
6385
6498
|
* Configuration specific to geo area labels.
|
|
@@ -6624,10 +6737,28 @@ export interface JsonApiLlmProviderIn {
|
|
|
6624
6737
|
* API identifier of an object
|
|
6625
6738
|
*/
|
|
6626
6739
|
'id': string;
|
|
6627
|
-
'attributes'?:
|
|
6740
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
6628
6741
|
}
|
|
6629
6742
|
export type JsonApiLlmProviderInTypeEnum = 'llmProvider';
|
|
6630
|
-
export interface
|
|
6743
|
+
export interface JsonApiLlmProviderInDocument {
|
|
6744
|
+
'data': JsonApiLlmProviderIn;
|
|
6745
|
+
}
|
|
6746
|
+
/**
|
|
6747
|
+
* LLM Provider configuration for connecting to LLM services.
|
|
6748
|
+
*/
|
|
6749
|
+
export interface JsonApiLlmProviderOut {
|
|
6750
|
+
/**
|
|
6751
|
+
* Object type
|
|
6752
|
+
*/
|
|
6753
|
+
'type': JsonApiLlmProviderOutTypeEnum;
|
|
6754
|
+
/**
|
|
6755
|
+
* API identifier of an object
|
|
6756
|
+
*/
|
|
6757
|
+
'id': string;
|
|
6758
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
6759
|
+
}
|
|
6760
|
+
export type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
|
|
6761
|
+
export interface JsonApiLlmProviderOutAttributes {
|
|
6631
6762
|
'name'?: string | null;
|
|
6632
6763
|
/**
|
|
6633
6764
|
* Description of the LLM Provider.
|
|
@@ -6637,16 +6768,16 @@ export interface JsonApiLlmProviderInAttributes {
|
|
|
6637
6768
|
* Required ID of the default model to use from the models list.
|
|
6638
6769
|
*/
|
|
6639
6770
|
'defaultModelId'?: string | null;
|
|
6640
|
-
'providerConfig'?:
|
|
6771
|
+
'providerConfig'?: JsonApiLlmProviderOutAttributesProviderConfig | null;
|
|
6641
6772
|
/**
|
|
6642
6773
|
* List of LLM models available for this provider.
|
|
6643
6774
|
*/
|
|
6644
|
-
'models'?: Array<
|
|
6775
|
+
'models'?: Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
6645
6776
|
}
|
|
6646
6777
|
/**
|
|
6647
6778
|
* LLM Model configuration (id, family) within a provider.
|
|
6648
6779
|
*/
|
|
6649
|
-
export interface
|
|
6780
|
+
export interface JsonApiLlmProviderOutAttributesModelsInner {
|
|
6650
6781
|
/**
|
|
6651
6782
|
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
6652
6783
|
*/
|
|
@@ -6654,32 +6785,14 @@ export interface JsonApiLlmProviderInAttributesModelsInner {
|
|
|
6654
6785
|
/**
|
|
6655
6786
|
* Family of LLM models.
|
|
6656
6787
|
*/
|
|
6657
|
-
'family':
|
|
6788
|
+
'family': JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum;
|
|
6658
6789
|
}
|
|
6659
|
-
export type
|
|
6790
|
+
export type JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE' | 'UNKNOWN';
|
|
6660
6791
|
/**
|
|
6661
|
-
* @type
|
|
6792
|
+
* @type JsonApiLlmProviderOutAttributesProviderConfig
|
|
6662
6793
|
* Provider-specific configuration including authentication.
|
|
6663
6794
|
*/
|
|
6664
|
-
export type
|
|
6665
|
-
export interface JsonApiLlmProviderInDocument {
|
|
6666
|
-
'data': JsonApiLlmProviderIn;
|
|
6667
|
-
}
|
|
6668
|
-
/**
|
|
6669
|
-
* LLM Provider configuration for connecting to LLM services.
|
|
6670
|
-
*/
|
|
6671
|
-
export interface JsonApiLlmProviderOut {
|
|
6672
|
-
/**
|
|
6673
|
-
* Object type
|
|
6674
|
-
*/
|
|
6675
|
-
'type': JsonApiLlmProviderOutTypeEnum;
|
|
6676
|
-
/**
|
|
6677
|
-
* API identifier of an object
|
|
6678
|
-
*/
|
|
6679
|
-
'id': string;
|
|
6680
|
-
'attributes'?: JsonApiLlmProviderInAttributes;
|
|
6681
|
-
}
|
|
6682
|
-
export type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
|
|
6795
|
+
export type JsonApiLlmProviderOutAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
6683
6796
|
export interface JsonApiLlmProviderOutDocument {
|
|
6684
6797
|
'data': JsonApiLlmProviderOut;
|
|
6685
6798
|
'links'?: ObjectLinks;
|
|
@@ -6701,7 +6814,7 @@ export interface JsonApiLlmProviderOutWithLinks {
|
|
|
6701
6814
|
* API identifier of an object
|
|
6702
6815
|
*/
|
|
6703
6816
|
'id': string;
|
|
6704
|
-
'attributes'?:
|
|
6817
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
6705
6818
|
'links'?: ObjectLinks;
|
|
6706
6819
|
}
|
|
6707
6820
|
export type JsonApiLlmProviderOutWithLinksTypeEnum = 'llmProvider';
|
|
@@ -6717,7 +6830,7 @@ export interface JsonApiLlmProviderPatch {
|
|
|
6717
6830
|
* API identifier of an object
|
|
6718
6831
|
*/
|
|
6719
6832
|
'id': string;
|
|
6720
|
-
'attributes'?:
|
|
6833
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
6721
6834
|
}
|
|
6722
6835
|
export type JsonApiLlmProviderPatchTypeEnum = 'llmProvider';
|
|
6723
6836
|
export interface JsonApiLlmProviderPatchDocument {
|
|
@@ -7002,7 +7115,7 @@ export interface JsonApiMetricOutDocument {
|
|
|
7002
7115
|
/**
|
|
7003
7116
|
* @type JsonApiMetricOutIncludes
|
|
7004
7117
|
*/
|
|
7005
|
-
export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
7118
|
+
export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
7006
7119
|
/**
|
|
7007
7120
|
* A JSON:API document with a list of resources
|
|
7008
7121
|
*/
|
|
@@ -7024,6 +7137,13 @@ export interface JsonApiMetricOutRelationships {
|
|
|
7024
7137
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
7025
7138
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
7026
7139
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
7140
|
+
'parameters'?: JsonApiMetricOutRelationshipsParameters;
|
|
7141
|
+
}
|
|
7142
|
+
export interface JsonApiMetricOutRelationshipsParameters {
|
|
7143
|
+
/**
|
|
7144
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7145
|
+
*/
|
|
7146
|
+
'data': Array<JsonApiParameterLinkage>;
|
|
7027
7147
|
}
|
|
7028
7148
|
export interface JsonApiMetricOutWithLinks {
|
|
7029
7149
|
/**
|
|
@@ -7189,7 +7309,7 @@ export type JsonApiNotificationChannelOutTypeEnum = 'notificationChannel';
|
|
|
7189
7309
|
export interface JsonApiNotificationChannelOutAttributes {
|
|
7190
7310
|
'name'?: string | null;
|
|
7191
7311
|
'description'?: string | null;
|
|
7192
|
-
'destination'?:
|
|
7312
|
+
'destination'?: JsonApiNotificationChannelPostOptionalIdAttributesDestination;
|
|
7193
7313
|
'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
|
|
7194
7314
|
/**
|
|
7195
7315
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
@@ -7216,11 +7336,6 @@ export type JsonApiNotificationChannelOutAttributesDestinationTypeEnum = 'WEBHOO
|
|
|
7216
7336
|
export type JsonApiNotificationChannelOutAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
7217
7337
|
export type JsonApiNotificationChannelOutAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
7218
7338
|
export type JsonApiNotificationChannelOutAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
7219
|
-
/**
|
|
7220
|
-
* @type JsonApiNotificationChannelOutAttributesDestination
|
|
7221
|
-
* The destination where the notifications are to be sent.
|
|
7222
|
-
*/
|
|
7223
|
-
export type JsonApiNotificationChannelOutAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
7224
7339
|
export interface JsonApiNotificationChannelOutDocument {
|
|
7225
7340
|
'data': JsonApiNotificationChannelOut;
|
|
7226
7341
|
'links'?: ObjectLinks;
|
|
@@ -7282,7 +7397,7 @@ export type JsonApiNotificationChannelPostOptionalIdTypeEnum = 'notificationChan
|
|
|
7282
7397
|
export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
7283
7398
|
'name'?: string | null;
|
|
7284
7399
|
'description'?: string | null;
|
|
7285
|
-
'destination'?:
|
|
7400
|
+
'destination'?: JsonApiNotificationChannelPostOptionalIdAttributesDestination;
|
|
7286
7401
|
/**
|
|
7287
7402
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
7288
7403
|
*/
|
|
@@ -7307,6 +7422,11 @@ export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
|
7307
7422
|
export type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
7308
7423
|
export type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
7309
7424
|
export type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
7425
|
+
/**
|
|
7426
|
+
* @type JsonApiNotificationChannelPostOptionalIdAttributesDestination
|
|
7427
|
+
* The destination where the notifications are to be sent.
|
|
7428
|
+
*/
|
|
7429
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
7310
7430
|
export interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
7311
7431
|
'data': JsonApiNotificationChannelPostOptionalId;
|
|
7312
7432
|
}
|
|
@@ -7455,9 +7575,17 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
7455
7575
|
* API identifier of an object
|
|
7456
7576
|
*/
|
|
7457
7577
|
'id': string;
|
|
7458
|
-
'attributes'?:
|
|
7578
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
7459
7579
|
}
|
|
7460
7580
|
export type JsonApiOrganizationSettingInTypeEnum = 'organizationSetting';
|
|
7581
|
+
export interface JsonApiOrganizationSettingInAttributes {
|
|
7582
|
+
/**
|
|
7583
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7584
|
+
*/
|
|
7585
|
+
'content'?: object;
|
|
7586
|
+
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
7587
|
+
}
|
|
7588
|
+
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
7461
7589
|
export interface JsonApiOrganizationSettingInDocument {
|
|
7462
7590
|
'data': JsonApiOrganizationSettingIn;
|
|
7463
7591
|
}
|
|
@@ -7473,17 +7601,9 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
7473
7601
|
* API identifier of an object
|
|
7474
7602
|
*/
|
|
7475
7603
|
'id': string;
|
|
7476
|
-
'attributes'?:
|
|
7604
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
7477
7605
|
}
|
|
7478
7606
|
export type JsonApiOrganizationSettingOutTypeEnum = 'organizationSetting';
|
|
7479
|
-
export interface JsonApiOrganizationSettingOutAttributes {
|
|
7480
|
-
/**
|
|
7481
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7482
|
-
*/
|
|
7483
|
-
'content'?: object;
|
|
7484
|
-
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
7485
|
-
}
|
|
7486
|
-
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
7487
7607
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
7488
7608
|
'data': JsonApiOrganizationSettingOut;
|
|
7489
7609
|
'links'?: ObjectLinks;
|
|
@@ -7505,7 +7625,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
7505
7625
|
* API identifier of an object
|
|
7506
7626
|
*/
|
|
7507
7627
|
'id': string;
|
|
7508
|
-
'attributes'?:
|
|
7628
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
7509
7629
|
'links'?: ObjectLinks;
|
|
7510
7630
|
}
|
|
7511
7631
|
export type JsonApiOrganizationSettingOutWithLinksTypeEnum = 'organizationSetting';
|
|
@@ -7521,7 +7641,7 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
7521
7641
|
* API identifier of an object
|
|
7522
7642
|
*/
|
|
7523
7643
|
'id': string;
|
|
7524
|
-
'attributes'?:
|
|
7644
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
7525
7645
|
}
|
|
7526
7646
|
export type JsonApiOrganizationSettingPatchTypeEnum = 'organizationSetting';
|
|
7527
7647
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -7545,6 +7665,14 @@ export type JsonApiParameterInTypeEnum = 'parameter';
|
|
|
7545
7665
|
export interface JsonApiParameterInDocument {
|
|
7546
7666
|
'data': JsonApiParameterIn;
|
|
7547
7667
|
}
|
|
7668
|
+
/**
|
|
7669
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
7670
|
+
*/
|
|
7671
|
+
export interface JsonApiParameterLinkage {
|
|
7672
|
+
'id': string;
|
|
7673
|
+
'type': JsonApiParameterLinkageTypeEnum;
|
|
7674
|
+
}
|
|
7675
|
+
export type JsonApiParameterLinkageTypeEnum = 'parameter';
|
|
7548
7676
|
/**
|
|
7549
7677
|
* JSON:API representation of parameter entity.
|
|
7550
7678
|
*/
|
|
@@ -7792,7 +7920,7 @@ export interface JsonApiUserDataFilterOutDocument {
|
|
|
7792
7920
|
/**
|
|
7793
7921
|
* @type JsonApiUserDataFilterOutIncludes
|
|
7794
7922
|
*/
|
|
7795
|
-
export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
7923
|
+
export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
7796
7924
|
/**
|
|
7797
7925
|
* A JSON:API document with a list of resources
|
|
7798
7926
|
*/
|
|
@@ -7813,6 +7941,7 @@ export interface JsonApiUserDataFilterOutRelationships {
|
|
|
7813
7941
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
7814
7942
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
7815
7943
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
7944
|
+
'parameters'?: JsonApiMetricOutRelationshipsParameters;
|
|
7816
7945
|
}
|
|
7817
7946
|
export interface JsonApiUserDataFilterOutWithLinks {
|
|
7818
7947
|
/**
|
|
@@ -8156,7 +8285,7 @@ export interface JsonApiUserSettingIn {
|
|
|
8156
8285
|
* API identifier of an object
|
|
8157
8286
|
*/
|
|
8158
8287
|
'id': string;
|
|
8159
|
-
'attributes'?:
|
|
8288
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8160
8289
|
}
|
|
8161
8290
|
export type JsonApiUserSettingInTypeEnum = 'userSetting';
|
|
8162
8291
|
export interface JsonApiUserSettingInDocument {
|
|
@@ -8174,7 +8303,7 @@ export interface JsonApiUserSettingOut {
|
|
|
8174
8303
|
* API identifier of an object
|
|
8175
8304
|
*/
|
|
8176
8305
|
'id': string;
|
|
8177
|
-
'attributes'?:
|
|
8306
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8178
8307
|
}
|
|
8179
8308
|
export type JsonApiUserSettingOutTypeEnum = 'userSetting';
|
|
8180
8309
|
export interface JsonApiUserSettingOutDocument {
|
|
@@ -8198,7 +8327,7 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
8198
8327
|
* API identifier of an object
|
|
8199
8328
|
*/
|
|
8200
8329
|
'id': string;
|
|
8201
|
-
'attributes'?:
|
|
8330
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8202
8331
|
'links'?: ObjectLinks;
|
|
8203
8332
|
}
|
|
8204
8333
|
export type JsonApiUserSettingOutWithLinksTypeEnum = 'userSetting';
|
|
@@ -8242,7 +8371,7 @@ export interface JsonApiVisualizationObjectOut {
|
|
|
8242
8371
|
'id': string;
|
|
8243
8372
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
8244
8373
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
8245
|
-
'relationships'?:
|
|
8374
|
+
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
8246
8375
|
}
|
|
8247
8376
|
export type JsonApiVisualizationObjectOutTypeEnum = 'visualizationObject';
|
|
8248
8377
|
export interface JsonApiVisualizationObjectOutAttributes {
|
|
@@ -8283,8 +8412,12 @@ export interface JsonApiVisualizationObjectOutDocument {
|
|
|
8283
8412
|
/**
|
|
8284
8413
|
* Included resources
|
|
8285
8414
|
*/
|
|
8286
|
-
'included'?: Array<
|
|
8415
|
+
'included'?: Array<JsonApiVisualizationObjectOutIncludes>;
|
|
8287
8416
|
}
|
|
8417
|
+
/**
|
|
8418
|
+
* @type JsonApiVisualizationObjectOutIncludes
|
|
8419
|
+
*/
|
|
8420
|
+
export type JsonApiVisualizationObjectOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
8288
8421
|
/**
|
|
8289
8422
|
* A JSON:API document with a list of resources
|
|
8290
8423
|
*/
|
|
@@ -8295,7 +8428,17 @@ export interface JsonApiVisualizationObjectOutList {
|
|
|
8295
8428
|
/**
|
|
8296
8429
|
* Included resources
|
|
8297
8430
|
*/
|
|
8298
|
-
'included'?: Array<
|
|
8431
|
+
'included'?: Array<JsonApiVisualizationObjectOutIncludes>;
|
|
8432
|
+
}
|
|
8433
|
+
export interface JsonApiVisualizationObjectOutRelationships {
|
|
8434
|
+
'createdBy'?: JsonApiAgentOutRelationshipsCreatedBy;
|
|
8435
|
+
'modifiedBy'?: JsonApiAgentOutRelationshipsCreatedBy;
|
|
8436
|
+
'certifiedBy'?: JsonApiAgentOutRelationshipsCreatedBy;
|
|
8437
|
+
'facts'?: JsonApiDatasetOutRelationshipsFacts;
|
|
8438
|
+
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
8439
|
+
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
8440
|
+
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
8441
|
+
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
8299
8442
|
}
|
|
8300
8443
|
export interface JsonApiVisualizationObjectOutWithLinks {
|
|
8301
8444
|
/**
|
|
@@ -8308,7 +8451,7 @@ export interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
8308
8451
|
'id': string;
|
|
8309
8452
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
8310
8453
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
8311
|
-
'relationships'?:
|
|
8454
|
+
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
8312
8455
|
'links'?: ObjectLinks;
|
|
8313
8456
|
}
|
|
8314
8457
|
export type JsonApiVisualizationObjectOutWithLinksTypeEnum = 'visualizationObject';
|
|
@@ -8951,7 +9094,7 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
8951
9094
|
* API identifier of an object
|
|
8952
9095
|
*/
|
|
8953
9096
|
'id': string;
|
|
8954
|
-
'attributes'?:
|
|
9097
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8955
9098
|
}
|
|
8956
9099
|
export type JsonApiWorkspaceSettingInTypeEnum = 'workspaceSetting';
|
|
8957
9100
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -8970,7 +9113,7 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
8970
9113
|
*/
|
|
8971
9114
|
'id': string;
|
|
8972
9115
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
8973
|
-
'attributes'?:
|
|
9116
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8974
9117
|
}
|
|
8975
9118
|
export type JsonApiWorkspaceSettingOutTypeEnum = 'workspaceSetting';
|
|
8976
9119
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
@@ -8995,7 +9138,7 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
8995
9138
|
*/
|
|
8996
9139
|
'id': string;
|
|
8997
9140
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
8998
|
-
'attributes'?:
|
|
9141
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
8999
9142
|
'links'?: ObjectLinks;
|
|
9000
9143
|
}
|
|
9001
9144
|
export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = 'workspaceSetting';
|
|
@@ -9011,7 +9154,7 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
9011
9154
|
* API identifier of an object
|
|
9012
9155
|
*/
|
|
9013
9156
|
'id': string;
|
|
9014
|
-
'attributes'?:
|
|
9157
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
9015
9158
|
}
|
|
9016
9159
|
export type JsonApiWorkspaceSettingPatchTypeEnum = 'workspaceSetting';
|
|
9017
9160
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -9029,7 +9172,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
9029
9172
|
* API identifier of an object
|
|
9030
9173
|
*/
|
|
9031
9174
|
'id'?: string;
|
|
9032
|
-
'attributes'?:
|
|
9175
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
9033
9176
|
}
|
|
9034
9177
|
export type JsonApiWorkspaceSettingPostOptionalIdTypeEnum = 'workspaceSetting';
|
|
9035
9178
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -9292,6 +9435,16 @@ export interface Parameter {
|
|
|
9292
9435
|
'name': string;
|
|
9293
9436
|
'value': string;
|
|
9294
9437
|
}
|
|
9438
|
+
/**
|
|
9439
|
+
* (EXPERIMENTAL) Parameter value for this execution.
|
|
9440
|
+
*/
|
|
9441
|
+
export interface ParameterItem {
|
|
9442
|
+
'parameter': AfmObjectIdentifierParameter;
|
|
9443
|
+
/**
|
|
9444
|
+
* Value to use for this parameter instead of its default.
|
|
9445
|
+
*/
|
|
9446
|
+
'value': string;
|
|
9447
|
+
}
|
|
9295
9448
|
/**
|
|
9296
9449
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
9297
9450
|
*/
|
|
@@ -9601,7 +9754,7 @@ export interface ReferenceSourceColumn {
|
|
|
9601
9754
|
'isNullable'?: boolean;
|
|
9602
9755
|
'nullValue'?: string;
|
|
9603
9756
|
}
|
|
9604
|
-
export type ReferenceSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
9757
|
+
export type ReferenceSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
9605
9758
|
export interface Relative {
|
|
9606
9759
|
/**
|
|
9607
9760
|
* Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value.
|
|
@@ -9930,7 +10083,7 @@ export interface SqlColumn {
|
|
|
9930
10083
|
*/
|
|
9931
10084
|
'dataType': SqlColumnDataTypeEnum;
|
|
9932
10085
|
}
|
|
9933
|
-
export type SqlColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN';
|
|
10086
|
+
export type SqlColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
9934
10087
|
export interface SwitchIdentityProviderRequest {
|
|
9935
10088
|
/**
|
|
9936
10089
|
* Identity provider ID to set as active for the organization.
|
|
@@ -9950,6 +10103,19 @@ export interface TableOverride {
|
|
|
9950
10103
|
*/
|
|
9951
10104
|
'path': Array<string>;
|
|
9952
10105
|
}
|
|
10106
|
+
export interface TableStatisticsEntry {
|
|
10107
|
+
'schemaName': string;
|
|
10108
|
+
'tableName': string;
|
|
10109
|
+
/**
|
|
10110
|
+
* Total number of rows in the table.
|
|
10111
|
+
*/
|
|
10112
|
+
'rowCount'?: number;
|
|
10113
|
+
/**
|
|
10114
|
+
* Total data size of the table in bytes.
|
|
10115
|
+
*/
|
|
10116
|
+
'dataSize'?: number;
|
|
10117
|
+
'columns': Array<ColumnStatisticsEntry>;
|
|
10118
|
+
}
|
|
9953
10119
|
/**
|
|
9954
10120
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
9955
10121
|
*/
|
|
@@ -24747,13 +24913,13 @@ export declare class DashboardsApi extends BaseAPI implements DashboardsApiInter
|
|
|
24747
24913
|
* @summary Post User Data Filters
|
|
24748
24914
|
* @param {string} workspaceId
|
|
24749
24915
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
24750
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24916
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24751
24917
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24752
24918
|
* @param {*} [options] Override http request option.
|
|
24753
24919
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24754
24920
|
* @throws {RequiredError}
|
|
24755
24921
|
*/
|
|
24756
|
-
export declare function DataFiltersApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24922
|
+
export declare function DataFiltersApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24757
24923
|
/**
|
|
24758
24924
|
*
|
|
24759
24925
|
* @summary Post Settings for Workspace Data Filters
|
|
@@ -24814,7 +24980,7 @@ export declare function DataFiltersApiAxiosParamCreator_DeleteEntityWorkspaceDat
|
|
|
24814
24980
|
* @param {string} workspaceId
|
|
24815
24981
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
24816
24982
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24817
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24983
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24818
24984
|
* @param {number} [page] Zero-based page index (0..N)
|
|
24819
24985
|
* @param {number} [size] The size of the page to be returned
|
|
24820
24986
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -24824,7 +24990,7 @@ export declare function DataFiltersApiAxiosParamCreator_DeleteEntityWorkspaceDat
|
|
|
24824
24990
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24825
24991
|
* @throws {RequiredError}
|
|
24826
24992
|
*/
|
|
24827
|
-
export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24993
|
+
export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24828
24994
|
/**
|
|
24829
24995
|
*
|
|
24830
24996
|
* @summary Get all Settings for Workspace Data Filters
|
|
@@ -24865,14 +25031,14 @@ export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesWorkspaceD
|
|
|
24865
25031
|
* @param {string} workspaceId
|
|
24866
25032
|
* @param {string} objectId
|
|
24867
25033
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24868
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25034
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24869
25035
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24870
25036
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24871
25037
|
* @param {*} [options] Override http request option.
|
|
24872
25038
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24873
25039
|
* @throws {RequiredError}
|
|
24874
25040
|
*/
|
|
24875
|
-
export declare function DataFiltersApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
25041
|
+
export declare function DataFiltersApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24876
25042
|
/**
|
|
24877
25043
|
*
|
|
24878
25044
|
* @summary Get a Setting for Workspace Data Filter
|
|
@@ -24916,12 +25082,12 @@ export declare function DataFiltersApiAxiosParamCreator_GetWorkspaceDataFiltersL
|
|
|
24916
25082
|
* @param {string} objectId
|
|
24917
25083
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
24918
25084
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24919
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25085
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24920
25086
|
* @param {*} [options] Override http request option.
|
|
24921
25087
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24922
25088
|
* @throws {RequiredError}
|
|
24923
25089
|
*/
|
|
24924
|
-
export declare function DataFiltersApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
25090
|
+
export declare function DataFiltersApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
24925
25091
|
/**
|
|
24926
25092
|
*
|
|
24927
25093
|
* @summary Patch a Settings for Workspace Data Filter
|
|
@@ -25000,12 +25166,12 @@ export declare function DataFiltersApiAxiosParamCreator_SetWorkspaceDataFiltersL
|
|
|
25000
25166
|
* @param {string} objectId
|
|
25001
25167
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
25002
25168
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
25003
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25169
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25004
25170
|
* @param {*} [options] Override http request option.
|
|
25005
25171
|
* @param {Configuration} [configuration] Optional configuration.
|
|
25006
25172
|
* @throws {RequiredError}
|
|
25007
25173
|
*/
|
|
25008
|
-
export declare function DataFiltersApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
25174
|
+
export declare function DataFiltersApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
25009
25175
|
/**
|
|
25010
25176
|
*
|
|
25011
25177
|
* @summary Put a Settings for Workspace Data Filter
|
|
@@ -25517,10 +25683,10 @@ export interface DataFiltersApiCreateEntityUserDataFiltersRequest {
|
|
|
25517
25683
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
25518
25684
|
/**
|
|
25519
25685
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25520
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
25686
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
25521
25687
|
* @memberof DataFiltersApiCreateEntityUserDataFilters
|
|
25522
25688
|
*/
|
|
25523
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
25689
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
25524
25690
|
/**
|
|
25525
25691
|
* Include Meta objects.
|
|
25526
25692
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -25673,10 +25839,10 @@ export interface DataFiltersApiGetAllEntitiesUserDataFiltersRequest {
|
|
|
25673
25839
|
readonly filter?: string;
|
|
25674
25840
|
/**
|
|
25675
25841
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25676
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
25842
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
25677
25843
|
* @memberof DataFiltersApiGetAllEntitiesUserDataFilters
|
|
25678
25844
|
*/
|
|
25679
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
25845
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
25680
25846
|
/**
|
|
25681
25847
|
* Zero-based page index (0..N)
|
|
25682
25848
|
* @type {number}
|
|
@@ -25856,10 +26022,10 @@ export interface DataFiltersApiGetEntityUserDataFiltersRequest {
|
|
|
25856
26022
|
readonly filter?: string;
|
|
25857
26023
|
/**
|
|
25858
26024
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25859
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
26025
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
25860
26026
|
* @memberof DataFiltersApiGetEntityUserDataFilters
|
|
25861
26027
|
*/
|
|
25862
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
26028
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
25863
26029
|
/**
|
|
25864
26030
|
*
|
|
25865
26031
|
* @type {boolean}
|
|
@@ -25991,10 +26157,10 @@ export interface DataFiltersApiPatchEntityUserDataFiltersRequest {
|
|
|
25991
26157
|
readonly filter?: string;
|
|
25992
26158
|
/**
|
|
25993
26159
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25994
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
26160
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
25995
26161
|
* @memberof DataFiltersApiPatchEntityUserDataFilters
|
|
25996
26162
|
*/
|
|
25997
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
26163
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
25998
26164
|
}
|
|
25999
26165
|
/**
|
|
26000
26166
|
* Request parameters for patchEntityWorkspaceDataFilterSettings operation in DataFiltersApi.
|
|
@@ -26208,10 +26374,10 @@ export interface DataFiltersApiUpdateEntityUserDataFiltersRequest {
|
|
|
26208
26374
|
readonly filter?: string;
|
|
26209
26375
|
/**
|
|
26210
26376
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
26211
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
26377
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
26212
26378
|
* @memberof DataFiltersApiUpdateEntityUserDataFilters
|
|
26213
26379
|
*/
|
|
26214
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
26380
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
26215
26381
|
}
|
|
26216
26382
|
/**
|
|
26217
26383
|
* Request parameters for updateEntityWorkspaceDataFilterSettings operation in DataFiltersApi.
|
|
@@ -27700,6 +27866,195 @@ export declare class DataSourceIdentifierControllerApi extends BaseAPI implement
|
|
|
27700
27866
|
*/
|
|
27701
27867
|
getEntityDataSourceIdentifiers(requestParameters: DataSourceIdentifierControllerApiGetEntityDataSourceIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceIdentifierOutDocument>;
|
|
27702
27868
|
}
|
|
27869
|
+
/**
|
|
27870
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
27871
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
27872
|
+
* @param {string} dataSourceId
|
|
27873
|
+
* @param {*} [options] Override http request option.
|
|
27874
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27875
|
+
* @throws {RequiredError}
|
|
27876
|
+
*/
|
|
27877
|
+
export declare function DataSourceStatisticsApiAxiosParamCreator_DeleteDataSourceStatistics(dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
27878
|
+
/**
|
|
27879
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
27880
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
27881
|
+
* @param {string} dataSourceId
|
|
27882
|
+
* @param {string} [schemaName]
|
|
27883
|
+
* @param {string} [tableName]
|
|
27884
|
+
* @param {*} [options] Override http request option.
|
|
27885
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27886
|
+
* @throws {RequiredError}
|
|
27887
|
+
*/
|
|
27888
|
+
export declare function DataSourceStatisticsApiAxiosParamCreator_GetDataSourceStatistics(dataSourceId: string, schemaName?: string, tableName?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
27889
|
+
/**
|
|
27890
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
27891
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
27892
|
+
* @param {string} dataSourceId
|
|
27893
|
+
* @param {DataSourceStatisticsRequest} dataSourceStatisticsRequest
|
|
27894
|
+
* @param {*} [options] Override http request option.
|
|
27895
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27896
|
+
* @throws {RequiredError}
|
|
27897
|
+
*/
|
|
27898
|
+
export declare function DataSourceStatisticsApiAxiosParamCreator_PutDataSourceStatistics(dataSourceId: string, dataSourceStatisticsRequest: DataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
27899
|
+
/**
|
|
27900
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
27901
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
27902
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
27903
|
+
* @param {string} basePath Base path.
|
|
27904
|
+
* @param {DataSourceStatisticsApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27905
|
+
* @param {*} [options] Override http request option.
|
|
27906
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27907
|
+
* @throws {RequiredError}
|
|
27908
|
+
*/
|
|
27909
|
+
export declare function DataSourceStatisticsApi_DeleteDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: DataSourceStatisticsApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
27910
|
+
/**
|
|
27911
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
27912
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
27913
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
27914
|
+
* @param {string} basePath Base path.
|
|
27915
|
+
* @param {DataSourceStatisticsApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27916
|
+
* @param {*} [options] Override http request option.
|
|
27917
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27918
|
+
* @throws {RequiredError}
|
|
27919
|
+
*/
|
|
27920
|
+
export declare function DataSourceStatisticsApi_GetDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: DataSourceStatisticsApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DataSourceStatisticsResponse>;
|
|
27921
|
+
/**
|
|
27922
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
27923
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
27924
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
27925
|
+
* @param {string} basePath Base path.
|
|
27926
|
+
* @param {DataSourceStatisticsApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27927
|
+
* @param {*} [options] Override http request option.
|
|
27928
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
27929
|
+
* @throws {RequiredError}
|
|
27930
|
+
*/
|
|
27931
|
+
export declare function DataSourceStatisticsApi_PutDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: DataSourceStatisticsApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
27932
|
+
/**
|
|
27933
|
+
* DataSourceStatisticsApi - interface
|
|
27934
|
+
* @export
|
|
27935
|
+
* @interface DataSourceStatisticsApi
|
|
27936
|
+
*/
|
|
27937
|
+
export interface DataSourceStatisticsApiInterface {
|
|
27938
|
+
/**
|
|
27939
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
27940
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
27941
|
+
* @param {DataSourceStatisticsApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27942
|
+
* @param {*} [options] Override http request option.
|
|
27943
|
+
* @throws {RequiredError}
|
|
27944
|
+
* @memberof DataSourceStatisticsApiInterface
|
|
27945
|
+
*/
|
|
27946
|
+
deleteDataSourceStatistics(requestParameters: DataSourceStatisticsApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
27947
|
+
/**
|
|
27948
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
27949
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
27950
|
+
* @param {DataSourceStatisticsApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27951
|
+
* @param {*} [options] Override http request option.
|
|
27952
|
+
* @throws {RequiredError}
|
|
27953
|
+
* @memberof DataSourceStatisticsApiInterface
|
|
27954
|
+
*/
|
|
27955
|
+
getDataSourceStatistics(requestParameters: DataSourceStatisticsApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<DataSourceStatisticsResponse>;
|
|
27956
|
+
/**
|
|
27957
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
27958
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
27959
|
+
* @param {DataSourceStatisticsApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
27960
|
+
* @param {*} [options] Override http request option.
|
|
27961
|
+
* @throws {RequiredError}
|
|
27962
|
+
* @memberof DataSourceStatisticsApiInterface
|
|
27963
|
+
*/
|
|
27964
|
+
putDataSourceStatistics(requestParameters: DataSourceStatisticsApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
27965
|
+
}
|
|
27966
|
+
/**
|
|
27967
|
+
* Request parameters for deleteDataSourceStatistics operation in DataSourceStatisticsApi.
|
|
27968
|
+
* @export
|
|
27969
|
+
* @interface DataSourceStatisticsApiDeleteDataSourceStatisticsRequest
|
|
27970
|
+
*/
|
|
27971
|
+
export interface DataSourceStatisticsApiDeleteDataSourceStatisticsRequest {
|
|
27972
|
+
/**
|
|
27973
|
+
*
|
|
27974
|
+
* @type {string}
|
|
27975
|
+
* @memberof DataSourceStatisticsApiDeleteDataSourceStatistics
|
|
27976
|
+
*/
|
|
27977
|
+
readonly dataSourceId: string;
|
|
27978
|
+
}
|
|
27979
|
+
/**
|
|
27980
|
+
* Request parameters for getDataSourceStatistics operation in DataSourceStatisticsApi.
|
|
27981
|
+
* @export
|
|
27982
|
+
* @interface DataSourceStatisticsApiGetDataSourceStatisticsRequest
|
|
27983
|
+
*/
|
|
27984
|
+
export interface DataSourceStatisticsApiGetDataSourceStatisticsRequest {
|
|
27985
|
+
/**
|
|
27986
|
+
*
|
|
27987
|
+
* @type {string}
|
|
27988
|
+
* @memberof DataSourceStatisticsApiGetDataSourceStatistics
|
|
27989
|
+
*/
|
|
27990
|
+
readonly dataSourceId: string;
|
|
27991
|
+
/**
|
|
27992
|
+
*
|
|
27993
|
+
* @type {string}
|
|
27994
|
+
* @memberof DataSourceStatisticsApiGetDataSourceStatistics
|
|
27995
|
+
*/
|
|
27996
|
+
readonly schemaName?: string;
|
|
27997
|
+
/**
|
|
27998
|
+
*
|
|
27999
|
+
* @type {string}
|
|
28000
|
+
* @memberof DataSourceStatisticsApiGetDataSourceStatistics
|
|
28001
|
+
*/
|
|
28002
|
+
readonly tableName?: string;
|
|
28003
|
+
}
|
|
28004
|
+
/**
|
|
28005
|
+
* Request parameters for putDataSourceStatistics operation in DataSourceStatisticsApi.
|
|
28006
|
+
* @export
|
|
28007
|
+
* @interface DataSourceStatisticsApiPutDataSourceStatisticsRequest
|
|
28008
|
+
*/
|
|
28009
|
+
export interface DataSourceStatisticsApiPutDataSourceStatisticsRequest {
|
|
28010
|
+
/**
|
|
28011
|
+
*
|
|
28012
|
+
* @type {string}
|
|
28013
|
+
* @memberof DataSourceStatisticsApiPutDataSourceStatistics
|
|
28014
|
+
*/
|
|
28015
|
+
readonly dataSourceId: string;
|
|
28016
|
+
/**
|
|
28017
|
+
*
|
|
28018
|
+
* @type {DataSourceStatisticsRequest}
|
|
28019
|
+
* @memberof DataSourceStatisticsApiPutDataSourceStatistics
|
|
28020
|
+
*/
|
|
28021
|
+
readonly dataSourceStatisticsRequest: DataSourceStatisticsRequest;
|
|
28022
|
+
}
|
|
28023
|
+
/**
|
|
28024
|
+
* DataSourceStatisticsApi - object-oriented interface
|
|
28025
|
+
* @export
|
|
28026
|
+
* @class DataSourceStatisticsApi
|
|
28027
|
+
* @extends {BaseAPI}
|
|
28028
|
+
*/
|
|
28029
|
+
export declare class DataSourceStatisticsApi extends BaseAPI implements DataSourceStatisticsApiInterface {
|
|
28030
|
+
/**
|
|
28031
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
28032
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
28033
|
+
* @param {DataSourceStatisticsApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
28034
|
+
* @param {*} [options] Override http request option.
|
|
28035
|
+
* @throws {RequiredError}
|
|
28036
|
+
* @memberof DataSourceStatisticsApi
|
|
28037
|
+
*/
|
|
28038
|
+
deleteDataSourceStatistics(requestParameters: DataSourceStatisticsApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
28039
|
+
/**
|
|
28040
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
28041
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
28042
|
+
* @param {DataSourceStatisticsApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
28043
|
+
* @param {*} [options] Override http request option.
|
|
28044
|
+
* @throws {RequiredError}
|
|
28045
|
+
* @memberof DataSourceStatisticsApi
|
|
28046
|
+
*/
|
|
28047
|
+
getDataSourceStatistics(requestParameters: DataSourceStatisticsApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<DataSourceStatisticsResponse>;
|
|
28048
|
+
/**
|
|
28049
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
28050
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
28051
|
+
* @param {DataSourceStatisticsApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
28052
|
+
* @param {*} [options] Override http request option.
|
|
28053
|
+
* @throws {RequiredError}
|
|
28054
|
+
* @memberof DataSourceStatisticsApi
|
|
28055
|
+
*/
|
|
28056
|
+
putDataSourceStatistics(requestParameters: DataSourceStatisticsApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
28057
|
+
}
|
|
27703
28058
|
/**
|
|
27704
28059
|
*
|
|
27705
28060
|
* @summary Get all Datasets
|
|
@@ -28767,13 +29122,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityMemoryItems(wor
|
|
|
28767
29122
|
* @summary Post Metrics
|
|
28768
29123
|
* @param {string} workspaceId
|
|
28769
29124
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
28770
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29125
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
28771
29126
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28772
29127
|
* @param {*} [options] Override http request option.
|
|
28773
29128
|
* @param {Configuration} [configuration] Optional configuration.
|
|
28774
29129
|
* @throws {RequiredError}
|
|
28775
29130
|
*/
|
|
28776
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29131
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28777
29132
|
/**
|
|
28778
29133
|
*
|
|
28779
29134
|
* @summary Post Notification Channel entities
|
|
@@ -28818,13 +29173,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityThemes(jsonApiT
|
|
|
28818
29173
|
* @summary Post User Data Filters
|
|
28819
29174
|
* @param {string} workspaceId
|
|
28820
29175
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
28821
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29176
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
28822
29177
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28823
29178
|
* @param {*} [options] Override http request option.
|
|
28824
29179
|
* @param {Configuration} [configuration] Optional configuration.
|
|
28825
29180
|
* @throws {RequiredError}
|
|
28826
29181
|
*/
|
|
28827
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29182
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28828
29183
|
/**
|
|
28829
29184
|
* User Group - creates tree-like structure for categorizing users
|
|
28830
29185
|
* @summary Post User Group entities
|
|
@@ -29692,7 +30047,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMemoryItems(w
|
|
|
29692
30047
|
* @param {string} workspaceId
|
|
29693
30048
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
29694
30049
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
29695
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30050
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29696
30051
|
* @param {number} [page] Zero-based page index (0..N)
|
|
29697
30052
|
* @param {number} [size] The size of the page to be returned
|
|
29698
30053
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -29702,7 +30057,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMemoryItems(w
|
|
|
29702
30057
|
* @param {Configuration} [configuration] Optional configuration.
|
|
29703
30058
|
* @throws {RequiredError}
|
|
29704
30059
|
*/
|
|
29705
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30060
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29706
30061
|
/**
|
|
29707
30062
|
*
|
|
29708
30063
|
* @summary Get all Notification Channel Identifier entities
|
|
@@ -29778,7 +30133,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesThemes(filter
|
|
|
29778
30133
|
* @param {string} workspaceId
|
|
29779
30134
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
29780
30135
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
29781
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30136
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29782
30137
|
* @param {number} [page] Zero-based page index (0..N)
|
|
29783
30138
|
* @param {number} [size] The size of the page to be returned
|
|
29784
30139
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -29788,7 +30143,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesThemes(filter
|
|
|
29788
30143
|
* @param {Configuration} [configuration] Optional configuration.
|
|
29789
30144
|
* @throws {RequiredError}
|
|
29790
30145
|
*/
|
|
29791
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30146
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29792
30147
|
/**
|
|
29793
30148
|
* User Group - creates tree-like structure for categorizing users
|
|
29794
30149
|
* @summary Get UserGroup entities
|
|
@@ -30299,14 +30654,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityMemoryItems(worksp
|
|
|
30299
30654
|
* @param {string} workspaceId
|
|
30300
30655
|
* @param {string} objectId
|
|
30301
30656
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30302
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30657
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30303
30658
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
30304
30659
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30305
30660
|
* @param {*} [options] Override http request option.
|
|
30306
30661
|
* @param {Configuration} [configuration] Optional configuration.
|
|
30307
30662
|
* @throws {RequiredError}
|
|
30308
30663
|
*/
|
|
30309
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30664
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30310
30665
|
/**
|
|
30311
30666
|
*
|
|
30312
30667
|
* @summary Get Notification Channel Identifier entity
|
|
@@ -30379,14 +30734,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityThemes(id: string,
|
|
|
30379
30734
|
* @param {string} workspaceId
|
|
30380
30735
|
* @param {string} objectId
|
|
30381
30736
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30382
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30737
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30383
30738
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
30384
30739
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30385
30740
|
* @param {*} [options] Override http request option.
|
|
30386
30741
|
* @param {Configuration} [configuration] Optional configuration.
|
|
30387
30742
|
* @throws {RequiredError}
|
|
30388
30743
|
*/
|
|
30389
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30744
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30390
30745
|
/**
|
|
30391
30746
|
* User Group - creates tree-like structure for categorizing users
|
|
30392
30747
|
* @summary Get UserGroup entity
|
|
@@ -30816,12 +31171,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityMemoryItems(work
|
|
|
30816
31171
|
* @param {string} objectId
|
|
30817
31172
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
30818
31173
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30819
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31174
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30820
31175
|
* @param {*} [options] Override http request option.
|
|
30821
31176
|
* @param {Configuration} [configuration] Optional configuration.
|
|
30822
31177
|
* @throws {RequiredError}
|
|
30823
31178
|
*/
|
|
30824
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31179
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30825
31180
|
/**
|
|
30826
31181
|
*
|
|
30827
31182
|
* @summary Patch Notification Channel entity
|
|
@@ -30887,12 +31242,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityThemes(id: strin
|
|
|
30887
31242
|
* @param {string} objectId
|
|
30888
31243
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
30889
31244
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30890
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31245
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30891
31246
|
* @param {*} [options] Override http request option.
|
|
30892
31247
|
* @param {Configuration} [configuration] Optional configuration.
|
|
30893
31248
|
* @throws {RequiredError}
|
|
30894
31249
|
*/
|
|
30895
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31250
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30896
31251
|
/**
|
|
30897
31252
|
* User Group - creates tree-like structure for categorizing users
|
|
30898
31253
|
* @summary Patch UserGroup entity
|
|
@@ -30980,6 +31335,17 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityWorkspaceSetting
|
|
|
30980
31335
|
* @throws {RequiredError}
|
|
30981
31336
|
*/
|
|
30982
31337
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityWorkspaces(id: string, jsonApiWorkspacePatchDocument: JsonApiWorkspacePatchDocument, filter?: string, include?: Array<'workspaces' | 'parent' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31338
|
+
/**
|
|
31339
|
+
* Notification sets up all reports to be computed again with new data.
|
|
31340
|
+
* @summary Register an upload notification
|
|
31341
|
+
* @param {string} workspaceId
|
|
31342
|
+
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31343
|
+
* @param {object} [body] Request body
|
|
31344
|
+
* @param {*} [options] Override http request option.
|
|
31345
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
31346
|
+
* @throws {RequiredError}
|
|
31347
|
+
*/
|
|
31348
|
+
export declare function EntitiesApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30983
31349
|
/**
|
|
30984
31350
|
*
|
|
30985
31351
|
* @summary The search endpoint (beta)
|
|
@@ -31514,12 +31880,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityMemoryItems(wor
|
|
|
31514
31880
|
* @param {string} objectId
|
|
31515
31881
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
31516
31882
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31517
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31883
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31518
31884
|
* @param {*} [options] Override http request option.
|
|
31519
31885
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31520
31886
|
* @throws {RequiredError}
|
|
31521
31887
|
*/
|
|
31522
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31888
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31523
31889
|
/**
|
|
31524
31890
|
*
|
|
31525
31891
|
* @summary Put Notification Channel entity
|
|
@@ -31585,12 +31951,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityThemes(id: stri
|
|
|
31585
31951
|
* @param {string} objectId
|
|
31586
31952
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
31587
31953
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31588
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31954
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31589
31955
|
* @param {*} [options] Override http request option.
|
|
31590
31956
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31591
31957
|
* @throws {RequiredError}
|
|
31592
31958
|
*/
|
|
31593
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31959
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31594
31960
|
/**
|
|
31595
31961
|
* User Group - creates tree-like structure for categorizing users
|
|
31596
31962
|
* @summary Put UserGroup entity
|
|
@@ -33923,6 +34289,17 @@ export declare function EntitiesApi_PatchEntityWorkspaceSettings(axios: AxiosIns
|
|
|
33923
34289
|
* @throws {RequiredError}
|
|
33924
34290
|
*/
|
|
33925
34291
|
export declare function EntitiesApi_PatchEntityWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
34292
|
+
/**
|
|
34293
|
+
* Notification sets up all reports to be computed again with new data.
|
|
34294
|
+
* @summary Register an upload notification
|
|
34295
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
34296
|
+
* @param {string} basePath Base path.
|
|
34297
|
+
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
34298
|
+
* @param {*} [options] Override http request option.
|
|
34299
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
34300
|
+
* @throws {RequiredError}
|
|
34301
|
+
*/
|
|
34302
|
+
export declare function EntitiesApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
33926
34303
|
/**
|
|
33927
34304
|
*
|
|
33928
34305
|
* @summary The search endpoint (beta)
|
|
@@ -36410,6 +36787,15 @@ export interface EntitiesApiInterface {
|
|
|
36410
36787
|
* @memberof EntitiesApiInterface
|
|
36411
36788
|
*/
|
|
36412
36789
|
patchEntityWorkspaces(requestParameters: EntitiesApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
36790
|
+
/**
|
|
36791
|
+
* Notification sets up all reports to be computed again with new data.
|
|
36792
|
+
* @summary Register an upload notification
|
|
36793
|
+
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
36794
|
+
* @param {*} [options] Override http request option.
|
|
36795
|
+
* @throws {RequiredError}
|
|
36796
|
+
* @memberof EntitiesApiInterface
|
|
36797
|
+
*/
|
|
36798
|
+
registerUploadNotificationWorkspaces(requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
36413
36799
|
/**
|
|
36414
36800
|
*
|
|
36415
36801
|
* @summary The search endpoint (beta)
|
|
@@ -37422,10 +37808,10 @@ export interface EntitiesApiCreateEntityMetricsRequest {
|
|
|
37422
37808
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
37423
37809
|
/**
|
|
37424
37810
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37425
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
37811
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
37426
37812
|
* @memberof EntitiesApiCreateEntityMetrics
|
|
37427
37813
|
*/
|
|
37428
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
37814
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
37429
37815
|
/**
|
|
37430
37816
|
* Include Meta objects.
|
|
37431
37817
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -37523,10 +37909,10 @@ export interface EntitiesApiCreateEntityUserDataFiltersRequest {
|
|
|
37523
37909
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
37524
37910
|
/**
|
|
37525
37911
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37526
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
37912
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
37527
37913
|
* @memberof EntitiesApiCreateEntityUserDataFilters
|
|
37528
37914
|
*/
|
|
37529
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
37915
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
37530
37916
|
/**
|
|
37531
37917
|
* Include Meta objects.
|
|
37532
37918
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -39774,10 +40160,10 @@ export interface EntitiesApiGetAllEntitiesMetricsRequest {
|
|
|
39774
40160
|
readonly filter?: string;
|
|
39775
40161
|
/**
|
|
39776
40162
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39777
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
40163
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
39778
40164
|
* @memberof EntitiesApiGetAllEntitiesMetrics
|
|
39779
40165
|
*/
|
|
39780
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
40166
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
39781
40167
|
/**
|
|
39782
40168
|
* Zero-based page index (0..N)
|
|
39783
40169
|
* @type {number}
|
|
@@ -40044,10 +40430,10 @@ export interface EntitiesApiGetAllEntitiesUserDataFiltersRequest {
|
|
|
40044
40430
|
readonly filter?: string;
|
|
40045
40431
|
/**
|
|
40046
40432
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40047
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
40433
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
40048
40434
|
* @memberof EntitiesApiGetAllEntitiesUserDataFilters
|
|
40049
40435
|
*/
|
|
40050
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
40436
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
40051
40437
|
/**
|
|
40052
40438
|
* Zero-based page index (0..N)
|
|
40053
40439
|
* @type {number}
|
|
@@ -41475,10 +41861,10 @@ export interface EntitiesApiGetEntityMetricsRequest {
|
|
|
41475
41861
|
readonly filter?: string;
|
|
41476
41862
|
/**
|
|
41477
41863
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
41478
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
41864
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
41479
41865
|
* @memberof EntitiesApiGetEntityMetrics
|
|
41480
41866
|
*/
|
|
41481
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
41867
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
41482
41868
|
/**
|
|
41483
41869
|
*
|
|
41484
41870
|
* @type {boolean}
|
|
@@ -41668,10 +42054,10 @@ export interface EntitiesApiGetEntityUserDataFiltersRequest {
|
|
|
41668
42054
|
readonly filter?: string;
|
|
41669
42055
|
/**
|
|
41670
42056
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
41671
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
42057
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
41672
42058
|
* @memberof EntitiesApiGetEntityUserDataFilters
|
|
41673
42059
|
*/
|
|
41674
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
42060
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
41675
42061
|
/**
|
|
41676
42062
|
*
|
|
41677
42063
|
* @type {boolean}
|
|
@@ -42814,10 +43200,10 @@ export interface EntitiesApiPatchEntityMetricsRequest {
|
|
|
42814
43200
|
readonly filter?: string;
|
|
42815
43201
|
/**
|
|
42816
43202
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
42817
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
43203
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
42818
43204
|
* @memberof EntitiesApiPatchEntityMetrics
|
|
42819
43205
|
*/
|
|
42820
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
43206
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
42821
43207
|
}
|
|
42822
43208
|
/**
|
|
42823
43209
|
* Request parameters for patchEntityNotificationChannels operation in EntitiesApi.
|
|
@@ -42994,10 +43380,10 @@ export interface EntitiesApiPatchEntityUserDataFiltersRequest {
|
|
|
42994
43380
|
readonly filter?: string;
|
|
42995
43381
|
/**
|
|
42996
43382
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
42997
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
43383
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
42998
43384
|
* @memberof EntitiesApiPatchEntityUserDataFilters
|
|
42999
43385
|
*/
|
|
43000
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
43386
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
43001
43387
|
}
|
|
43002
43388
|
/**
|
|
43003
43389
|
* Request parameters for patchEntityUserGroups operation in EntitiesApi.
|
|
@@ -43234,6 +43620,31 @@ export interface EntitiesApiPatchEntityWorkspacesRequest {
|
|
|
43234
43620
|
*/
|
|
43235
43621
|
readonly include?: Array<'workspaces' | 'parent' | 'ALL'>;
|
|
43236
43622
|
}
|
|
43623
|
+
/**
|
|
43624
|
+
* Request parameters for registerUploadNotificationWorkspaces operation in EntitiesApi.
|
|
43625
|
+
* @export
|
|
43626
|
+
* @interface EntitiesApiRegisterUploadNotificationWorkspacesRequest
|
|
43627
|
+
*/
|
|
43628
|
+
export interface EntitiesApiRegisterUploadNotificationWorkspacesRequest {
|
|
43629
|
+
/**
|
|
43630
|
+
*
|
|
43631
|
+
* @type {string}
|
|
43632
|
+
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
43633
|
+
*/
|
|
43634
|
+
readonly workspaceId: string;
|
|
43635
|
+
/**
|
|
43636
|
+
* Include Meta objects.
|
|
43637
|
+
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
43638
|
+
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
43639
|
+
*/
|
|
43640
|
+
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
43641
|
+
/**
|
|
43642
|
+
* Request body
|
|
43643
|
+
* @type {object}
|
|
43644
|
+
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
43645
|
+
*/
|
|
43646
|
+
readonly body?: object;
|
|
43647
|
+
}
|
|
43237
43648
|
/**
|
|
43238
43649
|
* Request parameters for searchEntitiesAggregatedFacts operation in EntitiesApi.
|
|
43239
43650
|
* @export
|
|
@@ -44624,10 +45035,10 @@ export interface EntitiesApiUpdateEntityMetricsRequest {
|
|
|
44624
45035
|
readonly filter?: string;
|
|
44625
45036
|
/**
|
|
44626
45037
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
44627
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
45038
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
44628
45039
|
* @memberof EntitiesApiUpdateEntityMetrics
|
|
44629
45040
|
*/
|
|
44630
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
45041
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
44631
45042
|
}
|
|
44632
45043
|
/**
|
|
44633
45044
|
* Request parameters for updateEntityNotificationChannels operation in EntitiesApi.
|
|
@@ -44804,10 +45215,10 @@ export interface EntitiesApiUpdateEntityUserDataFiltersRequest {
|
|
|
44804
45215
|
readonly filter?: string;
|
|
44805
45216
|
/**
|
|
44806
45217
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
44807
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
45218
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
44808
45219
|
* @memberof EntitiesApiUpdateEntityUserDataFilters
|
|
44809
45220
|
*/
|
|
44810
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
45221
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
44811
45222
|
}
|
|
44812
45223
|
/**
|
|
44813
45224
|
* Request parameters for updateEntityUserGroups operation in EntitiesApi.
|
|
@@ -46914,6 +47325,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
46914
47325
|
* @memberof EntitiesApi
|
|
46915
47326
|
*/
|
|
46916
47327
|
patchEntityWorkspaces(requestParameters: EntitiesApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
47328
|
+
/**
|
|
47329
|
+
* Notification sets up all reports to be computed again with new data.
|
|
47330
|
+
* @summary Register an upload notification
|
|
47331
|
+
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
47332
|
+
* @param {*} [options] Override http request option.
|
|
47333
|
+
* @throws {RequiredError}
|
|
47334
|
+
* @memberof EntitiesApi
|
|
47335
|
+
*/
|
|
47336
|
+
registerUploadNotificationWorkspaces(requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
46917
47337
|
/**
|
|
46918
47338
|
*
|
|
46919
47339
|
* @summary The search endpoint (beta)
|
|
@@ -54679,6 +55099,17 @@ export declare class IdentityProvidersApi extends BaseAPI implements IdentityPro
|
|
|
54679
55099
|
* @throws {RequiredError}
|
|
54680
55100
|
*/
|
|
54681
55101
|
export declare function InvalidateCacheApiAxiosParamCreator_RegisterUploadNotification(dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
55102
|
+
/**
|
|
55103
|
+
* Notification sets up all reports to be computed again with new data.
|
|
55104
|
+
* @summary Register an upload notification
|
|
55105
|
+
* @param {string} workspaceId
|
|
55106
|
+
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
55107
|
+
* @param {object} [body] Request body
|
|
55108
|
+
* @param {*} [options] Override http request option.
|
|
55109
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
55110
|
+
* @throws {RequiredError}
|
|
55111
|
+
*/
|
|
55112
|
+
export declare function InvalidateCacheApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
54682
55113
|
/**
|
|
54683
55114
|
* Notification sets up all reports to be computed again with new data.
|
|
54684
55115
|
* @summary Register an upload notification
|
|
@@ -54690,6 +55121,17 @@ export declare function InvalidateCacheApiAxiosParamCreator_RegisterUploadNotifi
|
|
|
54690
55121
|
* @throws {RequiredError}
|
|
54691
55122
|
*/
|
|
54692
55123
|
export declare function InvalidateCacheApi_RegisterUploadNotification(axios: AxiosInstance, basePath: string, requestParameters: InvalidateCacheApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
55124
|
+
/**
|
|
55125
|
+
* Notification sets up all reports to be computed again with new data.
|
|
55126
|
+
* @summary Register an upload notification
|
|
55127
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
55128
|
+
* @param {string} basePath Base path.
|
|
55129
|
+
* @param {InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
55130
|
+
* @param {*} [options] Override http request option.
|
|
55131
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
55132
|
+
* @throws {RequiredError}
|
|
55133
|
+
*/
|
|
55134
|
+
export declare function InvalidateCacheApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
54693
55135
|
/**
|
|
54694
55136
|
* InvalidateCacheApi - interface
|
|
54695
55137
|
* @export
|
|
@@ -54705,6 +55147,15 @@ export interface InvalidateCacheApiInterface {
|
|
|
54705
55147
|
* @memberof InvalidateCacheApiInterface
|
|
54706
55148
|
*/
|
|
54707
55149
|
registerUploadNotification(requestParameters: InvalidateCacheApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
55150
|
+
/**
|
|
55151
|
+
* Notification sets up all reports to be computed again with new data.
|
|
55152
|
+
* @summary Register an upload notification
|
|
55153
|
+
* @param {InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
55154
|
+
* @param {*} [options] Override http request option.
|
|
55155
|
+
* @throws {RequiredError}
|
|
55156
|
+
* @memberof InvalidateCacheApiInterface
|
|
55157
|
+
*/
|
|
55158
|
+
registerUploadNotificationWorkspaces(requestParameters: InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
54708
55159
|
}
|
|
54709
55160
|
/**
|
|
54710
55161
|
* Request parameters for registerUploadNotification operation in InvalidateCacheApi.
|
|
@@ -54719,6 +55170,31 @@ export interface InvalidateCacheApiRegisterUploadNotificationRequest {
|
|
|
54719
55170
|
*/
|
|
54720
55171
|
readonly dataSourceId: string;
|
|
54721
55172
|
}
|
|
55173
|
+
/**
|
|
55174
|
+
* Request parameters for registerUploadNotificationWorkspaces operation in InvalidateCacheApi.
|
|
55175
|
+
* @export
|
|
55176
|
+
* @interface InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest
|
|
55177
|
+
*/
|
|
55178
|
+
export interface InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest {
|
|
55179
|
+
/**
|
|
55180
|
+
*
|
|
55181
|
+
* @type {string}
|
|
55182
|
+
* @memberof InvalidateCacheApiRegisterUploadNotificationWorkspaces
|
|
55183
|
+
*/
|
|
55184
|
+
readonly workspaceId: string;
|
|
55185
|
+
/**
|
|
55186
|
+
* Include Meta objects.
|
|
55187
|
+
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
55188
|
+
* @memberof InvalidateCacheApiRegisterUploadNotificationWorkspaces
|
|
55189
|
+
*/
|
|
55190
|
+
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
55191
|
+
/**
|
|
55192
|
+
* Request body
|
|
55193
|
+
* @type {object}
|
|
55194
|
+
* @memberof InvalidateCacheApiRegisterUploadNotificationWorkspaces
|
|
55195
|
+
*/
|
|
55196
|
+
readonly body?: object;
|
|
55197
|
+
}
|
|
54722
55198
|
/**
|
|
54723
55199
|
* InvalidateCacheApi - object-oriented interface
|
|
54724
55200
|
* @export
|
|
@@ -54735,6 +55211,15 @@ export declare class InvalidateCacheApi extends BaseAPI implements InvalidateCac
|
|
|
54735
55211
|
* @memberof InvalidateCacheApi
|
|
54736
55212
|
*/
|
|
54737
55213
|
registerUploadNotification(requestParameters: InvalidateCacheApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
55214
|
+
/**
|
|
55215
|
+
* Notification sets up all reports to be computed again with new data.
|
|
55216
|
+
* @summary Register an upload notification
|
|
55217
|
+
* @param {InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
55218
|
+
* @param {*} [options] Override http request option.
|
|
55219
|
+
* @throws {RequiredError}
|
|
55220
|
+
* @memberof InvalidateCacheApi
|
|
55221
|
+
*/
|
|
55222
|
+
registerUploadNotificationWorkspaces(requestParameters: InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
54738
55223
|
}
|
|
54739
55224
|
/**
|
|
54740
55225
|
* Creates JSON web key - used to verify JSON web tokens (Jwts)
|
|
@@ -57701,6 +58186,23 @@ export declare class LabelsApi extends BaseAPI implements LabelsApiInterface {
|
|
|
57701
58186
|
*/
|
|
57702
58187
|
searchEntitiesLabels(requestParameters: LabelsApiSearchEntitiesLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutList>;
|
|
57703
58188
|
}
|
|
58189
|
+
/**
|
|
58190
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
58191
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
58192
|
+
* @param {string} dataSourceId
|
|
58193
|
+
* @param {*} [options] Override http request option.
|
|
58194
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58195
|
+
* @throws {RequiredError}
|
|
58196
|
+
*/
|
|
58197
|
+
export declare function LayoutApiAxiosParamCreator_DeleteDataSourceStatistics(dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
58198
|
+
/**
|
|
58199
|
+
* Gets complete layout of AI agent configurations.
|
|
58200
|
+
* @summary Get all AI agent configurations layout
|
|
58201
|
+
* @param {*} [options] Override http request option.
|
|
58202
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58203
|
+
* @throws {RequiredError}
|
|
58204
|
+
*/
|
|
58205
|
+
export declare function LayoutApiAxiosParamCreator_GetAgentsLayout(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
57704
58206
|
/**
|
|
57705
58207
|
* Retrieve current analytics model of the workspace.
|
|
57706
58208
|
* @summary Get analytics model
|
|
@@ -57738,6 +58240,17 @@ export declare function LayoutApiAxiosParamCreator_GetCustomGeoCollectionsLayout
|
|
|
57738
58240
|
* @throws {RequiredError}
|
|
57739
58241
|
*/
|
|
57740
58242
|
export declare function LayoutApiAxiosParamCreator_GetDataSourcePermissions(dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
58243
|
+
/**
|
|
58244
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
58245
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
58246
|
+
* @param {string} dataSourceId
|
|
58247
|
+
* @param {string} [schemaName]
|
|
58248
|
+
* @param {string} [tableName]
|
|
58249
|
+
* @param {*} [options] Override http request option.
|
|
58250
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58251
|
+
* @throws {RequiredError}
|
|
58252
|
+
*/
|
|
58253
|
+
export declare function LayoutApiAxiosParamCreator_GetDataSourceStatistics(dataSourceId: string, schemaName?: string, tableName?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
57741
58254
|
/**
|
|
57742
58255
|
* Retrieve all data sources including related physical model.
|
|
57743
58256
|
* @summary Get all data sources
|
|
@@ -57894,6 +58407,16 @@ export declare function LayoutApiAxiosParamCreator_GetWorkspacePermissions(works
|
|
|
57894
58407
|
* @throws {RequiredError}
|
|
57895
58408
|
*/
|
|
57896
58409
|
export declare function LayoutApiAxiosParamCreator_GetWorkspacesLayout(exclude?: Array<'ACTIVITY_INFO'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
58410
|
+
/**
|
|
58411
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
58412
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
58413
|
+
* @param {string} dataSourceId
|
|
58414
|
+
* @param {DataSourceStatisticsRequest} dataSourceStatisticsRequest
|
|
58415
|
+
* @param {*} [options] Override http request option.
|
|
58416
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58417
|
+
* @throws {RequiredError}
|
|
58418
|
+
*/
|
|
58419
|
+
export declare function LayoutApiAxiosParamCreator_PutDataSourceStatistics(dataSourceId: string, dataSourceStatisticsRequest: DataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
57897
58420
|
/**
|
|
57898
58421
|
* Set all data sources including related physical model.
|
|
57899
58422
|
* @summary Put all data sources
|
|
@@ -57940,6 +58463,15 @@ export declare function LayoutApiAxiosParamCreator_PutUsersUserGroupsLayout(decl
|
|
|
57940
58463
|
* @throws {RequiredError}
|
|
57941
58464
|
*/
|
|
57942
58465
|
export declare function LayoutApiAxiosParamCreator_PutWorkspaceLayout(workspaceId: string, declarativeWorkspaceModel: DeclarativeWorkspaceModel, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
58466
|
+
/**
|
|
58467
|
+
* Sets AI agent configurations in organization.
|
|
58468
|
+
* @summary Set all AI agent configurations
|
|
58469
|
+
* @param {DeclarativeAgents} declarativeAgents
|
|
58470
|
+
* @param {*} [options] Override http request option.
|
|
58471
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58472
|
+
* @throws {RequiredError}
|
|
58473
|
+
*/
|
|
58474
|
+
export declare function LayoutApiAxiosParamCreator_SetAgentsLayout(declarativeAgents: DeclarativeAgents, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
57943
58475
|
/**
|
|
57944
58476
|
* Set effective analytics model of the workspace.
|
|
57945
58477
|
* @summary Set analytics model
|
|
@@ -58102,6 +58634,27 @@ export declare function LayoutApiAxiosParamCreator_SetWorkspacePermissions(works
|
|
|
58102
58634
|
* @throws {RequiredError}
|
|
58103
58635
|
*/
|
|
58104
58636
|
export declare function LayoutApiAxiosParamCreator_SetWorkspacesLayout(declarativeWorkspaces: DeclarativeWorkspaces, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
58637
|
+
/**
|
|
58638
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
58639
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
58640
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
58641
|
+
* @param {string} basePath Base path.
|
|
58642
|
+
* @param {LayoutApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
58643
|
+
* @param {*} [options] Override http request option.
|
|
58644
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58645
|
+
* @throws {RequiredError}
|
|
58646
|
+
*/
|
|
58647
|
+
export declare function LayoutApi_DeleteDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
58648
|
+
/**
|
|
58649
|
+
* Gets complete layout of AI agent configurations.
|
|
58650
|
+
* @summary Get all AI agent configurations layout
|
|
58651
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
58652
|
+
* @param {string} basePath Base path.
|
|
58653
|
+
* @param {*} [options] Override http request option.
|
|
58654
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58655
|
+
* @throws {RequiredError}
|
|
58656
|
+
*/
|
|
58657
|
+
export declare function LayoutApi_GetAgentsLayout(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DeclarativeAgents>;
|
|
58105
58658
|
/**
|
|
58106
58659
|
* Retrieve current analytics model of the workspace.
|
|
58107
58660
|
* @summary Get analytics model
|
|
@@ -58145,6 +58698,17 @@ export declare function LayoutApi_GetCustomGeoCollectionsLayout(axios: AxiosInst
|
|
|
58145
58698
|
* @throws {RequiredError}
|
|
58146
58699
|
*/
|
|
58147
58700
|
export declare function LayoutApi_GetDataSourcePermissions(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiGetDataSourcePermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DeclarativeDataSourcePermissions>;
|
|
58701
|
+
/**
|
|
58702
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
58703
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
58704
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
58705
|
+
* @param {string} basePath Base path.
|
|
58706
|
+
* @param {LayoutApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
58707
|
+
* @param {*} [options] Override http request option.
|
|
58708
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58709
|
+
* @throws {RequiredError}
|
|
58710
|
+
*/
|
|
58711
|
+
export declare function LayoutApi_GetDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DataSourceStatisticsResponse>;
|
|
58148
58712
|
/**
|
|
58149
58713
|
* Retrieve all data sources including related physical model.
|
|
58150
58714
|
* @summary Get all data sources
|
|
@@ -58334,6 +58898,17 @@ export declare function LayoutApi_GetWorkspacePermissions(axios: AxiosInstance,
|
|
|
58334
58898
|
* @throws {RequiredError}
|
|
58335
58899
|
*/
|
|
58336
58900
|
export declare function LayoutApi_GetWorkspacesLayout(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiGetWorkspacesLayoutRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DeclarativeWorkspaces>;
|
|
58901
|
+
/**
|
|
58902
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
58903
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
58904
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
58905
|
+
* @param {string} basePath Base path.
|
|
58906
|
+
* @param {LayoutApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
58907
|
+
* @param {*} [options] Override http request option.
|
|
58908
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58909
|
+
* @throws {RequiredError}
|
|
58910
|
+
*/
|
|
58911
|
+
export declare function LayoutApi_PutDataSourceStatistics(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
58337
58912
|
/**
|
|
58338
58913
|
* Set all data sources including related physical model.
|
|
58339
58914
|
* @summary Put all data sources
|
|
@@ -58389,6 +58964,17 @@ export declare function LayoutApi_PutUsersUserGroupsLayout(axios: AxiosInstance,
|
|
|
58389
58964
|
* @throws {RequiredError}
|
|
58390
58965
|
*/
|
|
58391
58966
|
export declare function LayoutApi_PutWorkspaceLayout(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiPutWorkspaceLayoutRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
58967
|
+
/**
|
|
58968
|
+
* Sets AI agent configurations in organization.
|
|
58969
|
+
* @summary Set all AI agent configurations
|
|
58970
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
58971
|
+
* @param {string} basePath Base path.
|
|
58972
|
+
* @param {LayoutApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
58973
|
+
* @param {*} [options] Override http request option.
|
|
58974
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
58975
|
+
* @throws {RequiredError}
|
|
58976
|
+
*/
|
|
58977
|
+
export declare function LayoutApi_SetAgentsLayout(axios: AxiosInstance, basePath: string, requestParameters: LayoutApiSetAgentsLayoutRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
58392
58978
|
/**
|
|
58393
58979
|
* Set effective analytics model of the workspace.
|
|
58394
58980
|
* @summary Set analytics model
|
|
@@ -58582,6 +59168,23 @@ export declare function LayoutApi_SetWorkspacesLayout(axios: AxiosInstance, base
|
|
|
58582
59168
|
* @interface LayoutApi
|
|
58583
59169
|
*/
|
|
58584
59170
|
export interface LayoutApiInterface {
|
|
59171
|
+
/**
|
|
59172
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
59173
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
59174
|
+
* @param {LayoutApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
59175
|
+
* @param {*} [options] Override http request option.
|
|
59176
|
+
* @throws {RequiredError}
|
|
59177
|
+
* @memberof LayoutApiInterface
|
|
59178
|
+
*/
|
|
59179
|
+
deleteDataSourceStatistics(requestParameters: LayoutApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
59180
|
+
/**
|
|
59181
|
+
* Gets complete layout of AI agent configurations.
|
|
59182
|
+
* @summary Get all AI agent configurations layout
|
|
59183
|
+
* @param {*} [options] Override http request option.
|
|
59184
|
+
* @throws {RequiredError}
|
|
59185
|
+
* @memberof LayoutApiInterface
|
|
59186
|
+
*/
|
|
59187
|
+
getAgentsLayout(options?: AxiosRequestConfig): AxiosPromise<DeclarativeAgents>;
|
|
58585
59188
|
/**
|
|
58586
59189
|
* Retrieve current analytics model of the workspace.
|
|
58587
59190
|
* @summary Get analytics model
|
|
@@ -58617,6 +59220,15 @@ export interface LayoutApiInterface {
|
|
|
58617
59220
|
* @memberof LayoutApiInterface
|
|
58618
59221
|
*/
|
|
58619
59222
|
getDataSourcePermissions(requestParameters: LayoutApiGetDataSourcePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeDataSourcePermissions>;
|
|
59223
|
+
/**
|
|
59224
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
59225
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
59226
|
+
* @param {LayoutApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
59227
|
+
* @param {*} [options] Override http request option.
|
|
59228
|
+
* @throws {RequiredError}
|
|
59229
|
+
* @memberof LayoutApiInterface
|
|
59230
|
+
*/
|
|
59231
|
+
getDataSourceStatistics(requestParameters: LayoutApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<DataSourceStatisticsResponse>;
|
|
58620
59232
|
/**
|
|
58621
59233
|
* Retrieve all data sources including related physical model.
|
|
58622
59234
|
* @summary Get all data sources
|
|
@@ -58770,6 +59382,15 @@ export interface LayoutApiInterface {
|
|
|
58770
59382
|
* @memberof LayoutApiInterface
|
|
58771
59383
|
*/
|
|
58772
59384
|
getWorkspacesLayout(requestParameters: LayoutApiGetWorkspacesLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeWorkspaces>;
|
|
59385
|
+
/**
|
|
59386
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
59387
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
59388
|
+
* @param {LayoutApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
59389
|
+
* @param {*} [options] Override http request option.
|
|
59390
|
+
* @throws {RequiredError}
|
|
59391
|
+
* @memberof LayoutApiInterface
|
|
59392
|
+
*/
|
|
59393
|
+
putDataSourceStatistics(requestParameters: LayoutApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58773
59394
|
/**
|
|
58774
59395
|
* Set all data sources including related physical model.
|
|
58775
59396
|
* @summary Put all data sources
|
|
@@ -58815,6 +59436,15 @@ export interface LayoutApiInterface {
|
|
|
58815
59436
|
* @memberof LayoutApiInterface
|
|
58816
59437
|
*/
|
|
58817
59438
|
putWorkspaceLayout(requestParameters: LayoutApiPutWorkspaceLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
59439
|
+
/**
|
|
59440
|
+
* Sets AI agent configurations in organization.
|
|
59441
|
+
* @summary Set all AI agent configurations
|
|
59442
|
+
* @param {LayoutApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
59443
|
+
* @param {*} [options] Override http request option.
|
|
59444
|
+
* @throws {RequiredError}
|
|
59445
|
+
* @memberof LayoutApiInterface
|
|
59446
|
+
*/
|
|
59447
|
+
setAgentsLayout(requestParameters: LayoutApiSetAgentsLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58818
59448
|
/**
|
|
58819
59449
|
* Set effective analytics model of the workspace.
|
|
58820
59450
|
* @summary Set analytics model
|
|
@@ -58969,6 +59599,19 @@ export interface LayoutApiInterface {
|
|
|
58969
59599
|
*/
|
|
58970
59600
|
setWorkspacesLayout(requestParameters: LayoutApiSetWorkspacesLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58971
59601
|
}
|
|
59602
|
+
/**
|
|
59603
|
+
* Request parameters for deleteDataSourceStatistics operation in LayoutApi.
|
|
59604
|
+
* @export
|
|
59605
|
+
* @interface LayoutApiDeleteDataSourceStatisticsRequest
|
|
59606
|
+
*/
|
|
59607
|
+
export interface LayoutApiDeleteDataSourceStatisticsRequest {
|
|
59608
|
+
/**
|
|
59609
|
+
*
|
|
59610
|
+
* @type {string}
|
|
59611
|
+
* @memberof LayoutApiDeleteDataSourceStatistics
|
|
59612
|
+
*/
|
|
59613
|
+
readonly dataSourceId: string;
|
|
59614
|
+
}
|
|
58972
59615
|
/**
|
|
58973
59616
|
* Request parameters for getAnalyticsModel operation in LayoutApi.
|
|
58974
59617
|
* @export
|
|
@@ -59020,6 +59663,31 @@ export interface LayoutApiGetDataSourcePermissionsRequest {
|
|
|
59020
59663
|
*/
|
|
59021
59664
|
readonly dataSourceId: string;
|
|
59022
59665
|
}
|
|
59666
|
+
/**
|
|
59667
|
+
* Request parameters for getDataSourceStatistics operation in LayoutApi.
|
|
59668
|
+
* @export
|
|
59669
|
+
* @interface LayoutApiGetDataSourceStatisticsRequest
|
|
59670
|
+
*/
|
|
59671
|
+
export interface LayoutApiGetDataSourceStatisticsRequest {
|
|
59672
|
+
/**
|
|
59673
|
+
*
|
|
59674
|
+
* @type {string}
|
|
59675
|
+
* @memberof LayoutApiGetDataSourceStatistics
|
|
59676
|
+
*/
|
|
59677
|
+
readonly dataSourceId: string;
|
|
59678
|
+
/**
|
|
59679
|
+
*
|
|
59680
|
+
* @type {string}
|
|
59681
|
+
* @memberof LayoutApiGetDataSourceStatistics
|
|
59682
|
+
*/
|
|
59683
|
+
readonly schemaName?: string;
|
|
59684
|
+
/**
|
|
59685
|
+
*
|
|
59686
|
+
* @type {string}
|
|
59687
|
+
* @memberof LayoutApiGetDataSourceStatistics
|
|
59688
|
+
*/
|
|
59689
|
+
readonly tableName?: string;
|
|
59690
|
+
}
|
|
59023
59691
|
/**
|
|
59024
59692
|
* Request parameters for getFilterViews operation in LayoutApi.
|
|
59025
59693
|
* @export
|
|
@@ -59155,6 +59823,25 @@ export interface LayoutApiGetWorkspacesLayoutRequest {
|
|
|
59155
59823
|
*/
|
|
59156
59824
|
readonly exclude?: Array<'ACTIVITY_INFO'>;
|
|
59157
59825
|
}
|
|
59826
|
+
/**
|
|
59827
|
+
* Request parameters for putDataSourceStatistics operation in LayoutApi.
|
|
59828
|
+
* @export
|
|
59829
|
+
* @interface LayoutApiPutDataSourceStatisticsRequest
|
|
59830
|
+
*/
|
|
59831
|
+
export interface LayoutApiPutDataSourceStatisticsRequest {
|
|
59832
|
+
/**
|
|
59833
|
+
*
|
|
59834
|
+
* @type {string}
|
|
59835
|
+
* @memberof LayoutApiPutDataSourceStatistics
|
|
59836
|
+
*/
|
|
59837
|
+
readonly dataSourceId: string;
|
|
59838
|
+
/**
|
|
59839
|
+
*
|
|
59840
|
+
* @type {DataSourceStatisticsRequest}
|
|
59841
|
+
* @memberof LayoutApiPutDataSourceStatistics
|
|
59842
|
+
*/
|
|
59843
|
+
readonly dataSourceStatisticsRequest: DataSourceStatisticsRequest;
|
|
59844
|
+
}
|
|
59158
59845
|
/**
|
|
59159
59846
|
* Request parameters for putDataSourcesLayout operation in LayoutApi.
|
|
59160
59847
|
* @export
|
|
@@ -59226,6 +59913,19 @@ export interface LayoutApiPutWorkspaceLayoutRequest {
|
|
|
59226
59913
|
*/
|
|
59227
59914
|
readonly declarativeWorkspaceModel: DeclarativeWorkspaceModel;
|
|
59228
59915
|
}
|
|
59916
|
+
/**
|
|
59917
|
+
* Request parameters for setAgentsLayout operation in LayoutApi.
|
|
59918
|
+
* @export
|
|
59919
|
+
* @interface LayoutApiSetAgentsLayoutRequest
|
|
59920
|
+
*/
|
|
59921
|
+
export interface LayoutApiSetAgentsLayoutRequest {
|
|
59922
|
+
/**
|
|
59923
|
+
*
|
|
59924
|
+
* @type {DeclarativeAgents}
|
|
59925
|
+
* @memberof LayoutApiSetAgentsLayout
|
|
59926
|
+
*/
|
|
59927
|
+
readonly declarativeAgents: DeclarativeAgents;
|
|
59928
|
+
}
|
|
59229
59929
|
/**
|
|
59230
59930
|
* Request parameters for setAnalyticsModel operation in LayoutApi.
|
|
59231
59931
|
* @export
|
|
@@ -59508,6 +60208,23 @@ export interface LayoutApiSetWorkspacesLayoutRequest {
|
|
|
59508
60208
|
* @extends {BaseAPI}
|
|
59509
60209
|
*/
|
|
59510
60210
|
export declare class LayoutApi extends BaseAPI implements LayoutApiInterface {
|
|
60211
|
+
/**
|
|
60212
|
+
* (BETA) Removes all stored physical statistics for the specified data source.
|
|
60213
|
+
* @summary (BETA) Delete stored physical statistics for a data source
|
|
60214
|
+
* @param {LayoutApiDeleteDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
60215
|
+
* @param {*} [options] Override http request option.
|
|
60216
|
+
* @throws {RequiredError}
|
|
60217
|
+
* @memberof LayoutApi
|
|
60218
|
+
*/
|
|
60219
|
+
deleteDataSourceStatistics(requestParameters: LayoutApiDeleteDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
60220
|
+
/**
|
|
60221
|
+
* Gets complete layout of AI agent configurations.
|
|
60222
|
+
* @summary Get all AI agent configurations layout
|
|
60223
|
+
* @param {*} [options] Override http request option.
|
|
60224
|
+
* @throws {RequiredError}
|
|
60225
|
+
* @memberof LayoutApi
|
|
60226
|
+
*/
|
|
60227
|
+
getAgentsLayout(options?: AxiosRequestConfig): AxiosPromise<DeclarativeAgents>;
|
|
59511
60228
|
/**
|
|
59512
60229
|
* Retrieve current analytics model of the workspace.
|
|
59513
60230
|
* @summary Get analytics model
|
|
@@ -59543,6 +60260,15 @@ export declare class LayoutApi extends BaseAPI implements LayoutApiInterface {
|
|
|
59543
60260
|
* @memberof LayoutApi
|
|
59544
60261
|
*/
|
|
59545
60262
|
getDataSourcePermissions(requestParameters: LayoutApiGetDataSourcePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeDataSourcePermissions>;
|
|
60263
|
+
/**
|
|
60264
|
+
* (BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.
|
|
60265
|
+
* @summary (BETA) Retrieve stored physical statistics for a data source
|
|
60266
|
+
* @param {LayoutApiGetDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
60267
|
+
* @param {*} [options] Override http request option.
|
|
60268
|
+
* @throws {RequiredError}
|
|
60269
|
+
* @memberof LayoutApi
|
|
60270
|
+
*/
|
|
60271
|
+
getDataSourceStatistics(requestParameters: LayoutApiGetDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<DataSourceStatisticsResponse>;
|
|
59546
60272
|
/**
|
|
59547
60273
|
* Retrieve all data sources including related physical model.
|
|
59548
60274
|
* @summary Get all data sources
|
|
@@ -59696,6 +60422,15 @@ export declare class LayoutApi extends BaseAPI implements LayoutApiInterface {
|
|
|
59696
60422
|
* @memberof LayoutApi
|
|
59697
60423
|
*/
|
|
59698
60424
|
getWorkspacesLayout(requestParameters?: LayoutApiGetWorkspacesLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeWorkspaces>;
|
|
60425
|
+
/**
|
|
60426
|
+
* (BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.
|
|
60427
|
+
* @summary (BETA) Store physical table and column statistics for a data source
|
|
60428
|
+
* @param {LayoutApiPutDataSourceStatisticsRequest} requestParameters Request parameters.
|
|
60429
|
+
* @param {*} [options] Override http request option.
|
|
60430
|
+
* @throws {RequiredError}
|
|
60431
|
+
* @memberof LayoutApi
|
|
60432
|
+
*/
|
|
60433
|
+
putDataSourceStatistics(requestParameters: LayoutApiPutDataSourceStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
59699
60434
|
/**
|
|
59700
60435
|
* Set all data sources including related physical model.
|
|
59701
60436
|
* @summary Put all data sources
|
|
@@ -59741,6 +60476,15 @@ export declare class LayoutApi extends BaseAPI implements LayoutApiInterface {
|
|
|
59741
60476
|
* @memberof LayoutApi
|
|
59742
60477
|
*/
|
|
59743
60478
|
putWorkspaceLayout(requestParameters: LayoutApiPutWorkspaceLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
60479
|
+
/**
|
|
60480
|
+
* Sets AI agent configurations in organization.
|
|
60481
|
+
* @summary Set all AI agent configurations
|
|
60482
|
+
* @param {LayoutApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
60483
|
+
* @param {*} [options] Override http request option.
|
|
60484
|
+
* @throws {RequiredError}
|
|
60485
|
+
* @memberof LayoutApi
|
|
60486
|
+
*/
|
|
60487
|
+
setAgentsLayout(requestParameters: LayoutApiSetAgentsLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
59744
60488
|
/**
|
|
59745
60489
|
* Set effective analytics model of the workspace.
|
|
59746
60490
|
* @summary Set analytics model
|
|
@@ -61530,13 +62274,13 @@ export declare class MetadataSyncApi extends BaseAPI implements MetadataSyncApiI
|
|
|
61530
62274
|
* @summary Post Metrics
|
|
61531
62275
|
* @param {string} workspaceId
|
|
61532
62276
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
61533
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62277
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61534
62278
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
61535
62279
|
* @param {*} [options] Override http request option.
|
|
61536
62280
|
* @param {Configuration} [configuration] Optional configuration.
|
|
61537
62281
|
* @throws {RequiredError}
|
|
61538
62282
|
*/
|
|
61539
|
-
export declare function MetricControllerApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62283
|
+
export declare function MetricControllerApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
61540
62284
|
/**
|
|
61541
62285
|
*
|
|
61542
62286
|
* @summary Delete a Metric
|
|
@@ -61553,7 +62297,7 @@ export declare function MetricControllerApiAxiosParamCreator_DeleteEntityMetrics
|
|
|
61553
62297
|
* @param {string} workspaceId
|
|
61554
62298
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
61555
62299
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
61556
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62300
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61557
62301
|
* @param {number} [page] Zero-based page index (0..N)
|
|
61558
62302
|
* @param {number} [size] The size of the page to be returned
|
|
61559
62303
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -61563,21 +62307,21 @@ export declare function MetricControllerApiAxiosParamCreator_DeleteEntityMetrics
|
|
|
61563
62307
|
* @param {Configuration} [configuration] Optional configuration.
|
|
61564
62308
|
* @throws {RequiredError}
|
|
61565
62309
|
*/
|
|
61566
|
-
export declare function MetricControllerApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62310
|
+
export declare function MetricControllerApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
61567
62311
|
/**
|
|
61568
62312
|
*
|
|
61569
62313
|
* @summary Get a Metric
|
|
61570
62314
|
* @param {string} workspaceId
|
|
61571
62315
|
* @param {string} objectId
|
|
61572
62316
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
61573
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62317
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61574
62318
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
61575
62319
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
61576
62320
|
* @param {*} [options] Override http request option.
|
|
61577
62321
|
* @param {Configuration} [configuration] Optional configuration.
|
|
61578
62322
|
* @throws {RequiredError}
|
|
61579
62323
|
*/
|
|
61580
|
-
export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62324
|
+
export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
61581
62325
|
/**
|
|
61582
62326
|
*
|
|
61583
62327
|
* @summary Patch a Metric
|
|
@@ -61585,12 +62329,12 @@ export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(wo
|
|
|
61585
62329
|
* @param {string} objectId
|
|
61586
62330
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
61587
62331
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
61588
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62332
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61589
62333
|
* @param {*} [options] Override http request option.
|
|
61590
62334
|
* @param {Configuration} [configuration] Optional configuration.
|
|
61591
62335
|
* @throws {RequiredError}
|
|
61592
62336
|
*/
|
|
61593
|
-
export declare function MetricControllerApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62337
|
+
export declare function MetricControllerApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
61594
62338
|
/**
|
|
61595
62339
|
*
|
|
61596
62340
|
* @summary The search endpoint (beta)
|
|
@@ -61610,12 +62354,12 @@ export declare function MetricControllerApiAxiosParamCreator_SearchEntitiesMetri
|
|
|
61610
62354
|
* @param {string} objectId
|
|
61611
62355
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
61612
62356
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
61613
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62357
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61614
62358
|
* @param {*} [options] Override http request option.
|
|
61615
62359
|
* @param {Configuration} [configuration] Optional configuration.
|
|
61616
62360
|
* @throws {RequiredError}
|
|
61617
62361
|
*/
|
|
61618
|
-
export declare function MetricControllerApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62362
|
+
export declare function MetricControllerApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
61619
62363
|
/**
|
|
61620
62364
|
*
|
|
61621
62365
|
* @summary Post Metrics
|
|
@@ -61783,10 +62527,10 @@ export interface MetricControllerApiCreateEntityMetricsRequest {
|
|
|
61783
62527
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
61784
62528
|
/**
|
|
61785
62529
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61786
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62530
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
61787
62531
|
* @memberof MetricControllerApiCreateEntityMetrics
|
|
61788
62532
|
*/
|
|
61789
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62533
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
61790
62534
|
/**
|
|
61791
62535
|
* Include Meta objects.
|
|
61792
62536
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -61839,10 +62583,10 @@ export interface MetricControllerApiGetAllEntitiesMetricsRequest {
|
|
|
61839
62583
|
readonly filter?: string;
|
|
61840
62584
|
/**
|
|
61841
62585
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61842
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62586
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
61843
62587
|
* @memberof MetricControllerApiGetAllEntitiesMetrics
|
|
61844
62588
|
*/
|
|
61845
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62589
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
61846
62590
|
/**
|
|
61847
62591
|
* Zero-based page index (0..N)
|
|
61848
62592
|
* @type {number}
|
|
@@ -61900,10 +62644,10 @@ export interface MetricControllerApiGetEntityMetricsRequest {
|
|
|
61900
62644
|
readonly filter?: string;
|
|
61901
62645
|
/**
|
|
61902
62646
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61903
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62647
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
61904
62648
|
* @memberof MetricControllerApiGetEntityMetrics
|
|
61905
62649
|
*/
|
|
61906
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62650
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
61907
62651
|
/**
|
|
61908
62652
|
*
|
|
61909
62653
|
* @type {boolean}
|
|
@@ -61949,10 +62693,10 @@ export interface MetricControllerApiPatchEntityMetricsRequest {
|
|
|
61949
62693
|
readonly filter?: string;
|
|
61950
62694
|
/**
|
|
61951
62695
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
61952
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62696
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
61953
62697
|
* @memberof MetricControllerApiPatchEntityMetrics
|
|
61954
62698
|
*/
|
|
61955
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62699
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
61956
62700
|
}
|
|
61957
62701
|
/**
|
|
61958
62702
|
* Request parameters for searchEntitiesMetrics operation in MetricControllerApi.
|
|
@@ -62017,10 +62761,10 @@ export interface MetricControllerApiUpdateEntityMetricsRequest {
|
|
|
62017
62761
|
readonly filter?: string;
|
|
62018
62762
|
/**
|
|
62019
62763
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62020
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62764
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62021
62765
|
* @memberof MetricControllerApiUpdateEntityMetrics
|
|
62022
62766
|
*/
|
|
62023
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62767
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62024
62768
|
}
|
|
62025
62769
|
/**
|
|
62026
62770
|
* MetricControllerApi - object-oriented interface
|
|
@@ -62098,13 +62842,13 @@ export declare class MetricControllerApi extends BaseAPI implements MetricContro
|
|
|
62098
62842
|
* @summary Post Metrics
|
|
62099
62843
|
* @param {string} workspaceId
|
|
62100
62844
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
62101
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62845
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62102
62846
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
62103
62847
|
* @param {*} [options] Override http request option.
|
|
62104
62848
|
* @param {Configuration} [configuration] Optional configuration.
|
|
62105
62849
|
* @throws {RequiredError}
|
|
62106
62850
|
*/
|
|
62107
|
-
export declare function MetricsApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62851
|
+
export declare function MetricsApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62108
62852
|
/**
|
|
62109
62853
|
*
|
|
62110
62854
|
* @summary Delete a Metric
|
|
@@ -62121,7 +62865,7 @@ export declare function MetricsApiAxiosParamCreator_DeleteEntityMetrics(workspac
|
|
|
62121
62865
|
* @param {string} workspaceId
|
|
62122
62866
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
62123
62867
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
62124
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62868
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62125
62869
|
* @param {number} [page] Zero-based page index (0..N)
|
|
62126
62870
|
* @param {number} [size] The size of the page to be returned
|
|
62127
62871
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -62131,21 +62875,21 @@ export declare function MetricsApiAxiosParamCreator_DeleteEntityMetrics(workspac
|
|
|
62131
62875
|
* @param {Configuration} [configuration] Optional configuration.
|
|
62132
62876
|
* @throws {RequiredError}
|
|
62133
62877
|
*/
|
|
62134
|
-
export declare function MetricsApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62878
|
+
export declare function MetricsApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62135
62879
|
/**
|
|
62136
62880
|
*
|
|
62137
62881
|
* @summary Get a Metric
|
|
62138
62882
|
* @param {string} workspaceId
|
|
62139
62883
|
* @param {string} objectId
|
|
62140
62884
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
62141
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62885
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62142
62886
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
62143
62887
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
62144
62888
|
* @param {*} [options] Override http request option.
|
|
62145
62889
|
* @param {Configuration} [configuration] Optional configuration.
|
|
62146
62890
|
* @throws {RequiredError}
|
|
62147
62891
|
*/
|
|
62148
|
-
export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62892
|
+
export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62149
62893
|
/**
|
|
62150
62894
|
*
|
|
62151
62895
|
* @summary Patch a Metric
|
|
@@ -62153,12 +62897,12 @@ export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId
|
|
|
62153
62897
|
* @param {string} objectId
|
|
62154
62898
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
62155
62899
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
62156
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62900
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62157
62901
|
* @param {*} [options] Override http request option.
|
|
62158
62902
|
* @param {Configuration} [configuration] Optional configuration.
|
|
62159
62903
|
* @throws {RequiredError}
|
|
62160
62904
|
*/
|
|
62161
|
-
export declare function MetricsApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62905
|
+
export declare function MetricsApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62162
62906
|
/**
|
|
62163
62907
|
*
|
|
62164
62908
|
* @summary The search endpoint (beta)
|
|
@@ -62178,12 +62922,12 @@ export declare function MetricsApiAxiosParamCreator_SearchEntitiesMetrics(worksp
|
|
|
62178
62922
|
* @param {string} objectId
|
|
62179
62923
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
62180
62924
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
62181
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62925
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62182
62926
|
* @param {*} [options] Override http request option.
|
|
62183
62927
|
* @param {Configuration} [configuration] Optional configuration.
|
|
62184
62928
|
* @throws {RequiredError}
|
|
62185
62929
|
*/
|
|
62186
|
-
export declare function MetricsApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62930
|
+
export declare function MetricsApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
62187
62931
|
/**
|
|
62188
62932
|
*
|
|
62189
62933
|
* @summary Post Metrics
|
|
@@ -62351,10 +63095,10 @@ export interface MetricsApiCreateEntityMetricsRequest {
|
|
|
62351
63095
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
62352
63096
|
/**
|
|
62353
63097
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62354
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
63098
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62355
63099
|
* @memberof MetricsApiCreateEntityMetrics
|
|
62356
63100
|
*/
|
|
62357
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
63101
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62358
63102
|
/**
|
|
62359
63103
|
* Include Meta objects.
|
|
62360
63104
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -62407,10 +63151,10 @@ export interface MetricsApiGetAllEntitiesMetricsRequest {
|
|
|
62407
63151
|
readonly filter?: string;
|
|
62408
63152
|
/**
|
|
62409
63153
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62410
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
63154
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62411
63155
|
* @memberof MetricsApiGetAllEntitiesMetrics
|
|
62412
63156
|
*/
|
|
62413
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
63157
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62414
63158
|
/**
|
|
62415
63159
|
* Zero-based page index (0..N)
|
|
62416
63160
|
* @type {number}
|
|
@@ -62468,10 +63212,10 @@ export interface MetricsApiGetEntityMetricsRequest {
|
|
|
62468
63212
|
readonly filter?: string;
|
|
62469
63213
|
/**
|
|
62470
63214
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62471
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
63215
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62472
63216
|
* @memberof MetricsApiGetEntityMetrics
|
|
62473
63217
|
*/
|
|
62474
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
63218
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62475
63219
|
/**
|
|
62476
63220
|
*
|
|
62477
63221
|
* @type {boolean}
|
|
@@ -62517,10 +63261,10 @@ export interface MetricsApiPatchEntityMetricsRequest {
|
|
|
62517
63261
|
readonly filter?: string;
|
|
62518
63262
|
/**
|
|
62519
63263
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62520
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
63264
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62521
63265
|
* @memberof MetricsApiPatchEntityMetrics
|
|
62522
63266
|
*/
|
|
62523
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
63267
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62524
63268
|
}
|
|
62525
63269
|
/**
|
|
62526
63270
|
* Request parameters for searchEntitiesMetrics operation in MetricsApi.
|
|
@@ -62585,10 +63329,10 @@ export interface MetricsApiUpdateEntityMetricsRequest {
|
|
|
62585
63329
|
readonly filter?: string;
|
|
62586
63330
|
/**
|
|
62587
63331
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
62588
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
63332
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
62589
63333
|
* @memberof MetricsApiUpdateEntityMetrics
|
|
62590
63334
|
*/
|
|
62591
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
63335
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
62592
63336
|
}
|
|
62593
63337
|
/**
|
|
62594
63338
|
* MetricsApi - object-oriented interface
|
|
@@ -63937,6 +64681,14 @@ export declare class OptionsApi extends BaseAPI implements OptionsApiInterface {
|
|
|
63937
64681
|
*/
|
|
63938
64682
|
getAllOptions(options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
63939
64683
|
}
|
|
64684
|
+
/**
|
|
64685
|
+
* Gets complete layout of AI agent configurations.
|
|
64686
|
+
* @summary Get all AI agent configurations layout
|
|
64687
|
+
* @param {*} [options] Override http request option.
|
|
64688
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
64689
|
+
* @throws {RequiredError}
|
|
64690
|
+
*/
|
|
64691
|
+
export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_GetAgentsLayout(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
63940
64692
|
/**
|
|
63941
64693
|
* Gets complete layout of custom geo collections.
|
|
63942
64694
|
* @summary Get all custom geo collections layout
|
|
@@ -63954,6 +64706,15 @@ export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_GetCusto
|
|
|
63954
64706
|
* @throws {RequiredError}
|
|
63955
64707
|
*/
|
|
63956
64708
|
export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_GetOrganizationLayout(exclude?: Array<'ACTIVITY_INFO'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
64709
|
+
/**
|
|
64710
|
+
* Sets AI agent configurations in organization.
|
|
64711
|
+
* @summary Set all AI agent configurations
|
|
64712
|
+
* @param {DeclarativeAgents} declarativeAgents
|
|
64713
|
+
* @param {*} [options] Override http request option.
|
|
64714
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
64715
|
+
* @throws {RequiredError}
|
|
64716
|
+
*/
|
|
64717
|
+
export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_SetAgentsLayout(declarativeAgents: DeclarativeAgents, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
63957
64718
|
/**
|
|
63958
64719
|
* Sets custom geo collections in organization.
|
|
63959
64720
|
* @summary Set all custom geo collections
|
|
@@ -63972,6 +64733,16 @@ export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_SetCusto
|
|
|
63972
64733
|
* @throws {RequiredError}
|
|
63973
64734
|
*/
|
|
63974
64735
|
export declare function OrganizationDeclarativeAPIsApiAxiosParamCreator_SetOrganizationLayout(declarativeOrganization: DeclarativeOrganization, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
64736
|
+
/**
|
|
64737
|
+
* Gets complete layout of AI agent configurations.
|
|
64738
|
+
* @summary Get all AI agent configurations layout
|
|
64739
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
64740
|
+
* @param {string} basePath Base path.
|
|
64741
|
+
* @param {*} [options] Override http request option.
|
|
64742
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
64743
|
+
* @throws {RequiredError}
|
|
64744
|
+
*/
|
|
64745
|
+
export declare function OrganizationDeclarativeAPIsApi_GetAgentsLayout(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DeclarativeAgents>;
|
|
63975
64746
|
/**
|
|
63976
64747
|
* Gets complete layout of custom geo collections.
|
|
63977
64748
|
* @summary Get all custom geo collections layout
|
|
@@ -63993,6 +64764,17 @@ export declare function OrganizationDeclarativeAPIsApi_GetCustomGeoCollectionsLa
|
|
|
63993
64764
|
* @throws {RequiredError}
|
|
63994
64765
|
*/
|
|
63995
64766
|
export declare function OrganizationDeclarativeAPIsApi_GetOrganizationLayout(axios: AxiosInstance, basePath: string, requestParameters: OrganizationDeclarativeAPIsApiGetOrganizationLayoutRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DeclarativeOrganization>;
|
|
64767
|
+
/**
|
|
64768
|
+
* Sets AI agent configurations in organization.
|
|
64769
|
+
* @summary Set all AI agent configurations
|
|
64770
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
64771
|
+
* @param {string} basePath Base path.
|
|
64772
|
+
* @param {OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
64773
|
+
* @param {*} [options] Override http request option.
|
|
64774
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
64775
|
+
* @throws {RequiredError}
|
|
64776
|
+
*/
|
|
64777
|
+
export declare function OrganizationDeclarativeAPIsApi_SetAgentsLayout(axios: AxiosInstance, basePath: string, requestParameters: OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
63996
64778
|
/**
|
|
63997
64779
|
* Sets custom geo collections in organization.
|
|
63998
64780
|
* @summary Set all custom geo collections
|
|
@@ -64021,6 +64803,14 @@ export declare function OrganizationDeclarativeAPIsApi_SetOrganizationLayout(axi
|
|
|
64021
64803
|
* @interface OrganizationDeclarativeAPIsApi
|
|
64022
64804
|
*/
|
|
64023
64805
|
export interface OrganizationDeclarativeAPIsApiInterface {
|
|
64806
|
+
/**
|
|
64807
|
+
* Gets complete layout of AI agent configurations.
|
|
64808
|
+
* @summary Get all AI agent configurations layout
|
|
64809
|
+
* @param {*} [options] Override http request option.
|
|
64810
|
+
* @throws {RequiredError}
|
|
64811
|
+
* @memberof OrganizationDeclarativeAPIsApiInterface
|
|
64812
|
+
*/
|
|
64813
|
+
getAgentsLayout(options?: AxiosRequestConfig): AxiosPromise<DeclarativeAgents>;
|
|
64024
64814
|
/**
|
|
64025
64815
|
* Gets complete layout of custom geo collections.
|
|
64026
64816
|
* @summary Get all custom geo collections layout
|
|
@@ -64038,6 +64828,15 @@ export interface OrganizationDeclarativeAPIsApiInterface {
|
|
|
64038
64828
|
* @memberof OrganizationDeclarativeAPIsApiInterface
|
|
64039
64829
|
*/
|
|
64040
64830
|
getOrganizationLayout(requestParameters: OrganizationDeclarativeAPIsApiGetOrganizationLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeOrganization>;
|
|
64831
|
+
/**
|
|
64832
|
+
* Sets AI agent configurations in organization.
|
|
64833
|
+
* @summary Set all AI agent configurations
|
|
64834
|
+
* @param {OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
64835
|
+
* @param {*} [options] Override http request option.
|
|
64836
|
+
* @throws {RequiredError}
|
|
64837
|
+
* @memberof OrganizationDeclarativeAPIsApiInterface
|
|
64838
|
+
*/
|
|
64839
|
+
setAgentsLayout(requestParameters: OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
64041
64840
|
/**
|
|
64042
64841
|
* Sets custom geo collections in organization.
|
|
64043
64842
|
* @summary Set all custom geo collections
|
|
@@ -64070,6 +64869,19 @@ export interface OrganizationDeclarativeAPIsApiGetOrganizationLayoutRequest {
|
|
|
64070
64869
|
*/
|
|
64071
64870
|
readonly exclude?: Array<'ACTIVITY_INFO'>;
|
|
64072
64871
|
}
|
|
64872
|
+
/**
|
|
64873
|
+
* Request parameters for setAgentsLayout operation in OrganizationDeclarativeAPIsApi.
|
|
64874
|
+
* @export
|
|
64875
|
+
* @interface OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest
|
|
64876
|
+
*/
|
|
64877
|
+
export interface OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest {
|
|
64878
|
+
/**
|
|
64879
|
+
*
|
|
64880
|
+
* @type {DeclarativeAgents}
|
|
64881
|
+
* @memberof OrganizationDeclarativeAPIsApiSetAgentsLayout
|
|
64882
|
+
*/
|
|
64883
|
+
readonly declarativeAgents: DeclarativeAgents;
|
|
64884
|
+
}
|
|
64073
64885
|
/**
|
|
64074
64886
|
* Request parameters for setCustomGeoCollections operation in OrganizationDeclarativeAPIsApi.
|
|
64075
64887
|
* @export
|
|
@@ -64103,6 +64915,14 @@ export interface OrganizationDeclarativeAPIsApiSetOrganizationLayoutRequest {
|
|
|
64103
64915
|
* @extends {BaseAPI}
|
|
64104
64916
|
*/
|
|
64105
64917
|
export declare class OrganizationDeclarativeAPIsApi extends BaseAPI implements OrganizationDeclarativeAPIsApiInterface {
|
|
64918
|
+
/**
|
|
64919
|
+
* Gets complete layout of AI agent configurations.
|
|
64920
|
+
* @summary Get all AI agent configurations layout
|
|
64921
|
+
* @param {*} [options] Override http request option.
|
|
64922
|
+
* @throws {RequiredError}
|
|
64923
|
+
* @memberof OrganizationDeclarativeAPIsApi
|
|
64924
|
+
*/
|
|
64925
|
+
getAgentsLayout(options?: AxiosRequestConfig): AxiosPromise<DeclarativeAgents>;
|
|
64106
64926
|
/**
|
|
64107
64927
|
* Gets complete layout of custom geo collections.
|
|
64108
64928
|
* @summary Get all custom geo collections layout
|
|
@@ -64120,6 +64940,15 @@ export declare class OrganizationDeclarativeAPIsApi extends BaseAPI implements O
|
|
|
64120
64940
|
* @memberof OrganizationDeclarativeAPIsApi
|
|
64121
64941
|
*/
|
|
64122
64942
|
getOrganizationLayout(requestParameters?: OrganizationDeclarativeAPIsApiGetOrganizationLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<DeclarativeOrganization>;
|
|
64943
|
+
/**
|
|
64944
|
+
* Sets AI agent configurations in organization.
|
|
64945
|
+
* @summary Set all AI agent configurations
|
|
64946
|
+
* @param {OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest} requestParameters Request parameters.
|
|
64947
|
+
* @param {*} [options] Override http request option.
|
|
64948
|
+
* @throws {RequiredError}
|
|
64949
|
+
* @memberof OrganizationDeclarativeAPIsApi
|
|
64950
|
+
*/
|
|
64951
|
+
setAgentsLayout(requestParameters: OrganizationDeclarativeAPIsApiSetAgentsLayoutRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
64123
64952
|
/**
|
|
64124
64953
|
* Sets custom geo collections in organization.
|
|
64125
64954
|
* @summary Set all custom geo collections
|
|
@@ -69156,13 +69985,13 @@ export declare class UserControllerApi extends BaseAPI implements UserController
|
|
|
69156
69985
|
* @summary Post User Data Filters
|
|
69157
69986
|
* @param {string} workspaceId
|
|
69158
69987
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
69159
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69988
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69160
69989
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69161
69990
|
* @param {*} [options] Override http request option.
|
|
69162
69991
|
* @param {Configuration} [configuration] Optional configuration.
|
|
69163
69992
|
* @throws {RequiredError}
|
|
69164
69993
|
*/
|
|
69165
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69994
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69166
69995
|
/**
|
|
69167
69996
|
*
|
|
69168
69997
|
* @summary Delete a User Data Filter
|
|
@@ -69179,7 +70008,7 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_DeleteEntit
|
|
|
69179
70008
|
* @param {string} workspaceId
|
|
69180
70009
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
69181
70010
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69182
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70011
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69183
70012
|
* @param {number} [page] Zero-based page index (0..N)
|
|
69184
70013
|
* @param {number} [size] The size of the page to be returned
|
|
69185
70014
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -69189,21 +70018,21 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_DeleteEntit
|
|
|
69189
70018
|
* @param {Configuration} [configuration] Optional configuration.
|
|
69190
70019
|
* @throws {RequiredError}
|
|
69191
70020
|
*/
|
|
69192
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
70021
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69193
70022
|
/**
|
|
69194
70023
|
*
|
|
69195
70024
|
* @summary Get a User Data Filter
|
|
69196
70025
|
* @param {string} workspaceId
|
|
69197
70026
|
* @param {string} objectId
|
|
69198
70027
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69199
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70028
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69200
70029
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
69201
70030
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69202
70031
|
* @param {*} [options] Override http request option.
|
|
69203
70032
|
* @param {Configuration} [configuration] Optional configuration.
|
|
69204
70033
|
* @throws {RequiredError}
|
|
69205
70034
|
*/
|
|
69206
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
70035
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69207
70036
|
/**
|
|
69208
70037
|
*
|
|
69209
70038
|
* @summary Patch a User Data Filter
|
|
@@ -69211,12 +70040,12 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUs
|
|
|
69211
70040
|
* @param {string} objectId
|
|
69212
70041
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
69213
70042
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69214
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70043
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69215
70044
|
* @param {*} [options] Override http request option.
|
|
69216
70045
|
* @param {Configuration} [configuration] Optional configuration.
|
|
69217
70046
|
* @throws {RequiredError}
|
|
69218
70047
|
*/
|
|
69219
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
70048
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69220
70049
|
/**
|
|
69221
70050
|
*
|
|
69222
70051
|
* @summary The search endpoint (beta)
|
|
@@ -69236,12 +70065,12 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_SearchEntit
|
|
|
69236
70065
|
* @param {string} objectId
|
|
69237
70066
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
69238
70067
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69239
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70068
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69240
70069
|
* @param {*} [options] Override http request option.
|
|
69241
70070
|
* @param {Configuration} [configuration] Optional configuration.
|
|
69242
70071
|
* @throws {RequiredError}
|
|
69243
70072
|
*/
|
|
69244
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
70073
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
69245
70074
|
/**
|
|
69246
70075
|
*
|
|
69247
70076
|
* @summary Post User Data Filters
|
|
@@ -69409,10 +70238,10 @@ export interface UserDataFilterControllerApiCreateEntityUserDataFiltersRequest {
|
|
|
69409
70238
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
69410
70239
|
/**
|
|
69411
70240
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69412
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
70241
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
69413
70242
|
* @memberof UserDataFilterControllerApiCreateEntityUserDataFilters
|
|
69414
70243
|
*/
|
|
69415
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
70244
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
69416
70245
|
/**
|
|
69417
70246
|
* Include Meta objects.
|
|
69418
70247
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -69465,10 +70294,10 @@ export interface UserDataFilterControllerApiGetAllEntitiesUserDataFiltersRequest
|
|
|
69465
70294
|
readonly filter?: string;
|
|
69466
70295
|
/**
|
|
69467
70296
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69468
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
70297
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
69469
70298
|
* @memberof UserDataFilterControllerApiGetAllEntitiesUserDataFilters
|
|
69470
70299
|
*/
|
|
69471
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
70300
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
69472
70301
|
/**
|
|
69473
70302
|
* Zero-based page index (0..N)
|
|
69474
70303
|
* @type {number}
|
|
@@ -69526,10 +70355,10 @@ export interface UserDataFilterControllerApiGetEntityUserDataFiltersRequest {
|
|
|
69526
70355
|
readonly filter?: string;
|
|
69527
70356
|
/**
|
|
69528
70357
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69529
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
70358
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
69530
70359
|
* @memberof UserDataFilterControllerApiGetEntityUserDataFilters
|
|
69531
70360
|
*/
|
|
69532
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
70361
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
69533
70362
|
/**
|
|
69534
70363
|
*
|
|
69535
70364
|
* @type {boolean}
|
|
@@ -69575,10 +70404,10 @@ export interface UserDataFilterControllerApiPatchEntityUserDataFiltersRequest {
|
|
|
69575
70404
|
readonly filter?: string;
|
|
69576
70405
|
/**
|
|
69577
70406
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69578
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
70407
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
69579
70408
|
* @memberof UserDataFilterControllerApiPatchEntityUserDataFilters
|
|
69580
70409
|
*/
|
|
69581
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
70410
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
69582
70411
|
}
|
|
69583
70412
|
/**
|
|
69584
70413
|
* Request parameters for searchEntitiesUserDataFilters operation in UserDataFilterControllerApi.
|
|
@@ -69643,10 +70472,10 @@ export interface UserDataFilterControllerApiUpdateEntityUserDataFiltersRequest {
|
|
|
69643
70472
|
readonly filter?: string;
|
|
69644
70473
|
/**
|
|
69645
70474
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69646
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>}
|
|
70475
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
69647
70476
|
* @memberof UserDataFilterControllerApiUpdateEntityUserDataFilters
|
|
69648
70477
|
*/
|
|
69649
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'user' | 'userGroup' | 'ALL'>;
|
|
70478
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
69650
70479
|
}
|
|
69651
70480
|
/**
|
|
69652
70481
|
* UserDataFilterControllerApi - object-oriented interface
|
|
@@ -74397,6 +75226,17 @@ export declare function WorkspaceControllerApiAxiosParamCreator_GetEntityWorkspa
|
|
|
74397
75226
|
* @throws {RequiredError}
|
|
74398
75227
|
*/
|
|
74399
75228
|
export declare function WorkspaceControllerApiAxiosParamCreator_PatchEntityWorkspaces(id: string, jsonApiWorkspacePatchDocument: JsonApiWorkspacePatchDocument, filter?: string, include?: Array<'workspaces' | 'parent' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
75229
|
+
/**
|
|
75230
|
+
* Notification sets up all reports to be computed again with new data.
|
|
75231
|
+
* @summary Register an upload notification
|
|
75232
|
+
* @param {string} workspaceId
|
|
75233
|
+
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
75234
|
+
* @param {object} [body] Request body
|
|
75235
|
+
* @param {*} [options] Override http request option.
|
|
75236
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
75237
|
+
* @throws {RequiredError}
|
|
75238
|
+
*/
|
|
75239
|
+
export declare function WorkspaceControllerApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74400
75240
|
/**
|
|
74401
75241
|
* Space of the shared interest
|
|
74402
75242
|
* @summary Put Workspace entity
|
|
@@ -74464,6 +75304,17 @@ export declare function WorkspaceControllerApi_GetEntityWorkspaces(axios: AxiosI
|
|
|
74464
75304
|
* @throws {RequiredError}
|
|
74465
75305
|
*/
|
|
74466
75306
|
export declare function WorkspaceControllerApi_PatchEntityWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
75307
|
+
/**
|
|
75308
|
+
* Notification sets up all reports to be computed again with new data.
|
|
75309
|
+
* @summary Register an upload notification
|
|
75310
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
75311
|
+
* @param {string} basePath Base path.
|
|
75312
|
+
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
75313
|
+
* @param {*} [options] Override http request option.
|
|
75314
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
75315
|
+
* @throws {RequiredError}
|
|
75316
|
+
*/
|
|
75317
|
+
export declare function WorkspaceControllerApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
74467
75318
|
/**
|
|
74468
75319
|
* Space of the shared interest
|
|
74469
75320
|
* @summary Put Workspace entity
|
|
@@ -74526,6 +75377,15 @@ export interface WorkspaceControllerApiInterface {
|
|
|
74526
75377
|
* @memberof WorkspaceControllerApiInterface
|
|
74527
75378
|
*/
|
|
74528
75379
|
patchEntityWorkspaces(requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
75380
|
+
/**
|
|
75381
|
+
* Notification sets up all reports to be computed again with new data.
|
|
75382
|
+
* @summary Register an upload notification
|
|
75383
|
+
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
75384
|
+
* @param {*} [options] Override http request option.
|
|
75385
|
+
* @throws {RequiredError}
|
|
75386
|
+
* @memberof WorkspaceControllerApiInterface
|
|
75387
|
+
*/
|
|
75388
|
+
registerUploadNotificationWorkspaces(requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
74529
75389
|
/**
|
|
74530
75390
|
* Space of the shared interest
|
|
74531
75391
|
* @summary Put Workspace entity
|
|
@@ -74679,6 +75539,31 @@ export interface WorkspaceControllerApiPatchEntityWorkspacesRequest {
|
|
|
74679
75539
|
*/
|
|
74680
75540
|
readonly include?: Array<'workspaces' | 'parent' | 'ALL'>;
|
|
74681
75541
|
}
|
|
75542
|
+
/**
|
|
75543
|
+
* Request parameters for registerUploadNotificationWorkspaces operation in WorkspaceControllerApi.
|
|
75544
|
+
* @export
|
|
75545
|
+
* @interface WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest
|
|
75546
|
+
*/
|
|
75547
|
+
export interface WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest {
|
|
75548
|
+
/**
|
|
75549
|
+
*
|
|
75550
|
+
* @type {string}
|
|
75551
|
+
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
75552
|
+
*/
|
|
75553
|
+
readonly workspaceId: string;
|
|
75554
|
+
/**
|
|
75555
|
+
* Include Meta objects.
|
|
75556
|
+
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
75557
|
+
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
75558
|
+
*/
|
|
75559
|
+
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
75560
|
+
/**
|
|
75561
|
+
* Request body
|
|
75562
|
+
* @type {object}
|
|
75563
|
+
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
75564
|
+
*/
|
|
75565
|
+
readonly body?: object;
|
|
75566
|
+
}
|
|
74682
75567
|
/**
|
|
74683
75568
|
* Request parameters for updateEntityWorkspaces operation in WorkspaceControllerApi.
|
|
74684
75569
|
* @export
|
|
@@ -74762,6 +75647,15 @@ export declare class WorkspaceControllerApi extends BaseAPI implements Workspace
|
|
|
74762
75647
|
* @memberof WorkspaceControllerApi
|
|
74763
75648
|
*/
|
|
74764
75649
|
patchEntityWorkspaces(requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
75650
|
+
/**
|
|
75651
|
+
* Notification sets up all reports to be computed again with new data.
|
|
75652
|
+
* @summary Register an upload notification
|
|
75653
|
+
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
75654
|
+
* @param {*} [options] Override http request option.
|
|
75655
|
+
* @throws {RequiredError}
|
|
75656
|
+
* @memberof WorkspaceControllerApi
|
|
75657
|
+
*/
|
|
75658
|
+
registerUploadNotificationWorkspaces(requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
74765
75659
|
/**
|
|
74766
75660
|
* Space of the shared interest
|
|
74767
75661
|
* @summary Put Workspace entity
|