Skip to content

Commit 2e5b18c

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 aa60809 commit 2e5b18c

File tree

1 file changed

+90
-74
lines changed

1 file changed

+90
-74
lines changed

‎Sources/Ingestion/IngestionClient.swift

Lines changed: 90 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ open class IngestionClient {
235235

236236
/// - parameter taskCreate: (body) Request body for creating a task.
237237
/// - returns: TaskCreateResponse
238+
@available(*, deprecated, message: "This operation is deprecated.")
238239
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
239240
open func createTaskV1(
240241
taskCreate: TaskCreateV1,
@@ -252,11 +253,12 @@ open class IngestionClient {
252253
return body
253254
}
254255

255-
// Creates a new task using the v1 endpoint, please use `createTask` instead.
256-
//
257-
//
258-
// - parameter taskCreate: (body) Request body for creating a task.
259-
// - returns: RequestBuilder<TaskCreateResponse>
256+
/// Creates a new task using the v1 endpoint, please use `createTask` instead.
257+
///
258+
///
259+
/// - parameter taskCreate: (body) Request body for creating a task.
260+
/// - returns: RequestBuilder<TaskCreateResponse>
261+
@available(*, deprecated, message: "This operation is deprecated.")
260262

261263
open func createTaskV1WithHTTPInfo(
262264
taskCreate: TaskCreateV1,
@@ -851,6 +853,7 @@ open class IngestionClient {
851853

852854
/// - parameter taskID: (path) Unique identifier of a task.
853855
/// - returns: DeleteResponse
856+
@available(*, deprecated, message: "This operation is deprecated.")
854857
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
855858
open func deleteTaskV1(taskID: String, requestOptions: RequestOptions? = nil) async throws -> DeleteResponse {
856859
let response: Response<DeleteResponse> = try await deleteTaskV1WithHTTPInfo(
@@ -865,11 +868,12 @@ open class IngestionClient {
865868
return body
866869
}
867870

868-
// Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
869-
//
870-
//
871-
// - parameter taskID: (path) Unique identifier of a task.
872-
// - returns: RequestBuilder<DeleteResponse>
871+
/// Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
872+
///
873+
///
874+
/// - parameter taskID: (path) Unique identifier of a task.
875+
/// - returns: RequestBuilder<DeleteResponse>
876+
@available(*, deprecated, message: "This operation is deprecated.")
873877

874878
open func deleteTaskV1WithHTTPInfo(
875879
taskID: String,
@@ -1155,6 +1159,7 @@ open class IngestionClient {
11551159

11561160
/// - parameter taskID: (path) Unique identifier of a task.
11571161
/// - returns: TaskUpdateResponse
1162+
@available(*, deprecated, message: "This operation is deprecated.")
11581163
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
11591164
open func enableTaskV1(taskID: String, requestOptions: RequestOptions? = nil) async throws -> TaskUpdateResponse {
11601165
let response: Response<TaskUpdateResponse> = try await enableTaskV1WithHTTPInfo(
@@ -1169,14 +1174,15 @@ open class IngestionClient {
11691174
return body
11701175
}
11711176

1172-
// Enables a task using the v1 endpoint, please use `enableTask` instead.
1173-
// Required API Key ACLs:
1174-
// - addObject
1175-
// - deleteIndex
1176-
// - editSettings
1177-
//
1178-
// - parameter taskID: (path) Unique identifier of a task.
1179-
// - returns: RequestBuilder<TaskUpdateResponse>
1177+
/// Enables a task using the v1 endpoint, please use `enableTask` instead.
1178+
/// Required API Key ACLs:
1179+
/// - addObject
1180+
/// - deleteIndex
1181+
/// - editSettings
1182+
///
1183+
/// - parameter taskID: (path) Unique identifier of a task.
1184+
/// - returns: RequestBuilder<TaskUpdateResponse>
1185+
@available(*, deprecated, message: "This operation is deprecated.")
11801186

11811187
open func enableTaskV1WithHTTPInfo(
11821188
taskID: String,
@@ -1598,6 +1604,7 @@ open class IngestionClient {
15981604

15991605
/// - parameter taskID: (path) Unique identifier of a task.
16001606
/// - returns: TaskV1
1607+
@available(*, deprecated, message: "This operation is deprecated.")
16011608
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
16021609
open func getTaskV1(taskID: String, requestOptions: RequestOptions? = nil) async throws -> TaskV1 {
16031610
let response: Response<TaskV1> = try await getTaskV1WithHTTPInfo(taskID: taskID, requestOptions: requestOptions)
@@ -1609,14 +1616,15 @@ open class IngestionClient {
16091616
return body
16101617
}
16111618

1612-
// Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
1613-
// Required API Key ACLs:
1614-
// - addObject
1615-
// - deleteIndex
1616-
// - editSettings
1617-
//
1618-
// - parameter taskID: (path) Unique identifier of a task.
1619-
// - returns: RequestBuilder<TaskV1>
1619+
/// Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
1620+
/// Required API Key ACLs:
1621+
/// - addObject
1622+
/// - deleteIndex
1623+
/// - editSettings
1624+
///
1625+
/// - parameter taskID: (path) Unique identifier of a task.
1626+
/// - returns: RequestBuilder<TaskV1>
1627+
@available(*, deprecated, message: "This operation is deprecated.")
16201628

16211629
open func getTaskV1WithHTTPInfo(
16221630
taskID: String,
@@ -2363,6 +2371,7 @@ open class IngestionClient {
23632371
/// - parameter sort: (query) Property by which to sort the list of tasks. (optional)
23642372
/// - parameter order: (query) Sort order of the response, ascending or descending. (optional)
23652373
/// - returns: ListTasksResponseV1
2374+
@available(*, deprecated, message: "This operation is deprecated.")
23662375
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
23672376
open func listTasksV1(
23682377
itemsPerPage: Int? = nil,
@@ -2396,30 +2405,31 @@ open class IngestionClient {
23962405
return body
23972406
}
23982407

2399-
// Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
2400-
// Required API Key ACLs:
2401-
// - addObject
2402-
// - deleteIndex
2403-
// - editSettings
2404-
//
2405-
// - parameter itemsPerPage: (query) Number of items per page. (optional, default to 10)
2406-
//
2407-
// - parameter page: (query) Page number of the paginated API response. (optional)
2408-
//
2409-
// - parameter action: (query) Actions for filtering the list of tasks. (optional)
2410-
//
2411-
// - parameter enabled: (query) Whether to filter the list of tasks by the `enabled` status. (optional)
2412-
//
2413-
// - parameter sourceID: (query) Source IDs for filtering the list of tasks. (optional)
2414-
//
2415-
// - parameter destinationID: (query) Destination IDs for filtering the list of tasks. (optional)
2416-
//
2417-
// - parameter triggerType: (query) Type of task trigger for filtering the list of tasks. (optional)
2418-
//
2419-
// - parameter sort: (query) Property by which to sort the list of tasks. (optional)
2420-
//
2421-
// - parameter order: (query) Sort order of the response, ascending or descending. (optional)
2422-
// - returns: RequestBuilder<ListTasksResponseV1>
2408+
/// Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
2409+
/// Required API Key ACLs:
2410+
/// - addObject
2411+
/// - deleteIndex
2412+
/// - editSettings
2413+
///
2414+
/// - parameter itemsPerPage: (query) Number of items per page. (optional, default to 10)
2415+
///
2416+
/// - parameter page: (query) Page number of the paginated API response. (optional)
2417+
///
2418+
/// - parameter action: (query) Actions for filtering the list of tasks. (optional)
2419+
///
2420+
/// - parameter enabled: (query) Whether to filter the list of tasks by the `enabled` status. (optional)
2421+
///
2422+
/// - parameter sourceID: (query) Source IDs for filtering the list of tasks. (optional)
2423+
///
2424+
/// - parameter destinationID: (query) Destination IDs for filtering the list of tasks. (optional)
2425+
///
2426+
/// - parameter triggerType: (query) Type of task trigger for filtering the list of tasks. (optional)
2427+
///
2428+
/// - parameter sort: (query) Property by which to sort the list of tasks. (optional)
2429+
///
2430+
/// - parameter order: (query) Sort order of the response, ascending or descending. (optional)
2431+
/// - returns: RequestBuilder<ListTasksResponseV1>
2432+
@available(*, deprecated, message: "This operation is deprecated.")
24232433

24242434
open func listTasksV1WithHTTPInfo(
24252435
itemsPerPage: Int? = nil,
@@ -2754,6 +2764,7 @@ open class IngestionClient {
27542764

27552765
/// - parameter taskID: (path) Unique identifier of a task.
27562766
/// - returns: RunResponse
2767+
@available(*, deprecated, message: "This operation is deprecated.")
27572768
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
27582769
open func runTaskV1(taskID: String, requestOptions: RequestOptions? = nil) async throws -> RunResponse {
27592770
let response: Response<RunResponse> = try await runTaskV1WithHTTPInfo(
@@ -2768,15 +2779,16 @@ open class IngestionClient {
27682779
return body
27692780
}
27702781

2771-
// Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the
2772-
// observability endpoints.
2773-
// Required API Key ACLs:
2774-
// - addObject
2775-
// - deleteIndex
2776-
// - editSettings
2777-
//
2778-
// - parameter taskID: (path) Unique identifier of a task.
2779-
// - returns: RequestBuilder<RunResponse>
2782+
/// Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the
2783+
/// observability endpoints.
2784+
/// Required API Key ACLs:
2785+
/// - addObject
2786+
/// - deleteIndex
2787+
/// - editSettings
2788+
///
2789+
/// - parameter taskID: (path) Unique identifier of a task.
2790+
/// - returns: RequestBuilder<RunResponse>
2791+
@available(*, deprecated, message: "This operation is deprecated.")
27802792

27812793
open func runTaskV1WithHTTPInfo(
27822794
taskID: String,
@@ -3020,6 +3032,7 @@ open class IngestionClient {
30203032

30213033
/// - parameter taskSearch: (body)
30223034
/// - returns: [TaskV1]
3035+
@available(*, deprecated, message: "This operation is deprecated.")
30233036
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
30243037
open func searchTasksV1(taskSearch: TaskSearch, requestOptions: RequestOptions? = nil) async throws -> [TaskV1] {
30253038
let response: Response<[TaskV1]> = try await searchTasksV1WithHTTPInfo(
@@ -3034,14 +3047,15 @@ open class IngestionClient {
30343047
return body
30353048
}
30363049

3037-
// Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
3038-
// Required API Key ACLs:
3039-
// - addObject
3040-
// - deleteIndex
3041-
// - editSettings
3042-
//
3043-
// - parameter taskSearch: (body)
3044-
// - returns: RequestBuilder<[TaskV1]>
3050+
/// Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
3051+
/// Required API Key ACLs:
3052+
/// - addObject
3053+
/// - deleteIndex
3054+
/// - editSettings
3055+
///
3056+
/// - parameter taskSearch: (body)
3057+
/// - returns: RequestBuilder<[TaskV1]>
3058+
@available(*, deprecated, message: "This operation is deprecated.")
30453059

30463060
open func searchTasksV1WithHTTPInfo(
30473061
taskSearch: TaskSearch,
@@ -3585,6 +3599,7 @@ open class IngestionClient {
35853599
/// - parameter taskID: (path) Unique identifier of a task.
35863600
/// - parameter taskUpdate: (body)
35873601
/// - returns: TaskUpdateResponse
3602+
@available(*, deprecated, message: "This operation is deprecated.")
35883603
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
35893604
open func updateTaskV1(
35903605
taskID: String,
@@ -3604,13 +3619,14 @@ open class IngestionClient {
36043619
return body
36053620
}
36063621

3607-
// Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3608-
//
3609-
//
3610-
// - parameter taskID: (path) Unique identifier of a task.
3611-
//
3612-
// - parameter taskUpdate: (body)
3613-
// - returns: RequestBuilder<TaskUpdateResponse>
3622+
/// Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3623+
///
3624+
///
3625+
/// - parameter taskID: (path) Unique identifier of a task.
3626+
///
3627+
/// - parameter taskUpdate: (body)
3628+
/// - returns: RequestBuilder<TaskUpdateResponse>
3629+
@available(*, deprecated, message: "This operation is deprecated.")
36143630

36153631
open func updateTaskV1WithHTTPInfo(
36163632
taskID: String,

0 commit comments

Comments
 (0)