rapidata 2.28.4__py3-none-any.whl → 2.29.0__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.

Potentially problematic release.


This version of rapidata might be problematic. Click here for more details.

Files changed (108) hide show
  1. rapidata/__init__.py +1 -1
  2. rapidata/api_client/__init__.py +44 -17
  3. rapidata/api_client/api/__init__.py +1 -0
  4. rapidata/api_client/api/benchmark_api.py +2766 -0
  5. rapidata/api_client/api/campaign_api.py +0 -780
  6. rapidata/api_client/api/coco_api.py +0 -571
  7. rapidata/api_client/api/customer_rapid_api.py +332 -1
  8. rapidata/api_client/api/datapoint_api.py +0 -524
  9. rapidata/api_client/api/dataset_api.py +595 -2276
  10. rapidata/api_client/api/feedback_api.py +0 -270
  11. rapidata/api_client/api/identity_api.py +74 -888
  12. rapidata/api_client/api/leaderboard_api.py +1642 -259
  13. rapidata/api_client/api/order_api.py +617 -5692
  14. rapidata/api_client/api/pipeline_api.py +31 -334
  15. rapidata/api_client/api/validation_set_api.py +469 -3356
  16. rapidata/api_client/api/workflow_api.py +0 -799
  17. rapidata/api_client/models/__init__.py +43 -17
  18. rapidata/api_client/models/add_campaign_model.py +3 -3
  19. rapidata/api_client/models/add_validation_rapid_model.py +1 -3
  20. rapidata/api_client/models/add_validation_text_rapid_model.py +1 -3
  21. rapidata/api_client/models/and_user_filter_model.py +106 -0
  22. rapidata/api_client/models/and_user_filter_model_filters_inner.py +282 -0
  23. rapidata/api_client/models/benchmark_query_result.py +94 -0
  24. rapidata/api_client/models/benchmark_query_result_paged_result.py +105 -0
  25. rapidata/api_client/models/boost_leaderboard_model.py +89 -0
  26. rapidata/api_client/models/clone_order_model.py +2 -4
  27. rapidata/api_client/models/create_benchmark_model.py +87 -0
  28. rapidata/api_client/models/create_benchmark_participant_model.py +87 -0
  29. rapidata/api_client/models/create_benchmark_participant_result.py +89 -0
  30. rapidata/api_client/models/create_benchmark_result.py +87 -0
  31. rapidata/api_client/models/create_datapoint_result.py +4 -16
  32. rapidata/api_client/models/create_leaderboard_model.py +18 -2
  33. rapidata/api_client/models/create_leaderboard_result.py +5 -3
  34. rapidata/api_client/models/create_order_model.py +3 -3
  35. rapidata/api_client/models/file_asset_input.py +104 -0
  36. rapidata/api_client/models/file_asset_input1.py +104 -0
  37. rapidata/api_client/models/file_asset_input1_file.py +168 -0
  38. rapidata/api_client/models/file_asset_input2.py +104 -0
  39. rapidata/api_client/models/file_asset_input_file.py +182 -0
  40. rapidata/api_client/models/form_file_wrapper.py +120 -0
  41. rapidata/api_client/models/get_benchmark_by_id_query.py +96 -0
  42. rapidata/api_client/models/get_benchmark_by_id_query_result.py +94 -0
  43. rapidata/api_client/models/get_benchmark_by_id_query_result_paged_result.py +105 -0
  44. rapidata/api_client/models/get_benchmark_by_id_result.py +94 -0
  45. rapidata/api_client/models/get_participant_by_id_result.py +6 -22
  46. rapidata/api_client/models/get_standing_by_id_result.py +113 -0
  47. rapidata/api_client/models/get_validation_rapids_result.py +3 -3
  48. rapidata/api_client/models/get_workflow_results_result.py +3 -3
  49. rapidata/api_client/models/local_file_wrapper.py +120 -0
  50. rapidata/api_client/models/multi_asset_input.py +110 -0
  51. rapidata/api_client/models/multi_asset_input1.py +110 -0
  52. rapidata/api_client/models/multi_asset_input1_assets_inner.py +170 -0
  53. rapidata/api_client/models/multi_asset_input2.py +110 -0
  54. rapidata/api_client/models/multi_asset_input_assets_inner.py +170 -0
  55. rapidata/api_client/models/not_user_filter_model.py +3 -3
  56. rapidata/api_client/models/or_user_filter_model.py +3 -3
  57. rapidata/api_client/models/participant_by_benchmark.py +102 -0
  58. rapidata/api_client/models/participant_by_benchmark_paged_result.py +105 -0
  59. rapidata/api_client/models/participant_by_leaderboard.py +6 -2
  60. rapidata/api_client/models/participant_status.py +1 -4
  61. rapidata/api_client/models/pipeline_id_workflow_config_put_request.py +140 -0
  62. rapidata/api_client/models/potential_validation_rapid.py +103 -0
  63. rapidata/api_client/models/potential_validation_rapid_paged_result.py +105 -0
  64. rapidata/api_client/models/potential_validation_rapid_truth.py +280 -0
  65. rapidata/api_client/models/prompt_asset_metadata_input.py +3 -3
  66. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +170 -0
  67. rapidata/api_client/models/prompt_by_benchmark_result.py +92 -0
  68. rapidata/api_client/models/prompt_by_benchmark_result_paged_result.py +105 -0
  69. rapidata/api_client/models/prompt_metadata_input.py +5 -3
  70. rapidata/api_client/models/proxy_file_wrapper.py +114 -0
  71. rapidata/api_client/models/query_validation_model.py +97 -0
  72. rapidata/api_client/models/rapid_model.py +3 -3
  73. rapidata/api_client/models/simple_workflow_config.py +3 -3
  74. rapidata/api_client/models/simple_workflow_model1.py +3 -3
  75. rapidata/api_client/models/standing_by_leaderboard.py +113 -0
  76. rapidata/api_client/models/standing_by_leaderboard_paged_result.py +105 -0
  77. rapidata/api_client/models/standing_status.py +38 -0
  78. rapidata/api_client/models/stream_file_wrapper.py +116 -0
  79. rapidata/api_client/models/submit_coco_model.py +1 -3
  80. rapidata/api_client/models/submit_prompt_model.py +89 -0
  81. rapidata/api_client/models/text_asset_input.py +100 -0
  82. rapidata/api_client/models/transcription_metadata_input.py +5 -3
  83. rapidata/api_client/models/validation_set_zip_post_request_blueprint.py +252 -0
  84. rapidata/api_client/models/zip_entry_file_wrapper.py +120 -0
  85. rapidata/api_client_README.md +67 -76
  86. rapidata/rapidata_client/benchmark/leaderboard/__init__.py +0 -0
  87. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +62 -0
  88. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +227 -0
  89. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +83 -0
  90. rapidata/rapidata_client/filter/not_filter.py +2 -2
  91. rapidata/rapidata_client/filter/or_filter.py +2 -2
  92. rapidata/rapidata_client/metadata/__init__.py +1 -0
  93. rapidata/rapidata_client/metadata/_media_asset_metadata.py +8 -1
  94. rapidata/rapidata_client/metadata/_prompt_identifier_metadata.py +15 -0
  95. rapidata/rapidata_client/order/_rapidata_dataset.py +6 -6
  96. rapidata/rapidata_client/order/_rapidata_order_builder.py +4 -4
  97. rapidata/rapidata_client/order/rapidata_order.py +1 -1
  98. rapidata/rapidata_client/rapidata_client.py +3 -3
  99. rapidata/rapidata_client/validation/rapidata_validation_set.py +1 -1
  100. rapidata/rapidata_client/validation/rapids/rapids.py +4 -6
  101. rapidata/service/openapi_service.py +5 -0
  102. {rapidata-2.28.4.dist-info → rapidata-2.29.0.dist-info}/METADATA +1 -1
  103. {rapidata-2.28.4.dist-info → rapidata-2.29.0.dist-info}/RECORD +106 -57
  104. rapidata/rapidata_client/leaderboard/rapidata_leaderboard.py +0 -127
  105. rapidata/rapidata_client/leaderboard/rapidata_leaderboard_manager.py +0 -92
  106. /rapidata/rapidata_client/{leaderboard → benchmark}/__init__.py +0 -0
  107. {rapidata-2.28.4.dist-info → rapidata-2.29.0.dist-info}/LICENSE +0 -0
  108. {rapidata-2.28.4.dist-info → rapidata-2.29.0.dist-info}/WHEEL +0 -0
@@ -1028,786 +1028,6 @@ class CampaignApi:
1028
1028
 
1029
1029
 
1030
1030
 
1031
- @validate_call
1032
- def campaign_pause_post(
1033
- self,
1034
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1035
- _request_timeout: Union[
1036
- None,
1037
- Annotated[StrictFloat, Field(gt=0)],
1038
- Tuple[
1039
- Annotated[StrictFloat, Field(gt=0)],
1040
- Annotated[StrictFloat, Field(gt=0)]
1041
- ]
1042
- ] = None,
1043
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1044
- _content_type: Optional[StrictStr] = None,
1045
- _headers: Optional[Dict[StrictStr, Any]] = None,
1046
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1047
- ) -> None:
1048
- """(Deprecated) Pauses a campaign.
1049
-
1050
-
1051
- :param campaign_id: id of the campaign that should be paused
1052
- :type campaign_id: str
1053
- :param _request_timeout: timeout setting for this request. If one
1054
- number provided, it will be total request
1055
- timeout. It can also be a pair (tuple) of
1056
- (connection, read) timeouts.
1057
- :type _request_timeout: int, tuple(int, int), optional
1058
- :param _request_auth: set to override the auth_settings for an a single
1059
- request; this effectively ignores the
1060
- authentication in the spec for a single request.
1061
- :type _request_auth: dict, optional
1062
- :param _content_type: force content-type for the request.
1063
- :type _content_type: str, Optional
1064
- :param _headers: set to override the headers for a single
1065
- request; this effectively ignores the headers
1066
- in the spec for a single request.
1067
- :type _headers: dict, optional
1068
- :param _host_index: set to override the host_index for a single
1069
- request; this effectively ignores the host_index
1070
- in the spec for a single request.
1071
- :type _host_index: int, optional
1072
- :return: Returns the result object.
1073
- """ # noqa: E501
1074
- warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
1075
-
1076
- _param = self._campaign_pause_post_serialize(
1077
- campaign_id=campaign_id,
1078
- _request_auth=_request_auth,
1079
- _content_type=_content_type,
1080
- _headers=_headers,
1081
- _host_index=_host_index
1082
- )
1083
-
1084
- _response_types_map: Dict[str, Optional[str]] = {
1085
- '200': None,
1086
- }
1087
- response_data = self.api_client.call_api(
1088
- *_param,
1089
- _request_timeout=_request_timeout
1090
- )
1091
- response_data.read()
1092
- return self.api_client.response_deserialize(
1093
- response_data=response_data,
1094
- response_types_map=_response_types_map,
1095
- ).data
1096
-
1097
-
1098
- @validate_call
1099
- def campaign_pause_post_with_http_info(
1100
- self,
1101
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1102
- _request_timeout: Union[
1103
- None,
1104
- Annotated[StrictFloat, Field(gt=0)],
1105
- Tuple[
1106
- Annotated[StrictFloat, Field(gt=0)],
1107
- Annotated[StrictFloat, Field(gt=0)]
1108
- ]
1109
- ] = None,
1110
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1111
- _content_type: Optional[StrictStr] = None,
1112
- _headers: Optional[Dict[StrictStr, Any]] = None,
1113
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1114
- ) -> ApiResponse[None]:
1115
- """(Deprecated) Pauses a campaign.
1116
-
1117
-
1118
- :param campaign_id: id of the campaign that should be paused
1119
- :type campaign_id: str
1120
- :param _request_timeout: timeout setting for this request. If one
1121
- number provided, it will be total request
1122
- timeout. It can also be a pair (tuple) of
1123
- (connection, read) timeouts.
1124
- :type _request_timeout: int, tuple(int, int), optional
1125
- :param _request_auth: set to override the auth_settings for an a single
1126
- request; this effectively ignores the
1127
- authentication in the spec for a single request.
1128
- :type _request_auth: dict, optional
1129
- :param _content_type: force content-type for the request.
1130
- :type _content_type: str, Optional
1131
- :param _headers: set to override the headers for a single
1132
- request; this effectively ignores the headers
1133
- in the spec for a single request.
1134
- :type _headers: dict, optional
1135
- :param _host_index: set to override the host_index for a single
1136
- request; this effectively ignores the host_index
1137
- in the spec for a single request.
1138
- :type _host_index: int, optional
1139
- :return: Returns the result object.
1140
- """ # noqa: E501
1141
- warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
1142
-
1143
- _param = self._campaign_pause_post_serialize(
1144
- campaign_id=campaign_id,
1145
- _request_auth=_request_auth,
1146
- _content_type=_content_type,
1147
- _headers=_headers,
1148
- _host_index=_host_index
1149
- )
1150
-
1151
- _response_types_map: Dict[str, Optional[str]] = {
1152
- '200': None,
1153
- }
1154
- response_data = self.api_client.call_api(
1155
- *_param,
1156
- _request_timeout=_request_timeout
1157
- )
1158
- response_data.read()
1159
- return self.api_client.response_deserialize(
1160
- response_data=response_data,
1161
- response_types_map=_response_types_map,
1162
- )
1163
-
1164
-
1165
- @validate_call
1166
- def campaign_pause_post_without_preload_content(
1167
- self,
1168
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1169
- _request_timeout: Union[
1170
- None,
1171
- Annotated[StrictFloat, Field(gt=0)],
1172
- Tuple[
1173
- Annotated[StrictFloat, Field(gt=0)],
1174
- Annotated[StrictFloat, Field(gt=0)]
1175
- ]
1176
- ] = None,
1177
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1178
- _content_type: Optional[StrictStr] = None,
1179
- _headers: Optional[Dict[StrictStr, Any]] = None,
1180
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1181
- ) -> RESTResponseType:
1182
- """(Deprecated) Pauses a campaign.
1183
-
1184
-
1185
- :param campaign_id: id of the campaign that should be paused
1186
- :type campaign_id: str
1187
- :param _request_timeout: timeout setting for this request. If one
1188
- number provided, it will be total request
1189
- timeout. It can also be a pair (tuple) of
1190
- (connection, read) timeouts.
1191
- :type _request_timeout: int, tuple(int, int), optional
1192
- :param _request_auth: set to override the auth_settings for an a single
1193
- request; this effectively ignores the
1194
- authentication in the spec for a single request.
1195
- :type _request_auth: dict, optional
1196
- :param _content_type: force content-type for the request.
1197
- :type _content_type: str, Optional
1198
- :param _headers: set to override the headers for a single
1199
- request; this effectively ignores the headers
1200
- in the spec for a single request.
1201
- :type _headers: dict, optional
1202
- :param _host_index: set to override the host_index for a single
1203
- request; this effectively ignores the host_index
1204
- in the spec for a single request.
1205
- :type _host_index: int, optional
1206
- :return: Returns the result object.
1207
- """ # noqa: E501
1208
- warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
1209
-
1210
- _param = self._campaign_pause_post_serialize(
1211
- campaign_id=campaign_id,
1212
- _request_auth=_request_auth,
1213
- _content_type=_content_type,
1214
- _headers=_headers,
1215
- _host_index=_host_index
1216
- )
1217
-
1218
- _response_types_map: Dict[str, Optional[str]] = {
1219
- '200': None,
1220
- }
1221
- response_data = self.api_client.call_api(
1222
- *_param,
1223
- _request_timeout=_request_timeout
1224
- )
1225
- return response_data.response
1226
-
1227
-
1228
- def _campaign_pause_post_serialize(
1229
- self,
1230
- campaign_id,
1231
- _request_auth,
1232
- _content_type,
1233
- _headers,
1234
- _host_index,
1235
- ) -> RequestSerialized:
1236
-
1237
- _host = None
1238
-
1239
- _collection_formats: Dict[str, str] = {
1240
- }
1241
-
1242
- _path_params: Dict[str, str] = {}
1243
- _query_params: List[Tuple[str, str]] = []
1244
- _header_params: Dict[str, Optional[str]] = _headers or {}
1245
- _form_params: List[Tuple[str, str]] = []
1246
- _files: Dict[
1247
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1248
- ] = {}
1249
- _body_params: Optional[bytes] = None
1250
-
1251
- # process the path parameters
1252
- # process the query parameters
1253
- if campaign_id is not None:
1254
-
1255
- _query_params.append(('campaignId', campaign_id))
1256
-
1257
- # process the header parameters
1258
- # process the form parameters
1259
- # process the body parameter
1260
-
1261
-
1262
-
1263
-
1264
- # authentication setting
1265
- _auth_settings: List[str] = [
1266
- 'bearer',
1267
- 'oauth2'
1268
- ]
1269
-
1270
- return self.api_client.param_serialize(
1271
- method='POST',
1272
- resource_path='/campaign/pause',
1273
- path_params=_path_params,
1274
- query_params=_query_params,
1275
- header_params=_header_params,
1276
- body=_body_params,
1277
- post_params=_form_params,
1278
- files=_files,
1279
- auth_settings=_auth_settings,
1280
- collection_formats=_collection_formats,
1281
- _host=_host,
1282
- _request_auth=_request_auth
1283
- )
1284
-
1285
-
1286
-
1287
-
1288
- @validate_call
1289
- def campaign_query_get(
1290
- self,
1291
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1292
- _request_timeout: Union[
1293
- None,
1294
- Annotated[StrictFloat, Field(gt=0)],
1295
- Tuple[
1296
- Annotated[StrictFloat, Field(gt=0)],
1297
- Annotated[StrictFloat, Field(gt=0)]
1298
- ]
1299
- ] = None,
1300
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1301
- _content_type: Optional[StrictStr] = None,
1302
- _headers: Optional[Dict[StrictStr, Any]] = None,
1303
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1304
- ) -> CampaignQueryResultPagedResult:
1305
- """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1306
-
1307
-
1308
- :param request: The parameters for filtering, paging, and sorting
1309
- :type request: QueryModel
1310
- :param _request_timeout: timeout setting for this request. If one
1311
- number provided, it will be total request
1312
- timeout. It can also be a pair (tuple) of
1313
- (connection, read) timeouts.
1314
- :type _request_timeout: int, tuple(int, int), optional
1315
- :param _request_auth: set to override the auth_settings for an a single
1316
- request; this effectively ignores the
1317
- authentication in the spec for a single request.
1318
- :type _request_auth: dict, optional
1319
- :param _content_type: force content-type for the request.
1320
- :type _content_type: str, Optional
1321
- :param _headers: set to override the headers for a single
1322
- request; this effectively ignores the headers
1323
- in the spec for a single request.
1324
- :type _headers: dict, optional
1325
- :param _host_index: set to override the host_index for a single
1326
- request; this effectively ignores the host_index
1327
- in the spec for a single request.
1328
- :type _host_index: int, optional
1329
- :return: Returns the result object.
1330
- """ # noqa: E501
1331
- warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1332
-
1333
- _param = self._campaign_query_get_serialize(
1334
- request=request,
1335
- _request_auth=_request_auth,
1336
- _content_type=_content_type,
1337
- _headers=_headers,
1338
- _host_index=_host_index
1339
- )
1340
-
1341
- _response_types_map: Dict[str, Optional[str]] = {
1342
- '200': "CampaignQueryResultPagedResult",
1343
- }
1344
- response_data = self.api_client.call_api(
1345
- *_param,
1346
- _request_timeout=_request_timeout
1347
- )
1348
- response_data.read()
1349
- return self.api_client.response_deserialize(
1350
- response_data=response_data,
1351
- response_types_map=_response_types_map,
1352
- ).data
1353
-
1354
-
1355
- @validate_call
1356
- def campaign_query_get_with_http_info(
1357
- self,
1358
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1359
- _request_timeout: Union[
1360
- None,
1361
- Annotated[StrictFloat, Field(gt=0)],
1362
- Tuple[
1363
- Annotated[StrictFloat, Field(gt=0)],
1364
- Annotated[StrictFloat, Field(gt=0)]
1365
- ]
1366
- ] = None,
1367
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1368
- _content_type: Optional[StrictStr] = None,
1369
- _headers: Optional[Dict[StrictStr, Any]] = None,
1370
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1371
- ) -> ApiResponse[CampaignQueryResultPagedResult]:
1372
- """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1373
-
1374
-
1375
- :param request: The parameters for filtering, paging, and sorting
1376
- :type request: QueryModel
1377
- :param _request_timeout: timeout setting for this request. If one
1378
- number provided, it will be total request
1379
- timeout. It can also be a pair (tuple) of
1380
- (connection, read) timeouts.
1381
- :type _request_timeout: int, tuple(int, int), optional
1382
- :param _request_auth: set to override the auth_settings for an a single
1383
- request; this effectively ignores the
1384
- authentication in the spec for a single request.
1385
- :type _request_auth: dict, optional
1386
- :param _content_type: force content-type for the request.
1387
- :type _content_type: str, Optional
1388
- :param _headers: set to override the headers for a single
1389
- request; this effectively ignores the headers
1390
- in the spec for a single request.
1391
- :type _headers: dict, optional
1392
- :param _host_index: set to override the host_index for a single
1393
- request; this effectively ignores the host_index
1394
- in the spec for a single request.
1395
- :type _host_index: int, optional
1396
- :return: Returns the result object.
1397
- """ # noqa: E501
1398
- warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1399
-
1400
- _param = self._campaign_query_get_serialize(
1401
- request=request,
1402
- _request_auth=_request_auth,
1403
- _content_type=_content_type,
1404
- _headers=_headers,
1405
- _host_index=_host_index
1406
- )
1407
-
1408
- _response_types_map: Dict[str, Optional[str]] = {
1409
- '200': "CampaignQueryResultPagedResult",
1410
- }
1411
- response_data = self.api_client.call_api(
1412
- *_param,
1413
- _request_timeout=_request_timeout
1414
- )
1415
- response_data.read()
1416
- return self.api_client.response_deserialize(
1417
- response_data=response_data,
1418
- response_types_map=_response_types_map,
1419
- )
1420
-
1421
-
1422
- @validate_call
1423
- def campaign_query_get_without_preload_content(
1424
- self,
1425
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1426
- _request_timeout: Union[
1427
- None,
1428
- Annotated[StrictFloat, Field(gt=0)],
1429
- Tuple[
1430
- Annotated[StrictFloat, Field(gt=0)],
1431
- Annotated[StrictFloat, Field(gt=0)]
1432
- ]
1433
- ] = None,
1434
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1435
- _content_type: Optional[StrictStr] = None,
1436
- _headers: Optional[Dict[StrictStr, Any]] = None,
1437
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1438
- ) -> RESTResponseType:
1439
- """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1440
-
1441
-
1442
- :param request: The parameters for filtering, paging, and sorting
1443
- :type request: QueryModel
1444
- :param _request_timeout: timeout setting for this request. If one
1445
- number provided, it will be total request
1446
- timeout. It can also be a pair (tuple) of
1447
- (connection, read) timeouts.
1448
- :type _request_timeout: int, tuple(int, int), optional
1449
- :param _request_auth: set to override the auth_settings for an a single
1450
- request; this effectively ignores the
1451
- authentication in the spec for a single request.
1452
- :type _request_auth: dict, optional
1453
- :param _content_type: force content-type for the request.
1454
- :type _content_type: str, Optional
1455
- :param _headers: set to override the headers for a single
1456
- request; this effectively ignores the headers
1457
- in the spec for a single request.
1458
- :type _headers: dict, optional
1459
- :param _host_index: set to override the host_index for a single
1460
- request; this effectively ignores the host_index
1461
- in the spec for a single request.
1462
- :type _host_index: int, optional
1463
- :return: Returns the result object.
1464
- """ # noqa: E501
1465
- warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1466
-
1467
- _param = self._campaign_query_get_serialize(
1468
- request=request,
1469
- _request_auth=_request_auth,
1470
- _content_type=_content_type,
1471
- _headers=_headers,
1472
- _host_index=_host_index
1473
- )
1474
-
1475
- _response_types_map: Dict[str, Optional[str]] = {
1476
- '200': "CampaignQueryResultPagedResult",
1477
- }
1478
- response_data = self.api_client.call_api(
1479
- *_param,
1480
- _request_timeout=_request_timeout
1481
- )
1482
- return response_data.response
1483
-
1484
-
1485
- def _campaign_query_get_serialize(
1486
- self,
1487
- request,
1488
- _request_auth,
1489
- _content_type,
1490
- _headers,
1491
- _host_index,
1492
- ) -> RequestSerialized:
1493
-
1494
- _host = None
1495
-
1496
- _collection_formats: Dict[str, str] = {
1497
- }
1498
-
1499
- _path_params: Dict[str, str] = {}
1500
- _query_params: List[Tuple[str, str]] = []
1501
- _header_params: Dict[str, Optional[str]] = _headers or {}
1502
- _form_params: List[Tuple[str, str]] = []
1503
- _files: Dict[
1504
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1505
- ] = {}
1506
- _body_params: Optional[bytes] = None
1507
-
1508
- # process the path parameters
1509
- # process the query parameters
1510
- if request is not None:
1511
-
1512
- _query_params.append(('request', request))
1513
-
1514
- # process the header parameters
1515
- # process the form parameters
1516
- # process the body parameter
1517
-
1518
-
1519
- # set the HTTP header `Accept`
1520
- if 'Accept' not in _header_params:
1521
- _header_params['Accept'] = self.api_client.select_header_accept(
1522
- [
1523
- 'text/plain',
1524
- 'application/json',
1525
- 'text/json'
1526
- ]
1527
- )
1528
-
1529
-
1530
- # authentication setting
1531
- _auth_settings: List[str] = [
1532
- 'bearer',
1533
- 'oauth2'
1534
- ]
1535
-
1536
- return self.api_client.param_serialize(
1537
- method='GET',
1538
- resource_path='/campaign/query',
1539
- path_params=_path_params,
1540
- query_params=_query_params,
1541
- header_params=_header_params,
1542
- body=_body_params,
1543
- post_params=_form_params,
1544
- files=_files,
1545
- auth_settings=_auth_settings,
1546
- collection_formats=_collection_formats,
1547
- _host=_host,
1548
- _request_auth=_request_auth
1549
- )
1550
-
1551
-
1552
-
1553
-
1554
- @validate_call
1555
- def campaign_resume_post(
1556
- self,
1557
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1558
- _request_timeout: Union[
1559
- None,
1560
- Annotated[StrictFloat, Field(gt=0)],
1561
- Tuple[
1562
- Annotated[StrictFloat, Field(gt=0)],
1563
- Annotated[StrictFloat, Field(gt=0)]
1564
- ]
1565
- ] = None,
1566
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1567
- _content_type: Optional[StrictStr] = None,
1568
- _headers: Optional[Dict[StrictStr, Any]] = None,
1569
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1570
- ) -> None:
1571
- """(Deprecated) Resumes a campaign.
1572
-
1573
-
1574
- :param campaign_id: id of the campaign that should be paused
1575
- :type campaign_id: str
1576
- :param _request_timeout: timeout setting for this request. If one
1577
- number provided, it will be total request
1578
- timeout. It can also be a pair (tuple) of
1579
- (connection, read) timeouts.
1580
- :type _request_timeout: int, tuple(int, int), optional
1581
- :param _request_auth: set to override the auth_settings for an a single
1582
- request; this effectively ignores the
1583
- authentication in the spec for a single request.
1584
- :type _request_auth: dict, optional
1585
- :param _content_type: force content-type for the request.
1586
- :type _content_type: str, Optional
1587
- :param _headers: set to override the headers for a single
1588
- request; this effectively ignores the headers
1589
- in the spec for a single request.
1590
- :type _headers: dict, optional
1591
- :param _host_index: set to override the host_index for a single
1592
- request; this effectively ignores the host_index
1593
- in the spec for a single request.
1594
- :type _host_index: int, optional
1595
- :return: Returns the result object.
1596
- """ # noqa: E501
1597
- warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1598
-
1599
- _param = self._campaign_resume_post_serialize(
1600
- campaign_id=campaign_id,
1601
- _request_auth=_request_auth,
1602
- _content_type=_content_type,
1603
- _headers=_headers,
1604
- _host_index=_host_index
1605
- )
1606
-
1607
- _response_types_map: Dict[str, Optional[str]] = {
1608
- '200': None,
1609
- }
1610
- response_data = self.api_client.call_api(
1611
- *_param,
1612
- _request_timeout=_request_timeout
1613
- )
1614
- response_data.read()
1615
- return self.api_client.response_deserialize(
1616
- response_data=response_data,
1617
- response_types_map=_response_types_map,
1618
- ).data
1619
-
1620
-
1621
- @validate_call
1622
- def campaign_resume_post_with_http_info(
1623
- self,
1624
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1625
- _request_timeout: Union[
1626
- None,
1627
- Annotated[StrictFloat, Field(gt=0)],
1628
- Tuple[
1629
- Annotated[StrictFloat, Field(gt=0)],
1630
- Annotated[StrictFloat, Field(gt=0)]
1631
- ]
1632
- ] = None,
1633
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1634
- _content_type: Optional[StrictStr] = None,
1635
- _headers: Optional[Dict[StrictStr, Any]] = None,
1636
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1637
- ) -> ApiResponse[None]:
1638
- """(Deprecated) Resumes a campaign.
1639
-
1640
-
1641
- :param campaign_id: id of the campaign that should be paused
1642
- :type campaign_id: str
1643
- :param _request_timeout: timeout setting for this request. If one
1644
- number provided, it will be total request
1645
- timeout. It can also be a pair (tuple) of
1646
- (connection, read) timeouts.
1647
- :type _request_timeout: int, tuple(int, int), optional
1648
- :param _request_auth: set to override the auth_settings for an a single
1649
- request; this effectively ignores the
1650
- authentication in the spec for a single request.
1651
- :type _request_auth: dict, optional
1652
- :param _content_type: force content-type for the request.
1653
- :type _content_type: str, Optional
1654
- :param _headers: set to override the headers for a single
1655
- request; this effectively ignores the headers
1656
- in the spec for a single request.
1657
- :type _headers: dict, optional
1658
- :param _host_index: set to override the host_index for a single
1659
- request; this effectively ignores the host_index
1660
- in the spec for a single request.
1661
- :type _host_index: int, optional
1662
- :return: Returns the result object.
1663
- """ # noqa: E501
1664
- warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1665
-
1666
- _param = self._campaign_resume_post_serialize(
1667
- campaign_id=campaign_id,
1668
- _request_auth=_request_auth,
1669
- _content_type=_content_type,
1670
- _headers=_headers,
1671
- _host_index=_host_index
1672
- )
1673
-
1674
- _response_types_map: Dict[str, Optional[str]] = {
1675
- '200': None,
1676
- }
1677
- response_data = self.api_client.call_api(
1678
- *_param,
1679
- _request_timeout=_request_timeout
1680
- )
1681
- response_data.read()
1682
- return self.api_client.response_deserialize(
1683
- response_data=response_data,
1684
- response_types_map=_response_types_map,
1685
- )
1686
-
1687
-
1688
- @validate_call
1689
- def campaign_resume_post_without_preload_content(
1690
- self,
1691
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1692
- _request_timeout: Union[
1693
- None,
1694
- Annotated[StrictFloat, Field(gt=0)],
1695
- Tuple[
1696
- Annotated[StrictFloat, Field(gt=0)],
1697
- Annotated[StrictFloat, Field(gt=0)]
1698
- ]
1699
- ] = None,
1700
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1701
- _content_type: Optional[StrictStr] = None,
1702
- _headers: Optional[Dict[StrictStr, Any]] = None,
1703
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1704
- ) -> RESTResponseType:
1705
- """(Deprecated) Resumes a campaign.
1706
-
1707
-
1708
- :param campaign_id: id of the campaign that should be paused
1709
- :type campaign_id: str
1710
- :param _request_timeout: timeout setting for this request. If one
1711
- number provided, it will be total request
1712
- timeout. It can also be a pair (tuple) of
1713
- (connection, read) timeouts.
1714
- :type _request_timeout: int, tuple(int, int), optional
1715
- :param _request_auth: set to override the auth_settings for an a single
1716
- request; this effectively ignores the
1717
- authentication in the spec for a single request.
1718
- :type _request_auth: dict, optional
1719
- :param _content_type: force content-type for the request.
1720
- :type _content_type: str, Optional
1721
- :param _headers: set to override the headers for a single
1722
- request; this effectively ignores the headers
1723
- in the spec for a single request.
1724
- :type _headers: dict, optional
1725
- :param _host_index: set to override the host_index for a single
1726
- request; this effectively ignores the host_index
1727
- in the spec for a single request.
1728
- :type _host_index: int, optional
1729
- :return: Returns the result object.
1730
- """ # noqa: E501
1731
- warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1732
-
1733
- _param = self._campaign_resume_post_serialize(
1734
- campaign_id=campaign_id,
1735
- _request_auth=_request_auth,
1736
- _content_type=_content_type,
1737
- _headers=_headers,
1738
- _host_index=_host_index
1739
- )
1740
-
1741
- _response_types_map: Dict[str, Optional[str]] = {
1742
- '200': None,
1743
- }
1744
- response_data = self.api_client.call_api(
1745
- *_param,
1746
- _request_timeout=_request_timeout
1747
- )
1748
- return response_data.response
1749
-
1750
-
1751
- def _campaign_resume_post_serialize(
1752
- self,
1753
- campaign_id,
1754
- _request_auth,
1755
- _content_type,
1756
- _headers,
1757
- _host_index,
1758
- ) -> RequestSerialized:
1759
-
1760
- _host = None
1761
-
1762
- _collection_formats: Dict[str, str] = {
1763
- }
1764
-
1765
- _path_params: Dict[str, str] = {}
1766
- _query_params: List[Tuple[str, str]] = []
1767
- _header_params: Dict[str, Optional[str]] = _headers or {}
1768
- _form_params: List[Tuple[str, str]] = []
1769
- _files: Dict[
1770
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1771
- ] = {}
1772
- _body_params: Optional[bytes] = None
1773
-
1774
- # process the path parameters
1775
- # process the query parameters
1776
- if campaign_id is not None:
1777
-
1778
- _query_params.append(('campaignId', campaign_id))
1779
-
1780
- # process the header parameters
1781
- # process the form parameters
1782
- # process the body parameter
1783
-
1784
-
1785
-
1786
-
1787
- # authentication setting
1788
- _auth_settings: List[str] = [
1789
- 'bearer',
1790
- 'oauth2'
1791
- ]
1792
-
1793
- return self.api_client.param_serialize(
1794
- method='POST',
1795
- resource_path='/campaign/resume',
1796
- path_params=_path_params,
1797
- query_params=_query_params,
1798
- header_params=_header_params,
1799
- body=_body_params,
1800
- post_params=_form_params,
1801
- files=_files,
1802
- auth_settings=_auth_settings,
1803
- collection_formats=_collection_formats,
1804
- _host=_host,
1805
- _request_auth=_request_auth
1806
- )
1807
-
1808
-
1809
-
1810
-
1811
1031
  @validate_call
1812
1032
  def campaigns_get(
1813
1033
  self,