Skip to content

Commit 0c9a4ea

Browse files
algolia-botkai687shortcuts
committed
chore: deprecate mcm methods (generated)
algolia/api-clients-automation#4694 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: shortcuts <[email protected]>
1 parent f39b186 commit 0c9a4ea

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

algoliasearch/Clients/SearchClient.cs

+36
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ public partial interface ISearchClient
129129
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
130130
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
131131
/// <returns>Task of CreatedAtResponse</returns>
132+
[Obsolete]
132133
Task<CreatedAtResponse> AssignUserIdAsync(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default);
133134

134135
/// <summary>
@@ -145,6 +146,7 @@ public partial interface ISearchClient
145146
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
146147
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
147148
/// <returns>CreatedAtResponse</returns>
149+
[Obsolete]
148150
CreatedAtResponse AssignUserId(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default);
149151

150152
/// <summary>
@@ -187,6 +189,7 @@ public partial interface ISearchClient
187189
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
188190
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
189191
/// <returns>Task of CreatedAtResponse</returns>
192+
[Obsolete]
190193
Task<CreatedAtResponse> BatchAssignUserIdsAsync(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
191194

192195
/// <summary>
@@ -203,6 +206,7 @@ public partial interface ISearchClient
203206
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
204207
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
205208
/// <returns>CreatedAtResponse</returns>
209+
[Obsolete]
206210
CreatedAtResponse BatchAssignUserIds(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
207211

208212
/// <summary>
@@ -1069,6 +1073,7 @@ public partial interface ISearchClient
10691073
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
10701074
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
10711075
/// <returns>Task of GetTopUserIdsResponse</returns>
1076+
[Obsolete]
10721077
Task<GetTopUserIdsResponse> GetTopUserIdsAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
10731078

10741079
/// <summary>
@@ -1083,6 +1088,7 @@ public partial interface ISearchClient
10831088
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
10841089
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
10851090
/// <returns>GetTopUserIdsResponse</returns>
1091+
[Obsolete]
10861092
GetTopUserIdsResponse GetTopUserIds(RequestOptions options = null, CancellationToken cancellationToken = default);
10871093

10881094
/// <summary>
@@ -1098,6 +1104,7 @@ public partial interface ISearchClient
10981104
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
10991105
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
11001106
/// <returns>Task of UserId</returns>
1107+
[Obsolete]
11011108
Task<UserId> GetUserIdAsync(string userID, RequestOptions options = null, CancellationToken cancellationToken = default);
11021109

11031110
/// <summary>
@@ -1113,6 +1120,7 @@ public partial interface ISearchClient
11131120
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
11141121
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
11151122
/// <returns>UserId</returns>
1123+
[Obsolete]
11161124
UserId GetUserId(string userID, RequestOptions options = null, CancellationToken cancellationToken = default);
11171125

11181126
/// <summary>
@@ -1128,6 +1136,7 @@ public partial interface ISearchClient
11281136
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
11291137
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
11301138
/// <returns>Task of HasPendingMappingsResponse</returns>
1139+
[Obsolete]
11311140
Task<HasPendingMappingsResponse> HasPendingMappingsAsync(bool? getClusters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
11321141

11331142
/// <summary>
@@ -1143,6 +1152,7 @@ public partial interface ISearchClient
11431152
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
11441153
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
11451154
/// <returns>HasPendingMappingsResponse</returns>
1155+
[Obsolete]
11461156
HasPendingMappingsResponse HasPendingMappings(bool? getClusters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
11471157

11481158
/// <summary>
@@ -1185,6 +1195,7 @@ public partial interface ISearchClient
11851195
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
11861196
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
11871197
/// <returns>Task of ListClustersResponse</returns>
1198+
[Obsolete]
11881199
Task<ListClustersResponse> ListClustersAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
11891200

11901201
/// <summary>
@@ -1199,6 +1210,7 @@ public partial interface ISearchClient
11991210
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12001211
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12011212
/// <returns>ListClustersResponse</returns>
1213+
[Obsolete]
12021214
ListClustersResponse ListClusters(RequestOptions options = null, CancellationToken cancellationToken = default);
12031215

12041216
/// <summary>
@@ -1247,6 +1259,7 @@ public partial interface ISearchClient
12471259
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12481260
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12491261
/// <returns>Task of ListUserIdsResponse</returns>
1262+
[Obsolete]
12501263
Task<ListUserIdsResponse> ListUserIdsAsync(int? page = default, int? hitsPerPage = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12511264

12521265
/// <summary>
@@ -1263,6 +1276,7 @@ public partial interface ISearchClient
12631276
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12641277
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12651278
/// <returns>ListUserIdsResponse</returns>
1279+
[Obsolete]
12661280
ListUserIdsResponse ListUserIds(int? page = default, int? hitsPerPage = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12671281

12681282
/// <summary>
@@ -1370,6 +1384,7 @@ public partial interface ISearchClient
13701384
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
13711385
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
13721386
/// <returns>Task of RemoveUserIdResponse</returns>
1387+
[Obsolete]
13731388
Task<RemoveUserIdResponse> RemoveUserIdAsync(string userID, RequestOptions options = null, CancellationToken cancellationToken = default);
13741389

13751390
/// <summary>
@@ -1385,6 +1400,7 @@ public partial interface ISearchClient
13851400
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
13861401
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
13871402
/// <returns>RemoveUserIdResponse</returns>
1403+
[Obsolete]
13881404
RemoveUserIdResponse RemoveUserId(string userID, RequestOptions options = null, CancellationToken cancellationToken = default);
13891405

13901406
/// <summary>
@@ -1828,6 +1844,7 @@ public partial interface ISearchClient
18281844
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
18291845
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
18301846
/// <returns>Task of SearchUserIdsResponse</returns>
1847+
[Obsolete]
18311848
Task<SearchUserIdsResponse> SearchUserIdsAsync(SearchUserIdsParams searchUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
18321849

18331850
/// <summary>
@@ -1843,6 +1860,7 @@ public partial interface ISearchClient
18431860
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
18441861
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
18451862
/// <returns>SearchUserIdsResponse</returns>
1863+
[Obsolete]
18461864
SearchUserIdsResponse SearchUserIds(SearchUserIdsParams searchUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
18471865

18481866
/// <summary>
@@ -2091,6 +2109,7 @@ public CreatedAtResponse AppendSource(Source source, RequestOptions options = nu
20912109

20922110

20932111
/// <inheritdoc />
2112+
[Obsolete]
20942113
public async Task<CreatedAtResponse> AssignUserIdAsync(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default)
20952114
{
20962115

@@ -2111,6 +2130,7 @@ public async Task<CreatedAtResponse> AssignUserIdAsync(string xAlgoliaUserID, As
21112130

21122131

21132132
/// <inheritdoc />
2133+
[Obsolete]
21142134
public CreatedAtResponse AssignUserId(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default) =>
21152135
AsyncHelper.RunSync(() => AssignUserIdAsync(xAlgoliaUserID, assignUserIdParams, options, cancellationToken));
21162136

@@ -2141,6 +2161,7 @@ public BatchResponse Batch(string indexName, BatchWriteParams batchWriteParams,
21412161

21422162

21432163
/// <inheritdoc />
2164+
[Obsolete]
21442165
public async Task<CreatedAtResponse> BatchAssignUserIdsAsync(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default)
21452166
{
21462167

@@ -2161,6 +2182,7 @@ public async Task<CreatedAtResponse> BatchAssignUserIdsAsync(string xAlgoliaUser
21612182

21622183

21632184
/// <inheritdoc />
2185+
[Obsolete]
21642186
public CreatedAtResponse BatchAssignUserIds(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default) =>
21652187
AsyncHelper.RunSync(() => BatchAssignUserIdsAsync(xAlgoliaUserID, batchAssignUserIdsParams, options, cancellationToken));
21662188

@@ -2756,6 +2778,7 @@ public GetTaskResponse GetTask(string indexName, long taskID, RequestOptions opt
27562778

27572779

27582780
/// <inheritdoc />
2781+
[Obsolete]
27592782
public async Task<GetTopUserIdsResponse> GetTopUserIdsAsync(RequestOptions options = null, CancellationToken cancellationToken = default)
27602783
{
27612784
var requestOptions = new InternalRequestOptions(options);
@@ -2766,11 +2789,13 @@ public async Task<GetTopUserIdsResponse> GetTopUserIdsAsync(RequestOptions optio
27662789

27672790

27682791
/// <inheritdoc />
2792+
[Obsolete]
27692793
public GetTopUserIdsResponse GetTopUserIds(RequestOptions options = null, CancellationToken cancellationToken = default) =>
27702794
AsyncHelper.RunSync(() => GetTopUserIdsAsync(options, cancellationToken));
27712795

27722796

27732797
/// <inheritdoc />
2798+
[Obsolete]
27742799
public async Task<UserId> GetUserIdAsync(string userID, RequestOptions options = null, CancellationToken cancellationToken = default)
27752800
{
27762801

@@ -2786,11 +2811,13 @@ public async Task<UserId> GetUserIdAsync(string userID, RequestOptions options =
27862811

27872812

27882813
/// <inheritdoc />
2814+
[Obsolete]
27892815
public UserId GetUserId(string userID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
27902816
AsyncHelper.RunSync(() => GetUserIdAsync(userID, options, cancellationToken));
27912817

27922818

27932819
/// <inheritdoc />
2820+
[Obsolete]
27942821
public async Task<HasPendingMappingsResponse> HasPendingMappingsAsync(bool? getClusters = default, RequestOptions options = null, CancellationToken cancellationToken = default)
27952822
{
27962823
var requestOptions = new InternalRequestOptions(options);
@@ -2802,6 +2829,7 @@ public async Task<HasPendingMappingsResponse> HasPendingMappingsAsync(bool? getC
28022829

28032830

28042831
/// <inheritdoc />
2832+
[Obsolete]
28052833
public HasPendingMappingsResponse HasPendingMappings(bool? getClusters = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
28062834
AsyncHelper.RunSync(() => HasPendingMappingsAsync(getClusters, options, cancellationToken));
28072835

@@ -2822,6 +2850,7 @@ public ListApiKeysResponse ListApiKeys(RequestOptions options = null, Cancellati
28222850

28232851

28242852
/// <inheritdoc />
2853+
[Obsolete]
28252854
public async Task<ListClustersResponse> ListClustersAsync(RequestOptions options = null, CancellationToken cancellationToken = default)
28262855
{
28272856
var requestOptions = new InternalRequestOptions(options);
@@ -2832,6 +2861,7 @@ public async Task<ListClustersResponse> ListClustersAsync(RequestOptions options
28322861

28332862

28342863
/// <inheritdoc />
2864+
[Obsolete]
28352865
public ListClustersResponse ListClusters(RequestOptions options = null, CancellationToken cancellationToken = default) =>
28362866
AsyncHelper.RunSync(() => ListClustersAsync(options, cancellationToken));
28372867

@@ -2854,6 +2884,7 @@ public ListIndicesResponse ListIndices(int? page = default, int? hitsPerPage = d
28542884

28552885

28562886
/// <inheritdoc />
2887+
[Obsolete]
28572888
public async Task<ListUserIdsResponse> ListUserIdsAsync(int? page = default, int? hitsPerPage = default, RequestOptions options = null, CancellationToken cancellationToken = default)
28582889
{
28592890
var requestOptions = new InternalRequestOptions(options);
@@ -2866,6 +2897,7 @@ public async Task<ListUserIdsResponse> ListUserIdsAsync(int? page = default, int
28662897

28672898

28682899
/// <inheritdoc />
2900+
[Obsolete]
28692901
public ListUserIdsResponse ListUserIds(int? page = default, int? hitsPerPage = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
28702902
AsyncHelper.RunSync(() => ListUserIdsAsync(page, hitsPerPage, options, cancellationToken));
28712903

@@ -2947,6 +2979,7 @@ public UpdatedAtWithObjectIdResponse PartialUpdateObject(string indexName, strin
29472979

29482980

29492981
/// <inheritdoc />
2982+
[Obsolete]
29502983
public async Task<RemoveUserIdResponse> RemoveUserIdAsync(string userID, RequestOptions options = null, CancellationToken cancellationToken = default)
29512984
{
29522985

@@ -2962,6 +2995,7 @@ public async Task<RemoveUserIdResponse> RemoveUserIdAsync(string userID, Request
29622995

29632996

29642997
/// <inheritdoc />
2998+
[Obsolete]
29652999
public RemoveUserIdResponse RemoveUserId(string userID, RequestOptions options = null, CancellationToken cancellationToken = default) =>
29663000
AsyncHelper.RunSync(() => RemoveUserIdAsync(userID, options, cancellationToken));
29673001

@@ -3285,6 +3319,7 @@ public SearchSynonymsResponse SearchSynonyms(string indexName, SearchSynonymsPar
32853319

32863320

32873321
/// <inheritdoc />
3322+
[Obsolete]
32883323
public async Task<SearchUserIdsResponse> SearchUserIdsAsync(SearchUserIdsParams searchUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default)
32893324
{
32903325

@@ -3301,6 +3336,7 @@ public async Task<SearchUserIdsResponse> SearchUserIdsAsync(SearchUserIdsParams
33013336

33023337

33033338
/// <inheritdoc />
3339+
[Obsolete]
33043340
public SearchUserIdsResponse SearchUserIds(SearchUserIdsParams searchUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default) =>
33053341
AsyncHelper.RunSync(() => SearchUserIdsAsync(searchUserIdsParams, options, cancellationToken));
33063342

0 commit comments

Comments
 (0)