Skip to content

Commit

Permalink
feat(alertcenter): update the API
Browse files Browse the repository at this point in the history
#### alertcenter:v1beta1

The following keys were added:
- schemas.AbuseDetected.description
- schemas.AbuseDetected.id
- schemas.AbuseDetected.properties.additionalDetails.$ref
- schemas.AbuseDetected.properties.additionalDetails.description
- schemas.AbuseDetected.properties.product.description
- schemas.AbuseDetected.properties.product.type
- schemas.AbuseDetected.properties.subAlertId.description
- schemas.AbuseDetected.properties.subAlertId.type
- schemas.AbuseDetected.properties.variationType.description
- schemas.AbuseDetected.properties.variationType.enum
- schemas.AbuseDetected.properties.variationType.enumDescriptions
- schemas.AbuseDetected.properties.variationType.type
- schemas.AbuseDetected.type
- schemas.Entity.description
- schemas.Entity.id
- schemas.Entity.properties.link.description
- schemas.Entity.properties.link.type
- schemas.Entity.properties.name.description
- schemas.Entity.properties.name.type
- schemas.Entity.properties.values.description
- schemas.Entity.properties.values.items.type
- schemas.Entity.properties.values.type
- schemas.Entity.type
- schemas.EntityList.description
- schemas.EntityList.id
- schemas.EntityList.properties.entities.description
- schemas.EntityList.properties.entities.items.$ref
- schemas.EntityList.properties.entities.type
- schemas.EntityList.properties.headers.description
- schemas.EntityList.properties.headers.items.type
- schemas.EntityList.properties.headers.type
- schemas.EntityList.properties.name.description
- schemas.EntityList.properties.name.type
- schemas.EntityList.type

The following keys were changed:
- schemas.AccountSuspensionWarning.description
- schemas.ApnsCertificateExpirationInfo.description
- schemas.ApnsCertificateExpirationInfo.properties.appleId.description
- schemas.ApnsCertificateExpirationInfo.properties.expirationTime.description
- schemas.ApnsCertificateExpirationInfo.properties.uid.description
  • Loading branch information
yoshi-automation authored and sofisl committed May 2, 2023
1 parent dd535b8 commit 00c6191
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 11 deletions.
92 changes: 86 additions & 6 deletions discovery/alertcenter-v1beta1.json
Original file line number Diff line number Diff line change
Expand Up @@ -423,9 +423,42 @@
}
}
},
"revision": "20230403",
"revision": "20230424",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
"AbuseDetected": {
"description": "A generic alert for abusive user activity occurring with a customer.",
"id": "AbuseDetected",
"properties": {
"additionalDetails": {
"$ref": "EntityList",
"description": "List of abusive users/entities to be displayed in a table in the alert."
},
"product": {
"description": "Product that the abuse is originating from.",
"type": "string"
},
"subAlertId": {
"description": "Unique identifier of each sub alert that is onboarded.",
"type": "string"
},
"variationType": {
"description": "Variation of AbuseDetected alerts. The variation_type determines the texts displayed the alert details. This differs from sub_alert_id because each sub alert can have multiple variation_types, representing different stages of the alert.",
"enum": [
"ABUSE_DETECTED_VARIATION_TYPE_UNSPECIFIED",
"DRIVE_ABUSIVE_CONTENT",
"LIMITED_DISABLE"
],
"enumDescriptions": [
"AbuseDetected alert variation type unspecified. No alert should be unspecified.",
"Variation displayed for Drive abusive content alerts.",
"Variation displayed for Limited Disable alerts, when a Google service is disabled for a user, totally or partially, due to the user's abusive behavior."
],
"type": "string"
}
},
"type": "object"
},
"AccountSuspensionDetails": {
"description": "Details about why an account is receiving an account suspension warning.",
"id": "AccountSuspensionDetails",
Expand Down Expand Up @@ -464,7 +497,7 @@
"type": "object"
},
"AccountSuspensionWarning": {
"description": "LINT.IfChange A warning that the customer's account is about to be suspended.",
"description": "A warning that the customer's account is about to be suspended.",
"id": "AccountSuspensionWarning",
"properties": {
"appealWindow": {
Expand Down Expand Up @@ -733,20 +766,20 @@
"type": "object"
},
"ApnsCertificateExpirationInfo": {
"description": "The explanation message associated with ApnsCertificationExpiring and ApnsCertificationExpired alerts.",
"description": "The explanation message associated with \"APNS certificate is expiring soon\" and \"APNS certificate has expired\" alerts.",
"id": "ApnsCertificateExpirationInfo",
"properties": {
"appleId": {
"description": "The Apple ID used for the certificate may be blank if admins didn't enter it.",
"description": "The Apple ID used to create the certificate. It may be blank if admins didn't enter it.",
"type": "string"
},
"expirationTime": {
"description": "The expiration date of the APNS Certificate.",
"description": "The expiration date of the APNS certificate.",
"format": "google-datetime",
"type": "string"
},
"uid": {
"description": "The UID for the certificate.",
"description": "The UID of the certificate.",
"type": "string"
}
},
Expand Down Expand Up @@ -1111,6 +1144,53 @@
"properties": {},
"type": "object"
},
"Entity": {
"description": "Individual entity affected by, or related to, an alert.",
"id": "Entity",
"properties": {
"link": {
"description": "Link to a Security Investigation Tool search based on this entity, if available.",
"type": "string"
},
"name": {
"description": "Human-readable name of this entity, such as an email address, file ID, or device name.",
"type": "string"
},
"values": {
"description": "Extra values beyond name. The order of values should align with headers in EntityList.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EntityList": {
"description": "EntityList stores entities in a format that can be translated to a table in the Alert Center UI.",
"id": "EntityList",
"properties": {
"entities": {
"description": "List of entities affected by the alert.",
"items": {
"$ref": "Entity"
},
"type": "array"
},
"headers": {
"description": "Headers of the values in entities. If no value is defined in Entity, this field should be empty.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the key detail used to display this entity list.",
"type": "string"
}
},
"type": "object"
},
"GmailMessageInfo": {
"description": "Details of a message in phishing spike alert.",
"id": "GmailMessageInfo",
Expand Down
65 changes: 60 additions & 5 deletions src/apis/alertcenter/v1beta1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,27 @@ export namespace alertcenter_v1beta1 {
}
}

/**
* A generic alert for abusive user activity occurring with a customer.
*/
export interface Schema$AbuseDetected {
/**
* List of abusive users/entities to be displayed in a table in the alert.
*/
additionalDetails?: Schema$EntityList;
/**
* Product that the abuse is originating from.
*/
product?: string | null;
/**
* Unique identifier of each sub alert that is onboarded.
*/
subAlertId?: string | null;
/**
* Variation of AbuseDetected alerts. The variation_type determines the texts displayed the alert details. This differs from sub_alert_id because each sub alert can have multiple variation_types, representing different stages of the alert.
*/
variationType?: string | null;
}
/**
* Details about why an account is receiving an account suspension warning.
*/
Expand All @@ -140,7 +161,7 @@ export namespace alertcenter_v1beta1 {
productName?: string | null;
}
/**
* LINT.IfChange A warning that the customer's account is about to be suspended.
* A warning that the customer's account is about to be suspended.
*/
export interface Schema$AccountSuspensionWarning {
/**
Expand Down Expand Up @@ -346,19 +367,19 @@ export namespace alertcenter_v1beta1 {
updateTime?: string | null;
}
/**
* The explanation message associated with ApnsCertificationExpiring and ApnsCertificationExpired alerts.
* The explanation message associated with "APNS certificate is expiring soon" and "APNS certificate has expired" alerts.
*/
export interface Schema$ApnsCertificateExpirationInfo {
/**
* The Apple ID used for the certificate may be blank if admins didn't enter it.
* The Apple ID used to create the certificate. It may be blank if admins didn't enter it.
*/
appleId?: string | null;
/**
* The expiration date of the APNS Certificate.
* The expiration date of the APNS certificate.
*/
expirationTime?: string | null;
/**
* The UID for the certificate.
* The UID of the certificate.
*/
uid?: string | null;
}
Expand Down Expand Up @@ -615,6 +636,40 @@ export namespace alertcenter_v1beta1 {
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {}
/**
* Individual entity affected by, or related to, an alert.
*/
export interface Schema$Entity {
/**
* Link to a Security Investigation Tool search based on this entity, if available.
*/
link?: string | null;
/**
* Human-readable name of this entity, such as an email address, file ID, or device name.
*/
name?: string | null;
/**
* Extra values beyond name. The order of values should align with headers in EntityList.
*/
values?: string[] | null;
}
/**
* EntityList stores entities in a format that can be translated to a table in the Alert Center UI.
*/
export interface Schema$EntityList {
/**
* List of entities affected by the alert.
*/
entities?: Schema$Entity[];
/**
* Headers of the values in entities. If no value is defined in Entity, this field should be empty.
*/
headers?: string[] | null;
/**
* Name of the key detail used to display this entity list.
*/
name?: string | null;
}
/**
* Details of a message in phishing spike alert.
*/
Expand Down

0 comments on commit 00c6191

Please sign in to comment.