feat(retail): update the api

#### retail:v2alpha The following keys were added: - resources.projects.methods.getAlertConfig (Total Keys: 11) - resources.projects.methods.updateAlertConfig (Total Keys: 15) - schemas.GoogleCloudRetailV2alphaAlertConfig (Total Keys: 14)
googleapis · Mar 5, 2024 · eb0ea7d · eb0ea7d
1 parent a5b7ab3
commit eb0ea7d
Show file tree

Hide file tree

Showing 4 changed files with 208 additions and 3 deletions.
diff --git a/docs/dyn/retail_v2alpha.projects.html b/docs/dyn/retail_v2alpha.projects.html
@@ -95,6 +95,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#enrollSolution">enrollSolution(project, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.</p>
+<p class="toc_element">
+  <code><a href="#getAlertConfig">getAlertConfig(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Get the AlertConfig of the requested project.</p>
 <p class="toc_element">
   <code><a href="#getLoggingConfig">getLoggingConfig(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets the LoggingConfig of the requested project.</p>
@@ -104,6 +107,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#listEnrolledSolutions">listEnrolledSolutions(parent, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists all the retail API solutions the project has enrolled.</p>
+<p class="toc_element">
+  <code><a href="#updateAlertConfig">updateAlertConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Update the alert config of the requested project.</p>
 <p class="toc_element">
   <code><a href="#updateLoggingConfig">updateLoggingConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Updates the LoggingConfig of the requested project.</p>
@@ -155,6 +161,36 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="getAlertConfig">getAlertConfig(name, x__xgafv=None)</code>
+  <pre>Get the AlertConfig of the requested project.
+
+Args:
+  name: string, Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Project level alert config.
+  &quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
+    { # Alert policy for a customer.
+      &quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
+      &quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
+      &quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
+        { # Recipient contact information.
+          &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
+        },
+      ],
+    },
+  ],
+  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="getLoggingConfig">getLoggingConfig(name, x__xgafv=None)</code>
   <pre>Gets the LoggingConfig of the requested project.
@@ -230,6 +266,55 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="updateAlertConfig">updateAlertConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
+  <pre>Update the alert config of the requested project.
+
+Args:
+  name: string, Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Project level alert config.
+  &quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
+    { # Alert policy for a customer.
+      &quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
+      &quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
+      &quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
+        { # Recipient contact information.
+          &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
+        },
+      ],
+    },
+  ],
+  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
+}
+
+  updateMask: string, Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Project level alert config.
+  &quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
+    { # Alert policy for a customer.
+      &quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
+      &quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
+      &quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
+        { # Recipient contact information.
+          &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
+        },
+      ],
+    },
+  ],
+  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="updateLoggingConfig">updateLoggingConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
   <pre>Updates the LoggingConfig of the requested project.

diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -2087,7 +2087,7 @@
 }
 }
 },
-"revision": "20240222",
+"revision": "20240229",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {

diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -135,6 +135,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getAlertConfig": {
+"description": "Get the AlertConfig of the requested project.",
+"flatPath": "v2alpha/projects/{projectsId}/alertConfig",
+"httpMethod": "GET",
+"id": "retail.projects.getAlertConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig",
+"location": "path",
+"pattern": "^projects/[^/]+/alertConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2alpha/{+name}",
+"response": {
+"$ref": "GoogleCloudRetailV2alphaAlertConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "getLoggingConfig": {
 "description": "Gets the LoggingConfig of the requested project.",
 "flatPath": "v2alpha/projects/{projectsId}/loggingConfig",
@@ -210,6 +235,40 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"updateAlertConfig": {
+"description": "Update the alert config of the requested project.",
+"flatPath": "v2alpha/projects/{projectsId}/alertConfig",
+"httpMethod": "PATCH",
+"id": "retail.projects.updateAlertConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig",
+"location": "path",
+"pattern": "^projects/[^/]+/alertConfig$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v2alpha/{+name}",
+"request": {
+"$ref": "GoogleCloudRetailV2alphaAlertConfig"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2alphaAlertConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "updateLoggingConfig": {
 "description": "Updates the LoggingConfig of the requested project.",
 "flatPath": "v2alpha/projects/{projectsId}/loggingConfig",
@@ -2416,7 +2475,7 @@
 }
 }
 },
-"revision": "20240222",
+"revision": "20240229",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -3241,6 +3300,67 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2alphaAlertConfig": {
+"description": "Project level alert config.",
+"id": "GoogleCloudRetailV2alphaAlertConfig",
+"properties": {
+"alertPolicies": {
+"description": "Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]",
+"items": {
+"$ref": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy"
+},
+"type": "array"
+},
+"name": {
+"description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2alphaAlertConfigAlertPolicy": {
+"description": "Alert policy for a customer.",
+"id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy",
+"properties": {
+"alertGroup": {
+"description": "The feature that provides alerting capability. Supported value is only `search-data-quality` for now.",
+"type": "string"
+},
+"enrollStatus": {
+"description": "The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATUS_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+},
+"recipients": {
+"description": "Recipients for the alert policy. One alert policy should not exceed 20 recipients.",
+"items": {
+"$ref": "GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient": {
+"description": "Recipient contact information.",
+"id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient",
+"properties": {
+"emailAddress": {
+"description": "Email address of the recipient.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2alphaAttributesConfig": {
 "description": "Catalog level attribute config.",
 "id": "GoogleCloudRetailV2alphaAttributesConfig",

diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -2115,7 +2115,7 @@
 }
 }
 },
-"revision": "20240222",
+"revision": "20240229",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {