@googleapis/safebrowsing 6.0.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [7.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/safebrowsing-v6.0.0...safebrowsing-v7.0.0) (2024-03-12)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * This release has breaking changes.
9
+
10
+ ### Features
11
+
12
+ * run the generator ([#3434](https://github.com/googleapis/google-api-nodejs-client/issues/3434)) ([f0db524](https://github.com/googleapis/google-api-nodejs-client/commit/f0db524bb26f05cea3dec4c0ed66b496399e3857))
13
+
3
14
  ## [6.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/safebrowsing-v5.0.2...safebrowsing-v6.0.0) (2023-10-11)
4
15
 
5
16
 
package/build/v5.d.ts CHANGED
@@ -85,7 +85,7 @@ export declare namespace safebrowsing_v5 {
85
85
  fullHashDetails?: Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail[];
86
86
  }
87
87
  /**
88
- * Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning), so clients MUST be prepared to receive FullHashDetail messages containing ThreatType enum values or ThreatAttribute enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all ThreatType and ThreatAttribute enum values; if any value is considered invalid, the client MUST disregard the entire FullHashDetail message.
88
+ * Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning for the versioning policy), so clients MUST be prepared to receive `FullHashDetail` messages containing `ThreatType` enum values or `ThreatAttribute` enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all `ThreatType` and `ThreatAttribute` enum values; if any value is considered invalid, the client MUST disregard the entire `FullHashDetail` message.
89
89
  */
90
90
  export interface Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail {
91
91
  /**
@@ -98,11 +98,11 @@ export declare namespace safebrowsing_v5 {
98
98
  threatType?: string | null;
99
99
  }
100
100
  /**
101
- * The response returned after searching threat hashes. Note that if nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404).
101
+ * The response returned after searching threat hashes. If nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). **What's new in V5**: There is a separation between FullHash and FullHashDetail. In the case when a hash represents a site having multiple threats (e.g. both MALWARE and SOCIAL_ENGINEERING), the full hash does not need to be sent twice as in V4. Furthermore, the cache duration has been simplified into a single `cache_duration` field.
102
102
  */
103
103
  export interface Schema$GoogleSecuritySafebrowsingV5SearchHashesResponse {
104
104
  /**
105
- * The client-side cache duration. The client shall add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact should also be cached by the client. Important: the client must not assume that the server will return the same cache duration for all responses. The server may choose different cache durations for different responses depending on the situation.
105
+ * The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact MUST also be cached by the client. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation.
106
106
  */
107
107
  cacheDuration?: string | null;
108
108
  /**
@@ -114,7 +114,7 @@ export declare namespace safebrowsing_v5 {
114
114
  context: APIRequestContext;
115
115
  constructor(context: APIRequestContext);
116
116
  /**
117
- * Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136
117
+ * Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).
118
118
  *
119
119
  * @param params - Parameters for request
120
120
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -130,7 +130,7 @@ export declare namespace safebrowsing_v5 {
130
130
  }
131
131
  export interface Params$Resource$Hashes$Search extends StandardParameters {
132
132
  /**
133
- * Required. The hash prefixes to be looked up.
133
+ * Required. The hash prefixes to be looked up. Clients MUST NOT send more than 1000 hash prefixes. However, following the URL processing procedure, clients SHOULD NOT need to send more than 30 hash prefixes. Currently each hash prefix is required to be exactly 4 bytes long. This MAY be relaxed in the future.
134
134
  */
135
135
  hashPrefixes?: string[];
136
136
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@googleapis/safebrowsing",
3
- "version": "6.0.0",
3
+ "version": "7.0.0",
4
4
  "description": "safebrowsing",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
package/v5.ts CHANGED
@@ -138,7 +138,7 @@ export namespace safebrowsing_v5 {
138
138
  fullHashDetails?: Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail[];
139
139
  }
140
140
  /**
141
- * Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning), so clients MUST be prepared to receive FullHashDetail messages containing ThreatType enum values or ThreatAttribute enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all ThreatType and ThreatAttribute enum values; if any value is considered invalid, the client MUST disregard the entire FullHashDetail message.
141
+ * Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning for the versioning policy), so clients MUST be prepared to receive `FullHashDetail` messages containing `ThreatType` enum values or `ThreatAttribute` enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all `ThreatType` and `ThreatAttribute` enum values; if any value is considered invalid, the client MUST disregard the entire `FullHashDetail` message.
142
142
  */
143
143
  export interface Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail {
144
144
  /**
@@ -151,11 +151,11 @@ export namespace safebrowsing_v5 {
151
151
  threatType?: string | null;
152
152
  }
153
153
  /**
154
- * The response returned after searching threat hashes. Note that if nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404).
154
+ * The response returned after searching threat hashes. If nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). **What's new in V5**: There is a separation between FullHash and FullHashDetail. In the case when a hash represents a site having multiple threats (e.g. both MALWARE and SOCIAL_ENGINEERING), the full hash does not need to be sent twice as in V4. Furthermore, the cache duration has been simplified into a single `cache_duration` field.
155
155
  */
156
156
  export interface Schema$GoogleSecuritySafebrowsingV5SearchHashesResponse {
157
157
  /**
158
- * The client-side cache duration. The client shall add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact should also be cached by the client. Important: the client must not assume that the server will return the same cache duration for all responses. The server may choose different cache durations for different responses depending on the situation.
158
+ * The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact MUST also be cached by the client. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation.
159
159
  */
160
160
  cacheDuration?: string | null;
161
161
  /**
@@ -171,7 +171,7 @@ export namespace safebrowsing_v5 {
171
171
  }
172
172
 
173
173
  /**
174
- * Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136
174
+ * Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).
175
175
  *
176
176
  * @param params - Parameters for request
177
177
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -265,7 +265,7 @@ export namespace safebrowsing_v5 {
265
265
 
266
266
  export interface Params$Resource$Hashes$Search extends StandardParameters {
267
267
  /**
268
- * Required. The hash prefixes to be looked up.
268
+ * Required. The hash prefixes to be looked up. Clients MUST NOT send more than 1000 hash prefixes. However, following the URL processing procedure, clients SHOULD NOT need to send more than 30 hash prefixes. Currently each hash prefix is required to be exactly 4 bytes long. This MAY be relaxed in the future.
269
269
  */
270
270
  hashPrefixes?: string[];
271
271
  }