Skip to content

Commit d277c78

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
chore: generated code for commit fe6f5eda. [skip ci]
algolia/api-clients-automation@fe6f5ed Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent c28e710 commit d277c78

File tree

8 files changed

+565
-139
lines changed

8 files changed

+565
-139
lines changed

‎src/main/scala/algoliasearch/api/IngestionClient.scala

Lines changed: 367 additions & 136 deletions
Large diffs are not rendered by default.

‎src/main/scala/algoliasearch/ingestion/ListTasksResponseV1.scala

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
/** Configured tasks and pagination information.
27+
*/
28+
case class ListTasksResponseV1(
29+
tasks: Seq[TaskV1],
30+
pagination: Pagination
31+
)

‎src/main/scala/algoliasearch/ingestion/Task.scala

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ import algoliasearch.ingestion.ActionType._
3333
* Universally uniqud identifier (UUID) of a source.
3434
* @param destinationID
3535
* Universally unique identifier (UUID) of a destination resource.
36+
* @param cron
37+
* Cron expression for the task's schedule.
38+
* @param lastRun
39+
* The last time the scheduled task ran in RFC 3339 format.
40+
* @param nextRun
41+
* The next scheduled run of the task in RFC 3339 format.
3642
* @param enabled
3743
* Whether the task is enabled.
3844
* @param failureThreshold
@@ -48,7 +54,9 @@ case class Task(
4854
taskID: String,
4955
sourceID: String,
5056
destinationID: String,
51-
trigger: Trigger,
57+
cron: Option[String] = scala.None,
58+
lastRun: Option[String] = scala.None,
59+
nextRun: Option[String] = scala.None,
5260
input: Option[TaskInput] = scala.None,
5361
enabled: Boolean,
5462
failureThreshold: Option[Int] = scala.None,

‎src/main/scala/algoliasearch/ingestion/TaskCreate.scala

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ import algoliasearch.ingestion.ActionType._
3131
* Universally uniqud identifier (UUID) of a source.
3232
* @param destinationID
3333
* Universally unique identifier (UUID) of a destination resource.
34+
* @param cron
35+
* Cron expression for the task's schedule.
3436
* @param enabled
3537
* Whether the task is enabled.
3638
* @param failureThreshold
@@ -41,8 +43,8 @@ import algoliasearch.ingestion.ActionType._
4143
case class TaskCreate(
4244
sourceID: String,
4345
destinationID: String,
44-
trigger: TaskCreateTrigger,
4546
action: ActionType,
47+
cron: Option[String] = scala.None,
4648
enabled: Option[Boolean] = scala.None,
4749
failureThreshold: Option[Int] = scala.None,
4850
input: Option[TaskInput] = scala.None,

‎src/main/scala/algoliasearch/ingestion/TaskCreateV1.scala

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
import algoliasearch.ingestion.ActionType._
27+
28+
/** API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1
29+
* suffix.
30+
*
31+
* @param sourceID
32+
* Universally uniqud identifier (UUID) of a source.
33+
* @param destinationID
34+
* Universally unique identifier (UUID) of a destination resource.
35+
* @param enabled
36+
* Whether the task is enabled.
37+
* @param failureThreshold
38+
* Maximum accepted percentage of failures for a task run to finish successfully.
39+
* @param cursor
40+
* Date of the last cursor in RFC 3339 format.
41+
*/
42+
case class TaskCreateV1(
43+
sourceID: String,
44+
destinationID: String,
45+
trigger: TaskCreateTrigger,
46+
action: ActionType,
47+
enabled: Option[Boolean] = scala.None,
48+
failureThreshold: Option[Int] = scala.None,
49+
input: Option[TaskInput] = scala.None,
50+
cursor: Option[String] = scala.None
51+
)

‎src/main/scala/algoliasearch/ingestion/TaskUpdate.scala

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ package algoliasearch.ingestion
2727
*
2828
* @param destinationID
2929
* Universally unique identifier (UUID) of a destination resource.
30+
* @param cron
31+
* Cron expression for the task's schedule.
3032
* @param enabled
3133
* Whether the task is enabled.
3234
* @param failureThreshold
3335
* Maximum accepted percentage of failures for a task run to finish successfully.
3436
*/
3537
case class TaskUpdate(
3638
destinationID: Option[String] = scala.None,
37-
trigger: Option[TriggerUpdateInput] = scala.None,
39+
cron: Option[String] = scala.None,
3840
input: Option[TaskInput] = scala.None,
3941
enabled: Option[Boolean] = scala.None,
4042
failureThreshold: Option[Int] = scala.None

‎src/main/scala/algoliasearch/ingestion/TaskUpdateV1.scala

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
/** API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1
27+
* suffix.
28+
*
29+
* @param destinationID
30+
* Universally unique identifier (UUID) of a destination resource.
31+
* @param enabled
32+
* Whether the task is enabled.
33+
* @param failureThreshold
34+
* Maximum accepted percentage of failures for a task run to finish successfully.
35+
*/
36+
case class TaskUpdateV1(
37+
destinationID: Option[String] = scala.None,
38+
trigger: Option[TriggerUpdateInput] = scala.None,
39+
input: Option[TaskInput] = scala.None,
40+
enabled: Option[Boolean] = scala.None,
41+
failureThreshold: Option[Int] = scala.None
42+
)

‎src/main/scala/algoliasearch/ingestion/TaskV1.scala

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
2+
* to ingest your data. The Ingestion API powers the no-code [data
3+
* connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
4+
* are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
5+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
6+
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
7+
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
8+
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
9+
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
10+
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
11+
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
12+
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13+
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14+
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15+
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16+
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17+
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
18+
*
19+
* The version of the OpenAPI document: 1.0.0
20+
*
21+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22+
* https://openapi-generator.tech Do not edit the class manually.
23+
*/
24+
package algoliasearch.ingestion
25+
26+
import algoliasearch.ingestion.ActionType._
27+
28+
/** The V1 task object, please use methods and types that don't contain the V1 suffix.
29+
*
30+
* @param taskID
31+
* Universally unique identifier (UUID) of a task.
32+
* @param sourceID
33+
* Universally uniqud identifier (UUID) of a source.
34+
* @param destinationID
35+
* Universally unique identifier (UUID) of a destination resource.
36+
* @param enabled
37+
* Whether the task is enabled.
38+
* @param failureThreshold
39+
* Maximum accepted percentage of failures for a task run to finish successfully.
40+
* @param cursor
41+
* Date of the last cursor in RFC 3339 format.
42+
* @param createdAt
43+
* Date of creation in RFC 3339 format.
44+
* @param updatedAt
45+
* Date of last update in RFC 3339 format.
46+
*/
47+
case class TaskV1(
48+
taskID: String,
49+
sourceID: String,
50+
destinationID: String,
51+
trigger: Trigger,
52+
input: Option[TaskInput] = scala.None,
53+
enabled: Boolean,
54+
failureThreshold: Option[Int] = scala.None,
55+
action: ActionType,
56+
cursor: Option[String] = scala.None,
57+
createdAt: String,
58+
updatedAt: Option[String] = scala.None
59+
)

0 commit comments

Comments
 (0)