Skip to content

Commit 68b98ea

Browse files
algolia-botmillotp
andcommitted
feat(specs): add notification settings to tasks [skip-bc] (generated)
algolia/api-clients-automation#4297 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 4d9b926 commit 68b98ea

File tree

8 files changed

+98
-2
lines changed

8 files changed

+98
-2
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,6 +1058,8 @@ class IngestionClient(
10581058
* Destination IDs for filtering the list of tasks.
10591059
* @param triggerType
10601060
* Type of task trigger for filtering the list of tasks.
1061+
* @param withEmailNotifications
1062+
* If specified, the response only includes tasks with notifications.email.enabled set to this value.
10611063
* @param sort
10621064
* Property by which to sort the list of tasks.
10631065
* @param order
@@ -1072,6 +1074,7 @@ class IngestionClient(
10721074
sourceType: Option[Seq[SourceType]] = None,
10731075
destinationID: Option[Seq[String]] = None,
10741076
triggerType: Option[Seq[TriggerType]] = None,
1077+
withEmailNotifications: Option[Boolean] = None,
10751078
sort: Option[TaskSortKeys] = None,
10761079
order: Option[OrderKeys] = None,
10771080
requestOptions: Option[RequestOptions] = None
@@ -1089,6 +1092,7 @@ class IngestionClient(
10891092
.withQueryParameter("sourceType", sourceType)
10901093
.withQueryParameter("destinationID", destinationID)
10911094
.withQueryParameter("triggerType", triggerType)
1095+
.withQueryParameter("withEmailNotifications", withEmailNotifications)
10921096
.withQueryParameter("sort", sort)
10931097
.withQueryParameter("order", order)
10941098
.build()
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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. Successful responses return a `2xx`
11+
* status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a
12+
* `message` property with more information. ## Version The current version of the Ingestion API is version 1, as
13+
* indicated by the `/1/` in each endpoint's URL.
14+
*
15+
* The version of the OpenAPI document: 1.0.0
16+
*
17+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
18+
* https://openapi-generator.tech Do not edit the class manually.
19+
*/
20+
package algoliasearch.ingestion
21+
22+
/** EmailNotifications
23+
*
24+
* @param enabled
25+
* Whether to send email notifications, note that this doesn't prevent the task from being blocked.
26+
*/
27+
case class EmailNotifications(
28+
enabled: Option[Boolean] = scala.None
29+
)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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. Successful responses return a `2xx`
11+
* status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a
12+
* `message` property with more information. ## Version The current version of the Ingestion API is version 1, as
13+
* indicated by the `/1/` in each endpoint's URL.
14+
*
15+
* The version of the OpenAPI document: 1.0.0
16+
*
17+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
18+
* https://openapi-generator.tech Do not edit the class manually.
19+
*/
20+
package algoliasearch.ingestion
21+
22+
/** Notifications settings for a task.
23+
*/
24+
case class Notifications(
25+
email: EmailNotifications
26+
)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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. Successful responses return a `2xx`
11+
* status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a
12+
* `message` property with more information. ## Version The current version of the Ingestion API is version 1, as
13+
* indicated by the `/1/` in each endpoint's URL.
14+
*
15+
* The version of the OpenAPI document: 1.0.0
16+
*
17+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
18+
* https://openapi-generator.tech Do not edit the class manually.
19+
*/
20+
package algoliasearch.ingestion
21+
22+
/** Set of rules for a task.
23+
*
24+
* @param criticalThreshold
25+
* The number of critical failures in a row before blocking the task and sending a notification.
26+
*/
27+
case class Policies(
28+
criticalThreshold: Option[Int] = scala.None
29+
)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ case class Task(
5858
failureThreshold: Option[Int] = scala.None,
5959
action: Option[ActionType] = scala.None,
6060
cursor: Option[String] = scala.None,
61+
notifications: Option[Notifications] = scala.None,
62+
policies: Option[Policies] = scala.None,
6163
createdAt: String,
6264
updatedAt: Option[String] = scala.None
6365
)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,7 @@ case class TaskCreate(
4444
enabled: Option[Boolean] = scala.None,
4545
failureThreshold: Option[Int] = scala.None,
4646
input: Option[TaskInput] = scala.None,
47-
cursor: Option[String] = scala.None
47+
cursor: Option[String] = scala.None,
48+
notifications: Option[Notifications] = scala.None,
49+
policies: Option[Policies] = scala.None
4850
)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,7 @@ case class TaskUpdate(
3535
cron: Option[String] = scala.None,
3636
input: Option[TaskInput] = scala.None,
3737
enabled: Option[Boolean] = scala.None,
38-
failureThreshold: Option[Int] = scala.None
38+
failureThreshold: Option[Int] = scala.None,
39+
notifications: Option[Notifications] = scala.None,
40+
policies: Option[Policies] = scala.None
3941
)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ case class TaskV1(
5050
failureThreshold: Option[Int] = scala.None,
5151
action: Option[ActionType] = scala.None,
5252
cursor: Option[String] = scala.None,
53+
notifications: Option[Notifications] = scala.None,
54+
policies: Option[Policies] = scala.None,
5355
createdAt: String,
5456
updatedAt: Option[String] = scala.None
5557
)

0 commit comments

Comments
 (0)