Skip to content

Commit 004be40

Browse files
algolia-botmillotp
andcommitted
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 81eace1 commit 004be40

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

algoliasearch/Clients/IngestionClient.cs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ public interface IIngestionClient
157157
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
158158
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
159159
/// <returns>Task of TaskCreateResponse</returns>
160+
[Obsolete]
160161
Task<TaskCreateResponse> CreateTaskV1Async(TaskCreateV1 taskCreate, RequestOptions options = null, CancellationToken cancellationToken = default);
161162

162163
/// <summary>
@@ -169,6 +170,7 @@ public interface IIngestionClient
169170
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
170171
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
171172
/// <returns>TaskCreateResponse</returns>
173+
[Obsolete]
172174
TaskCreateResponse CreateTaskV1(TaskCreateV1 taskCreate, RequestOptions options = null, CancellationToken cancellationToken = default);
173175

174176
/// <summary>
@@ -439,6 +441,7 @@ public interface IIngestionClient
439441
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
440442
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
441443
/// <returns>Task of DeleteResponse</returns>
444+
[Obsolete]
442445
Task<DeleteResponse> DeleteTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
443446

444447
/// <summary>
@@ -451,6 +454,7 @@ public interface IIngestionClient
451454
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
452455
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
453456
/// <returns>DeleteResponse</returns>
457+
[Obsolete]
454458
DeleteResponse DeleteTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
455459

456460
/// <summary>
@@ -596,6 +600,7 @@ public interface IIngestionClient
596600
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
597601
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
598602
/// <returns>Task of TaskUpdateResponse</returns>
603+
[Obsolete]
599604
Task<TaskUpdateResponse> EnableTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
600605

601606
/// <summary>
@@ -613,6 +618,7 @@ public interface IIngestionClient
613618
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
614619
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
615620
/// <returns>TaskUpdateResponse</returns>
621+
[Obsolete]
616622
TaskUpdateResponse EnableTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
617623

618624
/// <summary>
@@ -836,6 +842,7 @@ public interface IIngestionClient
836842
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
837843
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
838844
/// <returns>Task of TaskV1</returns>
845+
[Obsolete]
839846
Task<TaskV1> GetTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
840847

841848
/// <summary>
@@ -853,6 +860,7 @@ public interface IIngestionClient
853860
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
854861
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
855862
/// <returns>TaskV1</returns>
863+
[Obsolete]
856864
TaskV1 GetTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
857865

858866
/// <summary>
@@ -1200,6 +1208,7 @@ public interface IIngestionClient
12001208
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12011209
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12021210
/// <returns>Task of ListTasksResponseV1</returns>
1211+
[Obsolete]
12031212
Task<ListTasksResponseV1> ListTasksV1Async(int? itemsPerPage = default, int? page = default, List<ActionType> action = default, bool? enabled = default, List<string> sourceID = default, List<string> destinationID = default, List<TriggerType> triggerType = default, TaskSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12041213

12051214
/// <summary>
@@ -1225,6 +1234,7 @@ public interface IIngestionClient
12251234
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12261235
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12271236
/// <returns>ListTasksResponseV1</returns>
1237+
[Obsolete]
12281238
ListTasksResponseV1 ListTasksV1(int? itemsPerPage = default, int? page = default, List<ActionType> action = default, bool? enabled = default, List<string> sourceID = default, List<string> destinationID = default, List<TriggerType> triggerType = default, TaskSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12291239

12301240
/// <summary>
@@ -1390,6 +1400,7 @@ public interface IIngestionClient
13901400
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
13911401
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
13921402
/// <returns>Task of RunResponse</returns>
1403+
[Obsolete]
13931404
Task<RunResponse> RunTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
13941405

13951406
/// <summary>
@@ -1407,6 +1418,7 @@ public interface IIngestionClient
14071418
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
14081419
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
14091420
/// <returns>RunResponse</returns>
1421+
[Obsolete]
14101422
RunResponse RunTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default);
14111423

14121424
/// <summary>
@@ -1560,6 +1572,7 @@ public interface IIngestionClient
15601572
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
15611573
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
15621574
/// <returns>Task of List{TaskV1}</returns>
1575+
[Obsolete]
15631576
Task<List<TaskV1>> SearchTasksV1Async(TaskSearch taskSearch, RequestOptions options = null, CancellationToken cancellationToken = default);
15641577

15651578
/// <summary>
@@ -1577,6 +1590,7 @@ public interface IIngestionClient
15771590
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
15781591
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
15791592
/// <returns>List{TaskV1}</returns>
1593+
[Obsolete]
15801594
List<TaskV1> SearchTasksV1(TaskSearch taskSearch, RequestOptions options = null, CancellationToken cancellationToken = default);
15811595

15821596
/// <summary>
@@ -1862,6 +1876,7 @@ public interface IIngestionClient
18621876
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
18631877
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
18641878
/// <returns>Task of TaskUpdateResponse</returns>
1879+
[Obsolete]
18651880
Task<TaskUpdateResponse> UpdateTaskV1Async(string taskID, TaskUpdateV1 taskUpdate, RequestOptions options = null, CancellationToken cancellationToken = default);
18661881

18671882
/// <summary>
@@ -1875,6 +1890,7 @@ public interface IIngestionClient
18751890
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
18761891
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
18771892
/// <returns>TaskUpdateResponse</returns>
1893+
[Obsolete]
18781894
TaskUpdateResponse UpdateTaskV1(string taskID, TaskUpdateV1 taskUpdate, RequestOptions options = null, CancellationToken cancellationToken = default);
18791895

18801896
/// <summary>
@@ -2133,6 +2149,7 @@ public TaskCreateResponse CreateTask(TaskCreate taskCreate, RequestOptions optio
21332149

21342150

21352151
/// <inheritdoc />
2152+
[Obsolete]
21362153
public async Task<TaskCreateResponse> CreateTaskV1Async(TaskCreateV1 taskCreate, RequestOptions options = null, CancellationToken cancellationToken = default)
21372154
{
21382155

@@ -2148,6 +2165,7 @@ public async Task<TaskCreateResponse> CreateTaskV1Async(TaskCreateV1 taskCreate,
21482165

21492166

21502167
/// <inheritdoc />
2168+
[Obsolete]
21512169
public TaskCreateResponse CreateTaskV1(TaskCreateV1 taskCreate, RequestOptions options = null, CancellationToken cancellationToken = default) =>
21522170
AsyncHelper.RunSync(() => CreateTaskV1Async(taskCreate, options, cancellationToken));
21532171

@@ -2335,6 +2353,7 @@ public DeleteResponse DeleteTask(string taskID, RequestOptions options = null, C
23352353

23362354

23372355
/// <inheritdoc />
2356+
[Obsolete]
23382357
public async Task<DeleteResponse> DeleteTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default)
23392358
{
23402359

@@ -2350,6 +2369,7 @@ public async Task<DeleteResponse> DeleteTaskV1Async(string taskID, RequestOption
23502369

23512370

23522371
/// <inheritdoc />
2372+
[Obsolete]
23532373
public DeleteResponse DeleteTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
23542374
AsyncHelper.RunSync(() => DeleteTaskV1Async(taskID, options, cancellationToken));
23552375

@@ -2437,6 +2457,7 @@ public TaskUpdateResponse EnableTask(string taskID, RequestOptions options = nul
24372457

24382458

24392459
/// <inheritdoc />
2460+
[Obsolete]
24402461
public async Task<TaskUpdateResponse> EnableTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default)
24412462
{
24422463

@@ -2452,6 +2473,7 @@ public async Task<TaskUpdateResponse> EnableTaskV1Async(string taskID, RequestOp
24522473

24532474

24542475
/// <inheritdoc />
2476+
[Obsolete]
24552477
public TaskUpdateResponse EnableTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
24562478
AsyncHelper.RunSync(() => EnableTaskV1Async(taskID, options, cancellationToken));
24572479

@@ -2582,6 +2604,7 @@ public IngestionTask GetTask(string taskID, RequestOptions options = null, Cance
25822604

25832605

25842606
/// <inheritdoc />
2607+
[Obsolete]
25852608
public async Task<TaskV1> GetTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default)
25862609
{
25872610

@@ -2597,6 +2620,7 @@ public async Task<TaskV1> GetTaskV1Async(string taskID, RequestOptions options =
25972620

25982621

25992622
/// <inheritdoc />
2623+
[Obsolete]
26002624
public TaskV1 GetTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
26012625
AsyncHelper.RunSync(() => GetTaskV1Async(taskID, options, cancellationToken));
26022626

@@ -2764,6 +2788,7 @@ public ListTasksResponse ListTasks(int? itemsPerPage = default, int? page = defa
27642788

27652789

27662790
/// <inheritdoc />
2791+
[Obsolete]
27672792
public async Task<ListTasksResponseV1> ListTasksV1Async(int? itemsPerPage = default, int? page = default, List<ActionType> action = default, bool? enabled = default, List<string> sourceID = default, List<string> destinationID = default, List<TriggerType> triggerType = default, TaskSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default)
27682793
{
27692794
var requestOptions = new InternalRequestOptions(options);
@@ -2783,6 +2808,7 @@ public async Task<ListTasksResponseV1> ListTasksV1Async(int? itemsPerPage = defa
27832808

27842809

27852810
/// <inheritdoc />
2811+
[Obsolete]
27862812
public ListTasksResponseV1 ListTasksV1(int? itemsPerPage = default, int? page = default, List<ActionType> action = default, bool? enabled = default, List<string> sourceID = default, List<string> destinationID = default, List<TriggerType> triggerType = default, TaskSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
27872813
AsyncHelper.RunSync(() => ListTasksV1Async(itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, options, cancellationToken));
27882814

@@ -2877,6 +2903,7 @@ public RunResponse RunTask(string taskID, RequestOptions options = null, Cancell
28772903

28782904

28792905
/// <inheritdoc />
2906+
[Obsolete]
28802907
public async Task<RunResponse> RunTaskV1Async(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default)
28812908
{
28822909

@@ -2892,6 +2919,7 @@ public async Task<RunResponse> RunTaskV1Async(string taskID, RequestOptions opti
28922919

28932920

28942921
/// <inheritdoc />
2922+
[Obsolete]
28952923
public RunResponse RunTaskV1(string taskID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
28962924
AsyncHelper.RunSync(() => RunTaskV1Async(taskID, options, cancellationToken));
28972925

@@ -2977,6 +3005,7 @@ public List<IngestionTask> SearchTasks(TaskSearch taskSearch, RequestOptions opt
29773005

29783006

29793007
/// <inheritdoc />
3008+
[Obsolete]
29803009
public async Task<List<TaskV1>> SearchTasksV1Async(TaskSearch taskSearch, RequestOptions options = null, CancellationToken cancellationToken = default)
29813010
{
29823011

@@ -2992,6 +3021,7 @@ public async Task<List<TaskV1>> SearchTasksV1Async(TaskSearch taskSearch, Reques
29923021

29933022

29943023
/// <inheritdoc />
3024+
[Obsolete]
29953025
public List<TaskV1> SearchTasksV1(TaskSearch taskSearch, RequestOptions options = null, CancellationToken cancellationToken = default) =>
29963026
AsyncHelper.RunSync(() => SearchTasksV1Async(taskSearch, options, cancellationToken));
29973027

@@ -3185,6 +3215,7 @@ public TaskUpdateResponse UpdateTask(string taskID, TaskUpdate taskUpdate, Reque
31853215

31863216

31873217
/// <inheritdoc />
3218+
[Obsolete]
31883219
public async Task<TaskUpdateResponse> UpdateTaskV1Async(string taskID, TaskUpdateV1 taskUpdate, RequestOptions options = null, CancellationToken cancellationToken = default)
31893220
{
31903221

@@ -3205,6 +3236,7 @@ public async Task<TaskUpdateResponse> UpdateTaskV1Async(string taskID, TaskUpdat
32053236

32063237

32073238
/// <inheritdoc />
3239+
[Obsolete]
32083240
public TaskUpdateResponse UpdateTaskV1(string taskID, TaskUpdateV1 taskUpdate, RequestOptions options = null, CancellationToken cancellationToken = default) =>
32093241
AsyncHelper.RunSync(() => UpdateTaskV1Async(taskID, taskUpdate, options, cancellationToken));
32103242

0 commit comments

Comments
 (0)