@google-cloud/recaptcha-enterprise - npm Package Compare versions

Comparing version 2.3.0 to 2.4.0

build/src/v1/recaptcha_enterprise_service_client_config.json

@@ -65,2 +65,14 @@ {
                     "retry_params_name": "default"
+                },
+                "ListRelatedAccountGroups": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
+                },
+                "ListRelatedAccountGroupMemberships": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
+                },
+                "SearchRelatedAccountGroupMemberships": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
                 }
@@ -67,0 +79,0 @@ }

build/src/v1/recaptcha_enterprise_service_client.d.ts

@@ -189,3 +189,232 @@ /// <reference types="node" />
     listKeysAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IKey>;
+    listRelatedAccountGroups(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroup[], protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest | null, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsResponse]>;
+    listRelatedAccountGroups(request: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroup>): void;
+    listRelatedAccountGroups(request: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroup>): void;
     /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The name of the project to list related account groups from, in the format
+     *   "projects/{project}".
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of groups to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 groups will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRelatedAccountGroups` must match the call that provided the page
+     *   token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [RelatedAccountGroup]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroup} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listRelatedAccountGroupsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
+    listRelatedAccountGroupsStream(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listRelatedAccountGroups`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The name of the project to list related account groups from, in the format
+     *   "projects/{project}".
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of groups to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 groups will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
+     *   Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRelatedAccountGroups` must match the call that provided the page
+     *   token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   [RelatedAccountGroup]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroup}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     * @example
+     * const iterable = client.listRelatedAccountGroupsAsync(request);
+     * for await (const response of iterable) {
+     *   // process response
+     * }
+     */
+    listRelatedAccountGroupsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroup>;
+    listRelatedAccountGroupMemberships(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership[], protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest | null, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsResponse]>;
+    listRelatedAccountGroupMemberships(request: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>): void;
+    listRelatedAccountGroupMemberships(request: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name for the related account group in the format
+     *   `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of accounts to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 accounts will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
+     *   call.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRelatedAccountGroupMemberships` must match the call that provided the
+     *   page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listRelatedAccountGroupMembershipsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
+    listRelatedAccountGroupMembershipsStream(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listRelatedAccountGroupMemberships`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name for the related account group in the format
+     *   `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of accounts to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 accounts will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
+     *   call.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRelatedAccountGroupMemberships` must match the call that provided the
+     *   page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     * @example
+     * const iterable = client.listRelatedAccountGroupMembershipsAsync(request);
+     * for await (const response of iterable) {
+     *   // process response
+     * }
+     */
+    listRelatedAccountGroupMembershipsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>;
+    searchRelatedAccountGroupMemberships(request?: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership[], protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest | null, protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsResponse]>;
+    searchRelatedAccountGroupMemberships(request: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>): void;
+    searchRelatedAccountGroupMemberships(request: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The name of the project to search related account group memberships from,
+     *   in the format "projects/{project}".
+     * @param {Buffer} [request.hashedAccountId]
+     *   Optional. The unique stable hashed user identifier we should search connections to.
+     *   The identifier should correspond to a `hashed_account_id` provided in a
+     *   previous CreateAssessment or AnnotateAssessment call.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of groups to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 groups will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous
+     *   `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
+     *   subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `SearchRelatedAccountGroupMemberships` must match the call that provided
+     *   the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `searchRelatedAccountGroupMembershipsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
+    searchRelatedAccountGroupMembershipsStream(request?: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `searchRelatedAccountGroupMemberships`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The name of the project to search related account group memberships from,
+     *   in the format "projects/{project}".
+     * @param {Buffer} [request.hashedAccountId]
+     *   Optional. The unique stable hashed user identifier we should search connections to.
+     *   The identifier should correspond to a `hashed_account_id` provided in a
+     *   previous CreateAssessment or AnnotateAssessment call.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of groups to return. The service may return fewer than
+     *   this value.
+     *   If unspecified, at most 50 groups will be returned.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous
+     *   `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
+     *   subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `SearchRelatedAccountGroupMemberships` must match the call that provided
+     *   the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     * @example
+     * const iterable = client.searchRelatedAccountGroupMembershipsAsync(request);
+     * for await (const response of iterable) {
+     *   // process response
+     * }
+     */
+    searchRelatedAccountGroupMembershipsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>;
+    /**
      * Return a fully-qualified assessment resource name string.
@@ -278,2 +507,59 @@ *
     /**
+     * Return a fully-qualified relatedAccountGroup resource name string.
+     *
+     * @param {string} project
+     * @param {string} relatedaccountgroup
+     * @returns {string} Resource name string.
+     */
+    relatedAccountGroupPath(project: string, relatedaccountgroup: string): string;
+    /**
+     * Parse the project from RelatedAccountGroup resource.
+     *
+     * @param {string} relatedAccountGroupName
+     *   A fully-qualified path representing RelatedAccountGroup resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromRelatedAccountGroupName(relatedAccountGroupName: string): string | number;
+    /**
+     * Parse the relatedaccountgroup from RelatedAccountGroup resource.
+     *
+     * @param {string} relatedAccountGroupName
+     *   A fully-qualified path representing RelatedAccountGroup resource.
+     * @returns {string} A string representing the relatedaccountgroup.
+     */
+    matchRelatedaccountgroupFromRelatedAccountGroupName(relatedAccountGroupName: string): string | number;
+    /**
+     * Return a fully-qualified relatedAccountGroupMembership resource name string.
+     *
+     * @param {string} project
+     * @param {string} relatedaccountgroup
+     * @param {string} membership
+     * @returns {string} Resource name string.
+     */
+    relatedAccountGroupMembershipPath(project: string, relatedaccountgroup: string, membership: string): string;
+    /**
+     * Parse the project from RelatedAccountGroupMembership resource.
+     *
+     * @param {string} relatedAccountGroupMembershipName
+     *   A fully-qualified path representing RelatedAccountGroupMembership resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName: string): string | number;
+    /**
+     * Parse the relatedaccountgroup from RelatedAccountGroupMembership resource.
+     *
+     * @param {string} relatedAccountGroupMembershipName
+     *   A fully-qualified path representing RelatedAccountGroupMembership resource.
+     * @returns {string} A string representing the relatedaccountgroup.
+     */
+    matchRelatedaccountgroupFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName: string): string | number;
+    /**
+     * Parse the membership from RelatedAccountGroupMembership resource.
+     *
+     * @param {string} relatedAccountGroupMembershipName
+     *   A fully-qualified path representing RelatedAccountGroupMembership resource.
+     * @returns {string} A string representing the membership.
+     */
+    matchMembershipFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName: string): string | number;
+    /**
      * Terminate the gRPC channel and close the client.
@@ -280,0 +566,0 @@ *

build/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.js

@@ -560,3 +560,4 @@ "use strict";
             });
-        const callSettings = new gax.CallSettings(options);
+        const defaultCallSettings = this._defaults['listKeys'];
+        const callSettings = defaultCallSettings.merge(options);
         this.initialize();
@@ -606,3 +607,4 @@ return this.descriptors.page.listKeys.createStream(this.innerApiCalls.listKeys, request, callSettings);
         options = options || {};
-        const callSettings = new gax.CallSettings(options);
+        const defaultCallSettings = this._defaults['listKeys'];
+        const callSettings = defaultCallSettings.merge(options);
         this.initialize();
@@ -609,0 +611,0 @@ return this.descriptors.page.listKeys.asyncIterate(this.innerApiCalls['listKeys'], request, callSettings);

CHANGELOG.md

@@ -7,2 +7,9 @@ # Changelog
 
+## [2.4.0](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/compare/v2.3.0...v2.4.0) (2021-11-09)
+
+
+### Features
+
+* add reCAPTCHA Enterprise account defender API methods ([#328](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/issues/328)) ([2099c50](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/commit/2099c503c2bb91347761b083140c66f22b042a0d))
+
 ## [2.3.0](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/compare/v2.2.1...v2.3.0) (2021-09-16)
@@ -9,0 +16,0 @@

package.json

 {
   "repository": "googleapis/nodejs-recaptcha-enterprise",
   "name": "@google-cloud/recaptcha-enterprise",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "author": "Google LLC",
@@ -32,3 +32,3 @@ "description": "reCAPTCHA Enterprise API client for Node.js",
     "@types/mocha": "^8.0.0",
-    "@types/node": "^14.0.0",
+    "@types/node": "^16.0.0",
     "@types/sinon": "^10.0.0",
@@ -44,3 +44,3 @@ "c8": "^7.0.0",
     "pack-n-play": "^1.0.0-2",
-    "sinon": "^11.0.0",
+    "sinon": "^12.0.0",
     "ts-loader": "^9.0.0",
@@ -47,0 +47,0 @@ "typescript": "^3.8.3",

No alert changes

Improved metrics

Total package byte prevSize

2319124

increased by14.99%

Lines of code

36177

increased by12.67%

No dependency changes