rapidata 2.14.1__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 (69) hide show
  1. rapidata/api_client/__init__.py +18 -7
  2. rapidata/api_client/api/__init__.py +2 -1
  3. rapidata/api_client/api/campaign_api.py +868 -92
  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 +5570 -516
  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_api.py +283 -0
  17. rapidata/api_client/api/validation_set_api.py +5259 -0
  18. rapidata/api_client/api/workflow_api.py +929 -134
  19. rapidata/api_client/models/__init__.py +16 -6
  20. rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
  21. rapidata/api_client/models/add_campaign_model.py +9 -2
  22. rapidata/api_client/models/add_user_response_result.py +106 -0
  23. rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
  24. rapidata/api_client/models/add_validation_rapid_model.py +3 -3
  25. rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
  26. rapidata/api_client/models/are_rapids_active_result.py +87 -0
  27. rapidata/api_client/models/campaign_query_result.py +2 -2
  28. rapidata/api_client/models/campaign_status.py +1 -0
  29. rapidata/api_client/models/compare_workflow_model.py +3 -3
  30. rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
  31. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
  32. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
  33. rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
  34. rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
  35. rapidata/api_client/models/create_order_model.py +15 -1
  36. rapidata/api_client/models/create_rapid_result.py +87 -0
  37. rapidata/api_client/models/create_validation_set_model.py +87 -0
  38. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  39. rapidata/api_client/models/evaluation_workflow_model.py +1 -1
  40. rapidata/api_client/models/get_validation_rapids_query.py +123 -0
  41. rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
  42. rapidata/api_client/models/order_model.py +2 -2
  43. rapidata/api_client/models/order_state.py +1 -0
  44. rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
  45. rapidata/api_client/models/query_validation_rapids_result.py +3 -3
  46. rapidata/api_client/models/rapid_issue.py +4 -0
  47. rapidata/api_client/models/report_model.py +4 -4
  48. rapidata/api_client/models/shuffling_selection.py +106 -0
  49. rapidata/api_client/models/update_dataset_name_model.py +87 -0
  50. rapidata/api_client/models/update_dimensions_model.py +87 -0
  51. rapidata/api_client/models/update_order_name_model.py +87 -0
  52. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  53. rapidata/api_client/models/user_score_user_filter_model.py +9 -2
  54. rapidata/api_client_README.md +154 -84
  55. rapidata/rapidata_client/demographic/demographic_manager.py +36 -1
  56. rapidata/rapidata_client/filter/user_score_filter.py +4 -1
  57. rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
  58. rapidata/rapidata_client/order/_rapidata_order_builder.py +3 -1
  59. rapidata/rapidata_client/order/rapidata_order.py +8 -10
  60. rapidata/rapidata_client/order/rapidata_order_manager.py +11 -2
  61. rapidata/rapidata_client/order/rapidata_results.py +1 -1
  62. rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
  63. rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
  64. rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
  65. rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
  66. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
  67. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/RECORD +69 -51
  68. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
  69. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
@@ -41,8 +41,9 @@ class CampaignApi:
41
41
 
42
42
 
43
43
  @validate_call
44
- def campaign_monitor_get(
44
+ def campaign_campaign_id_pause_post(
45
45
  self,
46
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
46
47
  _request_timeout: Union[
47
48
  None,
48
49
  Annotated[StrictFloat, Field(gt=0)],
@@ -56,9 +57,11 @@ class CampaignApi:
56
57
  _headers: Optional[Dict[StrictStr, Any]] = None,
57
58
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
58
59
  ) -> None:
59
- """The monitor endpoint is used to monitor the health of the service
60
+ """Pauses a campaign.
60
61
 
61
62
 
63
+ :param campaign_id: id of the campaign that should be paused (required)
64
+ :type campaign_id: str
62
65
  :param _request_timeout: timeout setting for this request. If one
63
66
  number provided, it will be total request
64
67
  timeout. It can also be a pair (tuple) of
@@ -81,7 +84,8 @@ class CampaignApi:
81
84
  :return: Returns the result object.
82
85
  """ # noqa: E501
83
86
 
84
- _param = self._campaign_monitor_get_serialize(
87
+ _param = self._campaign_campaign_id_pause_post_serialize(
88
+ campaign_id=campaign_id,
85
89
  _request_auth=_request_auth,
86
90
  _content_type=_content_type,
87
91
  _headers=_headers,
@@ -89,7 +93,7 @@ class CampaignApi:
89
93
  )
90
94
 
91
95
  _response_types_map: Dict[str, Optional[str]] = {
92
- '200': None,
96
+ '204': None,
93
97
  }
94
98
  response_data = self.api_client.call_api(
95
99
  *_param,
@@ -103,8 +107,9 @@ class CampaignApi:
103
107
 
104
108
 
105
109
  @validate_call
106
- def campaign_monitor_get_with_http_info(
110
+ def campaign_campaign_id_pause_post_with_http_info(
107
111
  self,
112
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
108
113
  _request_timeout: Union[
109
114
  None,
110
115
  Annotated[StrictFloat, Field(gt=0)],
@@ -118,9 +123,11 @@ class CampaignApi:
118
123
  _headers: Optional[Dict[StrictStr, Any]] = None,
119
124
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
120
125
  ) -> ApiResponse[None]:
121
- """The monitor endpoint is used to monitor the health of the service
126
+ """Pauses a campaign.
122
127
 
123
128
 
129
+ :param campaign_id: id of the campaign that should be paused (required)
130
+ :type campaign_id: str
124
131
  :param _request_timeout: timeout setting for this request. If one
125
132
  number provided, it will be total request
126
133
  timeout. It can also be a pair (tuple) of
@@ -143,7 +150,8 @@ class CampaignApi:
143
150
  :return: Returns the result object.
144
151
  """ # noqa: E501
145
152
 
146
- _param = self._campaign_monitor_get_serialize(
153
+ _param = self._campaign_campaign_id_pause_post_serialize(
154
+ campaign_id=campaign_id,
147
155
  _request_auth=_request_auth,
148
156
  _content_type=_content_type,
149
157
  _headers=_headers,
@@ -151,7 +159,7 @@ class CampaignApi:
151
159
  )
152
160
 
153
161
  _response_types_map: Dict[str, Optional[str]] = {
154
- '200': None,
162
+ '204': None,
155
163
  }
156
164
  response_data = self.api_client.call_api(
157
165
  *_param,
@@ -165,8 +173,9 @@ class CampaignApi:
165
173
 
166
174
 
167
175
  @validate_call
168
- def campaign_monitor_get_without_preload_content(
176
+ def campaign_campaign_id_pause_post_without_preload_content(
169
177
  self,
178
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
170
179
  _request_timeout: Union[
171
180
  None,
172
181
  Annotated[StrictFloat, Field(gt=0)],
@@ -180,9 +189,11 @@ class CampaignApi:
180
189
  _headers: Optional[Dict[StrictStr, Any]] = None,
181
190
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
182
191
  ) -> RESTResponseType:
183
- """The monitor endpoint is used to monitor the health of the service
192
+ """Pauses a campaign.
184
193
 
185
194
 
195
+ :param campaign_id: id of the campaign that should be paused (required)
196
+ :type campaign_id: str
186
197
  :param _request_timeout: timeout setting for this request. If one
187
198
  number provided, it will be total request
188
199
  timeout. It can also be a pair (tuple) of
@@ -205,7 +216,8 @@ class CampaignApi:
205
216
  :return: Returns the result object.
206
217
  """ # noqa: E501
207
218
 
208
- _param = self._campaign_monitor_get_serialize(
219
+ _param = self._campaign_campaign_id_pause_post_serialize(
220
+ campaign_id=campaign_id,
209
221
  _request_auth=_request_auth,
210
222
  _content_type=_content_type,
211
223
  _headers=_headers,
@@ -213,7 +225,7 @@ class CampaignApi:
213
225
  )
214
226
 
215
227
  _response_types_map: Dict[str, Optional[str]] = {
216
- '200': None,
228
+ '204': None,
217
229
  }
218
230
  response_data = self.api_client.call_api(
219
231
  *_param,
@@ -222,8 +234,9 @@ class CampaignApi:
222
234
  return response_data.response
223
235
 
224
236
 
225
- def _campaign_monitor_get_serialize(
237
+ def _campaign_campaign_id_pause_post_serialize(
226
238
  self,
239
+ campaign_id,
227
240
  _request_auth,
228
241
  _content_type,
229
242
  _headers,
@@ -245,6 +258,8 @@ class CampaignApi:
245
258
  _body_params: Optional[bytes] = None
246
259
 
247
260
  # process the path parameters
261
+ if campaign_id is not None:
262
+ _path_params['campaignId'] = campaign_id
248
263
  # process the query parameters
249
264
  # process the header parameters
250
265
  # process the form parameters
@@ -260,8 +275,8 @@ class CampaignApi:
260
275
  ]
261
276
 
262
277
  return self.api_client.param_serialize(
263
- method='GET',
264
- resource_path='/Campaign/Monitor',
278
+ method='POST',
279
+ resource_path='/campaign/{campaignId}/pause',
265
280
  path_params=_path_params,
266
281
  query_params=_query_params,
267
282
  header_params=_header_params,
@@ -278,9 +293,9 @@ class CampaignApi:
278
293
 
279
294
 
280
295
  @validate_call
281
- def campaign_pause_post(
296
+ def campaign_campaign_id_resume_post(
282
297
  self,
283
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
298
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
284
299
  _request_timeout: Union[
285
300
  None,
286
301
  Annotated[StrictFloat, Field(gt=0)],
@@ -294,10 +309,10 @@ class CampaignApi:
294
309
  _headers: Optional[Dict[StrictStr, Any]] = None,
295
310
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
296
311
  ) -> None:
297
- """Pauses a campaign.
312
+ """Resumes a campaign.
298
313
 
299
314
 
300
- :param campaign_id: id of the campaign that should be paused
315
+ :param campaign_id: id of the campaign that should be paused (required)
301
316
  :type campaign_id: str
302
317
  :param _request_timeout: timeout setting for this request. If one
303
318
  number provided, it will be total request
@@ -321,7 +336,7 @@ class CampaignApi:
321
336
  :return: Returns the result object.
322
337
  """ # noqa: E501
323
338
 
324
- _param = self._campaign_pause_post_serialize(
339
+ _param = self._campaign_campaign_id_resume_post_serialize(
325
340
  campaign_id=campaign_id,
326
341
  _request_auth=_request_auth,
327
342
  _content_type=_content_type,
@@ -330,7 +345,7 @@ class CampaignApi:
330
345
  )
331
346
 
332
347
  _response_types_map: Dict[str, Optional[str]] = {
333
- '200': None,
348
+ '204': None,
334
349
  }
335
350
  response_data = self.api_client.call_api(
336
351
  *_param,
@@ -344,9 +359,9 @@ class CampaignApi:
344
359
 
345
360
 
346
361
  @validate_call
347
- def campaign_pause_post_with_http_info(
362
+ def campaign_campaign_id_resume_post_with_http_info(
348
363
  self,
349
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
364
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
350
365
  _request_timeout: Union[
351
366
  None,
352
367
  Annotated[StrictFloat, Field(gt=0)],
@@ -360,10 +375,10 @@ class CampaignApi:
360
375
  _headers: Optional[Dict[StrictStr, Any]] = None,
361
376
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
362
377
  ) -> ApiResponse[None]:
363
- """Pauses a campaign.
378
+ """Resumes a campaign.
364
379
 
365
380
 
366
- :param campaign_id: id of the campaign that should be paused
381
+ :param campaign_id: id of the campaign that should be paused (required)
367
382
  :type campaign_id: str
368
383
  :param _request_timeout: timeout setting for this request. If one
369
384
  number provided, it will be total request
@@ -387,7 +402,7 @@ class CampaignApi:
387
402
  :return: Returns the result object.
388
403
  """ # noqa: E501
389
404
 
390
- _param = self._campaign_pause_post_serialize(
405
+ _param = self._campaign_campaign_id_resume_post_serialize(
391
406
  campaign_id=campaign_id,
392
407
  _request_auth=_request_auth,
393
408
  _content_type=_content_type,
@@ -396,7 +411,7 @@ class CampaignApi:
396
411
  )
397
412
 
398
413
  _response_types_map: Dict[str, Optional[str]] = {
399
- '200': None,
414
+ '204': None,
400
415
  }
401
416
  response_data = self.api_client.call_api(
402
417
  *_param,
@@ -410,9 +425,9 @@ class CampaignApi:
410
425
 
411
426
 
412
427
  @validate_call
413
- def campaign_pause_post_without_preload_content(
428
+ def campaign_campaign_id_resume_post_without_preload_content(
414
429
  self,
415
- campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
430
+ campaign_id: Annotated[StrictStr, Field(description="id of the campaign that should be paused")],
416
431
  _request_timeout: Union[
417
432
  None,
418
433
  Annotated[StrictFloat, Field(gt=0)],
@@ -426,10 +441,10 @@ class CampaignApi:
426
441
  _headers: Optional[Dict[StrictStr, Any]] = None,
427
442
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
428
443
  ) -> RESTResponseType:
429
- """Pauses a campaign.
444
+ """Resumes a campaign.
430
445
 
431
446
 
432
- :param campaign_id: id of the campaign that should be paused
447
+ :param campaign_id: id of the campaign that should be paused (required)
433
448
  :type campaign_id: str
434
449
  :param _request_timeout: timeout setting for this request. If one
435
450
  number provided, it will be total request
@@ -453,7 +468,7 @@ class CampaignApi:
453
468
  :return: Returns the result object.
454
469
  """ # noqa: E501
455
470
 
456
- _param = self._campaign_pause_post_serialize(
471
+ _param = self._campaign_campaign_id_resume_post_serialize(
457
472
  campaign_id=campaign_id,
458
473
  _request_auth=_request_auth,
459
474
  _content_type=_content_type,
@@ -462,7 +477,7 @@ class CampaignApi:
462
477
  )
463
478
 
464
479
  _response_types_map: Dict[str, Optional[str]] = {
465
- '200': None,
480
+ '204': None,
466
481
  }
467
482
  response_data = self.api_client.call_api(
468
483
  *_param,
@@ -471,7 +486,7 @@ class CampaignApi:
471
486
  return response_data.response
472
487
 
473
488
 
474
- def _campaign_pause_post_serialize(
489
+ def _campaign_campaign_id_resume_post_serialize(
475
490
  self,
476
491
  campaign_id,
477
492
  _request_auth,
@@ -495,11 +510,9 @@ class CampaignApi:
495
510
  _body_params: Optional[bytes] = None
496
511
 
497
512
  # process the path parameters
498
- # process the query parameters
499
513
  if campaign_id is not None:
500
-
501
- _query_params.append(('campaignId', campaign_id))
502
-
514
+ _path_params['campaignId'] = campaign_id
515
+ # process the query parameters
503
516
  # process the header parameters
504
517
  # process the form parameters
505
518
  # process the body parameter
@@ -515,7 +528,7 @@ class CampaignApi:
515
528
 
516
529
  return self.api_client.param_serialize(
517
530
  method='POST',
518
- resource_path='/Campaign/Pause',
531
+ resource_path='/campaign/{campaignId}/resume',
519
532
  path_params=_path_params,
520
533
  query_params=_query_params,
521
534
  header_params=_header_params,
@@ -532,9 +545,8 @@ class CampaignApi:
532
545
 
533
546
 
534
547
  @validate_call
535
- def campaign_query_get(
548
+ def campaign_monitor_get(
536
549
  self,
537
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
538
550
  _request_timeout: Union[
539
551
  None,
540
552
  Annotated[StrictFloat, Field(gt=0)],
@@ -547,12 +559,10 @@ class CampaignApi:
547
559
  _content_type: Optional[StrictStr] = None,
548
560
  _headers: Optional[Dict[StrictStr, Any]] = None,
549
561
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
550
- ) -> CampaignQueryResultPagedResult:
551
- """Queries orders based on a filter, page, and sort criteria.
562
+ ) -> None:
563
+ """The monitor endpoint is used to monitor the health of the service
552
564
 
553
565
 
554
- :param request: The parameters for filtering, paging, and sorting
555
- :type request: QueryModel
556
566
  :param _request_timeout: timeout setting for this request. If one
557
567
  number provided, it will be total request
558
568
  timeout. It can also be a pair (tuple) of
@@ -575,8 +585,7 @@ class CampaignApi:
575
585
  :return: Returns the result object.
576
586
  """ # noqa: E501
577
587
 
578
- _param = self._campaign_query_get_serialize(
579
- request=request,
588
+ _param = self._campaign_monitor_get_serialize(
580
589
  _request_auth=_request_auth,
581
590
  _content_type=_content_type,
582
591
  _headers=_headers,
@@ -584,7 +593,7 @@ class CampaignApi:
584
593
  )
585
594
 
586
595
  _response_types_map: Dict[str, Optional[str]] = {
587
- '200': "CampaignQueryResultPagedResult",
596
+ '200': None,
588
597
  }
589
598
  response_data = self.api_client.call_api(
590
599
  *_param,
@@ -598,9 +607,8 @@ class CampaignApi:
598
607
 
599
608
 
600
609
  @validate_call
601
- def campaign_query_get_with_http_info(
610
+ def campaign_monitor_get_with_http_info(
602
611
  self,
603
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
604
612
  _request_timeout: Union[
605
613
  None,
606
614
  Annotated[StrictFloat, Field(gt=0)],
@@ -613,12 +621,10 @@ class CampaignApi:
613
621
  _content_type: Optional[StrictStr] = None,
614
622
  _headers: Optional[Dict[StrictStr, Any]] = None,
615
623
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
616
- ) -> ApiResponse[CampaignQueryResultPagedResult]:
617
- """Queries orders based on a filter, page, and sort criteria.
624
+ ) -> ApiResponse[None]:
625
+ """The monitor endpoint is used to monitor the health of the service
618
626
 
619
627
 
620
- :param request: The parameters for filtering, paging, and sorting
621
- :type request: QueryModel
622
628
  :param _request_timeout: timeout setting for this request. If one
623
629
  number provided, it will be total request
624
630
  timeout. It can also be a pair (tuple) of
@@ -641,8 +647,7 @@ class CampaignApi:
641
647
  :return: Returns the result object.
642
648
  """ # noqa: E501
643
649
 
644
- _param = self._campaign_query_get_serialize(
645
- request=request,
650
+ _param = self._campaign_monitor_get_serialize(
646
651
  _request_auth=_request_auth,
647
652
  _content_type=_content_type,
648
653
  _headers=_headers,
@@ -650,7 +655,7 @@ class CampaignApi:
650
655
  )
651
656
 
652
657
  _response_types_map: Dict[str, Optional[str]] = {
653
- '200': "CampaignQueryResultPagedResult",
658
+ '200': None,
654
659
  }
655
660
  response_data = self.api_client.call_api(
656
661
  *_param,
@@ -664,9 +669,8 @@ class CampaignApi:
664
669
 
665
670
 
666
671
  @validate_call
667
- def campaign_query_get_without_preload_content(
672
+ def campaign_monitor_get_without_preload_content(
668
673
  self,
669
- request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
670
674
  _request_timeout: Union[
671
675
  None,
672
676
  Annotated[StrictFloat, Field(gt=0)],
@@ -680,11 +684,9 @@ class CampaignApi:
680
684
  _headers: Optional[Dict[StrictStr, Any]] = None,
681
685
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
682
686
  ) -> RESTResponseType:
683
- """Queries orders based on a filter, page, and sort criteria.
687
+ """The monitor endpoint is used to monitor the health of the service
684
688
 
685
689
 
686
- :param request: The parameters for filtering, paging, and sorting
687
- :type request: QueryModel
688
690
  :param _request_timeout: timeout setting for this request. If one
689
691
  number provided, it will be total request
690
692
  timeout. It can also be a pair (tuple) of
@@ -707,8 +709,7 @@ class CampaignApi:
707
709
  :return: Returns the result object.
708
710
  """ # noqa: E501
709
711
 
710
- _param = self._campaign_query_get_serialize(
711
- request=request,
712
+ _param = self._campaign_monitor_get_serialize(
712
713
  _request_auth=_request_auth,
713
714
  _content_type=_content_type,
714
715
  _headers=_headers,
@@ -716,7 +717,7 @@ class CampaignApi:
716
717
  )
717
718
 
718
719
  _response_types_map: Dict[str, Optional[str]] = {
719
- '200': "CampaignQueryResultPagedResult",
720
+ '200': None,
720
721
  }
721
722
  response_data = self.api_client.call_api(
722
723
  *_param,
@@ -725,9 +726,8 @@ class CampaignApi:
725
726
  return response_data.response
726
727
 
727
728
 
728
- def _campaign_query_get_serialize(
729
+ def _campaign_monitor_get_serialize(
729
730
  self,
730
- request,
731
731
  _request_auth,
732
732
  _content_type,
733
733
  _headers,
@@ -750,24 +750,11 @@ class CampaignApi:
750
750
 
751
751
  # process the path parameters
752
752
  # process the query parameters
753
- if request is not None:
754
-
755
- _query_params.append(('request', request))
756
-
757
753
  # process the header parameters
758
754
  # process the form parameters
759
755
  # process the body parameter
760
756
 
761
757
 
762
- # set the HTTP header `Accept`
763
- if 'Accept' not in _header_params:
764
- _header_params['Accept'] = self.api_client.select_header_accept(
765
- [
766
- 'text/plain',
767
- 'application/json',
768
- 'text/json'
769
- ]
770
- )
771
758
 
772
759
 
773
760
  # authentication setting
@@ -778,7 +765,7 @@ class CampaignApi:
778
765
 
779
766
  return self.api_client.param_serialize(
780
767
  method='GET',
781
- resource_path='/Campaign/Query',
768
+ resource_path='/campaign/monitor',
782
769
  path_params=_path_params,
783
770
  query_params=_query_params,
784
771
  header_params=_header_params,
@@ -795,7 +782,7 @@ class CampaignApi:
795
782
 
796
783
 
797
784
  @validate_call
798
- def campaign_resume_post(
785
+ def campaign_pause_post(
799
786
  self,
800
787
  campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
801
788
  _request_timeout: Union[
@@ -811,7 +798,7 @@ class CampaignApi:
811
798
  _headers: Optional[Dict[StrictStr, Any]] = None,
812
799
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
813
800
  ) -> None:
814
- """Resumes a campaign.
801
+ """(Deprecated) Pauses a campaign.
815
802
 
816
803
 
817
804
  :param campaign_id: id of the campaign that should be paused
@@ -837,8 +824,9 @@ class CampaignApi:
837
824
  :type _host_index: int, optional
838
825
  :return: Returns the result object.
839
826
  """ # noqa: E501
827
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
840
828
 
841
- _param = self._campaign_resume_post_serialize(
829
+ _param = self._campaign_pause_post_serialize(
842
830
  campaign_id=campaign_id,
843
831
  _request_auth=_request_auth,
844
832
  _content_type=_content_type,
@@ -861,7 +849,7 @@ class CampaignApi:
861
849
 
862
850
 
863
851
  @validate_call
864
- def campaign_resume_post_with_http_info(
852
+ def campaign_pause_post_with_http_info(
865
853
  self,
866
854
  campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
867
855
  _request_timeout: Union[
@@ -877,7 +865,7 @@ class CampaignApi:
877
865
  _headers: Optional[Dict[StrictStr, Any]] = None,
878
866
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
879
867
  ) -> ApiResponse[None]:
880
- """Resumes a campaign.
868
+ """(Deprecated) Pauses a campaign.
881
869
 
882
870
 
883
871
  :param campaign_id: id of the campaign that should be paused
@@ -903,8 +891,9 @@ class CampaignApi:
903
891
  :type _host_index: int, optional
904
892
  :return: Returns the result object.
905
893
  """ # noqa: E501
894
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
906
895
 
907
- _param = self._campaign_resume_post_serialize(
896
+ _param = self._campaign_pause_post_serialize(
908
897
  campaign_id=campaign_id,
909
898
  _request_auth=_request_auth,
910
899
  _content_type=_content_type,
@@ -927,7 +916,7 @@ class CampaignApi:
927
916
 
928
917
 
929
918
  @validate_call
930
- def campaign_resume_post_without_preload_content(
919
+ def campaign_pause_post_without_preload_content(
931
920
  self,
932
921
  campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
933
922
  _request_timeout: Union[
@@ -943,7 +932,7 @@ class CampaignApi:
943
932
  _headers: Optional[Dict[StrictStr, Any]] = None,
944
933
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
945
934
  ) -> RESTResponseType:
946
- """Resumes a campaign.
935
+ """(Deprecated) Pauses a campaign.
947
936
 
948
937
 
949
938
  :param campaign_id: id of the campaign that should be paused
@@ -969,8 +958,9 @@ class CampaignApi:
969
958
  :type _host_index: int, optional
970
959
  :return: Returns the result object.
971
960
  """ # noqa: E501
961
+ warnings.warn("POST /campaign/pause is deprecated.", DeprecationWarning)
972
962
 
973
- _param = self._campaign_resume_post_serialize(
963
+ _param = self._campaign_pause_post_serialize(
974
964
  campaign_id=campaign_id,
975
965
  _request_auth=_request_auth,
976
966
  _content_type=_content_type,
@@ -988,7 +978,7 @@ class CampaignApi:
988
978
  return response_data.response
989
979
 
990
980
 
991
- def _campaign_resume_post_serialize(
981
+ def _campaign_pause_post_serialize(
992
982
  self,
993
983
  campaign_id,
994
984
  _request_auth,
@@ -1032,7 +1022,793 @@ class CampaignApi:
1032
1022
 
1033
1023
  return self.api_client.param_serialize(
1034
1024
  method='POST',
1035
- resource_path='/Campaign/Resume',
1025
+ resource_path='/campaign/pause',
1026
+ path_params=_path_params,
1027
+ query_params=_query_params,
1028
+ header_params=_header_params,
1029
+ body=_body_params,
1030
+ post_params=_form_params,
1031
+ files=_files,
1032
+ auth_settings=_auth_settings,
1033
+ collection_formats=_collection_formats,
1034
+ _host=_host,
1035
+ _request_auth=_request_auth
1036
+ )
1037
+
1038
+
1039
+
1040
+
1041
+ @validate_call
1042
+ def campaign_query_get(
1043
+ self,
1044
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1045
+ _request_timeout: Union[
1046
+ None,
1047
+ Annotated[StrictFloat, Field(gt=0)],
1048
+ Tuple[
1049
+ Annotated[StrictFloat, Field(gt=0)],
1050
+ Annotated[StrictFloat, Field(gt=0)]
1051
+ ]
1052
+ ] = None,
1053
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1054
+ _content_type: Optional[StrictStr] = None,
1055
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1056
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1057
+ ) -> CampaignQueryResultPagedResult:
1058
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1059
+
1060
+
1061
+ :param request: The parameters for filtering, paging, and sorting
1062
+ :type request: QueryModel
1063
+ :param _request_timeout: timeout setting for this request. If one
1064
+ number provided, it will be total request
1065
+ timeout. It can also be a pair (tuple) of
1066
+ (connection, read) timeouts.
1067
+ :type _request_timeout: int, tuple(int, int), optional
1068
+ :param _request_auth: set to override the auth_settings for an a single
1069
+ request; this effectively ignores the
1070
+ authentication in the spec for a single request.
1071
+ :type _request_auth: dict, optional
1072
+ :param _content_type: force content-type for the request.
1073
+ :type _content_type: str, Optional
1074
+ :param _headers: set to override the headers for a single
1075
+ request; this effectively ignores the headers
1076
+ in the spec for a single request.
1077
+ :type _headers: dict, optional
1078
+ :param _host_index: set to override the host_index for a single
1079
+ request; this effectively ignores the host_index
1080
+ in the spec for a single request.
1081
+ :type _host_index: int, optional
1082
+ :return: Returns the result object.
1083
+ """ # noqa: E501
1084
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1085
+
1086
+ _param = self._campaign_query_get_serialize(
1087
+ request=request,
1088
+ _request_auth=_request_auth,
1089
+ _content_type=_content_type,
1090
+ _headers=_headers,
1091
+ _host_index=_host_index
1092
+ )
1093
+
1094
+ _response_types_map: Dict[str, Optional[str]] = {
1095
+ '200': "CampaignQueryResultPagedResult",
1096
+ }
1097
+ response_data = self.api_client.call_api(
1098
+ *_param,
1099
+ _request_timeout=_request_timeout
1100
+ )
1101
+ response_data.read()
1102
+ return self.api_client.response_deserialize(
1103
+ response_data=response_data,
1104
+ response_types_map=_response_types_map,
1105
+ ).data
1106
+
1107
+
1108
+ @validate_call
1109
+ def campaign_query_get_with_http_info(
1110
+ self,
1111
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1112
+ _request_timeout: Union[
1113
+ None,
1114
+ Annotated[StrictFloat, Field(gt=0)],
1115
+ Tuple[
1116
+ Annotated[StrictFloat, Field(gt=0)],
1117
+ Annotated[StrictFloat, Field(gt=0)]
1118
+ ]
1119
+ ] = None,
1120
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1121
+ _content_type: Optional[StrictStr] = None,
1122
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1123
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1124
+ ) -> ApiResponse[CampaignQueryResultPagedResult]:
1125
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1126
+
1127
+
1128
+ :param request: The parameters for filtering, paging, and sorting
1129
+ :type request: QueryModel
1130
+ :param _request_timeout: timeout setting for this request. If one
1131
+ number provided, it will be total request
1132
+ timeout. It can also be a pair (tuple) of
1133
+ (connection, read) timeouts.
1134
+ :type _request_timeout: int, tuple(int, int), optional
1135
+ :param _request_auth: set to override the auth_settings for an a single
1136
+ request; this effectively ignores the
1137
+ authentication in the spec for a single request.
1138
+ :type _request_auth: dict, optional
1139
+ :param _content_type: force content-type for the request.
1140
+ :type _content_type: str, Optional
1141
+ :param _headers: set to override the headers for a single
1142
+ request; this effectively ignores the headers
1143
+ in the spec for a single request.
1144
+ :type _headers: dict, optional
1145
+ :param _host_index: set to override the host_index for a single
1146
+ request; this effectively ignores the host_index
1147
+ in the spec for a single request.
1148
+ :type _host_index: int, optional
1149
+ :return: Returns the result object.
1150
+ """ # noqa: E501
1151
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1152
+
1153
+ _param = self._campaign_query_get_serialize(
1154
+ request=request,
1155
+ _request_auth=_request_auth,
1156
+ _content_type=_content_type,
1157
+ _headers=_headers,
1158
+ _host_index=_host_index
1159
+ )
1160
+
1161
+ _response_types_map: Dict[str, Optional[str]] = {
1162
+ '200': "CampaignQueryResultPagedResult",
1163
+ }
1164
+ response_data = self.api_client.call_api(
1165
+ *_param,
1166
+ _request_timeout=_request_timeout
1167
+ )
1168
+ response_data.read()
1169
+ return self.api_client.response_deserialize(
1170
+ response_data=response_data,
1171
+ response_types_map=_response_types_map,
1172
+ )
1173
+
1174
+
1175
+ @validate_call
1176
+ def campaign_query_get_without_preload_content(
1177
+ self,
1178
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1179
+ _request_timeout: Union[
1180
+ None,
1181
+ Annotated[StrictFloat, Field(gt=0)],
1182
+ Tuple[
1183
+ Annotated[StrictFloat, Field(gt=0)],
1184
+ Annotated[StrictFloat, Field(gt=0)]
1185
+ ]
1186
+ ] = None,
1187
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1188
+ _content_type: Optional[StrictStr] = None,
1189
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1190
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1191
+ ) -> RESTResponseType:
1192
+ """(Deprecated) Queries orders based on a filter, page, and sort criteria.
1193
+
1194
+
1195
+ :param request: The parameters for filtering, paging, and sorting
1196
+ :type request: QueryModel
1197
+ :param _request_timeout: timeout setting for this request. If one
1198
+ number provided, it will be total request
1199
+ timeout. It can also be a pair (tuple) of
1200
+ (connection, read) timeouts.
1201
+ :type _request_timeout: int, tuple(int, int), optional
1202
+ :param _request_auth: set to override the auth_settings for an a single
1203
+ request; this effectively ignores the
1204
+ authentication in the spec for a single request.
1205
+ :type _request_auth: dict, optional
1206
+ :param _content_type: force content-type for the request.
1207
+ :type _content_type: str, Optional
1208
+ :param _headers: set to override the headers for a single
1209
+ request; this effectively ignores the headers
1210
+ in the spec for a single request.
1211
+ :type _headers: dict, optional
1212
+ :param _host_index: set to override the host_index for a single
1213
+ request; this effectively ignores the host_index
1214
+ in the spec for a single request.
1215
+ :type _host_index: int, optional
1216
+ :return: Returns the result object.
1217
+ """ # noqa: E501
1218
+ warnings.warn("GET /campaign/query is deprecated.", DeprecationWarning)
1219
+
1220
+ _param = self._campaign_query_get_serialize(
1221
+ request=request,
1222
+ _request_auth=_request_auth,
1223
+ _content_type=_content_type,
1224
+ _headers=_headers,
1225
+ _host_index=_host_index
1226
+ )
1227
+
1228
+ _response_types_map: Dict[str, Optional[str]] = {
1229
+ '200': "CampaignQueryResultPagedResult",
1230
+ }
1231
+ response_data = self.api_client.call_api(
1232
+ *_param,
1233
+ _request_timeout=_request_timeout
1234
+ )
1235
+ return response_data.response
1236
+
1237
+
1238
+ def _campaign_query_get_serialize(
1239
+ self,
1240
+ request,
1241
+ _request_auth,
1242
+ _content_type,
1243
+ _headers,
1244
+ _host_index,
1245
+ ) -> RequestSerialized:
1246
+
1247
+ _host = None
1248
+
1249
+ _collection_formats: Dict[str, str] = {
1250
+ }
1251
+
1252
+ _path_params: Dict[str, str] = {}
1253
+ _query_params: List[Tuple[str, str]] = []
1254
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1255
+ _form_params: List[Tuple[str, str]] = []
1256
+ _files: Dict[
1257
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1258
+ ] = {}
1259
+ _body_params: Optional[bytes] = None
1260
+
1261
+ # process the path parameters
1262
+ # process the query parameters
1263
+ if request is not None:
1264
+
1265
+ _query_params.append(('request', request))
1266
+
1267
+ # process the header parameters
1268
+ # process the form parameters
1269
+ # process the body parameter
1270
+
1271
+
1272
+ # set the HTTP header `Accept`
1273
+ if 'Accept' not in _header_params:
1274
+ _header_params['Accept'] = self.api_client.select_header_accept(
1275
+ [
1276
+ 'text/plain',
1277
+ 'application/json',
1278
+ 'text/json'
1279
+ ]
1280
+ )
1281
+
1282
+
1283
+ # authentication setting
1284
+ _auth_settings: List[str] = [
1285
+ 'bearer',
1286
+ 'oauth2'
1287
+ ]
1288
+
1289
+ return self.api_client.param_serialize(
1290
+ method='GET',
1291
+ resource_path='/campaign/query',
1292
+ path_params=_path_params,
1293
+ query_params=_query_params,
1294
+ header_params=_header_params,
1295
+ body=_body_params,
1296
+ post_params=_form_params,
1297
+ files=_files,
1298
+ auth_settings=_auth_settings,
1299
+ collection_formats=_collection_formats,
1300
+ _host=_host,
1301
+ _request_auth=_request_auth
1302
+ )
1303
+
1304
+
1305
+
1306
+
1307
+ @validate_call
1308
+ def campaign_resume_post(
1309
+ self,
1310
+ campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1311
+ _request_timeout: Union[
1312
+ None,
1313
+ Annotated[StrictFloat, Field(gt=0)],
1314
+ Tuple[
1315
+ Annotated[StrictFloat, Field(gt=0)],
1316
+ Annotated[StrictFloat, Field(gt=0)]
1317
+ ]
1318
+ ] = None,
1319
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1320
+ _content_type: Optional[StrictStr] = None,
1321
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1322
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1323
+ ) -> None:
1324
+ """(Deprecated) Resumes a campaign.
1325
+
1326
+
1327
+ :param campaign_id: id of the campaign that should be paused
1328
+ :type campaign_id: str
1329
+ :param _request_timeout: timeout setting for this request. If one
1330
+ number provided, it will be total request
1331
+ timeout. It can also be a pair (tuple) of
1332
+ (connection, read) timeouts.
1333
+ :type _request_timeout: int, tuple(int, int), optional
1334
+ :param _request_auth: set to override the auth_settings for an a single
1335
+ request; this effectively ignores the
1336
+ authentication in the spec for a single request.
1337
+ :type _request_auth: dict, optional
1338
+ :param _content_type: force content-type for the request.
1339
+ :type _content_type: str, Optional
1340
+ :param _headers: set to override the headers for a single
1341
+ request; this effectively ignores the headers
1342
+ in the spec for a single request.
1343
+ :type _headers: dict, optional
1344
+ :param _host_index: set to override the host_index for a single
1345
+ request; this effectively ignores the host_index
1346
+ in the spec for a single request.
1347
+ :type _host_index: int, optional
1348
+ :return: Returns the result object.
1349
+ """ # noqa: E501
1350
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1351
+
1352
+ _param = self._campaign_resume_post_serialize(
1353
+ campaign_id=campaign_id,
1354
+ _request_auth=_request_auth,
1355
+ _content_type=_content_type,
1356
+ _headers=_headers,
1357
+ _host_index=_host_index
1358
+ )
1359
+
1360
+ _response_types_map: Dict[str, Optional[str]] = {
1361
+ '200': None,
1362
+ }
1363
+ response_data = self.api_client.call_api(
1364
+ *_param,
1365
+ _request_timeout=_request_timeout
1366
+ )
1367
+ response_data.read()
1368
+ return self.api_client.response_deserialize(
1369
+ response_data=response_data,
1370
+ response_types_map=_response_types_map,
1371
+ ).data
1372
+
1373
+
1374
+ @validate_call
1375
+ def campaign_resume_post_with_http_info(
1376
+ self,
1377
+ campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1378
+ _request_timeout: Union[
1379
+ None,
1380
+ Annotated[StrictFloat, Field(gt=0)],
1381
+ Tuple[
1382
+ Annotated[StrictFloat, Field(gt=0)],
1383
+ Annotated[StrictFloat, Field(gt=0)]
1384
+ ]
1385
+ ] = None,
1386
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1387
+ _content_type: Optional[StrictStr] = None,
1388
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1389
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1390
+ ) -> ApiResponse[None]:
1391
+ """(Deprecated) Resumes a campaign.
1392
+
1393
+
1394
+ :param campaign_id: id of the campaign that should be paused
1395
+ :type campaign_id: str
1396
+ :param _request_timeout: timeout setting for this request. If one
1397
+ number provided, it will be total request
1398
+ timeout. It can also be a pair (tuple) of
1399
+ (connection, read) timeouts.
1400
+ :type _request_timeout: int, tuple(int, int), optional
1401
+ :param _request_auth: set to override the auth_settings for an a single
1402
+ request; this effectively ignores the
1403
+ authentication in the spec for a single request.
1404
+ :type _request_auth: dict, optional
1405
+ :param _content_type: force content-type for the request.
1406
+ :type _content_type: str, Optional
1407
+ :param _headers: set to override the headers for a single
1408
+ request; this effectively ignores the headers
1409
+ in the spec for a single request.
1410
+ :type _headers: dict, optional
1411
+ :param _host_index: set to override the host_index for a single
1412
+ request; this effectively ignores the host_index
1413
+ in the spec for a single request.
1414
+ :type _host_index: int, optional
1415
+ :return: Returns the result object.
1416
+ """ # noqa: E501
1417
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1418
+
1419
+ _param = self._campaign_resume_post_serialize(
1420
+ campaign_id=campaign_id,
1421
+ _request_auth=_request_auth,
1422
+ _content_type=_content_type,
1423
+ _headers=_headers,
1424
+ _host_index=_host_index
1425
+ )
1426
+
1427
+ _response_types_map: Dict[str, Optional[str]] = {
1428
+ '200': None,
1429
+ }
1430
+ response_data = self.api_client.call_api(
1431
+ *_param,
1432
+ _request_timeout=_request_timeout
1433
+ )
1434
+ response_data.read()
1435
+ return self.api_client.response_deserialize(
1436
+ response_data=response_data,
1437
+ response_types_map=_response_types_map,
1438
+ )
1439
+
1440
+
1441
+ @validate_call
1442
+ def campaign_resume_post_without_preload_content(
1443
+ self,
1444
+ campaign_id: Annotated[Optional[StrictStr], Field(description="id of the campaign that should be paused")] = None,
1445
+ _request_timeout: Union[
1446
+ None,
1447
+ Annotated[StrictFloat, Field(gt=0)],
1448
+ Tuple[
1449
+ Annotated[StrictFloat, Field(gt=0)],
1450
+ Annotated[StrictFloat, Field(gt=0)]
1451
+ ]
1452
+ ] = None,
1453
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1454
+ _content_type: Optional[StrictStr] = None,
1455
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1456
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1457
+ ) -> RESTResponseType:
1458
+ """(Deprecated) Resumes a campaign.
1459
+
1460
+
1461
+ :param campaign_id: id of the campaign that should be paused
1462
+ :type campaign_id: str
1463
+ :param _request_timeout: timeout setting for this request. If one
1464
+ number provided, it will be total request
1465
+ timeout. It can also be a pair (tuple) of
1466
+ (connection, read) timeouts.
1467
+ :type _request_timeout: int, tuple(int, int), optional
1468
+ :param _request_auth: set to override the auth_settings for an a single
1469
+ request; this effectively ignores the
1470
+ authentication in the spec for a single request.
1471
+ :type _request_auth: dict, optional
1472
+ :param _content_type: force content-type for the request.
1473
+ :type _content_type: str, Optional
1474
+ :param _headers: set to override the headers for a single
1475
+ request; this effectively ignores the headers
1476
+ in the spec for a single request.
1477
+ :type _headers: dict, optional
1478
+ :param _host_index: set to override the host_index for a single
1479
+ request; this effectively ignores the host_index
1480
+ in the spec for a single request.
1481
+ :type _host_index: int, optional
1482
+ :return: Returns the result object.
1483
+ """ # noqa: E501
1484
+ warnings.warn("POST /campaign/resume is deprecated.", DeprecationWarning)
1485
+
1486
+ _param = self._campaign_resume_post_serialize(
1487
+ campaign_id=campaign_id,
1488
+ _request_auth=_request_auth,
1489
+ _content_type=_content_type,
1490
+ _headers=_headers,
1491
+ _host_index=_host_index
1492
+ )
1493
+
1494
+ _response_types_map: Dict[str, Optional[str]] = {
1495
+ '200': None,
1496
+ }
1497
+ response_data = self.api_client.call_api(
1498
+ *_param,
1499
+ _request_timeout=_request_timeout
1500
+ )
1501
+ return response_data.response
1502
+
1503
+
1504
+ def _campaign_resume_post_serialize(
1505
+ self,
1506
+ campaign_id,
1507
+ _request_auth,
1508
+ _content_type,
1509
+ _headers,
1510
+ _host_index,
1511
+ ) -> RequestSerialized:
1512
+
1513
+ _host = None
1514
+
1515
+ _collection_formats: Dict[str, str] = {
1516
+ }
1517
+
1518
+ _path_params: Dict[str, str] = {}
1519
+ _query_params: List[Tuple[str, str]] = []
1520
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1521
+ _form_params: List[Tuple[str, str]] = []
1522
+ _files: Dict[
1523
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1524
+ ] = {}
1525
+ _body_params: Optional[bytes] = None
1526
+
1527
+ # process the path parameters
1528
+ # process the query parameters
1529
+ if campaign_id is not None:
1530
+
1531
+ _query_params.append(('campaignId', campaign_id))
1532
+
1533
+ # process the header parameters
1534
+ # process the form parameters
1535
+ # process the body parameter
1536
+
1537
+
1538
+
1539
+
1540
+ # authentication setting
1541
+ _auth_settings: List[str] = [
1542
+ 'bearer',
1543
+ 'oauth2'
1544
+ ]
1545
+
1546
+ return self.api_client.param_serialize(
1547
+ method='POST',
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',
1036
1812
  path_params=_path_params,
1037
1813
  query_params=_query_params,
1038
1814
  header_params=_header_params,