Skip to content

Commit 9709609

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
fix(specs): deprecate task v1 [skip-bc] (generated)
algolia/api-clients-automation#4327 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 0554e3c commit 9709609

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

‎algoliasearch/ingestion/client.py

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,7 @@ async def create_task_v1_with_http_info(
466466
request_options: Optional[Union[dict, RequestOptions]] = None,
467467
) -> ApiResponse[str]:
468468
"""
469+
(Deprecated) create_task_v1
469470
Creates a new task using the v1 endpoint, please use `createTask` instead.
470471
471472
@@ -475,6 +476,8 @@ async def create_task_v1_with_http_info(
475476
:return: Returns the raw algoliasearch 'APIResponse' object.
476477
"""
477478

479+
warn("POST /1/tasks is deprecated.", DeprecationWarning)
480+
478481
if task_create is None:
479482
raise ValueError(
480483
"Parameter `task_create` is required when calling `create_task_v1`."
@@ -505,6 +508,7 @@ async def create_task_v1(
505508
request_options: Optional[Union[dict, RequestOptions]] = None,
506509
) -> TaskCreateResponse:
507510
"""
511+
(Deprecated) create_task_v1
508512
Creates a new task using the v1 endpoint, please use `createTask` instead.
509513
510514
@@ -1159,6 +1163,7 @@ async def delete_task_v1_with_http_info(
11591163
request_options: Optional[Union[dict, RequestOptions]] = None,
11601164
) -> ApiResponse[str]:
11611165
"""
1166+
(Deprecated) delete_task_v1
11621167
Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
11631168
11641169
@@ -1168,6 +1173,8 @@ async def delete_task_v1_with_http_info(
11681173
:return: Returns the raw algoliasearch 'APIResponse' object.
11691174
"""
11701175

1176+
warn("DELETE /1/tasks/{taskID} is deprecated.", DeprecationWarning)
1177+
11711178
if task_id is None:
11721179
raise ValueError(
11731180
"Parameter `task_id` is required when calling `delete_task_v1`."
@@ -1190,6 +1197,7 @@ async def delete_task_v1(
11901197
request_options: Optional[Union[dict, RequestOptions]] = None,
11911198
) -> DeleteResponse:
11921199
"""
1200+
(Deprecated) delete_task_v1
11931201
Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
11941202
11951203
@@ -1447,6 +1455,7 @@ async def enable_task_v1_with_http_info(
14471455
request_options: Optional[Union[dict, RequestOptions]] = None,
14481456
) -> ApiResponse[str]:
14491457
"""
1458+
(Deprecated) enable_task_v1
14501459
Enables a task using the v1 endpoint, please use `enableTask` instead.
14511460
14521461
Required API Key ACLs:
@@ -1460,6 +1469,8 @@ async def enable_task_v1_with_http_info(
14601469
:return: Returns the raw algoliasearch 'APIResponse' object.
14611470
"""
14621471

1472+
warn("PUT /1/tasks/{taskID}/enable is deprecated.", DeprecationWarning)
1473+
14631474
if task_id is None:
14641475
raise ValueError(
14651476
"Parameter `task_id` is required when calling `enable_task_v1`."
@@ -1484,6 +1495,7 @@ async def enable_task_v1(
14841495
request_options: Optional[Union[dict, RequestOptions]] = None,
14851496
) -> TaskUpdateResponse:
14861497
"""
1498+
(Deprecated) enable_task_v1
14871499
Enables a task using the v1 endpoint, please use `enableTask` instead.
14881500
14891501
Required API Key ACLs:
@@ -1878,6 +1890,7 @@ async def get_task_v1_with_http_info(
18781890
request_options: Optional[Union[dict, RequestOptions]] = None,
18791891
) -> ApiResponse[str]:
18801892
"""
1893+
(Deprecated) get_task_v1
18811894
Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
18821895
18831896
Required API Key ACLs:
@@ -1891,6 +1904,8 @@ async def get_task_v1_with_http_info(
18911904
:return: Returns the raw algoliasearch 'APIResponse' object.
18921905
"""
18931906

1907+
warn("GET /1/tasks/{taskID} is deprecated.", DeprecationWarning)
1908+
18941909
if task_id is None:
18951910
raise ValueError(
18961911
"Parameter `task_id` is required when calling `get_task_v1`."
@@ -1913,6 +1928,7 @@ async def get_task_v1(
19131928
request_options: Optional[Union[dict, RequestOptions]] = None,
19141929
) -> TaskV1:
19151930
"""
1931+
(Deprecated) get_task_v1
19161932
Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
19171933
19181934
Required API Key ACLs:
@@ -3186,6 +3202,7 @@ async def list_tasks_v1_with_http_info(
31863202
request_options: Optional[Union[dict, RequestOptions]] = None,
31873203
) -> ApiResponse[str]:
31883204
"""
3205+
(Deprecated) list_tasks_v1
31893206
Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
31903207
31913208
Required API Key ACLs:
@@ -3215,6 +3232,8 @@ async def list_tasks_v1_with_http_info(
32153232
:return: Returns the raw algoliasearch 'APIResponse' object.
32163233
"""
32173234

3235+
warn("GET /1/tasks is deprecated.", DeprecationWarning)
3236+
32183237
_query_parameters: Dict[str, Any] = {}
32193238

32203239
if items_per_page is not None:
@@ -3297,6 +3316,7 @@ async def list_tasks_v1(
32973316
request_options: Optional[Union[dict, RequestOptions]] = None,
32983317
) -> ListTasksResponseV1:
32993318
"""
3319+
(Deprecated) list_tasks_v1
33003320
Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
33013321
33023322
Required API Key ACLs:
@@ -3724,6 +3744,7 @@ async def run_task_v1_with_http_info(
37243744
request_options: Optional[Union[dict, RequestOptions]] = None,
37253745
) -> ApiResponse[str]:
37263746
"""
3747+
(Deprecated) run_task_v1
37273748
Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
37283749
37293750
Required API Key ACLs:
@@ -3737,6 +3758,8 @@ async def run_task_v1_with_http_info(
37373758
:return: Returns the raw algoliasearch 'APIResponse' object.
37383759
"""
37393760

3761+
warn("POST /1/tasks/{taskID}/run is deprecated.", DeprecationWarning)
3762+
37403763
if task_id is None:
37413764
raise ValueError(
37423765
"Parameter `task_id` is required when calling `run_task_v1`."
@@ -3761,6 +3784,7 @@ async def run_task_v1(
37613784
request_options: Optional[Union[dict, RequestOptions]] = None,
37623785
) -> RunResponse:
37633786
"""
3787+
(Deprecated) run_task_v1
37643788
Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
37653789
37663790
Required API Key ACLs:
@@ -4022,6 +4046,7 @@ async def search_tasks_v1_with_http_info(
40224046
request_options: Optional[Union[dict, RequestOptions]] = None,
40234047
) -> ApiResponse[str]:
40244048
"""
4049+
(Deprecated) search_tasks_v1
40254050
Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
40264051
40274052
Required API Key ACLs:
@@ -4035,6 +4060,8 @@ async def search_tasks_v1_with_http_info(
40354060
:return: Returns the raw algoliasearch 'APIResponse' object.
40364061
"""
40374062

4063+
warn("POST /1/tasks/search is deprecated.", DeprecationWarning)
4064+
40384065
if task_search is None:
40394066
raise ValueError(
40404067
"Parameter `task_search` is required when calling `search_tasks_v1`."
@@ -4060,6 +4087,7 @@ async def search_tasks_v1(
40604087
request_options: Optional[Union[dict, RequestOptions]] = None,
40614088
) -> List[TaskV1]:
40624089
"""
4090+
(Deprecated) search_tasks_v1
40634091
Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
40644092
40654093
Required API Key ACLs:
@@ -4655,6 +4683,7 @@ async def update_task_v1_with_http_info(
46554683
request_options: Optional[Union[dict, RequestOptions]] = None,
46564684
) -> ApiResponse[str]:
46574685
"""
4686+
(Deprecated) update_task_v1
46584687
Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
46594688
46604689
@@ -4666,6 +4695,8 @@ async def update_task_v1_with_http_info(
46664695
:return: Returns the raw algoliasearch 'APIResponse' object.
46674696
"""
46684697

4698+
warn("PATCH /1/tasks/{taskID} is deprecated.", DeprecationWarning)
4699+
46694700
if task_id is None:
46704701
raise ValueError(
46714702
"Parameter `task_id` is required when calling `update_task_v1`."
@@ -4699,6 +4730,7 @@ async def update_task_v1(
46994730
request_options: Optional[Union[dict, RequestOptions]] = None,
47004731
) -> TaskUpdateResponse:
47014732
"""
4733+
(Deprecated) update_task_v1
47024734
Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
47034735
47044736
@@ -5270,6 +5302,7 @@ def create_task_v1_with_http_info(
52705302
request_options: Optional[Union[dict, RequestOptions]] = None,
52715303
) -> ApiResponse[str]:
52725304
"""
5305+
(Deprecated) create_task_v1
52735306
Creates a new task using the v1 endpoint, please use `createTask` instead.
52745307
52755308
@@ -5279,6 +5312,8 @@ def create_task_v1_with_http_info(
52795312
:return: Returns the raw algoliasearch 'APIResponse' object.
52805313
"""
52815314

5315+
warn("POST /1/tasks is deprecated.", DeprecationWarning)
5316+
52825317
if task_create is None:
52835318
raise ValueError(
52845319
"Parameter `task_create` is required when calling `create_task_v1`."
@@ -5309,6 +5344,7 @@ def create_task_v1(
53095344
request_options: Optional[Union[dict, RequestOptions]] = None,
53105345
) -> TaskCreateResponse:
53115346
"""
5347+
(Deprecated) create_task_v1
53125348
Creates a new task using the v1 endpoint, please use `createTask` instead.
53135349
53145350
@@ -5955,6 +5991,7 @@ def delete_task_v1_with_http_info(
59555991
request_options: Optional[Union[dict, RequestOptions]] = None,
59565992
) -> ApiResponse[str]:
59575993
"""
5994+
(Deprecated) delete_task_v1
59585995
Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
59595996
59605997
@@ -5964,6 +6001,8 @@ def delete_task_v1_with_http_info(
59646001
:return: Returns the raw algoliasearch 'APIResponse' object.
59656002
"""
59666003

6004+
warn("DELETE /1/tasks/{taskID} is deprecated.", DeprecationWarning)
6005+
59676006
if task_id is None:
59686007
raise ValueError(
59696008
"Parameter `task_id` is required when calling `delete_task_v1`."
@@ -5986,6 +6025,7 @@ def delete_task_v1(
59866025
request_options: Optional[Union[dict, RequestOptions]] = None,
59876026
) -> DeleteResponse:
59886027
"""
6028+
(Deprecated) delete_task_v1
59896029
Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
59906030
59916031
@@ -6243,6 +6283,7 @@ def enable_task_v1_with_http_info(
62436283
request_options: Optional[Union[dict, RequestOptions]] = None,
62446284
) -> ApiResponse[str]:
62456285
"""
6286+
(Deprecated) enable_task_v1
62466287
Enables a task using the v1 endpoint, please use `enableTask` instead.
62476288
62486289
Required API Key ACLs:
@@ -6256,6 +6297,8 @@ def enable_task_v1_with_http_info(
62566297
:return: Returns the raw algoliasearch 'APIResponse' object.
62576298
"""
62586299

6300+
warn("PUT /1/tasks/{taskID}/enable is deprecated.", DeprecationWarning)
6301+
62596302
if task_id is None:
62606303
raise ValueError(
62616304
"Parameter `task_id` is required when calling `enable_task_v1`."
@@ -6280,6 +6323,7 @@ def enable_task_v1(
62806323
request_options: Optional[Union[dict, RequestOptions]] = None,
62816324
) -> TaskUpdateResponse:
62826325
"""
6326+
(Deprecated) enable_task_v1
62836327
Enables a task using the v1 endpoint, please use `enableTask` instead.
62846328
62856329
Required API Key ACLs:
@@ -6672,6 +6716,7 @@ def get_task_v1_with_http_info(
66726716
request_options: Optional[Union[dict, RequestOptions]] = None,
66736717
) -> ApiResponse[str]:
66746718
"""
6719+
(Deprecated) get_task_v1
66756720
Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
66766721
66776722
Required API Key ACLs:
@@ -6685,6 +6730,8 @@ def get_task_v1_with_http_info(
66856730
:return: Returns the raw algoliasearch 'APIResponse' object.
66866731
"""
66876732

6733+
warn("GET /1/tasks/{taskID} is deprecated.", DeprecationWarning)
6734+
66886735
if task_id is None:
66896736
raise ValueError(
66906737
"Parameter `task_id` is required when calling `get_task_v1`."
@@ -6707,6 +6754,7 @@ def get_task_v1(
67076754
request_options: Optional[Union[dict, RequestOptions]] = None,
67086755
) -> TaskV1:
67096756
"""
6757+
(Deprecated) get_task_v1
67106758
Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
67116759
67126760
Required API Key ACLs:
@@ -7980,6 +8028,7 @@ def list_tasks_v1_with_http_info(
79808028
request_options: Optional[Union[dict, RequestOptions]] = None,
79818029
) -> ApiResponse[str]:
79828030
"""
8031+
(Deprecated) list_tasks_v1
79838032
Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
79848033
79858034
Required API Key ACLs:
@@ -8009,6 +8058,8 @@ def list_tasks_v1_with_http_info(
80098058
:return: Returns the raw algoliasearch 'APIResponse' object.
80108059
"""
80118060

8061+
warn("GET /1/tasks is deprecated.", DeprecationWarning)
8062+
80128063
_query_parameters: Dict[str, Any] = {}
80138064

80148065
if items_per_page is not None:
@@ -8091,6 +8142,7 @@ def list_tasks_v1(
80918142
request_options: Optional[Union[dict, RequestOptions]] = None,
80928143
) -> ListTasksResponseV1:
80938144
"""
8145+
(Deprecated) list_tasks_v1
80948146
Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
80958147
80968148
Required API Key ACLs:
@@ -8518,6 +8570,7 @@ def run_task_v1_with_http_info(
85188570
request_options: Optional[Union[dict, RequestOptions]] = None,
85198571
) -> ApiResponse[str]:
85208572
"""
8573+
(Deprecated) run_task_v1
85218574
Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
85228575
85238576
Required API Key ACLs:
@@ -8531,6 +8584,8 @@ def run_task_v1_with_http_info(
85318584
:return: Returns the raw algoliasearch 'APIResponse' object.
85328585
"""
85338586

8587+
warn("POST /1/tasks/{taskID}/run is deprecated.", DeprecationWarning)
8588+
85348589
if task_id is None:
85358590
raise ValueError(
85368591
"Parameter `task_id` is required when calling `run_task_v1`."
@@ -8555,6 +8610,7 @@ def run_task_v1(
85558610
request_options: Optional[Union[dict, RequestOptions]] = None,
85568611
) -> RunResponse:
85578612
"""
8613+
(Deprecated) run_task_v1
85588614
Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
85598615
85608616
Required API Key ACLs:
@@ -8816,6 +8872,7 @@ def search_tasks_v1_with_http_info(
88168872
request_options: Optional[Union[dict, RequestOptions]] = None,
88178873
) -> ApiResponse[str]:
88188874
"""
8875+
(Deprecated) search_tasks_v1
88198876
Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
88208877
88218878
Required API Key ACLs:
@@ -8829,6 +8886,8 @@ def search_tasks_v1_with_http_info(
88298886
:return: Returns the raw algoliasearch 'APIResponse' object.
88308887
"""
88318888

8889+
warn("POST /1/tasks/search is deprecated.", DeprecationWarning)
8890+
88328891
if task_search is None:
88338892
raise ValueError(
88348893
"Parameter `task_search` is required when calling `search_tasks_v1`."
@@ -8854,6 +8913,7 @@ def search_tasks_v1(
88548913
request_options: Optional[Union[dict, RequestOptions]] = None,
88558914
) -> List[TaskV1]:
88568915
"""
8916+
(Deprecated) search_tasks_v1
88578917
Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
88588918
88598919
Required API Key ACLs:
@@ -9447,6 +9507,7 @@ def update_task_v1_with_http_info(
94479507
request_options: Optional[Union[dict, RequestOptions]] = None,
94489508
) -> ApiResponse[str]:
94499509
"""
9510+
(Deprecated) update_task_v1
94509511
Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
94519512
94529513
@@ -9458,6 +9519,8 @@ def update_task_v1_with_http_info(
94589519
:return: Returns the raw algoliasearch 'APIResponse' object.
94599520
"""
94609521

9522+
warn("PATCH /1/tasks/{taskID} is deprecated.", DeprecationWarning)
9523+
94619524
if task_id is None:
94629525
raise ValueError(
94639526
"Parameter `task_id` is required when calling `update_task_v1`."
@@ -9491,6 +9554,7 @@ def update_task_v1(
94919554
request_options: Optional[Union[dict, RequestOptions]] = None,
94929555
) -> TaskUpdateResponse:
94939556
"""
9557+
(Deprecated) update_task_v1
94949558
Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
94959559
94969560

0 commit comments

Comments
 (0)