rapidata 2.15.0__py3-none-any.whl → 2.16.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 (60) hide show
  1. rapidata/api_client/__init__.py +17 -7
  2. rapidata/api_client/api/__init__.py +2 -1
  3. rapidata/api_client/api/campaign_api.py +554 -30
  4. rapidata/api_client/api/client_api.py +292 -20
  5. rapidata/api_client/api/coco_api.py +594 -8
  6. rapidata/api_client/api/compare_workflow_api.py +23 -23
  7. rapidata/api_client/api/datapoint_api.py +548 -26
  8. rapidata/api_client/api/dataset_api.py +2198 -186
  9. rapidata/api_client/api/feedback_api.py +306 -0
  10. rapidata/api_client/api/identity_api.py +1143 -78
  11. rapidata/api_client/api/newsletter_api.py +299 -11
  12. rapidata/api_client/api/order_api.py +5358 -556
  13. rapidata/api_client/api/pipeline_api.py +263 -524
  14. rapidata/api_client/api/rapid_api.py +1930 -254
  15. rapidata/api_client/api/simple_workflow_api.py +23 -23
  16. rapidata/api_client/api/validation_set_api.py +5259 -0
  17. rapidata/api_client/api/workflow_api.py +929 -134
  18. rapidata/api_client/models/__init__.py +15 -6
  19. rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
  20. rapidata/api_client/models/add_user_response_result.py +106 -0
  21. rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
  22. rapidata/api_client/models/add_validation_rapid_model.py +3 -3
  23. rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
  24. rapidata/api_client/models/are_rapids_active_result.py +87 -0
  25. rapidata/api_client/models/compare_workflow_model.py +3 -3
  26. rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
  27. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
  28. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
  29. rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
  30. rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
  31. rapidata/api_client/models/create_rapid_result.py +87 -0
  32. rapidata/api_client/models/create_validation_set_model.py +87 -0
  33. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  34. rapidata/api_client/models/get_validation_rapids_query.py +123 -0
  35. rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
  36. rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
  37. rapidata/api_client/models/query_validation_rapids_result.py +3 -3
  38. rapidata/api_client/models/rapid_issue.py +4 -0
  39. rapidata/api_client/models/report_model.py +4 -4
  40. rapidata/api_client/models/shuffling_selection.py +106 -0
  41. rapidata/api_client/models/update_dataset_name_model.py +87 -0
  42. rapidata/api_client/models/update_order_name_model.py +87 -0
  43. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  44. rapidata/api_client/models/user_score_user_filter_model.py +9 -2
  45. rapidata/api_client_README.md +153 -88
  46. rapidata/rapidata_client/demographic/demographic_manager.py +1 -1
  47. rapidata/rapidata_client/filter/user_score_filter.py +4 -1
  48. rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
  49. rapidata/rapidata_client/order/_rapidata_order_builder.py +1 -1
  50. rapidata/rapidata_client/order/rapidata_order.py +5 -5
  51. rapidata/rapidata_client/order/rapidata_order_manager.py +1 -1
  52. rapidata/rapidata_client/order/rapidata_results.py +1 -1
  53. rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
  54. rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
  55. rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
  56. rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
  57. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
  58. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/RECORD +60 -43
  59. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
  60. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
@@ -41,9 +41,9 @@ class CampaignApi:
41
41
 
42
42
 
43
43
  @validate_call
44
- def campaign_campaign_id_release_post(
44
+ def campaign_campaign_id_pause_post(
45
45
  self,
46
- campaign_id: Annotated[StrictStr, Field(description="The campaign id that should be released")],
46
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
47
47
  _request_timeout: Union[
48
48
  None,
49
49
  Annotated[StrictFloat, Field(gt=0)],
@@ -57,10 +57,10 @@ class CampaignApi:
57
57
  _headers: Optional[Dict[StrictStr, Any]] = None,
58
58
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
59
59
  ) -> None:
60
- """Releases a campaign from the preview state. This will make the campaign available for the users to be labeled.
60
+ """Pauses a campaign.
61
61
 
62
62
 
63
- :param campaign_id: The campaign id that should be released (required)
63
+ :param campaign_id: id of the campaign that should be paused (required)
64
64
  :type campaign_id: str
65
65
  :param _request_timeout: timeout setting for this request. If one
66
66
  number provided, it will be total request
@@ -84,7 +84,7 @@ class CampaignApi:
84
84
  :return: Returns the result object.
85
85
  """ # noqa: E501
86
86
 
87
- _param = self._campaign_campaign_id_release_post_serialize(
87
+ _param = self._campaign_campaign_id_pause_post_serialize(
88
88
  campaign_id=campaign_id,
89
89
  _request_auth=_request_auth,
90
90
  _content_type=_content_type,
@@ -107,9 +107,9 @@ class CampaignApi:
107
107
 
108
108
 
109
109
  @validate_call
110
- def campaign_campaign_id_release_post_with_http_info(
110
+ def campaign_campaign_id_pause_post_with_http_info(
111
111
  self,
112
- campaign_id: Annotated[StrictStr, Field(description="The campaign id that should be released")],
112
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
113
113
  _request_timeout: Union[
114
114
  None,
115
115
  Annotated[StrictFloat, Field(gt=0)],
@@ -123,10 +123,10 @@ class CampaignApi:
123
123
  _headers: Optional[Dict[StrictStr, Any]] = None,
124
124
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
125
125
  ) -> ApiResponse[None]:
126
- """Releases a campaign from the preview state. This will make the campaign available for the users to be labeled.
126
+ """Pauses a campaign.
127
127
 
128
128
 
129
- :param campaign_id: The campaign id that should be released (required)
129
+ :param campaign_id: id of the campaign that should be paused (required)
130
130
  :type campaign_id: str
131
131
  :param _request_timeout: timeout setting for this request. If one
132
132
  number provided, it will be total request
@@ -150,7 +150,7 @@ class CampaignApi:
150
150
  :return: Returns the result object.
151
151
  """ # noqa: E501
152
152
 
153
- _param = self._campaign_campaign_id_release_post_serialize(
153
+ _param = self._campaign_campaign_id_pause_post_serialize(
154
154
  campaign_id=campaign_id,
155
155
  _request_auth=_request_auth,
156
156
  _content_type=_content_type,
@@ -173,9 +173,9 @@ class CampaignApi:
173
173
 
174
174
 
175
175
  @validate_call
176
- def campaign_campaign_id_release_post_without_preload_content(
176
+ def campaign_campaign_id_pause_post_without_preload_content(
177
177
  self,
178
- campaign_id: Annotated[StrictStr, Field(description="The campaign id that should be released")],
178
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
179
179
  _request_timeout: Union[
180
180
  None,
181
181
  Annotated[StrictFloat, Field(gt=0)],
@@ -189,10 +189,10 @@ class CampaignApi:
189
189
  _headers: Optional[Dict[StrictStr, Any]] = None,
190
190
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
191
191
  ) -> RESTResponseType:
192
- """Releases a campaign from the preview state. This will make the campaign available for the users to be labeled.
192
+ """Pauses a campaign.
193
193
 
194
194
 
195
- :param campaign_id: The campaign id that should be released (required)
195
+ :param campaign_id: id of the campaign that should be paused (required)
196
196
  :type campaign_id: str
197
197
  :param _request_timeout: timeout setting for this request. If one
198
198
  number provided, it will be total request
@@ -216,7 +216,7 @@ class CampaignApi:
216
216
  :return: Returns the result object.
217
217
  """ # noqa: E501
218
218
 
219
- _param = self._campaign_campaign_id_release_post_serialize(
219
+ _param = self._campaign_campaign_id_pause_post_serialize(
220
220
  campaign_id=campaign_id,
221
221
  _request_auth=_request_auth,
222
222
  _content_type=_content_type,
@@ -234,7 +234,7 @@ class CampaignApi:
234
234
  return response_data.response
235
235
 
236
236
 
237
- def _campaign_campaign_id_release_post_serialize(
237
+ def _campaign_campaign_id_pause_post_serialize(
238
238
  self,
239
239
  campaign_id,
240
240
  _request_auth,
@@ -276,7 +276,259 @@ class CampaignApi:
276
276
 
277
277
  return self.api_client.param_serialize(
278
278
  method='POST',
279
- resource_path='/campaign/{campaignId}/release',
279
+ resource_path='/campaign/{campaignId}/pause',
280
+ path_params=_path_params,
281
+ query_params=_query_params,
282
+ header_params=_header_params,
283
+ body=_body_params,
284
+ post_params=_form_params,
285
+ files=_files,
286
+ auth_settings=_auth_settings,
287
+ collection_formats=_collection_formats,
288
+ _host=_host,
289
+ _request_auth=_request_auth
290
+ )
291
+
292
+
293
+
294
+
295
+ @validate_call
296
+ def campaign_campaign_id_resume_post(
297
+ self,
298
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
299
+ _request_timeout: Union[
300
+ None,
301
+ Annotated[StrictFloat, Field(gt=0)],
302
+ Tuple[
303
+ Annotated[StrictFloat, Field(gt=0)],
304
+ Annotated[StrictFloat, Field(gt=0)]
305
+ ]
306
+ ] = None,
307
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
308
+ _content_type: Optional[StrictStr] = None,
309
+ _headers: Optional[Dict[StrictStr, Any]] = None,
310
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
311
+ ) -> None:
312
+ """Resumes a campaign.
313
+
314
+
315
+ :param campaign_id: id of the campaign that should be paused (required)
316
+ :type campaign_id: str
317
+ :param _request_timeout: timeout setting for this request. If one
318
+ number provided, it will be total request
319
+ timeout. It can also be a pair (tuple) of
320
+ (connection, read) timeouts.
321
+ :type _request_timeout: int, tuple(int, int), optional
322
+ :param _request_auth: set to override the auth_settings for an a single
323
+ request; this effectively ignores the
324
+ authentication in the spec for a single request.
325
+ :type _request_auth: dict, optional
326
+ :param _content_type: force content-type for the request.
327
+ :type _content_type: str, Optional
328
+ :param _headers: set to override the headers for a single
329
+ request; this effectively ignores the headers
330
+ in the spec for a single request.
331
+ :type _headers: dict, optional
332
+ :param _host_index: set to override the host_index for a single
333
+ request; this effectively ignores the host_index
334
+ in the spec for a single request.
335
+ :type _host_index: int, optional
336
+ :return: Returns the result object.
337
+ """ # noqa: E501
338
+
339
+ _param = self._campaign_campaign_id_resume_post_serialize(
340
+ campaign_id=campaign_id,
341
+ _request_auth=_request_auth,
342
+ _content_type=_content_type,
343
+ _headers=_headers,
344
+ _host_index=_host_index
345
+ )
346
+
347
+ _response_types_map: Dict[str, Optional[str]] = {
348
+ '204': None,
349
+ }
350
+ response_data = self.api_client.call_api(
351
+ *_param,
352
+ _request_timeout=_request_timeout
353
+ )
354
+ response_data.read()
355
+ return self.api_client.response_deserialize(
356
+ response_data=response_data,
357
+ response_types_map=_response_types_map,
358
+ ).data
359
+
360
+
361
+ @validate_call
362
+ def campaign_campaign_id_resume_post_with_http_info(
363
+ self,
364
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
365
+ _request_timeout: Union[
366
+ None,
367
+ Annotated[StrictFloat, Field(gt=0)],
368
+ Tuple[
369
+ Annotated[StrictFloat, Field(gt=0)],
370
+ Annotated[StrictFloat, Field(gt=0)]
371
+ ]
372
+ ] = None,
373
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
374
+ _content_type: Optional[StrictStr] = None,
375
+ _headers: Optional[Dict[StrictStr, Any]] = None,
376
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
377
+ ) -> ApiResponse[None]:
378
+ """Resumes a campaign.
379
+
380
+
381
+ :param campaign_id: id of the campaign that should be paused (required)
382
+ :type campaign_id: str
383
+ :param _request_timeout: timeout setting for this request. If one
384
+ number provided, it will be total request
385
+ timeout. It can also be a pair (tuple) of
386
+ (connection, read) timeouts.
387
+ :type _request_timeout: int, tuple(int, int), optional
388
+ :param _request_auth: set to override the auth_settings for an a single
389
+ request; this effectively ignores the
390
+ authentication in the spec for a single request.
391
+ :type _request_auth: dict, optional
392
+ :param _content_type: force content-type for the request.
393
+ :type _content_type: str, Optional
394
+ :param _headers: set to override the headers for a single
395
+ request; this effectively ignores the headers
396
+ in the spec for a single request.
397
+ :type _headers: dict, optional
398
+ :param _host_index: set to override the host_index for a single
399
+ request; this effectively ignores the host_index
400
+ in the spec for a single request.
401
+ :type _host_index: int, optional
402
+ :return: Returns the result object.
403
+ """ # noqa: E501
404
+
405
+ _param = self._campaign_campaign_id_resume_post_serialize(
406
+ campaign_id=campaign_id,
407
+ _request_auth=_request_auth,
408
+ _content_type=_content_type,
409
+ _headers=_headers,
410
+ _host_index=_host_index
411
+ )
412
+
413
+ _response_types_map: Dict[str, Optional[str]] = {
414
+ '204': None,
415
+ }
416
+ response_data = self.api_client.call_api(
417
+ *_param,
418
+ _request_timeout=_request_timeout
419
+ )
420
+ response_data.read()
421
+ return self.api_client.response_deserialize(
422
+ response_data=response_data,
423
+ response_types_map=_response_types_map,
424
+ )
425
+
426
+
427
+ @validate_call
428
+ def campaign_campaign_id_resume_post_without_preload_content(
429
+ self,
430
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
431
+ _request_timeout: Union[
432
+ None,
433
+ Annotated[StrictFloat, Field(gt=0)],
434
+ Tuple[
435
+ Annotated[StrictFloat, Field(gt=0)],
436
+ Annotated[StrictFloat, Field(gt=0)]
437
+ ]
438
+ ] = None,
439
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
440
+ _content_type: Optional[StrictStr] = None,
441
+ _headers: Optional[Dict[StrictStr, Any]] = None,
442
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
443
+ ) -> RESTResponseType:
444
+ """Resumes a campaign.
445
+
446
+
447
+ :param campaign_id: id of the campaign that should be paused (required)
448
+ :type campaign_id: str
449
+ :param _request_timeout: timeout setting for this request. If one
450
+ number provided, it will be total request
451
+ timeout. It can also be a pair (tuple) of
452
+ (connection, read) timeouts.
453
+ :type _request_timeout: int, tuple(int, int), optional
454
+ :param _request_auth: set to override the auth_settings for an a single
455
+ request; this effectively ignores the
456
+ authentication in the spec for a single request.
457
+ :type _request_auth: dict, optional
458
+ :param _content_type: force content-type for the request.
459
+ :type _content_type: str, Optional
460
+ :param _headers: set to override the headers for a single
461
+ request; this effectively ignores the headers
462
+ in the spec for a single request.
463
+ :type _headers: dict, optional
464
+ :param _host_index: set to override the host_index for a single
465
+ request; this effectively ignores the host_index
466
+ in the spec for a single request.
467
+ :type _host_index: int, optional
468
+ :return: Returns the result object.
469
+ """ # noqa: E501
470
+
471
+ _param = self._campaign_campaign_id_resume_post_serialize(
472
+ campaign_id=campaign_id,
473
+ _request_auth=_request_auth,
474
+ _content_type=_content_type,
475
+ _headers=_headers,
476
+ _host_index=_host_index
477
+ )
478
+
479
+ _response_types_map: Dict[str, Optional[str]] = {
480
+ '204': None,
481
+ }
482
+ response_data = self.api_client.call_api(
483
+ *_param,
484
+ _request_timeout=_request_timeout
485
+ )
486
+ return response_data.response
487
+
488
+
489
+ def _campaign_campaign_id_resume_post_serialize(
490
+ self,
491
+ campaign_id,
492
+ _request_auth,
493
+ _content_type,
494
+ _headers,
495
+ _host_index,
496
+ ) -> RequestSerialized:
497
+
498
+ _host = None
499
+
500
+ _collection_formats: Dict[str, str] = {
501
+ }
502
+
503
+ _path_params: Dict[str, str] = {}
504
+ _query_params: List[Tuple[str, str]] = []
505
+ _header_params: Dict[str, Optional[str]] = _headers or {}
506
+ _form_params: List[Tuple[str, str]] = []
507
+ _files: Dict[
508
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
509
+ ] = {}
510
+ _body_params: Optional[bytes] = None
511
+
512
+ # process the path parameters
513
+ if campaign_id is not None:
514
+ _path_params['campaignId'] = campaign_id
515
+ # process the query parameters
516
+ # process the header parameters
517
+ # process the form parameters
518
+ # process the body parameter
519
+
520
+
521
+
522
+
523
+ # authentication setting
524
+ _auth_settings: List[str] = [
525
+ 'bearer',
526
+ 'oauth2'
527
+ ]
528
+
529
+ return self.api_client.param_serialize(
530
+ method='POST',
531
+ resource_path='/campaign/{campaignId}/resume',
280
532
  path_params=_path_params,
281
533
  query_params=_query_params,
282
534
  header_params=_header_params,
@@ -513,7 +765,7 @@ class CampaignApi:
513
765
 
514
766
  return self.api_client.param_serialize(
515
767
  method='GET',
516
- resource_path='/Campaign/Monitor',
768
+ resource_path='/campaign/monitor',
517
769
  path_params=_path_params,
518
770
  query_params=_query_params,
519
771
  header_params=_header_params,
@@ -546,7 +798,7 @@ class CampaignApi:
546
798
  _headers: Optional[Dict[StrictStr, Any]] = None,
547
799
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
548
800
  ) -> None:
549
- """Pauses a campaign.
801
+ """(Deprecated) Pauses a campaign.
550
802
 
551
803
 
552
804
  :param campaign_id: id of the campaign that should be paused
@@ -572,6 +824,7 @@ class CampaignApi:
572
824
  :type _host_index: int, optional
573
825
  :return: Returns the result object.
574
826
  """ # noqa: E501
827
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
575
828
 
576
829
  _param = self._campaign_pause_post_serialize(
577
830
  campaign_id=campaign_id,
@@ -612,7 +865,7 @@ class CampaignApi:
612
865
  _headers: Optional[Dict[StrictStr, Any]] = None,
613
866
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
614
867
  ) -> ApiResponse[None]:
615
- """Pauses a campaign.
868
+ """(Deprecated) Pauses a campaign.
616
869
 
617
870
 
618
871
  :param campaign_id: id of the campaign that should be paused
@@ -638,6 +891,7 @@ class CampaignApi:
638
891
  :type _host_index: int, optional
639
892
  :return: Returns the result object.
640
893
  """ # noqa: E501
894
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
641
895
 
642
896
  _param = self._campaign_pause_post_serialize(
643
897
  campaign_id=campaign_id,
@@ -678,7 +932,7 @@ class CampaignApi:
678
932
  _headers: Optional[Dict[StrictStr, Any]] = None,
679
933
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
680
934
  ) -> RESTResponseType:
681
- """Pauses a campaign.
935
+ """(Deprecated) Pauses a campaign.
682
936
 
683
937
 
684
938
  :param campaign_id: id of the campaign that should be paused
@@ -704,6 +958,7 @@ class CampaignApi:
704
958
  :type _host_index: int, optional
705
959
  :return: Returns the result object.
706
960
  """ # noqa: E501
961
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
707
962
 
708
963
  _param = self._campaign_pause_post_serialize(
709
964
  campaign_id=campaign_id,
@@ -767,7 +1022,7 @@ class CampaignApi:
767
1022
 
768
1023
  return self.api_client.param_serialize(
769
1024
  method='POST',
770
- resource_path='/Campaign/Pause',
1025
+ resource_path='/campaign/pause',
771
1026
  path_params=_path_params,
772
1027
  query_params=_query_params,
773
1028
  header_params=_header_params,
@@ -800,7 +1055,7 @@ class CampaignApi:
800
1055
  _headers: Optional[Dict[StrictStr, Any]] = None,
801
1056
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
802
1057
  ) -> CampaignQueryResultPagedResult:
803
- """Queries orders based on a filter, page, and sort criteria.
1058
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
804
1059
 
805
1060
 
806
1061
  :param request: The parameters for filtering, paging, and sorting
@@ -826,6 +1081,7 @@ class CampaignApi:
826
1081
  :type _host_index: int, optional
827
1082
  :return: Returns the result object.
828
1083
  """ # noqa: E501
1084
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
829
1085
 
830
1086
  _param = self._campaign_query_get_serialize(
831
1087
  request=request,
@@ -866,7 +1122,7 @@ class CampaignApi:
866
1122
  _headers: Optional[Dict[StrictStr, Any]] = None,
867
1123
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
868
1124
  ) -> ApiResponse[CampaignQueryResultPagedResult]:
869
- """Queries orders based on a filter, page, and sort criteria.
1125
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
870
1126
 
871
1127
 
872
1128
  :param request: The parameters for filtering, paging, and sorting
@@ -892,6 +1148,7 @@ class CampaignApi:
892
1148
  :type _host_index: int, optional
893
1149
  :return: Returns the result object.
894
1150
  """ # noqa: E501
1151
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
895
1152
 
896
1153
  _param = self._campaign_query_get_serialize(
897
1154
  request=request,
@@ -932,7 +1189,7 @@ class CampaignApi:
932
1189
  _headers: Optional[Dict[StrictStr, Any]] = None,
933
1190
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
934
1191
  ) -> RESTResponseType:
935
- """Queries orders based on a filter, page, and sort criteria.
1192
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
936
1193
 
937
1194
 
938
1195
  :param request: The parameters for filtering, paging, and sorting
@@ -958,6 +1215,7 @@ class CampaignApi:
958
1215
  :type _host_index: int, optional
959
1216
  :return: Returns the result object.
960
1217
  """ # noqa: E501
1218
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
961
1219
 
962
1220
  _param = self._campaign_query_get_serialize(
963
1221
  request=request,
@@ -1030,7 +1288,7 @@ class CampaignApi:
1030
1288
 
1031
1289
  return self.api_client.param_serialize(
1032
1290
  method='GET',
1033
- resource_path='/Campaign/Query',
1291
+ resource_path='/campaign/query',
1034
1292
  path_params=_path_params,
1035
1293
  query_params=_query_params,
1036
1294
  header_params=_header_params,
@@ -1063,7 +1321,7 @@ class CampaignApi:
1063
1321
  _headers: Optional[Dict[StrictStr, Any]] = None,
1064
1322
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1065
1323
  ) -> None:
1066
- """Resumes a campaign.
1324
+ """(Deprecated) Resumes a campaign.
1067
1325
 
1068
1326
 
1069
1327
  :param campaign_id: id of the campaign that should be paused
@@ -1089,6 +1347,7 @@ class CampaignApi:
1089
1347
  :type _host_index: int, optional
1090
1348
  :return: Returns the result object.
1091
1349
  """ # noqa: E501
1350
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1092
1351
 
1093
1352
  _param = self._campaign_resume_post_serialize(
1094
1353
  campaign_id=campaign_id,
@@ -1129,7 +1388,7 @@ class CampaignApi:
1129
1388
  _headers: Optional[Dict[StrictStr, Any]] = None,
1130
1389
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1131
1390
  ) -> ApiResponse[None]:
1132
- """Resumes a campaign.
1391
+ """(Deprecated) Resumes a campaign.
1133
1392
 
1134
1393
 
1135
1394
  :param campaign_id: id of the campaign that should be paused
@@ -1155,6 +1414,7 @@ class CampaignApi:
1155
1414
  :type _host_index: int, optional
1156
1415
  :return: Returns the result object.
1157
1416
  """ # noqa: E501
1417
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1158
1418
 
1159
1419
  _param = self._campaign_resume_post_serialize(
1160
1420
  campaign_id=campaign_id,
@@ -1195,7 +1455,7 @@ class CampaignApi:
1195
1455
  _headers: Optional[Dict[StrictStr, Any]] = None,
1196
1456
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1197
1457
  ) -> RESTResponseType:
1198
- """Resumes a campaign.
1458
+ """(Deprecated) Resumes a campaign.
1199
1459
 
1200
1460
 
1201
1461
  :param campaign_id: id of the campaign that should be paused
@@ -1221,6 +1481,7 @@ class CampaignApi:
1221
1481
  :type _host_index: int, optional
1222
1482
  :return: Returns the result object.
1223
1483
  """ # noqa: E501
1484
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1224
1485
 
1225
1486
  _param = self._campaign_resume_post_serialize(
1226
1487
  campaign_id=campaign_id,
@@ -1284,7 +1545,270 @@ class CampaignApi:
1284
1545
 
1285
1546
  return self.api_client.param_serialize(
1286
1547
  method='POST',
1287
- resource_path='/Campaign/Resume',
1548
+ resource_path='/campaign/resume',
1549
+ path_params=_path_params,
1550
+ query_params=_query_params,
1551
+ header_params=_header_params,
1552
+ body=_body_params,
1553
+ post_params=_form_params,
1554
+ files=_files,
1555
+ auth_settings=_auth_settings,
1556
+ collection_formats=_collection_formats,
1557
+ _host=_host,
1558
+ _request_auth=_request_auth
1559
+ )
1560
+
1561
+
1562
+
1563
+
1564
+ @validate_call
1565
+ def campaigns_get(
1566
+ self,
1567
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1568
+ _request_timeout: Union[
1569
+ None,
1570
+ Annotated[StrictFloat, Field(gt=0)],
1571
+ Tuple[
1572
+ Annotated[StrictFloat, Field(gt=0)],
1573
+ Annotated[StrictFloat, Field(gt=0)]
1574
+ ]
1575
+ ] = None,
1576
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1577
+ _content_type: Optional[StrictStr] = None,
1578
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1579
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1580
+ ) -> CampaignQueryResultPagedResult:
1581
+ """Queries orders based on a filter, page, and sort criteria.
1582
+
1583
+
1584
+ :param request: The parameters for filtering, paging, and sorting
1585
+ :type request: QueryModel
1586
+ :param _request_timeout: timeout setting for this request. If one
1587
+ number provided, it will be total request
1588
+ timeout. It can also be a pair (tuple) of
1589
+ (connection, read) timeouts.
1590
+ :type _request_timeout: int, tuple(int, int), optional
1591
+ :param _request_auth: set to override the auth_settings for an a single
1592
+ request; this effectively ignores the
1593
+ authentication in the spec for a single request.
1594
+ :type _request_auth: dict, optional
1595
+ :param _content_type: force content-type for the request.
1596
+ :type _content_type: str, Optional
1597
+ :param _headers: set to override the headers for a single
1598
+ request; this effectively ignores the headers
1599
+ in the spec for a single request.
1600
+ :type _headers: dict, optional
1601
+ :param _host_index: set to override the host_index for a single
1602
+ request; this effectively ignores the host_index
1603
+ in the spec for a single request.
1604
+ :type _host_index: int, optional
1605
+ :return: Returns the result object.
1606
+ """ # noqa: E501
1607
+
1608
+ _param = self._campaigns_get_serialize(
1609
+ request=request,
1610
+ _request_auth=_request_auth,
1611
+ _content_type=_content_type,
1612
+ _headers=_headers,
1613
+ _host_index=_host_index
1614
+ )
1615
+
1616
+ _response_types_map: Dict[str, Optional[str]] = {
1617
+ '200': "CampaignQueryResultPagedResult",
1618
+ }
1619
+ response_data = self.api_client.call_api(
1620
+ *_param,
1621
+ _request_timeout=_request_timeout
1622
+ )
1623
+ response_data.read()
1624
+ return self.api_client.response_deserialize(
1625
+ response_data=response_data,
1626
+ response_types_map=_response_types_map,
1627
+ ).data
1628
+
1629
+
1630
+ @validate_call
1631
+ def campaigns_get_with_http_info(
1632
+ self,
1633
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1634
+ _request_timeout: Union[
1635
+ None,
1636
+ Annotated[StrictFloat, Field(gt=0)],
1637
+ Tuple[
1638
+ Annotated[StrictFloat, Field(gt=0)],
1639
+ Annotated[StrictFloat, Field(gt=0)]
1640
+ ]
1641
+ ] = None,
1642
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1643
+ _content_type: Optional[StrictStr] = None,
1644
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1645
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1646
+ ) -> ApiResponse[CampaignQueryResultPagedResult]:
1647
+ """Queries orders based on a filter, page, and sort criteria.
1648
+
1649
+
1650
+ :param request: The parameters for filtering, paging, and sorting
1651
+ :type request: QueryModel
1652
+ :param _request_timeout: timeout setting for this request. If one
1653
+ number provided, it will be total request
1654
+ timeout. It can also be a pair (tuple) of
1655
+ (connection, read) timeouts.
1656
+ :type _request_timeout: int, tuple(int, int), optional
1657
+ :param _request_auth: set to override the auth_settings for an a single
1658
+ request; this effectively ignores the
1659
+ authentication in the spec for a single request.
1660
+ :type _request_auth: dict, optional
1661
+ :param _content_type: force content-type for the request.
1662
+ :type _content_type: str, Optional
1663
+ :param _headers: set to override the headers for a single
1664
+ request; this effectively ignores the headers
1665
+ in the spec for a single request.
1666
+ :type _headers: dict, optional
1667
+ :param _host_index: set to override the host_index for a single
1668
+ request; this effectively ignores the host_index
1669
+ in the spec for a single request.
1670
+ :type _host_index: int, optional
1671
+ :return: Returns the result object.
1672
+ """ # noqa: E501
1673
+
1674
+ _param = self._campaigns_get_serialize(
1675
+ request=request,
1676
+ _request_auth=_request_auth,
1677
+ _content_type=_content_type,
1678
+ _headers=_headers,
1679
+ _host_index=_host_index
1680
+ )
1681
+
1682
+ _response_types_map: Dict[str, Optional[str]] = {
1683
+ '200': "CampaignQueryResultPagedResult",
1684
+ }
1685
+ response_data = self.api_client.call_api(
1686
+ *_param,
1687
+ _request_timeout=_request_timeout
1688
+ )
1689
+ response_data.read()
1690
+ return self.api_client.response_deserialize(
1691
+ response_data=response_data,
1692
+ response_types_map=_response_types_map,
1693
+ )
1694
+
1695
+
1696
+ @validate_call
1697
+ def campaigns_get_without_preload_content(
1698
+ self,
1699
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1700
+ _request_timeout: Union[
1701
+ None,
1702
+ Annotated[StrictFloat, Field(gt=0)],
1703
+ Tuple[
1704
+ Annotated[StrictFloat, Field(gt=0)],
1705
+ Annotated[StrictFloat, Field(gt=0)]
1706
+ ]
1707
+ ] = None,
1708
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1709
+ _content_type: Optional[StrictStr] = None,
1710
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1711
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1712
+ ) -> RESTResponseType:
1713
+ """Queries orders based on a filter, page, and sort criteria.
1714
+
1715
+
1716
+ :param request: The parameters for filtering, paging, and sorting
1717
+ :type request: QueryModel
1718
+ :param _request_timeout: timeout setting for this request. If one
1719
+ number provided, it will be total request
1720
+ timeout. It can also be a pair (tuple) of
1721
+ (connection, read) timeouts.
1722
+ :type _request_timeout: int, tuple(int, int), optional
1723
+ :param _request_auth: set to override the auth_settings for an a single
1724
+ request; this effectively ignores the
1725
+ authentication in the spec for a single request.
1726
+ :type _request_auth: dict, optional
1727
+ :param _content_type: force content-type for the request.
1728
+ :type _content_type: str, Optional
1729
+ :param _headers: set to override the headers for a single
1730
+ request; this effectively ignores the headers
1731
+ in the spec for a single request.
1732
+ :type _headers: dict, optional
1733
+ :param _host_index: set to override the host_index for a single
1734
+ request; this effectively ignores the host_index
1735
+ in the spec for a single request.
1736
+ :type _host_index: int, optional
1737
+ :return: Returns the result object.
1738
+ """ # noqa: E501
1739
+
1740
+ _param = self._campaigns_get_serialize(
1741
+ request=request,
1742
+ _request_auth=_request_auth,
1743
+ _content_type=_content_type,
1744
+ _headers=_headers,
1745
+ _host_index=_host_index
1746
+ )
1747
+
1748
+ _response_types_map: Dict[str, Optional[str]] = {
1749
+ '200': "CampaignQueryResultPagedResult",
1750
+ }
1751
+ response_data = self.api_client.call_api(
1752
+ *_param,
1753
+ _request_timeout=_request_timeout
1754
+ )
1755
+ return response_data.response
1756
+
1757
+
1758
+ def _campaigns_get_serialize(
1759
+ self,
1760
+ request,
1761
+ _request_auth,
1762
+ _content_type,
1763
+ _headers,
1764
+ _host_index,
1765
+ ) -> RequestSerialized:
1766
+
1767
+ _host = None
1768
+
1769
+ _collection_formats: Dict[str, str] = {
1770
+ }
1771
+
1772
+ _path_params: Dict[str, str] = {}
1773
+ _query_params: List[Tuple[str, str]] = []
1774
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1775
+ _form_params: List[Tuple[str, str]] = []
1776
+ _files: Dict[
1777
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1778
+ ] = {}
1779
+ _body_params: Optional[bytes] = None
1780
+
1781
+ # process the path parameters
1782
+ # process the query parameters
1783
+ if request is not None:
1784
+
1785
+ _query_params.append(('request', request))
1786
+
1787
+ # process the header parameters
1788
+ # process the form parameters
1789
+ # process the body parameter
1790
+
1791
+
1792
+ # set the HTTP header `Accept`
1793
+ if 'Accept' not in _header_params:
1794
+ _header_params['Accept'] = self.api_client.select_header_accept(
1795
+ [
1796
+ 'text/plain',
1797
+ 'application/json',
1798
+ 'text/json'
1799
+ ]
1800
+ )
1801
+
1802
+
1803
+ # authentication setting
1804
+ _auth_settings: List[str] = [
1805
+ 'bearer',
1806
+ 'oauth2'
1807
+ ]
1808
+
1809
+ return self.api_client.param_serialize(
1810
+ method='GET',
1811
+ resource_path='/campaigns',
1288
1812
  path_params=_path_params,
1289
1813
  query_params=_query_params,
1290
1814
  header_params=_header_params,