@gooddata/api-client-tiger 10.33.0-alpha.2 → 10.33.0-alpha.21

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.
@@ -476,6 +476,13 @@
476
476
  "$ref": "#/components/schemas/AutomationSlidesExport"
477
477
  }
478
478
  },
479
+ "dashboardTabularExports": {
480
+ "uniqueItems": true,
481
+ "type": "array",
482
+ "items": {
483
+ "$ref": "#/components/schemas/AutomationDashboardTabularExport"
484
+ }
485
+ },
479
486
  "externalRecipients": {
480
487
  "uniqueItems": true,
481
488
  "type": "array",
@@ -750,6 +757,45 @@
750
757
  },
751
758
  "description": "Metric representing arithmetics between other metrics."
752
759
  },
760
+ "AttributeElements": {
761
+ "type": "object",
762
+ "oneOf": [
763
+ {
764
+ "$ref": "#/components/schemas/AttributeElementsByRef"
765
+ },
766
+ {
767
+ "$ref": "#/components/schemas/AttributeElementsByValue"
768
+ }
769
+ ]
770
+ },
771
+ "AttributeElementsByRef": {
772
+ "required": ["uris"],
773
+ "type": "object",
774
+ "properties": {
775
+ "uris": {
776
+ "type": "array",
777
+ "description": "List of attribute elements by reference",
778
+ "items": {
779
+ "type": "string",
780
+ "nullable": true
781
+ }
782
+ }
783
+ }
784
+ },
785
+ "AttributeElementsByValue": {
786
+ "required": ["values"],
787
+ "type": "object",
788
+ "properties": {
789
+ "values": {
790
+ "type": "array",
791
+ "description": "List of attribute elements by value",
792
+ "items": {
793
+ "type": "string",
794
+ "nullable": true
795
+ }
796
+ }
797
+ }
798
+ },
753
799
  "AttributeFilter": {
754
800
  "type": "object",
755
801
  "description": "Abstract filter definition type attributes",
@@ -762,6 +808,18 @@
762
808
  }
763
809
  ]
764
810
  },
811
+ "AttributeFilterByDate": {
812
+ "required": ["filterLocalIdentifier", "isCommonDate"],
813
+ "type": "object",
814
+ "properties": {
815
+ "filterLocalIdentifier": {
816
+ "type": "string"
817
+ },
818
+ "isCommonDate": {
819
+ "type": "boolean"
820
+ }
821
+ }
822
+ },
765
823
  "AttributeFilterElements": {
766
824
  "required": ["values"],
767
825
  "type": "object",
@@ -779,6 +837,18 @@
779
837
  },
780
838
  "description": "Filter on specific set of label values."
781
839
  },
840
+ "AttributeFilterParent": {
841
+ "required": ["filterLocalIdentifier", "over"],
842
+ "type": "object",
843
+ "properties": {
844
+ "filterLocalIdentifier": {
845
+ "type": "string"
846
+ },
847
+ "over": {
848
+ "$ref": "#/components/schemas/Over"
849
+ }
850
+ }
851
+ },
782
852
  "AttributeItem": {
783
853
  "required": ["label", "localIdentifier"],
784
854
  "type": "object",
@@ -827,6 +897,15 @@
827
897
  }
828
898
  }
829
899
  },
900
+ "AutomationDashboardTabularExport": {
901
+ "required": ["requestPayload"],
902
+ "type": "object",
903
+ "properties": {
904
+ "requestPayload": {
905
+ "$ref": "#/components/schemas/DashboardTabularExportRequestV2"
906
+ }
907
+ }
908
+ },
830
909
  "AutomationExternalRecipient": {
831
910
  "required": ["email"],
832
911
  "type": "object",
@@ -1028,6 +1107,201 @@
1028
1107
  },
1029
1108
  "description": "Custom cell value overrides (IDs will be replaced with specified values)."
1030
1109
  },
1110
+ "DashboardAttributeFilter": {
1111
+ "required": ["attributeFilter"],
1112
+ "type": "object",
1113
+ "properties": {
1114
+ "attributeFilter": {
1115
+ "required": ["attributeElements", "displayForm", "negativeSelection"],
1116
+ "type": "object",
1117
+ "properties": {
1118
+ "displayForm": {
1119
+ "$ref": "#/components/schemas/IdentifierRef"
1120
+ },
1121
+ "negativeSelection": {
1122
+ "type": "boolean"
1123
+ },
1124
+ "attributeElements": {
1125
+ "$ref": "#/components/schemas/AttributeElements"
1126
+ },
1127
+ "filterElementsBy": {
1128
+ "type": "array",
1129
+ "items": {
1130
+ "$ref": "#/components/schemas/AttributeFilterParent"
1131
+ }
1132
+ },
1133
+ "filterElementsByDate": {
1134
+ "type": "array",
1135
+ "items": {
1136
+ "$ref": "#/components/schemas/AttributeFilterByDate"
1137
+ }
1138
+ },
1139
+ "validateElementsBy": {
1140
+ "type": "array",
1141
+ "items": {
1142
+ "$ref": "#/components/schemas/IdentifierRef"
1143
+ }
1144
+ },
1145
+ "title": {
1146
+ "type": "string"
1147
+ },
1148
+ "selectionMode": {
1149
+ "type": "string",
1150
+ "enum": ["single", "multi"]
1151
+ },
1152
+ "localIdentifier": {
1153
+ "type": "string"
1154
+ }
1155
+ }
1156
+ }
1157
+ }
1158
+ },
1159
+ "DashboardDateFilter": {
1160
+ "required": ["dateFilter"],
1161
+ "type": "object",
1162
+ "properties": {
1163
+ "dateFilter": {
1164
+ "required": ["granularity", "type"],
1165
+ "type": "object",
1166
+ "properties": {
1167
+ "type": {
1168
+ "type": "string",
1169
+ "enum": ["relative", "absolute"]
1170
+ },
1171
+ "granularity": {
1172
+ "type": "string",
1173
+ "enum": [
1174
+ "ALL_TIME_GRANULARITY",
1175
+ "GDC.time.year",
1176
+ "GDC.time.week_us",
1177
+ "GDC.time.week_in_year",
1178
+ "GDC.time.week_in_quarter",
1179
+ "GDC.time.week",
1180
+ "GDC.time.euweek_in_year",
1181
+ "GDC.time.euweek_in_quarter",
1182
+ "GDC.time.quarter",
1183
+ "GDC.time.quarter_in_year",
1184
+ "GDC.time.month",
1185
+ "GDC.time.month_in_quarter",
1186
+ "GDC.time.month_in_year",
1187
+ "GDC.time.day_in_year",
1188
+ "GDC.time.day_in_quarter",
1189
+ "GDC.time.day_in_month",
1190
+ "GDC.time.day_in_week",
1191
+ "GDC.time.day_in_euweek",
1192
+ "GDC.time.date",
1193
+ "GDC.time.hour",
1194
+ "GDC.time.hour_in_day",
1195
+ "GDC.time.minute",
1196
+ "GDC.time.minute_in_hour"
1197
+ ]
1198
+ },
1199
+ "from": {
1200
+ "oneOf": [
1201
+ {
1202
+ "type": "string"
1203
+ },
1204
+ {
1205
+ "type": "integer",
1206
+ "format": "int32"
1207
+ }
1208
+ ]
1209
+ },
1210
+ "to": {
1211
+ "oneOf": [
1212
+ {
1213
+ "type": "string"
1214
+ },
1215
+ {
1216
+ "type": "integer",
1217
+ "format": "int32"
1218
+ }
1219
+ ]
1220
+ },
1221
+ "dataSet": {
1222
+ "$ref": "#/components/schemas/IdentifierRef"
1223
+ },
1224
+ "attribute": {
1225
+ "$ref": "#/components/schemas/IdentifierRef"
1226
+ },
1227
+ "localIdentifier": {
1228
+ "type": "string"
1229
+ }
1230
+ }
1231
+ }
1232
+ }
1233
+ },
1234
+ "DashboardExportSettings": {
1235
+ "type": "object",
1236
+ "properties": {
1237
+ "exportInfo": {
1238
+ "type": "boolean",
1239
+ "description": "If true, the export will contain the information about the exported date and dashboard filters.",
1240
+ "example": true,
1241
+ "default": false
1242
+ },
1243
+ "mergeHeaders": {
1244
+ "type": "boolean",
1245
+ "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.",
1246
+ "example": true,
1247
+ "default": false
1248
+ }
1249
+ },
1250
+ "description": "Additional settings."
1251
+ },
1252
+ "DashboardFilter": {
1253
+ "type": "object",
1254
+ "oneOf": [
1255
+ {
1256
+ "$ref": "#/components/schemas/DashboardAttributeFilter"
1257
+ },
1258
+ {
1259
+ "$ref": "#/components/schemas/DashboardDateFilter"
1260
+ }
1261
+ ]
1262
+ },
1263
+ "DashboardTabularExportRequestV2": {
1264
+ "required": ["dashboardId", "fileName", "format"],
1265
+ "type": "object",
1266
+ "properties": {
1267
+ "format": {
1268
+ "type": "string",
1269
+ "description": "Requested tabular export type.",
1270
+ "example": "XLSX",
1271
+ "enum": ["XLSX"]
1272
+ },
1273
+ "fileName": {
1274
+ "type": "string",
1275
+ "description": "Filename of downloaded file without extension.",
1276
+ "example": "result"
1277
+ },
1278
+ "dashboardFiltersOverride": {
1279
+ "type": "array",
1280
+ "description": "List of filters that will be used instead of the default dashboard filters.",
1281
+ "items": {
1282
+ "$ref": "#/components/schemas/DashboardFilter"
1283
+ }
1284
+ },
1285
+ "dashboardId": {
1286
+ "type": "string",
1287
+ "description": "Dashboard identifier",
1288
+ "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
1289
+ },
1290
+ "widgetIds": {
1291
+ "maxItems": 1,
1292
+ "uniqueItems": true,
1293
+ "type": "array",
1294
+ "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.",
1295
+ "items": {
1296
+ "type": "string"
1297
+ }
1298
+ },
1299
+ "settings": {
1300
+ "$ref": "#/components/schemas/DashboardExportSettings"
1301
+ }
1302
+ },
1303
+ "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId)."
1304
+ },
1031
1305
  "DateFilter": {
1032
1306
  "type": "object",
1033
1307
  "description": "Abstract filter definition type for dates.",
@@ -1040,6 +1314,15 @@
1040
1314
  }
1041
1315
  ]
1042
1316
  },
1317
+ "DateValue": {
1318
+ "required": ["value"],
1319
+ "type": "object",
1320
+ "properties": {
1321
+ "value": {
1322
+ "type": "string"
1323
+ }
1324
+ }
1325
+ },
1043
1326
  "DeclarativeAnalyticalDashboardIdentifier": {
1044
1327
  "required": ["id", "type"],
1045
1328
  "type": "object",
@@ -1159,6 +1442,44 @@
1159
1442
  }
1160
1443
  ]
1161
1444
  },
1445
+ "IdentifierRef": {
1446
+ "type": "object",
1447
+ "properties": {
1448
+ "identifier": {
1449
+ "required": ["id", "type"],
1450
+ "type": "object",
1451
+ "properties": {
1452
+ "id": {
1453
+ "type": "string"
1454
+ },
1455
+ "type": {
1456
+ "type": "string",
1457
+ "enum": [
1458
+ "analyticalDashboard",
1459
+ "attribute",
1460
+ "attributeHierarchy",
1461
+ "dashboardPlugin",
1462
+ "dataset",
1463
+ "fact",
1464
+ "label",
1465
+ "metric",
1466
+ "userDataFilter",
1467
+ "exportDefinition",
1468
+ "automation",
1469
+ "prompt",
1470
+ "visualizationObject",
1471
+ "filterContext",
1472
+ "workspaceSettings",
1473
+ "customApplicationSetting",
1474
+ "workspaceDataFilter",
1475
+ "workspaceDataFilterSetting",
1476
+ "filterView"
1477
+ ]
1478
+ }
1479
+ }
1480
+ }
1481
+ }
1482
+ },
1162
1483
  "ImageExportRequest": {
1163
1484
  "required": ["dashboardId", "fileName", "format", "widgetIds"],
1164
1485
  "type": "object",
@@ -1360,6 +1681,18 @@
1360
1681
  },
1361
1682
  "description": "Filter able to limit element values by label and related selected negated elements."
1362
1683
  },
1684
+ "Over": {
1685
+ "required": ["attributes"],
1686
+ "type": "object",
1687
+ "properties": {
1688
+ "attributes": {
1689
+ "type": "array",
1690
+ "items": {
1691
+ "$ref": "#/components/schemas/IdentifierRef"
1692
+ }
1693
+ }
1694
+ }
1695
+ },
1363
1696
  "PdfTableStyle": {
1364
1697
  "required": ["selector"],
1365
1698
  "type": "object",
@@ -2519,7 +2852,8 @@
2519
2852
  "type": "object",
2520
2853
  "properties": {
2521
2854
  "timestamp": {
2522
- "type": "string"
2855
+ "type": "string",
2856
+ "format": "date-time"
2523
2857
  },
2524
2858
  "data": {
2525
2859
  "$ref": "#/components/schemas/WebhookMessageData"
@@ -2583,6 +2917,12 @@
2583
2917
  "$ref": "#/components/schemas/ExportResult"
2584
2918
  }
2585
2919
  },
2920
+ "dashboardTabularExports": {
2921
+ "type": "array",
2922
+ "items": {
2923
+ "$ref": "#/components/schemas/ExportResult"
2924
+ }
2925
+ },
2586
2926
  "alert": {
2587
2927
  "$ref": "#/components/schemas/AlertDescription"
2588
2928
  },