ultracart-rest-sdk 4.1.16__py3-none-any.whl → 4.1.17__py3-none-any.whl

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.
@@ -22,11 +22,17 @@ from ultracart.model_utils import ( # noqa: F401
22
22
  none_type,
23
23
  validate_and_convert_types
24
24
  )
25
+ from ultracart.model.custom_dashboard import CustomDashboard
26
+ from ultracart.model.custom_dashboard_response import CustomDashboardResponse
27
+ from ultracart.model.custom_dashboards_response import CustomDashboardsResponse
25
28
  from ultracart.model.custom_report import CustomReport
26
29
  from ultracart.model.custom_report_account_config import CustomReportAccountConfig
27
30
  from ultracart.model.custom_report_account_config_response import CustomReportAccountConfigResponse
28
31
  from ultracart.model.custom_report_execution_request import CustomReportExecutionRequest
32
+ from ultracart.model.custom_report_execution_response import CustomReportExecutionResponse
29
33
  from ultracart.model.custom_report_response import CustomReportResponse
34
+ from ultracart.model.custom_reports_execution_request import CustomReportsExecutionRequest
35
+ from ultracart.model.custom_reports_execution_response import CustomReportsExecutionResponse
30
36
  from ultracart.model.custom_reports_response import CustomReportsResponse
31
37
  from ultracart.model.error_response import ErrorResponse
32
38
  from ultracart.model.report import Report
@@ -62,6 +68,58 @@ class DatawarehouseApi(object):
62
68
  if api_client is None:
63
69
  api_client = ApiClient()
64
70
  self.api_client = api_client
71
+ self.delete_custom_dashboard_endpoint = _Endpoint(
72
+ settings={
73
+ 'response_type': None,
74
+ 'auth': [
75
+ 'ultraCartOauth',
76
+ 'ultraCartSimpleApiKey'
77
+ ],
78
+ 'endpoint_path': '/datawarehouse/custom_dashboards/{custom_dashboard_oid}',
79
+ 'operation_id': 'delete_custom_dashboard',
80
+ 'http_method': 'DELETE',
81
+ 'servers': None,
82
+ },
83
+ params_map={
84
+ 'all': [
85
+ 'custom_dashboard_oid',
86
+ ],
87
+ 'required': [
88
+ 'custom_dashboard_oid',
89
+ ],
90
+ 'nullable': [
91
+ ],
92
+ 'enum': [
93
+ ],
94
+ 'validation': [
95
+ ]
96
+ },
97
+ root_map={
98
+ 'validations': {
99
+ },
100
+ 'allowed_values': {
101
+ },
102
+ 'openapi_types': {
103
+ 'custom_dashboard_oid':
104
+ (int,),
105
+ },
106
+ 'attribute_map': {
107
+ 'custom_dashboard_oid': 'custom_dashboard_oid',
108
+ },
109
+ 'location_map': {
110
+ 'custom_dashboard_oid': 'path',
111
+ },
112
+ 'collection_format_map': {
113
+ }
114
+ },
115
+ headers_map={
116
+ 'accept': [
117
+ 'application/json'
118
+ ],
119
+ 'content_type': [],
120
+ },
121
+ api_client=api_client
122
+ )
65
123
  self.delete_custom_report_endpoint = _Endpoint(
66
124
  settings={
67
125
  'response_type': None,
@@ -221,7 +279,7 @@ class DatawarehouseApi(object):
221
279
  )
222
280
  self.execute_custom_report_endpoint = _Endpoint(
223
281
  settings={
224
- 'response_type': (CustomReportResponse,),
282
+ 'response_type': (CustomReportExecutionResponse,),
225
283
  'auth': [
226
284
  'ultraCartOauth',
227
285
  'ultraCartSimpleApiKey'
@@ -278,6 +336,59 @@ class DatawarehouseApi(object):
278
336
  },
279
337
  api_client=api_client
280
338
  )
339
+ self.execute_custom_reports_endpoint = _Endpoint(
340
+ settings={
341
+ 'response_type': (CustomReportsExecutionResponse,),
342
+ 'auth': [
343
+ 'ultraCartOauth',
344
+ 'ultraCartSimpleApiKey'
345
+ ],
346
+ 'endpoint_path': '/datawarehouse/custom_reports/execute',
347
+ 'operation_id': 'execute_custom_reports',
348
+ 'http_method': 'PUT',
349
+ 'servers': None,
350
+ },
351
+ params_map={
352
+ 'all': [
353
+ 'execution_request',
354
+ ],
355
+ 'required': [
356
+ 'execution_request',
357
+ ],
358
+ 'nullable': [
359
+ ],
360
+ 'enum': [
361
+ ],
362
+ 'validation': [
363
+ ]
364
+ },
365
+ root_map={
366
+ 'validations': {
367
+ },
368
+ 'allowed_values': {
369
+ },
370
+ 'openapi_types': {
371
+ 'execution_request':
372
+ (CustomReportsExecutionRequest,),
373
+ },
374
+ 'attribute_map': {
375
+ },
376
+ 'location_map': {
377
+ 'execution_request': 'body',
378
+ },
379
+ 'collection_format_map': {
380
+ }
381
+ },
382
+ headers_map={
383
+ 'accept': [
384
+ 'application/json'
385
+ ],
386
+ 'content_type': [
387
+ 'application/json; charset=UTF-8'
388
+ ]
389
+ },
390
+ api_client=api_client
391
+ )
281
392
  self.execute_report_queries_endpoint = _Endpoint(
282
393
  settings={
283
394
  'response_type': None,
@@ -331,6 +442,103 @@ class DatawarehouseApi(object):
331
442
  },
332
443
  api_client=api_client
333
444
  )
445
+ self.get_custom_dashboard_endpoint = _Endpoint(
446
+ settings={
447
+ 'response_type': (CustomDashboardResponse,),
448
+ 'auth': [
449
+ 'ultraCartOauth',
450
+ 'ultraCartSimpleApiKey'
451
+ ],
452
+ 'endpoint_path': '/datawarehouse/custom_dashboards/{custom_dashboard_oid}',
453
+ 'operation_id': 'get_custom_dashboard',
454
+ 'http_method': 'GET',
455
+ 'servers': None,
456
+ },
457
+ params_map={
458
+ 'all': [
459
+ 'custom_dashboard_oid',
460
+ ],
461
+ 'required': [
462
+ 'custom_dashboard_oid',
463
+ ],
464
+ 'nullable': [
465
+ ],
466
+ 'enum': [
467
+ ],
468
+ 'validation': [
469
+ ]
470
+ },
471
+ root_map={
472
+ 'validations': {
473
+ },
474
+ 'allowed_values': {
475
+ },
476
+ 'openapi_types': {
477
+ 'custom_dashboard_oid':
478
+ (int,),
479
+ },
480
+ 'attribute_map': {
481
+ 'custom_dashboard_oid': 'custom_dashboard_oid',
482
+ },
483
+ 'location_map': {
484
+ 'custom_dashboard_oid': 'path',
485
+ },
486
+ 'collection_format_map': {
487
+ }
488
+ },
489
+ headers_map={
490
+ 'accept': [
491
+ 'application/json'
492
+ ],
493
+ 'content_type': [],
494
+ },
495
+ api_client=api_client
496
+ )
497
+ self.get_custom_dashboards_endpoint = _Endpoint(
498
+ settings={
499
+ 'response_type': (CustomDashboardsResponse,),
500
+ 'auth': [
501
+ 'ultraCartOauth',
502
+ 'ultraCartSimpleApiKey'
503
+ ],
504
+ 'endpoint_path': '/datawarehouse/custom_dashboards',
505
+ 'operation_id': 'get_custom_dashboards',
506
+ 'http_method': 'GET',
507
+ 'servers': None,
508
+ },
509
+ params_map={
510
+ 'all': [
511
+ ],
512
+ 'required': [],
513
+ 'nullable': [
514
+ ],
515
+ 'enum': [
516
+ ],
517
+ 'validation': [
518
+ ]
519
+ },
520
+ root_map={
521
+ 'validations': {
522
+ },
523
+ 'allowed_values': {
524
+ },
525
+ 'openapi_types': {
526
+ },
527
+ 'attribute_map': {
528
+ },
529
+ 'location_map': {
530
+ },
531
+ 'collection_format_map': {
532
+ }
533
+ },
534
+ headers_map={
535
+ 'accept': [
536
+ 'application/json'
537
+ ],
538
+ 'content_type': [],
539
+ },
540
+ api_client=api_client
541
+ )
334
542
  self.get_custom_report_endpoint = _Endpoint(
335
543
  settings={
336
544
  'response_type': (CustomReportResponse,),
@@ -725,24 +933,24 @@ class DatawarehouseApi(object):
725
933
  },
726
934
  api_client=api_client
727
935
  )
728
- self.insert_custom_report_endpoint = _Endpoint(
936
+ self.insert_custom_dashboard_endpoint = _Endpoint(
729
937
  settings={
730
- 'response_type': (CustomReportResponse,),
938
+ 'response_type': (CustomDashboardResponse,),
731
939
  'auth': [
732
940
  'ultraCartOauth',
733
941
  'ultraCartSimpleApiKey'
734
942
  ],
735
- 'endpoint_path': '/datawarehouse/custom_reports',
736
- 'operation_id': 'insert_custom_report',
943
+ 'endpoint_path': '/datawarehouse/custom_dashboards',
944
+ 'operation_id': 'insert_custom_dashboard',
737
945
  'http_method': 'POST',
738
946
  'servers': None,
739
947
  },
740
948
  params_map={
741
949
  'all': [
742
- 'report',
950
+ 'dashboard',
743
951
  ],
744
952
  'required': [
745
- 'report',
953
+ 'dashboard',
746
954
  ],
747
955
  'nullable': [
748
956
  ],
@@ -757,13 +965,13 @@ class DatawarehouseApi(object):
757
965
  'allowed_values': {
758
966
  },
759
967
  'openapi_types': {
760
- 'report':
761
- (CustomReport,),
968
+ 'dashboard':
969
+ (CustomDashboard,),
762
970
  },
763
971
  'attribute_map': {
764
972
  },
765
973
  'location_map': {
766
- 'report': 'body',
974
+ 'dashboard': 'body',
767
975
  },
768
976
  'collection_format_map': {
769
977
  }
@@ -778,15 +986,15 @@ class DatawarehouseApi(object):
778
986
  },
779
987
  api_client=api_client
780
988
  )
781
- self.insert_report_endpoint = _Endpoint(
989
+ self.insert_custom_report_endpoint = _Endpoint(
782
990
  settings={
783
- 'response_type': (ReportResponse,),
991
+ 'response_type': (CustomReportResponse,),
784
992
  'auth': [
785
993
  'ultraCartOauth',
786
994
  'ultraCartSimpleApiKey'
787
995
  ],
788
- 'endpoint_path': '/datawarehouse/reports',
789
- 'operation_id': 'insert_report',
996
+ 'endpoint_path': '/datawarehouse/custom_reports',
997
+ 'operation_id': 'insert_custom_report',
790
998
  'http_method': 'POST',
791
999
  'servers': None,
792
1000
  },
@@ -811,7 +1019,7 @@ class DatawarehouseApi(object):
811
1019
  },
812
1020
  'openapi_types': {
813
1021
  'report':
814
- (Report,),
1022
+ (CustomReport,),
815
1023
  },
816
1024
  'attribute_map': {
817
1025
  },
@@ -831,25 +1039,23 @@ class DatawarehouseApi(object):
831
1039
  },
832
1040
  api_client=api_client
833
1041
  )
834
- self.update_custom_report_endpoint = _Endpoint(
1042
+ self.insert_report_endpoint = _Endpoint(
835
1043
  settings={
836
- 'response_type': (CustomReportResponse,),
1044
+ 'response_type': (ReportResponse,),
837
1045
  'auth': [
838
1046
  'ultraCartOauth',
839
1047
  'ultraCartSimpleApiKey'
840
1048
  ],
841
- 'endpoint_path': '/datawarehouse/custom_reports/{custom_report_oid}',
842
- 'operation_id': 'update_custom_report',
843
- 'http_method': 'PUT',
1049
+ 'endpoint_path': '/datawarehouse/reports',
1050
+ 'operation_id': 'insert_report',
1051
+ 'http_method': 'POST',
844
1052
  'servers': None,
845
1053
  },
846
1054
  params_map={
847
1055
  'all': [
848
- 'custom_report_oid',
849
1056
  'report',
850
1057
  ],
851
1058
  'required': [
852
- 'custom_report_oid',
853
1059
  'report',
854
1060
  ],
855
1061
  'nullable': [
@@ -865,16 +1071,12 @@ class DatawarehouseApi(object):
865
1071
  'allowed_values': {
866
1072
  },
867
1073
  'openapi_types': {
868
- 'custom_report_oid':
869
- (int,),
870
1074
  'report':
871
- (CustomReport,),
1075
+ (Report,),
872
1076
  },
873
1077
  'attribute_map': {
874
- 'custom_report_oid': 'custom_report_oid',
875
1078
  },
876
1079
  'location_map': {
877
- 'custom_report_oid': 'path',
878
1080
  'report': 'body',
879
1081
  },
880
1082
  'collection_format_map': {
@@ -890,24 +1092,26 @@ class DatawarehouseApi(object):
890
1092
  },
891
1093
  api_client=api_client
892
1094
  )
893
- self.update_custom_report_account_config_endpoint = _Endpoint(
1095
+ self.update_custom_dashboard_endpoint = _Endpoint(
894
1096
  settings={
895
- 'response_type': (CustomReportAccountConfigResponse,),
1097
+ 'response_type': (CustomDashboardResponse,),
896
1098
  'auth': [
897
1099
  'ultraCartOauth',
898
1100
  'ultraCartSimpleApiKey'
899
1101
  ],
900
- 'endpoint_path': '/datawarehouse/custom_reports/account_config',
901
- 'operation_id': 'update_custom_report_account_config',
1102
+ 'endpoint_path': '/datawarehouse/custom_dashboards/{custom_dashboard_oid}',
1103
+ 'operation_id': 'update_custom_dashboard',
902
1104
  'http_method': 'PUT',
903
1105
  'servers': None,
904
1106
  },
905
1107
  params_map={
906
1108
  'all': [
907
- 'account_config',
1109
+ 'custom_dashboard_oid',
1110
+ 'dashboard',
908
1111
  ],
909
1112
  'required': [
910
- 'account_config',
1113
+ 'custom_dashboard_oid',
1114
+ 'dashboard',
911
1115
  ],
912
1116
  'nullable': [
913
1117
  ],
@@ -922,13 +1126,17 @@ class DatawarehouseApi(object):
922
1126
  'allowed_values': {
923
1127
  },
924
1128
  'openapi_types': {
925
- 'account_config':
926
- (CustomReportAccountConfig,),
1129
+ 'custom_dashboard_oid':
1130
+ (int,),
1131
+ 'dashboard':
1132
+ (CustomDashboard,),
927
1133
  },
928
1134
  'attribute_map': {
1135
+ 'custom_dashboard_oid': 'custom_dashboard_oid',
929
1136
  },
930
1137
  'location_map': {
931
- 'account_config': 'body',
1138
+ 'custom_dashboard_oid': 'path',
1139
+ 'dashboard': 'body',
932
1140
  },
933
1141
  'collection_format_map': {
934
1142
  }
@@ -943,25 +1151,25 @@ class DatawarehouseApi(object):
943
1151
  },
944
1152
  api_client=api_client
945
1153
  )
946
- self.update_report_endpoint = _Endpoint(
1154
+ self.update_custom_report_endpoint = _Endpoint(
947
1155
  settings={
948
- 'response_type': (ReportResponse,),
1156
+ 'response_type': (CustomReportResponse,),
949
1157
  'auth': [
950
1158
  'ultraCartOauth',
951
1159
  'ultraCartSimpleApiKey'
952
1160
  ],
953
- 'endpoint_path': '/datawarehouse/reports/{report_oid}',
954
- 'operation_id': 'update_report',
1161
+ 'endpoint_path': '/datawarehouse/custom_reports/{custom_report_oid}',
1162
+ 'operation_id': 'update_custom_report',
955
1163
  'http_method': 'PUT',
956
1164
  'servers': None,
957
1165
  },
958
1166
  params_map={
959
1167
  'all': [
960
- 'report_oid',
1168
+ 'custom_report_oid',
961
1169
  'report',
962
1170
  ],
963
1171
  'required': [
964
- 'report_oid',
1172
+ 'custom_report_oid',
965
1173
  'report',
966
1174
  ],
967
1175
  'nullable': [
@@ -977,16 +1185,16 @@ class DatawarehouseApi(object):
977
1185
  'allowed_values': {
978
1186
  },
979
1187
  'openapi_types': {
980
- 'report_oid':
1188
+ 'custom_report_oid':
981
1189
  (int,),
982
1190
  'report':
983
- (Report,),
1191
+ (CustomReport,),
984
1192
  },
985
1193
  'attribute_map': {
986
- 'report_oid': 'report_oid',
1194
+ 'custom_report_oid': 'custom_report_oid',
987
1195
  },
988
1196
  'location_map': {
989
- 'report_oid': 'path',
1197
+ 'custom_report_oid': 'path',
990
1198
  'report': 'body',
991
1199
  },
992
1200
  'collection_format_map': {
@@ -1002,23 +1210,469 @@ class DatawarehouseApi(object):
1002
1210
  },
1003
1211
  api_client=api_client
1004
1212
  )
1213
+ self.update_custom_report_account_config_endpoint = _Endpoint(
1214
+ settings={
1215
+ 'response_type': (CustomReportAccountConfigResponse,),
1216
+ 'auth': [
1217
+ 'ultraCartOauth',
1218
+ 'ultraCartSimpleApiKey'
1219
+ ],
1220
+ 'endpoint_path': '/datawarehouse/custom_reports/account_config',
1221
+ 'operation_id': 'update_custom_report_account_config',
1222
+ 'http_method': 'PUT',
1223
+ 'servers': None,
1224
+ },
1225
+ params_map={
1226
+ 'all': [
1227
+ 'account_config',
1228
+ ],
1229
+ 'required': [
1230
+ 'account_config',
1231
+ ],
1232
+ 'nullable': [
1233
+ ],
1234
+ 'enum': [
1235
+ ],
1236
+ 'validation': [
1237
+ ]
1238
+ },
1239
+ root_map={
1240
+ 'validations': {
1241
+ },
1242
+ 'allowed_values': {
1243
+ },
1244
+ 'openapi_types': {
1245
+ 'account_config':
1246
+ (CustomReportAccountConfig,),
1247
+ },
1248
+ 'attribute_map': {
1249
+ },
1250
+ 'location_map': {
1251
+ 'account_config': 'body',
1252
+ },
1253
+ 'collection_format_map': {
1254
+ }
1255
+ },
1256
+ headers_map={
1257
+ 'accept': [
1258
+ 'application/json'
1259
+ ],
1260
+ 'content_type': [
1261
+ 'application/json; charset=UTF-8'
1262
+ ]
1263
+ },
1264
+ api_client=api_client
1265
+ )
1266
+ self.update_report_endpoint = _Endpoint(
1267
+ settings={
1268
+ 'response_type': (ReportResponse,),
1269
+ 'auth': [
1270
+ 'ultraCartOauth',
1271
+ 'ultraCartSimpleApiKey'
1272
+ ],
1273
+ 'endpoint_path': '/datawarehouse/reports/{report_oid}',
1274
+ 'operation_id': 'update_report',
1275
+ 'http_method': 'PUT',
1276
+ 'servers': None,
1277
+ },
1278
+ params_map={
1279
+ 'all': [
1280
+ 'report_oid',
1281
+ 'report',
1282
+ ],
1283
+ 'required': [
1284
+ 'report_oid',
1285
+ 'report',
1286
+ ],
1287
+ 'nullable': [
1288
+ ],
1289
+ 'enum': [
1290
+ ],
1291
+ 'validation': [
1292
+ ]
1293
+ },
1294
+ root_map={
1295
+ 'validations': {
1296
+ },
1297
+ 'allowed_values': {
1298
+ },
1299
+ 'openapi_types': {
1300
+ 'report_oid':
1301
+ (int,),
1302
+ 'report':
1303
+ (Report,),
1304
+ },
1305
+ 'attribute_map': {
1306
+ 'report_oid': 'report_oid',
1307
+ },
1308
+ 'location_map': {
1309
+ 'report_oid': 'path',
1310
+ 'report': 'body',
1311
+ },
1312
+ 'collection_format_map': {
1313
+ }
1314
+ },
1315
+ headers_map={
1316
+ 'accept': [
1317
+ 'application/json'
1318
+ ],
1319
+ 'content_type': [
1320
+ 'application/json; charset=UTF-8'
1321
+ ]
1322
+ },
1323
+ api_client=api_client
1324
+ )
1325
+
1326
+ def delete_custom_dashboard(
1327
+ self,
1328
+ custom_dashboard_oid,
1329
+ **kwargs
1330
+ ):
1331
+ """Delete a custom dashboard # noqa: E501
1332
+
1333
+ Delete a custom dashboard on the UltraCart account. # noqa: E501
1334
+ This method makes a synchronous HTTP request by default. To make an
1335
+ asynchronous HTTP request, please pass async_req=True
1336
+
1337
+ >>> thread = api.delete_custom_dashboard(custom_dashboard_oid, async_req=True)
1338
+ >>> result = thread.get()
1339
+
1340
+ Args:
1341
+ custom_dashboard_oid (int): The dashboard oid to delete.
1342
+
1343
+ Keyword Args:
1344
+ _return_http_data_only (bool): response data without head status
1345
+ code and headers. Default is True.
1346
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1347
+ will be returned without reading/decoding response data.
1348
+ Default is True.
1349
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1350
+ one number provided, it will be total request timeout. It can also
1351
+ be a pair (tuple) of (connection, read) timeouts.
1352
+ Default is None.
1353
+ _check_input_type (bool): specifies if type checking
1354
+ should be done one the data sent to the server.
1355
+ Default is True.
1356
+ _check_return_type (bool): specifies if type checking
1357
+ should be done one the data received from the server.
1358
+ Default is True.
1359
+ _spec_property_naming (bool): True if the variable names in the input data
1360
+ are serialized names, as specified in the OpenAPI document.
1361
+ False if the variable names in the input data
1362
+ are pythonic names, e.g. snake case (default)
1363
+ _content_type (str/None): force body content-type.
1364
+ Default is None and content-type will be predicted by allowed
1365
+ content-types and body.
1366
+ _host_index (int/None): specifies the index of the server
1367
+ that we want to use.
1368
+ Default is read from the configuration.
1369
+ _request_auths (list): set to override the auth_settings for an a single
1370
+ request; this effectively ignores the authentication
1371
+ in the spec for a single request.
1372
+ Default is None
1373
+ async_req (bool): execute request asynchronously
1374
+
1375
+ Returns:
1376
+ None
1377
+ If the method is called asynchronously, returns the request
1378
+ thread.
1379
+ """
1380
+ kwargs['async_req'] = kwargs.get(
1381
+ 'async_req', False
1382
+ )
1383
+ kwargs['_return_http_data_only'] = kwargs.get(
1384
+ '_return_http_data_only', True
1385
+ )
1386
+ kwargs['_preload_content'] = kwargs.get(
1387
+ '_preload_content', True
1388
+ )
1389
+ kwargs['_request_timeout'] = kwargs.get(
1390
+ '_request_timeout', None
1391
+ )
1392
+ kwargs['_check_input_type'] = kwargs.get(
1393
+ '_check_input_type', True
1394
+ )
1395
+ kwargs['_check_return_type'] = kwargs.get(
1396
+ '_check_return_type', True
1397
+ )
1398
+ kwargs['_spec_property_naming'] = kwargs.get(
1399
+ '_spec_property_naming', False
1400
+ )
1401
+ kwargs['_content_type'] = kwargs.get(
1402
+ '_content_type')
1403
+ kwargs['_host_index'] = kwargs.get('_host_index')
1404
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1405
+ kwargs['custom_dashboard_oid'] = \
1406
+ custom_dashboard_oid
1407
+ return self.delete_custom_dashboard_endpoint.call_with_http_info(**kwargs)
1408
+
1409
+ def delete_custom_report(
1410
+ self,
1411
+ custom_report_oid,
1412
+ **kwargs
1413
+ ):
1414
+ """Delete a custom report # noqa: E501
1415
+
1416
+ Delete a custom report on the UltraCart account. # noqa: E501
1417
+ This method makes a synchronous HTTP request by default. To make an
1418
+ asynchronous HTTP request, please pass async_req=True
1419
+
1420
+ >>> thread = api.delete_custom_report(custom_report_oid, async_req=True)
1421
+ >>> result = thread.get()
1422
+
1423
+ Args:
1424
+ custom_report_oid (int): The report oid to delete.
1425
+
1426
+ Keyword Args:
1427
+ _return_http_data_only (bool): response data without head status
1428
+ code and headers. Default is True.
1429
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1430
+ will be returned without reading/decoding response data.
1431
+ Default is True.
1432
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1433
+ one number provided, it will be total request timeout. It can also
1434
+ be a pair (tuple) of (connection, read) timeouts.
1435
+ Default is None.
1436
+ _check_input_type (bool): specifies if type checking
1437
+ should be done one the data sent to the server.
1438
+ Default is True.
1439
+ _check_return_type (bool): specifies if type checking
1440
+ should be done one the data received from the server.
1441
+ Default is True.
1442
+ _spec_property_naming (bool): True if the variable names in the input data
1443
+ are serialized names, as specified in the OpenAPI document.
1444
+ False if the variable names in the input data
1445
+ are pythonic names, e.g. snake case (default)
1446
+ _content_type (str/None): force body content-type.
1447
+ Default is None and content-type will be predicted by allowed
1448
+ content-types and body.
1449
+ _host_index (int/None): specifies the index of the server
1450
+ that we want to use.
1451
+ Default is read from the configuration.
1452
+ _request_auths (list): set to override the auth_settings for an a single
1453
+ request; this effectively ignores the authentication
1454
+ in the spec for a single request.
1455
+ Default is None
1456
+ async_req (bool): execute request asynchronously
1457
+
1458
+ Returns:
1459
+ None
1460
+ If the method is called asynchronously, returns the request
1461
+ thread.
1462
+ """
1463
+ kwargs['async_req'] = kwargs.get(
1464
+ 'async_req', False
1465
+ )
1466
+ kwargs['_return_http_data_only'] = kwargs.get(
1467
+ '_return_http_data_only', True
1468
+ )
1469
+ kwargs['_preload_content'] = kwargs.get(
1470
+ '_preload_content', True
1471
+ )
1472
+ kwargs['_request_timeout'] = kwargs.get(
1473
+ '_request_timeout', None
1474
+ )
1475
+ kwargs['_check_input_type'] = kwargs.get(
1476
+ '_check_input_type', True
1477
+ )
1478
+ kwargs['_check_return_type'] = kwargs.get(
1479
+ '_check_return_type', True
1480
+ )
1481
+ kwargs['_spec_property_naming'] = kwargs.get(
1482
+ '_spec_property_naming', False
1483
+ )
1484
+ kwargs['_content_type'] = kwargs.get(
1485
+ '_content_type')
1486
+ kwargs['_host_index'] = kwargs.get('_host_index')
1487
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1488
+ kwargs['custom_report_oid'] = \
1489
+ custom_report_oid
1490
+ return self.delete_custom_report_endpoint.call_with_http_info(**kwargs)
1491
+
1492
+ def delete_report(
1493
+ self,
1494
+ report_oid,
1495
+ **kwargs
1496
+ ):
1497
+ """Delete a report # noqa: E501
1498
+
1499
+ Delete a report on the UltraCart account. # noqa: E501
1500
+ This method makes a synchronous HTTP request by default. To make an
1501
+ asynchronous HTTP request, please pass async_req=True
1502
+
1503
+ >>> thread = api.delete_report(report_oid, async_req=True)
1504
+ >>> result = thread.get()
1505
+
1506
+ Args:
1507
+ report_oid (int): The report oid to delete.
1508
+
1509
+ Keyword Args:
1510
+ _return_http_data_only (bool): response data without head status
1511
+ code and headers. Default is True.
1512
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1513
+ will be returned without reading/decoding response data.
1514
+ Default is True.
1515
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1516
+ one number provided, it will be total request timeout. It can also
1517
+ be a pair (tuple) of (connection, read) timeouts.
1518
+ Default is None.
1519
+ _check_input_type (bool): specifies if type checking
1520
+ should be done one the data sent to the server.
1521
+ Default is True.
1522
+ _check_return_type (bool): specifies if type checking
1523
+ should be done one the data received from the server.
1524
+ Default is True.
1525
+ _spec_property_naming (bool): True if the variable names in the input data
1526
+ are serialized names, as specified in the OpenAPI document.
1527
+ False if the variable names in the input data
1528
+ are pythonic names, e.g. snake case (default)
1529
+ _content_type (str/None): force body content-type.
1530
+ Default is None and content-type will be predicted by allowed
1531
+ content-types and body.
1532
+ _host_index (int/None): specifies the index of the server
1533
+ that we want to use.
1534
+ Default is read from the configuration.
1535
+ _request_auths (list): set to override the auth_settings for an a single
1536
+ request; this effectively ignores the authentication
1537
+ in the spec for a single request.
1538
+ Default is None
1539
+ async_req (bool): execute request asynchronously
1540
+
1541
+ Returns:
1542
+ None
1543
+ If the method is called asynchronously, returns the request
1544
+ thread.
1545
+ """
1546
+ kwargs['async_req'] = kwargs.get(
1547
+ 'async_req', False
1548
+ )
1549
+ kwargs['_return_http_data_only'] = kwargs.get(
1550
+ '_return_http_data_only', True
1551
+ )
1552
+ kwargs['_preload_content'] = kwargs.get(
1553
+ '_preload_content', True
1554
+ )
1555
+ kwargs['_request_timeout'] = kwargs.get(
1556
+ '_request_timeout', None
1557
+ )
1558
+ kwargs['_check_input_type'] = kwargs.get(
1559
+ '_check_input_type', True
1560
+ )
1561
+ kwargs['_check_return_type'] = kwargs.get(
1562
+ '_check_return_type', True
1563
+ )
1564
+ kwargs['_spec_property_naming'] = kwargs.get(
1565
+ '_spec_property_naming', False
1566
+ )
1567
+ kwargs['_content_type'] = kwargs.get(
1568
+ '_content_type')
1569
+ kwargs['_host_index'] = kwargs.get('_host_index')
1570
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1571
+ kwargs['report_oid'] = \
1572
+ report_oid
1573
+ return self.delete_report_endpoint.call_with_http_info(**kwargs)
1574
+
1575
+ def dry_run_report_queries(
1576
+ self,
1577
+ query_request,
1578
+ **kwargs
1579
+ ):
1580
+ """Dry run the report queries # noqa: E501
1581
+
1582
+ Dry run the report queries # noqa: E501
1583
+ This method makes a synchronous HTTP request by default. To make an
1584
+ asynchronous HTTP request, please pass async_req=True
1585
+
1586
+ >>> thread = api.dry_run_report_queries(query_request, async_req=True)
1587
+ >>> result = thread.get()
1588
+
1589
+ Args:
1590
+ query_request (ReportDryRunQueriesRequest): Dry run request
1591
+
1592
+ Keyword Args:
1593
+ _return_http_data_only (bool): response data without head status
1594
+ code and headers. Default is True.
1595
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1596
+ will be returned without reading/decoding response data.
1597
+ Default is True.
1598
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1599
+ one number provided, it will be total request timeout. It can also
1600
+ be a pair (tuple) of (connection, read) timeouts.
1601
+ Default is None.
1602
+ _check_input_type (bool): specifies if type checking
1603
+ should be done one the data sent to the server.
1604
+ Default is True.
1605
+ _check_return_type (bool): specifies if type checking
1606
+ should be done one the data received from the server.
1607
+ Default is True.
1608
+ _spec_property_naming (bool): True if the variable names in the input data
1609
+ are serialized names, as specified in the OpenAPI document.
1610
+ False if the variable names in the input data
1611
+ are pythonic names, e.g. snake case (default)
1612
+ _content_type (str/None): force body content-type.
1613
+ Default is None and content-type will be predicted by allowed
1614
+ content-types and body.
1615
+ _host_index (int/None): specifies the index of the server
1616
+ that we want to use.
1617
+ Default is read from the configuration.
1618
+ _request_auths (list): set to override the auth_settings for an a single
1619
+ request; this effectively ignores the authentication
1620
+ in the spec for a single request.
1621
+ Default is None
1622
+ async_req (bool): execute request asynchronously
1623
+
1624
+ Returns:
1625
+ ReportDryRunQueriesResponse
1626
+ If the method is called asynchronously, returns the request
1627
+ thread.
1628
+ """
1629
+ kwargs['async_req'] = kwargs.get(
1630
+ 'async_req', False
1631
+ )
1632
+ kwargs['_return_http_data_only'] = kwargs.get(
1633
+ '_return_http_data_only', True
1634
+ )
1635
+ kwargs['_preload_content'] = kwargs.get(
1636
+ '_preload_content', True
1637
+ )
1638
+ kwargs['_request_timeout'] = kwargs.get(
1639
+ '_request_timeout', None
1640
+ )
1641
+ kwargs['_check_input_type'] = kwargs.get(
1642
+ '_check_input_type', True
1643
+ )
1644
+ kwargs['_check_return_type'] = kwargs.get(
1645
+ '_check_return_type', True
1646
+ )
1647
+ kwargs['_spec_property_naming'] = kwargs.get(
1648
+ '_spec_property_naming', False
1649
+ )
1650
+ kwargs['_content_type'] = kwargs.get(
1651
+ '_content_type')
1652
+ kwargs['_host_index'] = kwargs.get('_host_index')
1653
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1654
+ kwargs['query_request'] = \
1655
+ query_request
1656
+ return self.dry_run_report_queries_endpoint.call_with_http_info(**kwargs)
1005
1657
 
1006
- def delete_custom_report(
1658
+ def execute_custom_report(
1007
1659
  self,
1008
1660
  custom_report_oid,
1661
+ execution_request,
1009
1662
  **kwargs
1010
1663
  ):
1011
- """Delete a custom report # noqa: E501
1664
+ """Execute a custom report # noqa: E501
1012
1665
 
1013
- Delete a custom report on the UltraCart account. # noqa: E501
1666
+ Execute a custom report on the UltraCart account. # noqa: E501
1014
1667
  This method makes a synchronous HTTP request by default. To make an
1015
1668
  asynchronous HTTP request, please pass async_req=True
1016
1669
 
1017
- >>> thread = api.delete_custom_report(custom_report_oid, async_req=True)
1670
+ >>> thread = api.execute_custom_report(custom_report_oid, execution_request, async_req=True)
1018
1671
  >>> result = thread.get()
1019
1672
 
1020
1673
  Args:
1021
- custom_report_oid (int): The report oid to delete.
1674
+ custom_report_oid (int): The report oid to execute.
1675
+ execution_request (CustomReportExecutionRequest): Request to execute custom report
1022
1676
 
1023
1677
  Keyword Args:
1024
1678
  _return_http_data_only (bool): response data without head status
@@ -1053,7 +1707,7 @@ class DatawarehouseApi(object):
1053
1707
  async_req (bool): execute request asynchronously
1054
1708
 
1055
1709
  Returns:
1056
- None
1710
+ CustomReportExecutionResponse
1057
1711
  If the method is called asynchronously, returns the request
1058
1712
  thread.
1059
1713
  """
@@ -1084,24 +1738,26 @@ class DatawarehouseApi(object):
1084
1738
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1085
1739
  kwargs['custom_report_oid'] = \
1086
1740
  custom_report_oid
1087
- return self.delete_custom_report_endpoint.call_with_http_info(**kwargs)
1741
+ kwargs['execution_request'] = \
1742
+ execution_request
1743
+ return self.execute_custom_report_endpoint.call_with_http_info(**kwargs)
1088
1744
 
1089
- def delete_report(
1745
+ def execute_custom_reports(
1090
1746
  self,
1091
- report_oid,
1747
+ execution_request,
1092
1748
  **kwargs
1093
1749
  ):
1094
- """Delete a report # noqa: E501
1750
+ """Execute a custom reports # noqa: E501
1095
1751
 
1096
- Delete a report on the UltraCart account. # noqa: E501
1752
+ Execute a custom reports on the UltraCart account. # noqa: E501
1097
1753
  This method makes a synchronous HTTP request by default. To make an
1098
1754
  asynchronous HTTP request, please pass async_req=True
1099
1755
 
1100
- >>> thread = api.delete_report(report_oid, async_req=True)
1756
+ >>> thread = api.execute_custom_reports(execution_request, async_req=True)
1101
1757
  >>> result = thread.get()
1102
1758
 
1103
1759
  Args:
1104
- report_oid (int): The report oid to delete.
1760
+ execution_request (CustomReportsExecutionRequest): Request to execute custom reports
1105
1761
 
1106
1762
  Keyword Args:
1107
1763
  _return_http_data_only (bool): response data without head status
@@ -1136,7 +1792,7 @@ class DatawarehouseApi(object):
1136
1792
  async_req (bool): execute request asynchronously
1137
1793
 
1138
1794
  Returns:
1139
- None
1795
+ CustomReportsExecutionResponse
1140
1796
  If the method is called asynchronously, returns the request
1141
1797
  thread.
1142
1798
  """
@@ -1165,26 +1821,26 @@ class DatawarehouseApi(object):
1165
1821
  '_content_type')
1166
1822
  kwargs['_host_index'] = kwargs.get('_host_index')
1167
1823
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1168
- kwargs['report_oid'] = \
1169
- report_oid
1170
- return self.delete_report_endpoint.call_with_http_info(**kwargs)
1824
+ kwargs['execution_request'] = \
1825
+ execution_request
1826
+ return self.execute_custom_reports_endpoint.call_with_http_info(**kwargs)
1171
1827
 
1172
- def dry_run_report_queries(
1828
+ def execute_report_queries(
1173
1829
  self,
1174
1830
  query_request,
1175
1831
  **kwargs
1176
1832
  ):
1177
- """Dry run the report queries # noqa: E501
1833
+ """Execute the report queries # noqa: E501
1178
1834
 
1179
- Dry run the report queries # noqa: E501
1835
+ Execute the report queries # noqa: E501
1180
1836
  This method makes a synchronous HTTP request by default. To make an
1181
1837
  asynchronous HTTP request, please pass async_req=True
1182
1838
 
1183
- >>> thread = api.dry_run_report_queries(query_request, async_req=True)
1839
+ >>> thread = api.execute_report_queries(query_request, async_req=True)
1184
1840
  >>> result = thread.get()
1185
1841
 
1186
1842
  Args:
1187
- query_request (ReportDryRunQueriesRequest): Dry run request
1843
+ query_request (ReportExecuteQueriesRequest): Query request
1188
1844
 
1189
1845
  Keyword Args:
1190
1846
  _return_http_data_only (bool): response data without head status
@@ -1219,7 +1875,7 @@ class DatawarehouseApi(object):
1219
1875
  async_req (bool): execute request asynchronously
1220
1876
 
1221
1877
  Returns:
1222
- ReportDryRunQueriesResponse
1878
+ None
1223
1879
  If the method is called asynchronously, returns the request
1224
1880
  thread.
1225
1881
  """
@@ -1250,26 +1906,24 @@ class DatawarehouseApi(object):
1250
1906
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1251
1907
  kwargs['query_request'] = \
1252
1908
  query_request
1253
- return self.dry_run_report_queries_endpoint.call_with_http_info(**kwargs)
1909
+ return self.execute_report_queries_endpoint.call_with_http_info(**kwargs)
1254
1910
 
1255
- def execute_custom_report(
1911
+ def get_custom_dashboard(
1256
1912
  self,
1257
- custom_report_oid,
1258
- execution_request,
1913
+ custom_dashboard_oid,
1259
1914
  **kwargs
1260
1915
  ):
1261
- """Execute a custom report # noqa: E501
1916
+ """Get a custom dashboard # noqa: E501
1262
1917
 
1263
- Execute a custom report on the UltraCart account. # noqa: E501
1918
+ Retrieve a custom dashboard # noqa: E501
1264
1919
  This method makes a synchronous HTTP request by default. To make an
1265
1920
  asynchronous HTTP request, please pass async_req=True
1266
1921
 
1267
- >>> thread = api.execute_custom_report(custom_report_oid, execution_request, async_req=True)
1922
+ >>> thread = api.get_custom_dashboard(custom_dashboard_oid, async_req=True)
1268
1923
  >>> result = thread.get()
1269
1924
 
1270
1925
  Args:
1271
- custom_report_oid (int): The report oid to execute.
1272
- execution_request (CustomReportExecutionRequest): Request to execute custom report
1926
+ custom_dashboard_oid (int):
1273
1927
 
1274
1928
  Keyword Args:
1275
1929
  _return_http_data_only (bool): response data without head status
@@ -1304,7 +1958,7 @@ class DatawarehouseApi(object):
1304
1958
  async_req (bool): execute request asynchronously
1305
1959
 
1306
1960
  Returns:
1307
- CustomReportResponse
1961
+ CustomDashboardResponse
1308
1962
  If the method is called asynchronously, returns the request
1309
1963
  thread.
1310
1964
  """
@@ -1333,28 +1987,23 @@ class DatawarehouseApi(object):
1333
1987
  '_content_type')
1334
1988
  kwargs['_host_index'] = kwargs.get('_host_index')
1335
1989
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1336
- kwargs['custom_report_oid'] = \
1337
- custom_report_oid
1338
- kwargs['execution_request'] = \
1339
- execution_request
1340
- return self.execute_custom_report_endpoint.call_with_http_info(**kwargs)
1990
+ kwargs['custom_dashboard_oid'] = \
1991
+ custom_dashboard_oid
1992
+ return self.get_custom_dashboard_endpoint.call_with_http_info(**kwargs)
1341
1993
 
1342
- def execute_report_queries(
1994
+ def get_custom_dashboards(
1343
1995
  self,
1344
- query_request,
1345
1996
  **kwargs
1346
1997
  ):
1347
- """Execute the report queries # noqa: E501
1998
+ """Get custom dashboards # noqa: E501
1348
1999
 
1349
- Execute the report queries # noqa: E501
2000
+ Retrieve a custom dashboards # noqa: E501
1350
2001
  This method makes a synchronous HTTP request by default. To make an
1351
2002
  asynchronous HTTP request, please pass async_req=True
1352
2003
 
1353
- >>> thread = api.execute_report_queries(query_request, async_req=True)
2004
+ >>> thread = api.get_custom_dashboards(async_req=True)
1354
2005
  >>> result = thread.get()
1355
2006
 
1356
- Args:
1357
- query_request (ReportExecuteQueriesRequest): Query request
1358
2007
 
1359
2008
  Keyword Args:
1360
2009
  _return_http_data_only (bool): response data without head status
@@ -1389,7 +2038,7 @@ class DatawarehouseApi(object):
1389
2038
  async_req (bool): execute request asynchronously
1390
2039
 
1391
2040
  Returns:
1392
- None
2041
+ CustomDashboardsResponse
1393
2042
  If the method is called asynchronously, returns the request
1394
2043
  thread.
1395
2044
  """
@@ -1418,9 +2067,7 @@ class DatawarehouseApi(object):
1418
2067
  '_content_type')
1419
2068
  kwargs['_host_index'] = kwargs.get('_host_index')
1420
2069
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1421
- kwargs['query_request'] = \
1422
- query_request
1423
- return self.execute_report_queries_endpoint.call_with_http_info(**kwargs)
2070
+ return self.get_custom_dashboards_endpoint.call_with_http_info(**kwargs)
1424
2071
 
1425
2072
  def get_custom_report(
1426
2073
  self,
@@ -2070,6 +2717,89 @@ class DatawarehouseApi(object):
2070
2717
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2071
2718
  return self.get_reports_endpoint.call_with_http_info(**kwargs)
2072
2719
 
2720
+ def insert_custom_dashboard(
2721
+ self,
2722
+ dashboard,
2723
+ **kwargs
2724
+ ):
2725
+ """Create a custom dashboard # noqa: E501
2726
+
2727
+ Create a new custom dashboard on the UltraCart account. # noqa: E501
2728
+ This method makes a synchronous HTTP request by default. To make an
2729
+ asynchronous HTTP request, please pass async_req=True
2730
+
2731
+ >>> thread = api.insert_custom_dashboard(dashboard, async_req=True)
2732
+ >>> result = thread.get()
2733
+
2734
+ Args:
2735
+ dashboard (CustomDashboard): Dashboard to create
2736
+
2737
+ Keyword Args:
2738
+ _return_http_data_only (bool): response data without head status
2739
+ code and headers. Default is True.
2740
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2741
+ will be returned without reading/decoding response data.
2742
+ Default is True.
2743
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2744
+ one number provided, it will be total request timeout. It can also
2745
+ be a pair (tuple) of (connection, read) timeouts.
2746
+ Default is None.
2747
+ _check_input_type (bool): specifies if type checking
2748
+ should be done one the data sent to the server.
2749
+ Default is True.
2750
+ _check_return_type (bool): specifies if type checking
2751
+ should be done one the data received from the server.
2752
+ Default is True.
2753
+ _spec_property_naming (bool): True if the variable names in the input data
2754
+ are serialized names, as specified in the OpenAPI document.
2755
+ False if the variable names in the input data
2756
+ are pythonic names, e.g. snake case (default)
2757
+ _content_type (str/None): force body content-type.
2758
+ Default is None and content-type will be predicted by allowed
2759
+ content-types and body.
2760
+ _host_index (int/None): specifies the index of the server
2761
+ that we want to use.
2762
+ Default is read from the configuration.
2763
+ _request_auths (list): set to override the auth_settings for an a single
2764
+ request; this effectively ignores the authentication
2765
+ in the spec for a single request.
2766
+ Default is None
2767
+ async_req (bool): execute request asynchronously
2768
+
2769
+ Returns:
2770
+ CustomDashboardResponse
2771
+ If the method is called asynchronously, returns the request
2772
+ thread.
2773
+ """
2774
+ kwargs['async_req'] = kwargs.get(
2775
+ 'async_req', False
2776
+ )
2777
+ kwargs['_return_http_data_only'] = kwargs.get(
2778
+ '_return_http_data_only', True
2779
+ )
2780
+ kwargs['_preload_content'] = kwargs.get(
2781
+ '_preload_content', True
2782
+ )
2783
+ kwargs['_request_timeout'] = kwargs.get(
2784
+ '_request_timeout', None
2785
+ )
2786
+ kwargs['_check_input_type'] = kwargs.get(
2787
+ '_check_input_type', True
2788
+ )
2789
+ kwargs['_check_return_type'] = kwargs.get(
2790
+ '_check_return_type', True
2791
+ )
2792
+ kwargs['_spec_property_naming'] = kwargs.get(
2793
+ '_spec_property_naming', False
2794
+ )
2795
+ kwargs['_content_type'] = kwargs.get(
2796
+ '_content_type')
2797
+ kwargs['_host_index'] = kwargs.get('_host_index')
2798
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2799
+ kwargs['dashboard'] = \
2800
+ dashboard
2801
+ return self.insert_custom_dashboard_endpoint.call_with_http_info(**kwargs)
2802
+
2073
2803
  def insert_custom_report(
2074
2804
  self,
2075
2805
  report,
@@ -2236,6 +2966,93 @@ class DatawarehouseApi(object):
2236
2966
  report
2237
2967
  return self.insert_report_endpoint.call_with_http_info(**kwargs)
2238
2968
 
2969
+ def update_custom_dashboard(
2970
+ self,
2971
+ custom_dashboard_oid,
2972
+ dashboard,
2973
+ **kwargs
2974
+ ):
2975
+ """Update a custom dashboard # noqa: E501
2976
+
2977
+ Update a custom dashboard on the UltraCart account. # noqa: E501
2978
+ This method makes a synchronous HTTP request by default. To make an
2979
+ asynchronous HTTP request, please pass async_req=True
2980
+
2981
+ >>> thread = api.update_custom_dashboard(custom_dashboard_oid, dashboard, async_req=True)
2982
+ >>> result = thread.get()
2983
+
2984
+ Args:
2985
+ custom_dashboard_oid (int): The dashboard oid to custom update.
2986
+ dashboard (CustomDashboard): Dashboard to custom update
2987
+
2988
+ Keyword Args:
2989
+ _return_http_data_only (bool): response data without head status
2990
+ code and headers. Default is True.
2991
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2992
+ will be returned without reading/decoding response data.
2993
+ Default is True.
2994
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2995
+ one number provided, it will be total request timeout. It can also
2996
+ be a pair (tuple) of (connection, read) timeouts.
2997
+ Default is None.
2998
+ _check_input_type (bool): specifies if type checking
2999
+ should be done one the data sent to the server.
3000
+ Default is True.
3001
+ _check_return_type (bool): specifies if type checking
3002
+ should be done one the data received from the server.
3003
+ Default is True.
3004
+ _spec_property_naming (bool): True if the variable names in the input data
3005
+ are serialized names, as specified in the OpenAPI document.
3006
+ False if the variable names in the input data
3007
+ are pythonic names, e.g. snake case (default)
3008
+ _content_type (str/None): force body content-type.
3009
+ Default is None and content-type will be predicted by allowed
3010
+ content-types and body.
3011
+ _host_index (int/None): specifies the index of the server
3012
+ that we want to use.
3013
+ Default is read from the configuration.
3014
+ _request_auths (list): set to override the auth_settings for an a single
3015
+ request; this effectively ignores the authentication
3016
+ in the spec for a single request.
3017
+ Default is None
3018
+ async_req (bool): execute request asynchronously
3019
+
3020
+ Returns:
3021
+ CustomDashboardResponse
3022
+ If the method is called asynchronously, returns the request
3023
+ thread.
3024
+ """
3025
+ kwargs['async_req'] = kwargs.get(
3026
+ 'async_req', False
3027
+ )
3028
+ kwargs['_return_http_data_only'] = kwargs.get(
3029
+ '_return_http_data_only', True
3030
+ )
3031
+ kwargs['_preload_content'] = kwargs.get(
3032
+ '_preload_content', True
3033
+ )
3034
+ kwargs['_request_timeout'] = kwargs.get(
3035
+ '_request_timeout', None
3036
+ )
3037
+ kwargs['_check_input_type'] = kwargs.get(
3038
+ '_check_input_type', True
3039
+ )
3040
+ kwargs['_check_return_type'] = kwargs.get(
3041
+ '_check_return_type', True
3042
+ )
3043
+ kwargs['_spec_property_naming'] = kwargs.get(
3044
+ '_spec_property_naming', False
3045
+ )
3046
+ kwargs['_content_type'] = kwargs.get(
3047
+ '_content_type')
3048
+ kwargs['_host_index'] = kwargs.get('_host_index')
3049
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3050
+ kwargs['custom_dashboard_oid'] = \
3051
+ custom_dashboard_oid
3052
+ kwargs['dashboard'] = \
3053
+ dashboard
3054
+ return self.update_custom_dashboard_endpoint.call_with_http_info(**kwargs)
3055
+
2239
3056
  def update_custom_report(
2240
3057
  self,
2241
3058
  custom_report_oid,