Skip to content

Commit 1b559b4

Browse files
algolia-botmillotpshortcuts
committed
fix(specs): correct query params for ingestion [skip-bc] (generated)
algolia/api-clients-automation#3830 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]> Co-authored-by: shortcuts <[email protected]>
1 parent 0c0dbf8 commit 1b559b4

File tree

3 files changed

+31
-34
lines changed

3 files changed

+31
-34
lines changed

algoliasearch/Clients/IngestionClient.cs

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -900,8 +900,8 @@ public interface IIngestionClient
900900
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
901901
/// <param name="page">Page number of the paginated API response. (optional)</param>
902902
/// <param name="type">Type of authentication resource to retrieve. (optional)</param>
903-
/// <param name="platform">Ecommerce platform for which to retrieve authentication resources. (optional)</param>
904-
/// <param name="sort">Property by which to sort the list of authentication resources. (optional)</param>
903+
/// <param name="platform">Ecommerce platform for which to retrieve authentications. (optional)</param>
904+
/// <param name="sort">Property by which to sort the list of authentications. (optional)</param>
905905
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
906906
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
907907
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -922,8 +922,8 @@ public interface IIngestionClient
922922
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
923923
/// <param name="page">Page number of the paginated API response. (optional)</param>
924924
/// <param name="type">Type of authentication resource to retrieve. (optional)</param>
925-
/// <param name="platform">Ecommerce platform for which to retrieve authentication resources. (optional)</param>
926-
/// <param name="sort">Property by which to sort the list of authentication resources. (optional)</param>
925+
/// <param name="platform">Ecommerce platform for which to retrieve authentications. (optional)</param>
926+
/// <param name="sort">Property by which to sort the list of authentications. (optional)</param>
927927
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
928928
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
929929
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -945,6 +945,7 @@ public interface IIngestionClient
945945
/// <param name="page">Page number of the paginated API response. (optional)</param>
946946
/// <param name="type">Destination type. (optional)</param>
947947
/// <param name="authenticationID">Authentication ID used by destinations. (optional)</param>
948+
/// <param name="transformationID">Get the list of destinations used by a transformation. (optional)</param>
948949
/// <param name="sort">Property by which to sort the destinations. (optional)</param>
949950
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
950951
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -953,7 +954,7 @@ public interface IIngestionClient
953954
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
954955
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
955956
/// <returns>Task of ListDestinationsResponse</returns>
956-
Task<ListDestinationsResponse> ListDestinationsAsync(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
957+
Task<ListDestinationsResponse> ListDestinationsAsync(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
957958

958959
/// <summary>
959960
/// Retrieves a list of destinations. (Synchronous version)
@@ -967,6 +968,7 @@ public interface IIngestionClient
967968
/// <param name="page">Page number of the paginated API response. (optional)</param>
968969
/// <param name="type">Destination type. (optional)</param>
969970
/// <param name="authenticationID">Authentication ID used by destinations. (optional)</param>
971+
/// <param name="transformationID">Get the list of destinations used by a transformation. (optional)</param>
970972
/// <param name="sort">Property by which to sort the destinations. (optional)</param>
971973
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
972974
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -975,7 +977,7 @@ public interface IIngestionClient
975977
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
976978
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
977979
/// <returns>ListDestinationsResponse</returns>
978-
ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
980+
ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
979981

980982
/// <summary>
981983
/// Retrieves a list of events for a task run, identified by it's ID.
@@ -1088,7 +1090,7 @@ public interface IIngestionClient
10881090
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
10891091
/// <param name="page">Page number of the paginated API response. (optional)</param>
10901092
/// <param name="type">Source type. Some sources require authentication. (optional)</param>
1091-
/// <param name="authenticationID">Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication resource. (optional)</param>
1093+
/// <param name="authenticationID">Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)</param>
10921094
/// <param name="sort">Property by which to sort the list of sources. (optional)</param>
10931095
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
10941096
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -1110,7 +1112,7 @@ public interface IIngestionClient
11101112
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
11111113
/// <param name="page">Page number of the paginated API response. (optional)</param>
11121114
/// <param name="type">Source type. Some sources require authentication. (optional)</param>
1113-
/// <param name="authenticationID">Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication resource. (optional)</param>
1115+
/// <param name="authenticationID">Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)</param>
11141116
/// <param name="sort">Property by which to sort the list of sources. (optional)</param>
11151117
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
11161118
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -1231,15 +1233,15 @@ public interface IIngestionClient
12311233
/// - editSettings
12321234
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
12331235
/// <param name="page">Page number of the paginated API response. (optional)</param>
1234-
/// <param name="sort">Property by which to sort the list. (optional)</param>
1236+
/// <param name="sort">Property by which to sort the list of transformations. (optional)</param>
12351237
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
12361238
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
12371239
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
12381240
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
12391241
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12401242
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12411243
/// <returns>Task of ListTransformationsResponse</returns>
1242-
Task<ListTransformationsResponse> ListTransformationsAsync(int? itemsPerPage = default, int? page = default, SortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
1244+
Task<ListTransformationsResponse> ListTransformationsAsync(int? itemsPerPage = default, int? page = default, TransformationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12431245

12441246
/// <summary>
12451247
/// Retrieves a list of transformations. (Synchronous version)
@@ -1251,15 +1253,15 @@ public interface IIngestionClient
12511253
/// - editSettings
12521254
/// <param name="itemsPerPage">Number of items per page. (optional, default to 10)</param>
12531255
/// <param name="page">Page number of the paginated API response. (optional)</param>
1254-
/// <param name="sort">Property by which to sort the list. (optional)</param>
1256+
/// <param name="sort">Property by which to sort the list of transformations. (optional)</param>
12551257
/// <param name="order">Sort order of the response, ascending or descending. (optional)</param>
12561258
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
12571259
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
12581260
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
12591261
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
12601262
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
12611263
/// <returns>ListTransformationsResponse</returns>
1262-
ListTransformationsResponse ListTransformations(int? itemsPerPage = default, int? page = default, SortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
1264+
ListTransformationsResponse ListTransformations(int? itemsPerPage = default, int? page = default, TransformationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
12631265

12641266
/// <summary>
12651267
/// Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
@@ -2635,7 +2637,7 @@ public ListAuthenticationsResponse ListAuthentications(int? itemsPerPage = defau
26352637

26362638

26372639
/// <inheritdoc />
2638-
public async Task<ListDestinationsResponse> ListDestinationsAsync(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default)
2640+
public async Task<ListDestinationsResponse> ListDestinationsAsync(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default)
26392641
{
26402642
var requestOptions = new InternalRequestOptions(options);
26412643

@@ -2644,15 +2646,16 @@ public async Task<ListDestinationsResponse> ListDestinationsAsync(int? itemsPerP
26442646
requestOptions.AddQueryParameter("page", page);
26452647
requestOptions.AddQueryParameter("type", type);
26462648
requestOptions.AddQueryParameter("authenticationID", authenticationID);
2649+
requestOptions.AddQueryParameter("transformationID", transformationID);
26472650
requestOptions.AddQueryParameter("sort", sort);
26482651
requestOptions.AddQueryParameter("order", order);
26492652
return await _transport.ExecuteRequestAsync<ListDestinationsResponse>(new HttpMethod("GET"), "/1/destinations", requestOptions, cancellationToken).ConfigureAwait(false);
26502653
}
26512654

26522655

26532656
/// <inheritdoc />
2654-
public ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
2655-
AsyncHelper.RunSync(() => ListDestinationsAsync(itemsPerPage, page, type, authenticationID, sort, order, options, cancellationToken));
2657+
public ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
2658+
AsyncHelper.RunSync(() => ListDestinationsAsync(itemsPerPage, page, type, authenticationID, transformationID, sort, order, options, cancellationToken));
26562659

26572660

26582661
/// <inheritdoc />
@@ -2777,7 +2780,7 @@ public ListTasksResponseV1 ListTasksV1(int? itemsPerPage = default, int? page =
27772780

27782781

27792782
/// <inheritdoc />
2780-
public async Task<ListTransformationsResponse> ListTransformationsAsync(int? itemsPerPage = default, int? page = default, SortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default)
2783+
public async Task<ListTransformationsResponse> ListTransformationsAsync(int? itemsPerPage = default, int? page = default, TransformationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default)
27812784
{
27822785
var requestOptions = new InternalRequestOptions(options);
27832786

@@ -2791,7 +2794,7 @@ public async Task<ListTransformationsResponse> ListTransformationsAsync(int? ite
27912794

27922795

27932796
/// <inheritdoc />
2794-
public ListTransformationsResponse ListTransformations(int? itemsPerPage = default, int? page = default, SortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
2797+
public ListTransformationsResponse ListTransformations(int? itemsPerPage = default, int? page = default, TransformationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
27952798
AsyncHelper.RunSync(() => ListTransformationsAsync(itemsPerPage, page, sort, order, options, cancellationToken));
27962799

27972800

algoliasearch/Models/Ingestion/AuthenticationSortKeys.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
namespace Algolia.Search.Models.Ingestion;
1313

1414
/// <summary>
15-
/// Property by which to sort the list of authentication resources.
15+
/// Property by which to sort the list of authentications.
1616
/// </summary>
17-
/// <value>Property by which to sort the list of authentication resources.</value>
17+
/// <value>Property by which to sort the list of authentications.</value>
1818
[JsonConverter(typeof(Serializer.JsonStringEnumConverter<AuthenticationSortKeys>))]
1919
public enum AuthenticationSortKeys
2020
{
@@ -25,10 +25,10 @@ public enum AuthenticationSortKeys
2525
Name = 1,
2626

2727
/// <summary>
28-
/// Enum AuthType for value: auth_type
28+
/// Enum Type for value: type
2929
/// </summary>
30-
[JsonPropertyName("auth_type")]
31-
AuthType = 2,
30+
[JsonPropertyName("type")]
31+
Type = 2,
3232

3333
/// <summary>
3434
/// Enum Platform for value: platform

algoliasearch/Models/Ingestion/SortKeys.cs renamed to algoliasearch/Models/Ingestion/TransformationSortKeys.cs

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,28 @@
1212
namespace Algolia.Search.Models.Ingestion;
1313

1414
/// <summary>
15-
/// Property by which to sort the list.
15+
/// Property by which to sort the list of transformations.
1616
/// </summary>
17-
/// <value>Property by which to sort the list.</value>
18-
[JsonConverter(typeof(Serializer.JsonStringEnumConverter<SortKeys>))]
19-
public enum SortKeys
17+
/// <value>Property by which to sort the list of transformations.</value>
18+
[JsonConverter(typeof(Serializer.JsonStringEnumConverter<TransformationSortKeys>))]
19+
public enum TransformationSortKeys
2020
{
2121
/// <summary>
2222
/// Enum Name for value: name
2323
/// </summary>
2424
[JsonPropertyName("name")]
2525
Name = 1,
2626

27-
/// <summary>
28-
/// Enum Type for value: type
29-
/// </summary>
30-
[JsonPropertyName("type")]
31-
Type = 2,
32-
3327
/// <summary>
3428
/// Enum UpdatedAt for value: updatedAt
3529
/// </summary>
3630
[JsonPropertyName("updatedAt")]
37-
UpdatedAt = 3,
31+
UpdatedAt = 2,
3832

3933
/// <summary>
4034
/// Enum CreatedAt for value: createdAt
4135
/// </summary>
4236
[JsonPropertyName("createdAt")]
43-
CreatedAt = 4
37+
CreatedAt = 3
4438
}
4539

0 commit comments

Comments
 (0)