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
@@ -22,7 +22,7 @@ from typing_extensions import Annotated
22
22
  from rapidata.api_client.models.add_campaign_artifact_result import AddCampaignArtifactResult
23
23
  from rapidata.api_client.models.add_campaign_model import AddCampaignModel
24
24
  from rapidata.api_client.models.get_pipeline_by_id_result import GetPipelineByIdResult
25
- from rapidata.api_client.models.pipeline_id_workflow_put_request import PipelineIdWorkflowPutRequest
25
+ from rapidata.api_client.models.pipeline_id_workflow_artifact_id_put_request import PipelineIdWorkflowArtifactIdPutRequest
26
26
  from rapidata.api_client.models.preliminary_download_model import PreliminaryDownloadModel
27
27
  from rapidata.api_client.models.preliminary_download_result import PreliminaryDownloadResult
28
28
  from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
@@ -46,11 +46,11 @@ class PipelineApi:
46
46
 
47
47
 
48
48
  @validate_call
49
- def pipeline_id_campaign_artifact_id_put(
49
+ def pipeline_id_workflow_artifact_id_put(
50
50
  self,
51
51
  id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
52
- artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
53
- update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
52
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
53
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
54
54
  _request_timeout: Union[
55
55
  None,
56
56
  Annotated[StrictFloat, Field(gt=0)],
@@ -64,15 +64,16 @@ class PipelineApi:
64
64
  _headers: Optional[Dict[StrictStr, Any]] = None,
65
65
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
66
  ) -> None:
67
- """Updates a specific campaign for a pipeline.
67
+ """(Deprecated) Updates the workflow configuration for a pipeline.
68
68
 
69
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
69
70
 
70
71
  :param id: The id of the pipeline to update. (required)
71
72
  :type id: str
72
- :param artifact_id: The id of the campaign artifact to update. (required)
73
+ :param artifact_id: The id of the workflow config artifact to update. (required)
73
74
  :type artifact_id: str
74
- :param update_campaign_model: The new campaign settings.
75
- :type update_campaign_model: UpdateCampaignModel
75
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
76
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
76
77
  :param _request_timeout: timeout setting for this request. If one
77
78
  number provided, it will be total request
78
79
  timeout. It can also be a pair (tuple) of
@@ -94,11 +95,12 @@ class PipelineApi:
94
95
  :type _host_index: int, optional
95
96
  :return: Returns the result object.
96
97
  """ # noqa: E501
98
+ warnings.warn("PUT /pipeline/{id}/workflow/{artifactId} is deprecated.", DeprecationWarning)
97
99
 
98
- _param = self._pipeline_id_campaign_artifact_id_put_serialize(
100
+ _param = self._pipeline_id_workflow_artifact_id_put_serialize(
99
101
  id=id,
100
102
  artifact_id=artifact_id,
101
- update_campaign_model=update_campaign_model,
103
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
102
104
  _request_auth=_request_auth,
103
105
  _content_type=_content_type,
104
106
  _headers=_headers,
@@ -120,11 +122,11 @@ class PipelineApi:
120
122
 
121
123
 
122
124
  @validate_call
123
- def pipeline_id_campaign_artifact_id_put_with_http_info(
125
+ def pipeline_id_workflow_artifact_id_put_with_http_info(
124
126
  self,
125
127
  id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
126
- artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
127
- update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
128
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
129
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
128
130
  _request_timeout: Union[
129
131
  None,
130
132
  Annotated[StrictFloat, Field(gt=0)],
@@ -138,15 +140,16 @@ class PipelineApi:
138
140
  _headers: Optional[Dict[StrictStr, Any]] = None,
139
141
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
140
142
  ) -> ApiResponse[None]:
141
- """Updates a specific campaign for a pipeline.
143
+ """(Deprecated) Updates the workflow configuration for a pipeline.
142
144
 
145
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
143
146
 
144
147
  :param id: The id of the pipeline to update. (required)
145
148
  :type id: str
146
- :param artifact_id: The id of the campaign artifact to update. (required)
149
+ :param artifact_id: The id of the workflow config artifact to update. (required)
147
150
  :type artifact_id: str
148
- :param update_campaign_model: The new campaign settings.
149
- :type update_campaign_model: UpdateCampaignModel
151
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
152
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
150
153
  :param _request_timeout: timeout setting for this request. If one
151
154
  number provided, it will be total request
152
155
  timeout. It can also be a pair (tuple) of
@@ -168,11 +171,12 @@ class PipelineApi:
168
171
  :type _host_index: int, optional
169
172
  :return: Returns the result object.
170
173
  """ # noqa: E501
174
+ warnings.warn("PUT /pipeline/{id}/workflow/{artifactId} is deprecated.", DeprecationWarning)
171
175
 
172
- _param = self._pipeline_id_campaign_artifact_id_put_serialize(
176
+ _param = self._pipeline_id_workflow_artifact_id_put_serialize(
173
177
  id=id,
174
178
  artifact_id=artifact_id,
175
- update_campaign_model=update_campaign_model,
179
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
176
180
  _request_auth=_request_auth,
177
181
  _content_type=_content_type,
178
182
  _headers=_headers,
@@ -194,11 +198,11 @@ class PipelineApi:
194
198
 
195
199
 
196
200
  @validate_call
197
- def pipeline_id_campaign_artifact_id_put_without_preload_content(
201
+ def pipeline_id_workflow_artifact_id_put_without_preload_content(
198
202
  self,
199
203
  id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
200
- artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
201
- update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
204
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
205
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
202
206
  _request_timeout: Union[
203
207
  None,
204
208
  Annotated[StrictFloat, Field(gt=0)],
@@ -212,15 +216,16 @@ class PipelineApi:
212
216
  _headers: Optional[Dict[StrictStr, Any]] = None,
213
217
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
214
218
  ) -> RESTResponseType:
215
- """Updates a specific campaign for a pipeline.
219
+ """(Deprecated) Updates the workflow configuration for a pipeline.
216
220
 
221
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
217
222
 
218
223
  :param id: The id of the pipeline to update. (required)
219
224
  :type id: str
220
- :param artifact_id: The id of the campaign artifact to update. (required)
225
+ :param artifact_id: The id of the workflow config artifact to update. (required)
221
226
  :type artifact_id: str
222
- :param update_campaign_model: The new campaign settings.
223
- :type update_campaign_model: UpdateCampaignModel
227
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
228
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
224
229
  :param _request_timeout: timeout setting for this request. If one
225
230
  number provided, it will be total request
226
231
  timeout. It can also be a pair (tuple) of
@@ -242,11 +247,12 @@ class PipelineApi:
242
247
  :type _host_index: int, optional
243
248
  :return: Returns the result object.
244
249
  """ # noqa: E501
250
+ warnings.warn("PUT /pipeline/{id}/workflow/{artifactId} is deprecated.", DeprecationWarning)
245
251
 
246
- _param = self._pipeline_id_campaign_artifact_id_put_serialize(
252
+ _param = self._pipeline_id_workflow_artifact_id_put_serialize(
247
253
  id=id,
248
254
  artifact_id=artifact_id,
249
- update_campaign_model=update_campaign_model,
255
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
250
256
  _request_auth=_request_auth,
251
257
  _content_type=_content_type,
252
258
  _headers=_headers,
@@ -263,11 +269,11 @@ class PipelineApi:
263
269
  return response_data.response
264
270
 
265
271
 
266
- def _pipeline_id_campaign_artifact_id_put_serialize(
272
+ def _pipeline_id_workflow_artifact_id_put_serialize(
267
273
  self,
268
274
  id,
269
275
  artifact_id,
270
- update_campaign_model,
276
+ pipeline_id_workflow_artifact_id_put_request,
271
277
  _request_auth,
272
278
  _content_type,
273
279
  _headers,
@@ -292,13 +298,13 @@ class PipelineApi:
292
298
  if id is not None:
293
299
  _path_params['id'] = id
294
300
  if artifact_id is not None:
295
- _path_params['artifact-id'] = artifact_id
301
+ _path_params['artifactId'] = artifact_id
296
302
  # process the query parameters
297
303
  # process the header parameters
298
304
  # process the form parameters
299
305
  # process the body parameter
300
- if update_campaign_model is not None:
301
- _body_params = update_campaign_model
306
+ if pipeline_id_workflow_artifact_id_put_request is not None:
307
+ _body_params = pipeline_id_workflow_artifact_id_put_request
302
308
 
303
309
 
304
310
 
@@ -326,7 +332,7 @@ class PipelineApi:
326
332
 
327
333
  return self.api_client.param_serialize(
328
334
  method='PUT',
329
- resource_path='/pipeline/{id}/campaign/{artifact-id}',
335
+ resource_path='/pipeline/{id}/workflow/{artifactId}',
330
336
  path_params=_path_params,
331
337
  query_params=_query_params,
332
338
  header_params=_header_params,
@@ -343,10 +349,11 @@ class PipelineApi:
343
349
 
344
350
 
345
351
  @validate_call
346
- def pipeline_id_campaign_post(
352
+ def pipeline_id_workflow_config_artifact_id_put(
347
353
  self,
348
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
349
- add_campaign_model: Optional[AddCampaignModel] = None,
354
+ id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
355
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
356
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
350
357
  _request_timeout: Union[
351
358
  None,
352
359
  Annotated[StrictFloat, Field(gt=0)],
@@ -359,14 +366,17 @@ class PipelineApi:
359
366
  _content_type: Optional[StrictStr] = None,
360
367
  _headers: Optional[Dict[StrictStr, Any]] = None,
361
368
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
362
- ) -> AddCampaignArtifactResult:
363
- """Adds a campaign to a pipeline.
369
+ ) -> None:
370
+ """Updates the workflow configuration for a pipeline.
364
371
 
372
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
365
373
 
366
- :param id: The id of the pipeline to update (required)
374
+ :param id: The id of the pipeline to update. (required)
367
375
  :type id: str
368
- :param add_campaign_model:
369
- :type add_campaign_model: AddCampaignModel
376
+ :param artifact_id: The id of the workflow config artifact to update. (required)
377
+ :type artifact_id: str
378
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
379
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
370
380
  :param _request_timeout: timeout setting for this request. If one
371
381
  number provided, it will be total request
372
382
  timeout. It can also be a pair (tuple) of
@@ -389,9 +399,10 @@ class PipelineApi:
389
399
  :return: Returns the result object.
390
400
  """ # noqa: E501
391
401
 
392
- _param = self._pipeline_id_campaign_post_serialize(
402
+ _param = self._pipeline_id_workflow_config_artifact_id_put_serialize(
393
403
  id=id,
394
- add_campaign_model=add_campaign_model,
404
+ artifact_id=artifact_id,
405
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
395
406
  _request_auth=_request_auth,
396
407
  _content_type=_content_type,
397
408
  _headers=_headers,
@@ -399,7 +410,7 @@ class PipelineApi:
399
410
  )
400
411
 
401
412
  _response_types_map: Dict[str, Optional[str]] = {
402
- '200': "AddCampaignArtifactResult",
413
+ '204': None,
403
414
  }
404
415
  response_data = self.api_client.call_api(
405
416
  *_param,
@@ -413,10 +424,11 @@ class PipelineApi:
413
424
 
414
425
 
415
426
  @validate_call
416
- def pipeline_id_campaign_post_with_http_info(
427
+ def pipeline_id_workflow_config_artifact_id_put_with_http_info(
417
428
  self,
418
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
419
- add_campaign_model: Optional[AddCampaignModel] = None,
429
+ id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
430
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
431
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
420
432
  _request_timeout: Union[
421
433
  None,
422
434
  Annotated[StrictFloat, Field(gt=0)],
@@ -429,14 +441,17 @@ class PipelineApi:
429
441
  _content_type: Optional[StrictStr] = None,
430
442
  _headers: Optional[Dict[StrictStr, Any]] = None,
431
443
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
432
- ) -> ApiResponse[AddCampaignArtifactResult]:
433
- """Adds a campaign to a pipeline.
444
+ ) -> ApiResponse[None]:
445
+ """Updates the workflow configuration for a pipeline.
434
446
 
447
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
435
448
 
436
- :param id: The id of the pipeline to update (required)
449
+ :param id: The id of the pipeline to update. (required)
437
450
  :type id: str
438
- :param add_campaign_model:
439
- :type add_campaign_model: AddCampaignModel
451
+ :param artifact_id: The id of the workflow config artifact to update. (required)
452
+ :type artifact_id: str
453
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
454
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
440
455
  :param _request_timeout: timeout setting for this request. If one
441
456
  number provided, it will be total request
442
457
  timeout. It can also be a pair (tuple) of
@@ -459,9 +474,10 @@ class PipelineApi:
459
474
  :return: Returns the result object.
460
475
  """ # noqa: E501
461
476
 
462
- _param = self._pipeline_id_campaign_post_serialize(
477
+ _param = self._pipeline_id_workflow_config_artifact_id_put_serialize(
463
478
  id=id,
464
- add_campaign_model=add_campaign_model,
479
+ artifact_id=artifact_id,
480
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
465
481
  _request_auth=_request_auth,
466
482
  _content_type=_content_type,
467
483
  _headers=_headers,
@@ -469,7 +485,7 @@ class PipelineApi:
469
485
  )
470
486
 
471
487
  _response_types_map: Dict[str, Optional[str]] = {
472
- '200': "AddCampaignArtifactResult",
488
+ '204': None,
473
489
  }
474
490
  response_data = self.api_client.call_api(
475
491
  *_param,
@@ -483,10 +499,11 @@ class PipelineApi:
483
499
 
484
500
 
485
501
  @validate_call
486
- def pipeline_id_campaign_post_without_preload_content(
502
+ def pipeline_id_workflow_config_artifact_id_put_without_preload_content(
487
503
  self,
488
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
489
- add_campaign_model: Optional[AddCampaignModel] = None,
504
+ id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
505
+ artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
506
+ pipeline_id_workflow_artifact_id_put_request: Annotated[Optional[PipelineIdWorkflowArtifactIdPutRequest], Field(description="The new workflow configuration.")] = None,
490
507
  _request_timeout: Union[
491
508
  None,
492
509
  Annotated[StrictFloat, Field(gt=0)],
@@ -500,13 +517,16 @@ class PipelineApi:
500
517
  _headers: Optional[Dict[StrictStr, Any]] = None,
501
518
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
502
519
  ) -> RESTResponseType:
503
- """Adds a campaign to a pipeline.
520
+ """Updates the workflow configuration for a pipeline.
504
521
 
522
+ This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
505
523
 
506
- :param id: The id of the pipeline to update (required)
524
+ :param id: The id of the pipeline to update. (required)
507
525
  :type id: str
508
- :param add_campaign_model:
509
- :type add_campaign_model: AddCampaignModel
526
+ :param artifact_id: The id of the workflow config artifact to update. (required)
527
+ :type artifact_id: str
528
+ :param pipeline_id_workflow_artifact_id_put_request: The new workflow configuration.
529
+ :type pipeline_id_workflow_artifact_id_put_request: PipelineIdWorkflowArtifactIdPutRequest
510
530
  :param _request_timeout: timeout setting for this request. If one
511
531
  number provided, it will be total request
512
532
  timeout. It can also be a pair (tuple) of
@@ -529,9 +549,10 @@ class PipelineApi:
529
549
  :return: Returns the result object.
530
550
  """ # noqa: E501
531
551
 
532
- _param = self._pipeline_id_campaign_post_serialize(
552
+ _param = self._pipeline_id_workflow_config_artifact_id_put_serialize(
533
553
  id=id,
534
- add_campaign_model=add_campaign_model,
554
+ artifact_id=artifact_id,
555
+ pipeline_id_workflow_artifact_id_put_request=pipeline_id_workflow_artifact_id_put_request,
535
556
  _request_auth=_request_auth,
536
557
  _content_type=_content_type,
537
558
  _headers=_headers,
@@ -539,7 +560,7 @@ class PipelineApi:
539
560
  )
540
561
 
541
562
  _response_types_map: Dict[str, Optional[str]] = {
542
- '200': "AddCampaignArtifactResult",
563
+ '204': None,
543
564
  }
544
565
  response_data = self.api_client.call_api(
545
566
  *_param,
@@ -548,10 +569,11 @@ class PipelineApi:
548
569
  return response_data.response
549
570
 
550
571
 
551
- def _pipeline_id_campaign_post_serialize(
572
+ def _pipeline_id_workflow_config_artifact_id_put_serialize(
552
573
  self,
553
574
  id,
554
- add_campaign_model,
575
+ artifact_id,
576
+ pipeline_id_workflow_artifact_id_put_request,
555
577
  _request_auth,
556
578
  _content_type,
557
579
  _headers,
@@ -575,23 +597,16 @@ class PipelineApi:
575
597
  # process the path parameters
576
598
  if id is not None:
577
599
  _path_params['id'] = id
600
+ if artifact_id is not None:
601
+ _path_params['artifactId'] = artifact_id
578
602
  # process the query parameters
579
603
  # process the header parameters
580
604
  # process the form parameters
581
605
  # process the body parameter
582
- if add_campaign_model is not None:
583
- _body_params = add_campaign_model
606
+ if pipeline_id_workflow_artifact_id_put_request is not None:
607
+ _body_params = pipeline_id_workflow_artifact_id_put_request
584
608
 
585
609
 
586
- # set the HTTP header `Accept`
587
- if 'Accept' not in _header_params:
588
- _header_params['Accept'] = self.api_client.select_header_accept(
589
- [
590
- 'text/plain',
591
- 'application/json',
592
- 'text/json'
593
- ]
594
- )
595
610
 
596
611
  # set the HTTP header `Content-Type`
597
612
  if _content_type:
@@ -616,8 +631,8 @@ class PipelineApi:
616
631
  ]
617
632
 
618
633
  return self.api_client.param_serialize(
619
- method='POST',
620
- resource_path='/pipeline/{id}/campaign',
634
+ method='PUT',
635
+ resource_path='/pipeline/{id}/workflow-config/{artifactId}',
621
636
  path_params=_path_params,
622
637
  query_params=_query_params,
623
638
  header_params=_header_params,
@@ -634,9 +649,10 @@ class PipelineApi:
634
649
 
635
650
 
636
651
  @validate_call
637
- def pipeline_id_campaign_put(
652
+ def pipeline_pipeline_id_campaign_artifact_id_put(
638
653
  self,
639
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
654
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
655
+ artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
640
656
  update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
641
657
  _request_timeout: Union[
642
658
  None,
@@ -651,11 +667,13 @@ class PipelineApi:
651
667
  _headers: Optional[Dict[StrictStr, Any]] = None,
652
668
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
653
669
  ) -> None:
654
- """Updates the default campaign for a pipeline.
670
+ """Updates a specific campaign for a pipeline.
655
671
 
656
672
 
657
- :param id: The id of the pipeline to update. (required)
658
- :type id: str
673
+ :param pipeline_id: The id of the pipeline to update. (required)
674
+ :type pipeline_id: str
675
+ :param artifact_id: The id of the campaign artifact to update. (required)
676
+ :type artifact_id: str
659
677
  :param update_campaign_model: The new campaign settings.
660
678
  :type update_campaign_model: UpdateCampaignModel
661
679
  :param _request_timeout: timeout setting for this request. If one
@@ -680,8 +698,9 @@ class PipelineApi:
680
698
  :return: Returns the result object.
681
699
  """ # noqa: E501
682
700
 
683
- _param = self._pipeline_id_campaign_put_serialize(
684
- id=id,
701
+ _param = self._pipeline_pipeline_id_campaign_artifact_id_put_serialize(
702
+ pipeline_id=pipeline_id,
703
+ artifact_id=artifact_id,
685
704
  update_campaign_model=update_campaign_model,
686
705
  _request_auth=_request_auth,
687
706
  _content_type=_content_type,
@@ -704,9 +723,10 @@ class PipelineApi:
704
723
 
705
724
 
706
725
  @validate_call
707
- def pipeline_id_campaign_put_with_http_info(
726
+ def pipeline_pipeline_id_campaign_artifact_id_put_with_http_info(
708
727
  self,
709
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
728
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
729
+ artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
710
730
  update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
711
731
  _request_timeout: Union[
712
732
  None,
@@ -721,11 +741,13 @@ class PipelineApi:
721
741
  _headers: Optional[Dict[StrictStr, Any]] = None,
722
742
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
723
743
  ) -> ApiResponse[None]:
724
- """Updates the default campaign for a pipeline.
744
+ """Updates a specific campaign for a pipeline.
725
745
 
726
746
 
727
- :param id: The id of the pipeline to update. (required)
728
- :type id: str
747
+ :param pipeline_id: The id of the pipeline to update. (required)
748
+ :type pipeline_id: str
749
+ :param artifact_id: The id of the campaign artifact to update. (required)
750
+ :type artifact_id: str
729
751
  :param update_campaign_model: The new campaign settings.
730
752
  :type update_campaign_model: UpdateCampaignModel
731
753
  :param _request_timeout: timeout setting for this request. If one
@@ -750,8 +772,9 @@ class PipelineApi:
750
772
  :return: Returns the result object.
751
773
  """ # noqa: E501
752
774
 
753
- _param = self._pipeline_id_campaign_put_serialize(
754
- id=id,
775
+ _param = self._pipeline_pipeline_id_campaign_artifact_id_put_serialize(
776
+ pipeline_id=pipeline_id,
777
+ artifact_id=artifact_id,
755
778
  update_campaign_model=update_campaign_model,
756
779
  _request_auth=_request_auth,
757
780
  _content_type=_content_type,
@@ -774,9 +797,10 @@ class PipelineApi:
774
797
 
775
798
 
776
799
  @validate_call
777
- def pipeline_id_campaign_put_without_preload_content(
800
+ def pipeline_pipeline_id_campaign_artifact_id_put_without_preload_content(
778
801
  self,
779
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
802
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
803
+ artifact_id: Annotated[StrictStr, Field(description="The id of the campaign artifact to update.")],
780
804
  update_campaign_model: Annotated[Optional[UpdateCampaignModel], Field(description="The new campaign settings.")] = None,
781
805
  _request_timeout: Union[
782
806
  None,
@@ -791,11 +815,13 @@ class PipelineApi:
791
815
  _headers: Optional[Dict[StrictStr, Any]] = None,
792
816
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
793
817
  ) -> RESTResponseType:
794
- """Updates the default campaign for a pipeline.
818
+ """Updates a specific campaign for a pipeline.
795
819
 
796
820
 
797
- :param id: The id of the pipeline to update. (required)
798
- :type id: str
821
+ :param pipeline_id: The id of the pipeline to update. (required)
822
+ :type pipeline_id: str
823
+ :param artifact_id: The id of the campaign artifact to update. (required)
824
+ :type artifact_id: str
799
825
  :param update_campaign_model: The new campaign settings.
800
826
  :type update_campaign_model: UpdateCampaignModel
801
827
  :param _request_timeout: timeout setting for this request. If one
@@ -820,8 +846,9 @@ class PipelineApi:
820
846
  :return: Returns the result object.
821
847
  """ # noqa: E501
822
848
 
823
- _param = self._pipeline_id_campaign_put_serialize(
824
- id=id,
849
+ _param = self._pipeline_pipeline_id_campaign_artifact_id_put_serialize(
850
+ pipeline_id=pipeline_id,
851
+ artifact_id=artifact_id,
825
852
  update_campaign_model=update_campaign_model,
826
853
  _request_auth=_request_auth,
827
854
  _content_type=_content_type,
@@ -839,9 +866,10 @@ class PipelineApi:
839
866
  return response_data.response
840
867
 
841
868
 
842
- def _pipeline_id_campaign_put_serialize(
869
+ def _pipeline_pipeline_id_campaign_artifact_id_put_serialize(
843
870
  self,
844
- id,
871
+ pipeline_id,
872
+ artifact_id,
845
873
  update_campaign_model,
846
874
  _request_auth,
847
875
  _content_type,
@@ -864,8 +892,10 @@ class PipelineApi:
864
892
  _body_params: Optional[bytes] = None
865
893
 
866
894
  # process the path parameters
867
- if id is not None:
868
- _path_params['id'] = id
895
+ if pipeline_id is not None:
896
+ _path_params['pipelineId'] = pipeline_id
897
+ if artifact_id is not None:
898
+ _path_params['artifactId'] = artifact_id
869
899
  # process the query parameters
870
900
  # process the header parameters
871
901
  # process the form parameters
@@ -899,7 +929,7 @@ class PipelineApi:
899
929
 
900
930
  return self.api_client.param_serialize(
901
931
  method='PUT',
902
- resource_path='/pipeline/{id}/campaign',
932
+ resource_path='/pipeline/{pipelineId}/campaign/{artifactId}',
903
933
  path_params=_path_params,
904
934
  query_params=_query_params,
905
935
  header_params=_header_params,
@@ -916,9 +946,10 @@ class PipelineApi:
916
946
 
917
947
 
918
948
  @validate_call
919
- def pipeline_id_get(
949
+ def pipeline_pipeline_id_campaign_post(
920
950
  self,
921
- id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
951
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
952
+ add_campaign_model: Annotated[Optional[AddCampaignModel], Field(description="The body request")] = None,
922
953
  _request_timeout: Union[
923
954
  None,
924
955
  Annotated[StrictFloat, Field(gt=0)],
@@ -931,12 +962,14 @@ class PipelineApi:
931
962
  _content_type: Optional[StrictStr] = None,
932
963
  _headers: Optional[Dict[StrictStr, Any]] = None,
933
964
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
934
- ) -> GetPipelineByIdResult:
935
- """Gets a pipeline by its id.
965
+ ) -> AddCampaignArtifactResult:
966
+ """Adds a campaign to a pipeline.
936
967
 
937
968
 
938
- :param id: The id of the pipeline to get. (required)
939
- :type id: str
969
+ :param pipeline_id: The id of the pipeline to update (required)
970
+ :type pipeline_id: str
971
+ :param add_campaign_model: The body request
972
+ :type add_campaign_model: AddCampaignModel
940
973
  :param _request_timeout: timeout setting for this request. If one
941
974
  number provided, it will be total request
942
975
  timeout. It can also be a pair (tuple) of
@@ -959,8 +992,9 @@ class PipelineApi:
959
992
  :return: Returns the result object.
960
993
  """ # noqa: E501
961
994
 
962
- _param = self._pipeline_id_get_serialize(
963
- id=id,
995
+ _param = self._pipeline_pipeline_id_campaign_post_serialize(
996
+ pipeline_id=pipeline_id,
997
+ add_campaign_model=add_campaign_model,
964
998
  _request_auth=_request_auth,
965
999
  _content_type=_content_type,
966
1000
  _headers=_headers,
@@ -968,7 +1002,7 @@ class PipelineApi:
968
1002
  )
969
1003
 
970
1004
  _response_types_map: Dict[str, Optional[str]] = {
971
- '200': "GetPipelineByIdResult",
1005
+ '200': "AddCampaignArtifactResult",
972
1006
  }
973
1007
  response_data = self.api_client.call_api(
974
1008
  *_param,
@@ -982,9 +1016,10 @@ class PipelineApi:
982
1016
 
983
1017
 
984
1018
  @validate_call
985
- def pipeline_id_get_with_http_info(
1019
+ def pipeline_pipeline_id_campaign_post_with_http_info(
986
1020
  self,
987
- id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
1021
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
1022
+ add_campaign_model: Annotated[Optional[AddCampaignModel], Field(description="The body request")] = None,
988
1023
  _request_timeout: Union[
989
1024
  None,
990
1025
  Annotated[StrictFloat, Field(gt=0)],
@@ -997,12 +1032,14 @@ class PipelineApi:
997
1032
  _content_type: Optional[StrictStr] = None,
998
1033
  _headers: Optional[Dict[StrictStr, Any]] = None,
999
1034
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1000
- ) -> ApiResponse[GetPipelineByIdResult]:
1001
- """Gets a pipeline by its id.
1035
+ ) -> ApiResponse[AddCampaignArtifactResult]:
1036
+ """Adds a campaign to a pipeline.
1002
1037
 
1003
1038
 
1004
- :param id: The id of the pipeline to get. (required)
1005
- :type id: str
1039
+ :param pipeline_id: The id of the pipeline to update (required)
1040
+ :type pipeline_id: str
1041
+ :param add_campaign_model: The body request
1042
+ :type add_campaign_model: AddCampaignModel
1006
1043
  :param _request_timeout: timeout setting for this request. If one
1007
1044
  number provided, it will be total request
1008
1045
  timeout. It can also be a pair (tuple) of
@@ -1025,8 +1062,9 @@ class PipelineApi:
1025
1062
  :return: Returns the result object.
1026
1063
  """ # noqa: E501
1027
1064
 
1028
- _param = self._pipeline_id_get_serialize(
1029
- id=id,
1065
+ _param = self._pipeline_pipeline_id_campaign_post_serialize(
1066
+ pipeline_id=pipeline_id,
1067
+ add_campaign_model=add_campaign_model,
1030
1068
  _request_auth=_request_auth,
1031
1069
  _content_type=_content_type,
1032
1070
  _headers=_headers,
@@ -1034,7 +1072,7 @@ class PipelineApi:
1034
1072
  )
1035
1073
 
1036
1074
  _response_types_map: Dict[str, Optional[str]] = {
1037
- '200': "GetPipelineByIdResult",
1075
+ '200': "AddCampaignArtifactResult",
1038
1076
  }
1039
1077
  response_data = self.api_client.call_api(
1040
1078
  *_param,
@@ -1048,9 +1086,10 @@ class PipelineApi:
1048
1086
 
1049
1087
 
1050
1088
  @validate_call
1051
- def pipeline_id_get_without_preload_content(
1089
+ def pipeline_pipeline_id_campaign_post_without_preload_content(
1052
1090
  self,
1053
- id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
1091
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to update")],
1092
+ add_campaign_model: Annotated[Optional[AddCampaignModel], Field(description="The body request")] = None,
1054
1093
  _request_timeout: Union[
1055
1094
  None,
1056
1095
  Annotated[StrictFloat, Field(gt=0)],
@@ -1064,11 +1103,13 @@ class PipelineApi:
1064
1103
  _headers: Optional[Dict[StrictStr, Any]] = None,
1065
1104
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1066
1105
  ) -> RESTResponseType:
1067
- """Gets a pipeline by its id.
1106
+ """Adds a campaign to a pipeline.
1068
1107
 
1069
1108
 
1070
- :param id: The id of the pipeline to get. (required)
1071
- :type id: str
1109
+ :param pipeline_id: The id of the pipeline to update (required)
1110
+ :type pipeline_id: str
1111
+ :param add_campaign_model: The body request
1112
+ :type add_campaign_model: AddCampaignModel
1072
1113
  :param _request_timeout: timeout setting for this request. If one
1073
1114
  number provided, it will be total request
1074
1115
  timeout. It can also be a pair (tuple) of
@@ -1091,8 +1132,9 @@ class PipelineApi:
1091
1132
  :return: Returns the result object.
1092
1133
  """ # noqa: E501
1093
1134
 
1094
- _param = self._pipeline_id_get_serialize(
1095
- id=id,
1135
+ _param = self._pipeline_pipeline_id_campaign_post_serialize(
1136
+ pipeline_id=pipeline_id,
1137
+ add_campaign_model=add_campaign_model,
1096
1138
  _request_auth=_request_auth,
1097
1139
  _content_type=_content_type,
1098
1140
  _headers=_headers,
@@ -1100,7 +1142,7 @@ class PipelineApi:
1100
1142
  )
1101
1143
 
1102
1144
  _response_types_map: Dict[str, Optional[str]] = {
1103
- '200': "GetPipelineByIdResult",
1145
+ '200': "AddCampaignArtifactResult",
1104
1146
  }
1105
1147
  response_data = self.api_client.call_api(
1106
1148
  *_param,
@@ -1109,9 +1151,10 @@ class PipelineApi:
1109
1151
  return response_data.response
1110
1152
 
1111
1153
 
1112
- def _pipeline_id_get_serialize(
1154
+ def _pipeline_pipeline_id_campaign_post_serialize(
1113
1155
  self,
1114
- id,
1156
+ pipeline_id,
1157
+ add_campaign_model,
1115
1158
  _request_auth,
1116
1159
  _content_type,
1117
1160
  _headers,
@@ -1133,12 +1176,14 @@ class PipelineApi:
1133
1176
  _body_params: Optional[bytes] = None
1134
1177
 
1135
1178
  # process the path parameters
1136
- if id is not None:
1137
- _path_params['id'] = id
1179
+ if pipeline_id is not None:
1180
+ _path_params['pipelineId'] = pipeline_id
1138
1181
  # process the query parameters
1139
1182
  # process the header parameters
1140
1183
  # process the form parameters
1141
1184
  # process the body parameter
1185
+ if add_campaign_model is not None:
1186
+ _body_params = add_campaign_model
1142
1187
 
1143
1188
 
1144
1189
  # set the HTTP header `Accept`
@@ -1151,6 +1196,21 @@ class PipelineApi:
1151
1196
  ]
1152
1197
  )
1153
1198
 
1199
+ # set the HTTP header `Content-Type`
1200
+ if _content_type:
1201
+ _header_params['Content-Type'] = _content_type
1202
+ else:
1203
+ _default_content_type = (
1204
+ self.api_client.select_header_content_type(
1205
+ [
1206
+ 'application/json',
1207
+ 'text/json',
1208
+ 'application/*+json'
1209
+ ]
1210
+ )
1211
+ )
1212
+ if _default_content_type is not None:
1213
+ _header_params['Content-Type'] = _default_content_type
1154
1214
 
1155
1215
  # authentication setting
1156
1216
  _auth_settings: List[str] = [
@@ -1159,8 +1219,8 @@ class PipelineApi:
1159
1219
  ]
1160
1220
 
1161
1221
  return self.api_client.param_serialize(
1162
- method='GET',
1163
- resource_path='/Pipeline/{id}',
1222
+ method='POST',
1223
+ resource_path='/pipeline/{pipelineId}/campaign',
1164
1224
  path_params=_path_params,
1165
1225
  query_params=_query_params,
1166
1226
  header_params=_header_params,
@@ -1177,11 +1237,9 @@ class PipelineApi:
1177
1237
 
1178
1238
 
1179
1239
  @validate_call
1180
- def pipeline_id_workflow_artifact_id_put(
1240
+ def pipeline_pipeline_id_get(
1181
1241
  self,
1182
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1183
- artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
1184
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1242
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
1185
1243
  _request_timeout: Union[
1186
1244
  None,
1187
1245
  Annotated[StrictFloat, Field(gt=0)],
@@ -1194,17 +1252,12 @@ class PipelineApi:
1194
1252
  _content_type: Optional[StrictStr] = None,
1195
1253
  _headers: Optional[Dict[StrictStr, Any]] = None,
1196
1254
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1197
- ) -> None:
1198
- """Updates the workflow configuration for a pipeline.
1255
+ ) -> GetPipelineByIdResult:
1256
+ """Gets a pipeline by its id.
1199
1257
 
1200
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1201
1258
 
1202
- :param id: The id of the pipeline to update. (required)
1203
- :type id: str
1204
- :param artifact_id: The id of the workflow config artifact to update. (required)
1205
- :type artifact_id: str
1206
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1207
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
1259
+ :param pipeline_id: The id of the pipeline to get. (required)
1260
+ :type pipeline_id: str
1208
1261
  :param _request_timeout: timeout setting for this request. If one
1209
1262
  number provided, it will be total request
1210
1263
  timeout. It can also be a pair (tuple) of
@@ -1227,10 +1280,8 @@ class PipelineApi:
1227
1280
  :return: Returns the result object.
1228
1281
  """ # noqa: E501
1229
1282
 
1230
- _param = self._pipeline_id_workflow_artifact_id_put_serialize(
1231
- id=id,
1232
- artifact_id=artifact_id,
1233
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
1283
+ _param = self._pipeline_pipeline_id_get_serialize(
1284
+ pipeline_id=pipeline_id,
1234
1285
  _request_auth=_request_auth,
1235
1286
  _content_type=_content_type,
1236
1287
  _headers=_headers,
@@ -1238,7 +1289,7 @@ class PipelineApi:
1238
1289
  )
1239
1290
 
1240
1291
  _response_types_map: Dict[str, Optional[str]] = {
1241
- '204': None,
1292
+ '200': "GetPipelineByIdResult",
1242
1293
  }
1243
1294
  response_data = self.api_client.call_api(
1244
1295
  *_param,
@@ -1252,11 +1303,9 @@ class PipelineApi:
1252
1303
 
1253
1304
 
1254
1305
  @validate_call
1255
- def pipeline_id_workflow_artifact_id_put_with_http_info(
1306
+ def pipeline_pipeline_id_get_with_http_info(
1256
1307
  self,
1257
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1258
- artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
1259
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1308
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
1260
1309
  _request_timeout: Union[
1261
1310
  None,
1262
1311
  Annotated[StrictFloat, Field(gt=0)],
@@ -1269,17 +1318,12 @@ class PipelineApi:
1269
1318
  _content_type: Optional[StrictStr] = None,
1270
1319
  _headers: Optional[Dict[StrictStr, Any]] = None,
1271
1320
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1272
- ) -> ApiResponse[None]:
1273
- """Updates the workflow configuration for a pipeline.
1321
+ ) -> ApiResponse[GetPipelineByIdResult]:
1322
+ """Gets a pipeline by its id.
1274
1323
 
1275
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1276
1324
 
1277
- :param id: The id of the pipeline to update. (required)
1278
- :type id: str
1279
- :param artifact_id: The id of the workflow config artifact to update. (required)
1280
- :type artifact_id: str
1281
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1282
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
1325
+ :param pipeline_id: The id of the pipeline to get. (required)
1326
+ :type pipeline_id: str
1283
1327
  :param _request_timeout: timeout setting for this request. If one
1284
1328
  number provided, it will be total request
1285
1329
  timeout. It can also be a pair (tuple) of
@@ -1302,10 +1346,8 @@ class PipelineApi:
1302
1346
  :return: Returns the result object.
1303
1347
  """ # noqa: E501
1304
1348
 
1305
- _param = self._pipeline_id_workflow_artifact_id_put_serialize(
1306
- id=id,
1307
- artifact_id=artifact_id,
1308
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
1349
+ _param = self._pipeline_pipeline_id_get_serialize(
1350
+ pipeline_id=pipeline_id,
1309
1351
  _request_auth=_request_auth,
1310
1352
  _content_type=_content_type,
1311
1353
  _headers=_headers,
@@ -1313,7 +1355,7 @@ class PipelineApi:
1313
1355
  )
1314
1356
 
1315
1357
  _response_types_map: Dict[str, Optional[str]] = {
1316
- '204': None,
1358
+ '200': "GetPipelineByIdResult",
1317
1359
  }
1318
1360
  response_data = self.api_client.call_api(
1319
1361
  *_param,
@@ -1327,11 +1369,9 @@ class PipelineApi:
1327
1369
 
1328
1370
 
1329
1371
  @validate_call
1330
- def pipeline_id_workflow_artifact_id_put_without_preload_content(
1372
+ def pipeline_pipeline_id_get_without_preload_content(
1331
1373
  self,
1332
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1333
- artifact_id: Annotated[StrictStr, Field(description="The id of the workflow config artifact to update.")],
1334
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1374
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")],
1335
1375
  _request_timeout: Union[
1336
1376
  None,
1337
1377
  Annotated[StrictFloat, Field(gt=0)],
@@ -1345,16 +1385,11 @@ class PipelineApi:
1345
1385
  _headers: Optional[Dict[StrictStr, Any]] = None,
1346
1386
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1347
1387
  ) -> RESTResponseType:
1348
- """Updates the workflow configuration for a pipeline.
1388
+ """Gets a pipeline by its id.
1349
1389
 
1350
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1351
1390
 
1352
- :param id: The id of the pipeline to update. (required)
1353
- :type id: str
1354
- :param artifact_id: The id of the workflow config artifact to update. (required)
1355
- :type artifact_id: str
1356
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1357
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
1391
+ :param pipeline_id: The id of the pipeline to get. (required)
1392
+ :type pipeline_id: str
1358
1393
  :param _request_timeout: timeout setting for this request. If one
1359
1394
  number provided, it will be total request
1360
1395
  timeout. It can also be a pair (tuple) of
@@ -1377,10 +1412,8 @@ class PipelineApi:
1377
1412
  :return: Returns the result object.
1378
1413
  """ # noqa: E501
1379
1414
 
1380
- _param = self._pipeline_id_workflow_artifact_id_put_serialize(
1381
- id=id,
1382
- artifact_id=artifact_id,
1383
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
1415
+ _param = self._pipeline_pipeline_id_get_serialize(
1416
+ pipeline_id=pipeline_id,
1384
1417
  _request_auth=_request_auth,
1385
1418
  _content_type=_content_type,
1386
1419
  _headers=_headers,
@@ -1388,7 +1421,7 @@ class PipelineApi:
1388
1421
  )
1389
1422
 
1390
1423
  _response_types_map: Dict[str, Optional[str]] = {
1391
- '204': None,
1424
+ '200': "GetPipelineByIdResult",
1392
1425
  }
1393
1426
  response_data = self.api_client.call_api(
1394
1427
  *_param,
@@ -1397,11 +1430,9 @@ class PipelineApi:
1397
1430
  return response_data.response
1398
1431
 
1399
1432
 
1400
- def _pipeline_id_workflow_artifact_id_put_serialize(
1433
+ def _pipeline_pipeline_id_get_serialize(
1401
1434
  self,
1402
- id,
1403
- artifact_id,
1404
- pipeline_id_workflow_put_request,
1435
+ pipeline_id,
1405
1436
  _request_auth,
1406
1437
  _content_type,
1407
1438
  _headers,
@@ -1423,319 +1454,24 @@ class PipelineApi:
1423
1454
  _body_params: Optional[bytes] = None
1424
1455
 
1425
1456
  # process the path parameters
1426
- if id is not None:
1427
- _path_params['id'] = id
1428
- if artifact_id is not None:
1429
- _path_params['artifact-id'] = artifact_id
1457
+ if pipeline_id is not None:
1458
+ _path_params['pipelineId'] = pipeline_id
1430
1459
  # process the query parameters
1431
1460
  # process the header parameters
1432
1461
  # process the form parameters
1433
1462
  # process the body parameter
1434
- if pipeline_id_workflow_put_request is not None:
1435
- _body_params = pipeline_id_workflow_put_request
1436
1463
 
1437
1464
 
1438
-
1439
- # set the HTTP header `Content-Type`
1440
- if _content_type:
1441
- _header_params['Content-Type'] = _content_type
1442
- else:
1443
- _default_content_type = (
1444
- self.api_client.select_header_content_type(
1445
- [
1446
- 'application/json',
1447
- 'text/json',
1448
- 'application/*+json'
1449
- ]
1450
- )
1465
+ # set the HTTP header `Accept`
1466
+ if 'Accept' not in _header_params:
1467
+ _header_params['Accept'] = self.api_client.select_header_accept(
1468
+ [
1469
+ 'text/plain',
1470
+ 'application/json',
1471
+ 'text/json'
1472
+ ]
1451
1473
  )
1452
- if _default_content_type is not None:
1453
- _header_params['Content-Type'] = _default_content_type
1454
-
1455
- # authentication setting
1456
- _auth_settings: List[str] = [
1457
- 'bearer',
1458
- 'oauth2'
1459
- ]
1460
-
1461
- return self.api_client.param_serialize(
1462
- method='PUT',
1463
- resource_path='/pipeline/{id}/workflow/{artifact-id}',
1464
- path_params=_path_params,
1465
- query_params=_query_params,
1466
- header_params=_header_params,
1467
- body=_body_params,
1468
- post_params=_form_params,
1469
- files=_files,
1470
- auth_settings=_auth_settings,
1471
- collection_formats=_collection_formats,
1472
- _host=_host,
1473
- _request_auth=_request_auth
1474
- )
1475
-
1476
-
1477
-
1478
-
1479
- @validate_call
1480
- def pipeline_id_workflow_put(
1481
- self,
1482
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1483
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1484
- _request_timeout: Union[
1485
- None,
1486
- Annotated[StrictFloat, Field(gt=0)],
1487
- Tuple[
1488
- Annotated[StrictFloat, Field(gt=0)],
1489
- Annotated[StrictFloat, Field(gt=0)]
1490
- ]
1491
- ] = None,
1492
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1493
- _content_type: Optional[StrictStr] = None,
1494
- _headers: Optional[Dict[StrictStr, Any]] = None,
1495
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1496
- ) -> None:
1497
- """Updates the workflow configuration for a pipeline.
1498
-
1499
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1500
-
1501
- :param id: The id of the pipeline to update. (required)
1502
- :type id: str
1503
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1504
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
1505
- :param _request_timeout: timeout setting for this request. If one
1506
- number provided, it will be total request
1507
- timeout. It can also be a pair (tuple) of
1508
- (connection, read) timeouts.
1509
- :type _request_timeout: int, tuple(int, int), optional
1510
- :param _request_auth: set to override the auth_settings for an a single
1511
- request; this effectively ignores the
1512
- authentication in the spec for a single request.
1513
- :type _request_auth: dict, optional
1514
- :param _content_type: force content-type for the request.
1515
- :type _content_type: str, Optional
1516
- :param _headers: set to override the headers for a single
1517
- request; this effectively ignores the headers
1518
- in the spec for a single request.
1519
- :type _headers: dict, optional
1520
- :param _host_index: set to override the host_index for a single
1521
- request; this effectively ignores the host_index
1522
- in the spec for a single request.
1523
- :type _host_index: int, optional
1524
- :return: Returns the result object.
1525
- """ # noqa: E501
1526
-
1527
- _param = self._pipeline_id_workflow_put_serialize(
1528
- id=id,
1529
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
1530
- _request_auth=_request_auth,
1531
- _content_type=_content_type,
1532
- _headers=_headers,
1533
- _host_index=_host_index
1534
- )
1535
-
1536
- _response_types_map: Dict[str, Optional[str]] = {
1537
- '204': None,
1538
- }
1539
- response_data = self.api_client.call_api(
1540
- *_param,
1541
- _request_timeout=_request_timeout
1542
- )
1543
- response_data.read()
1544
- return self.api_client.response_deserialize(
1545
- response_data=response_data,
1546
- response_types_map=_response_types_map,
1547
- ).data
1548
-
1549
-
1550
- @validate_call
1551
- def pipeline_id_workflow_put_with_http_info(
1552
- self,
1553
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1554
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1555
- _request_timeout: Union[
1556
- None,
1557
- Annotated[StrictFloat, Field(gt=0)],
1558
- Tuple[
1559
- Annotated[StrictFloat, Field(gt=0)],
1560
- Annotated[StrictFloat, Field(gt=0)]
1561
- ]
1562
- ] = None,
1563
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1564
- _content_type: Optional[StrictStr] = None,
1565
- _headers: Optional[Dict[StrictStr, Any]] = None,
1566
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1567
- ) -> ApiResponse[None]:
1568
- """Updates the workflow configuration for a pipeline.
1569
-
1570
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1571
-
1572
- :param id: The id of the pipeline to update. (required)
1573
- :type id: str
1574
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1575
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
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
-
1598
- _param = self._pipeline_id_workflow_put_serialize(
1599
- id=id,
1600
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
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
- '204': 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
- )
1619
-
1620
1474
 
1621
- @validate_call
1622
- def pipeline_id_workflow_put_without_preload_content(
1623
- self,
1624
- id: Annotated[StrictStr, Field(description="The id of the pipeline to update.")],
1625
- pipeline_id_workflow_put_request: Annotated[Optional[PipelineIdWorkflowPutRequest], Field(description="The new workflow configuration.")] = None,
1626
- _request_timeout: Union[
1627
- None,
1628
- Annotated[StrictFloat, Field(gt=0)],
1629
- Tuple[
1630
- Annotated[StrictFloat, Field(gt=0)],
1631
- Annotated[StrictFloat, Field(gt=0)]
1632
- ]
1633
- ] = None,
1634
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1635
- _content_type: Optional[StrictStr] = None,
1636
- _headers: Optional[Dict[StrictStr, Any]] = None,
1637
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1638
- ) -> RESTResponseType:
1639
- """Updates the workflow configuration for a pipeline.
1640
-
1641
- This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
1642
-
1643
- :param id: The id of the pipeline to update. (required)
1644
- :type id: str
1645
- :param pipeline_id_workflow_put_request: The new workflow configuration.
1646
- :type pipeline_id_workflow_put_request: PipelineIdWorkflowPutRequest
1647
- :param _request_timeout: timeout setting for this request. If one
1648
- number provided, it will be total request
1649
- timeout. It can also be a pair (tuple) of
1650
- (connection, read) timeouts.
1651
- :type _request_timeout: int, tuple(int, int), optional
1652
- :param _request_auth: set to override the auth_settings for an a single
1653
- request; this effectively ignores the
1654
- authentication in the spec for a single request.
1655
- :type _request_auth: dict, optional
1656
- :param _content_type: force content-type for the request.
1657
- :type _content_type: str, Optional
1658
- :param _headers: set to override the headers for a single
1659
- request; this effectively ignores the headers
1660
- in the spec for a single request.
1661
- :type _headers: dict, optional
1662
- :param _host_index: set to override the host_index for a single
1663
- request; this effectively ignores the host_index
1664
- in the spec for a single request.
1665
- :type _host_index: int, optional
1666
- :return: Returns the result object.
1667
- """ # noqa: E501
1668
-
1669
- _param = self._pipeline_id_workflow_put_serialize(
1670
- id=id,
1671
- pipeline_id_workflow_put_request=pipeline_id_workflow_put_request,
1672
- _request_auth=_request_auth,
1673
- _content_type=_content_type,
1674
- _headers=_headers,
1675
- _host_index=_host_index
1676
- )
1677
-
1678
- _response_types_map: Dict[str, Optional[str]] = {
1679
- '204': None,
1680
- }
1681
- response_data = self.api_client.call_api(
1682
- *_param,
1683
- _request_timeout=_request_timeout
1684
- )
1685
- return response_data.response
1686
-
1687
-
1688
- def _pipeline_id_workflow_put_serialize(
1689
- self,
1690
- id,
1691
- pipeline_id_workflow_put_request,
1692
- _request_auth,
1693
- _content_type,
1694
- _headers,
1695
- _host_index,
1696
- ) -> RequestSerialized:
1697
-
1698
- _host = None
1699
-
1700
- _collection_formats: Dict[str, str] = {
1701
- }
1702
-
1703
- _path_params: Dict[str, str] = {}
1704
- _query_params: List[Tuple[str, str]] = []
1705
- _header_params: Dict[str, Optional[str]] = _headers or {}
1706
- _form_params: List[Tuple[str, str]] = []
1707
- _files: Dict[
1708
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1709
- ] = {}
1710
- _body_params: Optional[bytes] = None
1711
-
1712
- # process the path parameters
1713
- if id is not None:
1714
- _path_params['id'] = id
1715
- # process the query parameters
1716
- # process the header parameters
1717
- # process the form parameters
1718
- # process the body parameter
1719
- if pipeline_id_workflow_put_request is not None:
1720
- _body_params = pipeline_id_workflow_put_request
1721
-
1722
-
1723
-
1724
- # set the HTTP header `Content-Type`
1725
- if _content_type:
1726
- _header_params['Content-Type'] = _content_type
1727
- else:
1728
- _default_content_type = (
1729
- self.api_client.select_header_content_type(
1730
- [
1731
- 'application/json',
1732
- 'text/json',
1733
- 'application/*+json'
1734
- ]
1735
- )
1736
- )
1737
- if _default_content_type is not None:
1738
- _header_params['Content-Type'] = _default_content_type
1739
1475
 
1740
1476
  # authentication setting
1741
1477
  _auth_settings: List[str] = [
@@ -1744,8 +1480,8 @@ class PipelineApi:
1744
1480
  ]
1745
1481
 
1746
1482
  return self.api_client.param_serialize(
1747
- method='PUT',
1748
- resource_path='/pipeline/{id}/workflow',
1483
+ method='GET',
1484
+ resource_path='/pipeline/{pipelineId}',
1749
1485
  path_params=_path_params,
1750
1486
  query_params=_query_params,
1751
1487
  header_params=_header_params,
@@ -1764,8 +1500,8 @@ class PipelineApi:
1764
1500
  @validate_call
1765
1501
  def pipeline_pipeline_id_preliminary_download_post(
1766
1502
  self,
1767
- pipeline_id: StrictStr,
1768
- preliminary_download_model: Optional[PreliminaryDownloadModel] = None,
1503
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")],
1504
+ preliminary_download_model: Annotated[Optional[PreliminaryDownloadModel], Field(description="The body request.")] = None,
1769
1505
  _request_timeout: Union[
1770
1506
  None,
1771
1507
  Annotated[StrictFloat, Field(gt=0)],
@@ -1782,9 +1518,9 @@ class PipelineApi:
1782
1518
  """Initiates a preliminary download of the pipeline.
1783
1519
 
1784
1520
 
1785
- :param pipeline_id: (required)
1521
+ :param pipeline_id: The id of the pipeline to initiate the download for. (required)
1786
1522
  :type pipeline_id: str
1787
- :param preliminary_download_model:
1523
+ :param preliminary_download_model: The body request.
1788
1524
  :type preliminary_download_model: PreliminaryDownloadModel
1789
1525
  :param _request_timeout: timeout setting for this request. If one
1790
1526
  number provided, it will be total request
@@ -1834,8 +1570,8 @@ class PipelineApi:
1834
1570
  @validate_call
1835
1571
  def pipeline_pipeline_id_preliminary_download_post_with_http_info(
1836
1572
  self,
1837
- pipeline_id: StrictStr,
1838
- preliminary_download_model: Optional[PreliminaryDownloadModel] = None,
1573
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")],
1574
+ preliminary_download_model: Annotated[Optional[PreliminaryDownloadModel], Field(description="The body request.")] = None,
1839
1575
  _request_timeout: Union[
1840
1576
  None,
1841
1577
  Annotated[StrictFloat, Field(gt=0)],
@@ -1852,9 +1588,9 @@ class PipelineApi:
1852
1588
  """Initiates a preliminary download of the pipeline.
1853
1589
 
1854
1590
 
1855
- :param pipeline_id: (required)
1591
+ :param pipeline_id: The id of the pipeline to initiate the download for. (required)
1856
1592
  :type pipeline_id: str
1857
- :param preliminary_download_model:
1593
+ :param preliminary_download_model: The body request.
1858
1594
  :type preliminary_download_model: PreliminaryDownloadModel
1859
1595
  :param _request_timeout: timeout setting for this request. If one
1860
1596
  number provided, it will be total request
@@ -1904,8 +1640,8 @@ class PipelineApi:
1904
1640
  @validate_call
1905
1641
  def pipeline_pipeline_id_preliminary_download_post_without_preload_content(
1906
1642
  self,
1907
- pipeline_id: StrictStr,
1908
- preliminary_download_model: Optional[PreliminaryDownloadModel] = None,
1643
+ pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")],
1644
+ preliminary_download_model: Annotated[Optional[PreliminaryDownloadModel], Field(description="The body request.")] = None,
1909
1645
  _request_timeout: Union[
1910
1646
  None,
1911
1647
  Annotated[StrictFloat, Field(gt=0)],
@@ -1922,9 +1658,9 @@ class PipelineApi:
1922
1658
  """Initiates a preliminary download of the pipeline.
1923
1659
 
1924
1660
 
1925
- :param pipeline_id: (required)
1661
+ :param pipeline_id: The id of the pipeline to initiate the download for. (required)
1926
1662
  :type pipeline_id: str
1927
- :param preliminary_download_model:
1663
+ :param preliminary_download_model: The body request.
1928
1664
  :type preliminary_download_model: PreliminaryDownloadModel
1929
1665
  :param _request_timeout: timeout setting for this request. If one
1930
1666
  number provided, it will be total request
@@ -2055,7 +1791,7 @@ class PipelineApi:
2055
1791
  @validate_call
2056
1792
  def pipeline_preliminary_download_preliminary_download_id_get(
2057
1793
  self,
2058
- preliminary_download_id: StrictStr,
1794
+ preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")],
2059
1795
  _request_timeout: Union[
2060
1796
  None,
2061
1797
  Annotated[StrictFloat, Field(gt=0)],
@@ -2069,10 +1805,11 @@ class PipelineApi:
2069
1805
  _headers: Optional[Dict[StrictStr, Any]] = None,
2070
1806
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2071
1807
  ) -> bytearray:
2072
- """Gets the preliminary download. If it's still processing the request will return 202 Accepted.
1808
+ """Gets the preliminary download.
2073
1809
 
1810
+ If it's still processing the request will return 202 Accepted.
2074
1811
 
2075
- :param preliminary_download_id: (required)
1812
+ :param preliminary_download_id: The id of the preliminary download to get. (required)
2076
1813
  :type preliminary_download_id: str
2077
1814
  :param _request_timeout: timeout setting for this request. If one
2078
1815
  number provided, it will be total request
@@ -2122,7 +1859,7 @@ class PipelineApi:
2122
1859
  @validate_call
2123
1860
  def pipeline_preliminary_download_preliminary_download_id_get_with_http_info(
2124
1861
  self,
2125
- preliminary_download_id: StrictStr,
1862
+ preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")],
2126
1863
  _request_timeout: Union[
2127
1864
  None,
2128
1865
  Annotated[StrictFloat, Field(gt=0)],
@@ -2136,10 +1873,11 @@ class PipelineApi:
2136
1873
  _headers: Optional[Dict[StrictStr, Any]] = None,
2137
1874
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2138
1875
  ) -> ApiResponse[bytearray]:
2139
- """Gets the preliminary download. If it's still processing the request will return 202 Accepted.
1876
+ """Gets the preliminary download.
2140
1877
 
1878
+ If it's still processing the request will return 202 Accepted.
2141
1879
 
2142
- :param preliminary_download_id: (required)
1880
+ :param preliminary_download_id: The id of the preliminary download to get. (required)
2143
1881
  :type preliminary_download_id: str
2144
1882
  :param _request_timeout: timeout setting for this request. If one
2145
1883
  number provided, it will be total request
@@ -2189,7 +1927,7 @@ class PipelineApi:
2189
1927
  @validate_call
2190
1928
  def pipeline_preliminary_download_preliminary_download_id_get_without_preload_content(
2191
1929
  self,
2192
- preliminary_download_id: StrictStr,
1930
+ preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")],
2193
1931
  _request_timeout: Union[
2194
1932
  None,
2195
1933
  Annotated[StrictFloat, Field(gt=0)],
@@ -2203,10 +1941,11 @@ class PipelineApi:
2203
1941
  _headers: Optional[Dict[StrictStr, Any]] = None,
2204
1942
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2205
1943
  ) -> RESTResponseType:
2206
- """Gets the preliminary download. If it's still processing the request will return 202 Accepted.
1944
+ """Gets the preliminary download.
2207
1945
 
1946
+ If it's still processing the request will return 202 Accepted.
2208
1947
 
2209
- :param preliminary_download_id: (required)
1948
+ :param preliminary_download_id: The id of the preliminary download to get. (required)
2210
1949
  :type preliminary_download_id: str
2211
1950
  :param _request_timeout: timeout setting for this request. If one
2212
1951
  number provided, it will be total request