@google-cloud/recaptcha-enterprise
Advanced tools
Comparing version 2.4.0 to 2.5.0
@@ -104,26 +104,222 @@ /// <reference types="node" /> | ||
| getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
| /** | ||
| * Creates an Assessment of the likelihood an event is legitimate. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the assessment will be created, | ||
| * in the format "projects/{project}". | ||
| * @param {google.cloud.recaptchaenterprise.v1.Assessment} request.assessment | ||
| * Required. The assessment details. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Assessment]{@link google.cloud.recaptchaenterprise.v1.Assessment}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.create_assessment.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_async | ||
| */ | ||
| createAssessment(request?: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IAssessment, (protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | undefined), {} | undefined]>; | ||
| createAssessment(request: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| createAssessment(request: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Annotates a previously created Assessment to provide additional information | ||
| * on whether the event turned out to be authentic or fraudulent. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The resource name of the Assessment, in the format | ||
| * "projects/{project}/assessments/{assessment}". | ||
| * @param {google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation} [request.annotation] | ||
| * Optional. The annotation that will be assigned to the Event. This field can be left | ||
| * empty to provide reasons that apply to an event without concluding whether | ||
| * the event is legitimate or fraudulent. | ||
| * @param {number[]} [request.reasons] | ||
| * Optional. Optional reasons for the annotation that will be assigned to the Event. | ||
| * @param {Buffer} [request.hashedAccountId] | ||
| * Optional. Optional unique stable hashed user identifier to apply to the assessment. | ||
| * This is an alternative to setting the hashed_account_id in | ||
| * CreateAssessment, for example when the account identifier is not yet known | ||
| * in the initial request. It is recommended that the identifier is hashed | ||
| * using hmac-sha256 with stable secret. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [AnnotateAssessmentResponse]{@link google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_async | ||
| */ | ||
| annotateAssessment(request?: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, (protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | undefined), {} | undefined]>; | ||
| annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Creates a new reCAPTCHA Enterprise key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the key will be created, in the | ||
| * format "projects/{project}". | ||
| * @param {google.cloud.recaptchaenterprise.v1.Key} request.key | ||
| * Required. Information to create a reCAPTCHA Enterprise key. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.create_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_async | ||
| */ | ||
| createKey(request?: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | undefined, {} | undefined]>; | ||
| createKey(request: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| createKey(request: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Returns the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the requested key, in the format | ||
| * "projects/{project}/keys/{key}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.get_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_async | ||
| */ | ||
| getKey(request?: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | undefined, {} | undefined]>; | ||
| getKey(request: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| getKey(request: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Updates the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {google.cloud.recaptchaenterprise.v1.Key} request.key | ||
| * Required. The key to update. | ||
| * @param {google.protobuf.FieldMask} [request.updateMask] | ||
| * Optional. The mask to control which fields of the key get updated. If the mask is not | ||
| * present, all fields will be updated. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.update_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_async | ||
| */ | ||
| updateKey(request?: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | undefined, {} | undefined]>; | ||
| updateKey(request: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| updateKey(request: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Deletes the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the key to be deleted, in the format | ||
| * "projects/{project}/keys/{key}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.delete_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_async | ||
| */ | ||
| deleteKey(request?: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | undefined, {} | undefined]>; | ||
| deleteKey(request: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| deleteKey(request: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. | ||
| * Once a key is migrated, it can be used from either product. SiteVerify | ||
| * requests are billed as CreateAssessment calls. You must be | ||
| * authenticated as one of the current owners of the reCAPTCHA Site Key, and | ||
| * your user must have the reCAPTCHA Enterprise Admin IAM role in the | ||
| * destination project. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the key to be migrated, in the format | ||
| * "projects/{project}/keys/{key}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.migrate_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_async | ||
| */ | ||
| migrateKey(request?: protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest | undefined, {} | undefined]>; | ||
| migrateKey(request: protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| migrateKey(request: protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Get some aggregated metrics for a Key. This data can be used to build | ||
| * dashboards. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the requested metrics, in the format | ||
| * "projects/{project}/keys/{key}/metrics". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Metrics]{@link google.cloud.recaptchaenterprise.v1.Metrics}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.get_metrics.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_async | ||
| */ | ||
| getMetrics(request?: protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IMetrics, protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest | undefined, {} | undefined]>; | ||
| getMetrics(request: protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IMetrics, protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest | null | undefined, {} | null | undefined>): void; | ||
| getMetrics(request: protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IMetrics, protos.google.cloud.recaptchaenterprise.v1.IGetMetricsRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Returns the list of all keys that belong to a project. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project that contains the keys that will be | ||
| * listed, in the format "projects/{project}". | ||
| * @param {number} [request.pageSize] | ||
| * Optional. The maximum number of keys to return. Default is 10. Max limit is | ||
| * 1000. | ||
| * @param {string} [request.pageToken] | ||
| * Optional. The next_page_token value returned from a previous. | ||
| * ListKeysRequest, if any. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [Key]{@link google.cloud.recaptchaenterprise.v1.Key}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * Note that it can affect your quota. | ||
| * We recommend using `listKeysAsync()` | ||
| * 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. | ||
| */ | ||
| listKeys(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey[], protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest | null, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse]>; | ||
@@ -183,9 +379,39 @@ listKeys(request: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IKey>): void; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listKeysAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.list_keys.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_async | ||
| */ | ||
| listKeysAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IKey>; | ||
| /** | ||
| * List groups of related accounts. | ||
| * | ||
| * @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 {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [RelatedAccountGroup]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroup}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * 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. | ||
| */ | ||
| 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]>; | ||
@@ -257,9 +483,39 @@ 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; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listRelatedAccountGroupsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.list_related_account_groups.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_async | ||
| */ | ||
| listRelatedAccountGroupsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroup>; | ||
| /** | ||
| * Get the memberships in a group of related accounts. | ||
| * | ||
| * @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 {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * 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. | ||
| */ | ||
| 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]>; | ||
@@ -331,9 +587,44 @@ 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; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listRelatedAccountGroupMembershipsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.list_related_account_group_memberships.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_async | ||
| */ | ||
| listRelatedAccountGroupMembershipsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>; | ||
| /** | ||
| * Search group memberships related to a given account. | ||
| * | ||
| * @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 {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [RelatedAccountGroupMembership]{@link google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * 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. | ||
| */ | ||
| 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]>; | ||
@@ -415,7 +706,4 @@ 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; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.searchRelatedAccountGroupMembershipsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1/recaptcha_enterprise_service.search_related_account_group_memberships.js</caption> | ||
| * region_tag:recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_async | ||
| */ | ||
@@ -422,0 +710,0 @@ searchRelatedAccountGroupMembershipsAsync(request?: protos.google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IRelatedAccountGroupMembership>; |
@@ -104,20 +104,164 @@ /// <reference types="node" /> | ||
| getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
| /** | ||
| * Creates an Assessment of the likelihood an event is legitimate. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the assessment will be created, | ||
| * in the format "projects/{project_number}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Assessment} request.assessment | ||
| * Required. The assessment details. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Assessment]{@link google.cloud.recaptchaenterprise.v1beta1.Assessment}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_assessment.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_CreateAssessment_async | ||
| */ | ||
| createAssessment(request?: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IAssessment, (protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest | undefined), {} | undefined]>; | ||
| createAssessment(request: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IAssessment, protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| createAssessment(request: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IAssessment, protos.google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Annotates a previously created Assessment to provide additional information | ||
| * on whether the event turned out to be authentic or fradulent. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The resource name of the Assessment, in the format | ||
| * "projects/{project_number}/assessments/{assessment_id}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation} request.annotation | ||
| * Required. The annotation that will be assigned to the Event. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [AnnotateAssessmentResponse]{@link google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.annotate_assessment.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_AnnotateAssessment_async | ||
| */ | ||
| annotateAssessment(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentResponse, (protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest | undefined), {} | undefined]>; | ||
| annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Creates a new reCAPTCHA Enterprise key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the key will be created, in the | ||
| * format "projects/{project_number}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Key} request.key | ||
| * Required. Information to create a reCAPTCHA Enterprise key. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_CreateKey_async | ||
| */ | ||
| createKey(request?: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IKey, (protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest | undefined), {} | undefined]>; | ||
| createKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| createKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Returns the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the requested key, in the format | ||
| * "projects/{project_number}/keys/{key_id}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.get_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_GetKey_async | ||
| */ | ||
| getKey(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IKey, (protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest | undefined), {} | undefined]>; | ||
| getKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| getKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Updates the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Key} request.key | ||
| * Required. The key to update. | ||
| * @param {google.protobuf.FieldMask} [request.updateMask] | ||
| * Optional. The mask to control which field of the key get updated. If the mask is not | ||
| * present, all fields will be updated. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.update_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_UpdateKey_async | ||
| */ | ||
| updateKey(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IKey, (protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest | undefined), {} | undefined]>; | ||
| updateKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| updateKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1beta1.IKey, protos.google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Deletes the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the key to be deleted, in the format | ||
| * "projects/{project_number}/keys/{key_id}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.delete_key.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_DeleteKey_async | ||
| */ | ||
| deleteKey(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest | undefined), {} | undefined]>; | ||
| deleteKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| deleteKey(request: protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void; | ||
| /** | ||
| * Returns the list of all keys that belong to a project. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project that contains the keys that will be | ||
| * listed, in the format "projects/{project_number}". | ||
| * @param {number} [request.pageSize] | ||
| * Optional. The maximum number of keys to return. Default is 10. Max limit is | ||
| * 1000. | ||
| * @param {string} [request.pageToken] | ||
| * Optional. The next_page_token value returned from a previous. | ||
| * ListKeysRequest, if any. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * Note that it can affect your quota. | ||
| * We recommend using `listKeysAsync()` | ||
| * 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. | ||
| */ | ||
| listKeys(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1beta1.IKey[], protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest | null, protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysResponse]>; | ||
@@ -177,7 +321,4 @@ listKeys(request: protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1beta1.IKey>): void; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listKeysAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.list_keys.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_ListKeys_async | ||
| */ | ||
@@ -184,0 +325,0 @@ listKeysAsync(request?: protos.google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1beta1.IKey>; |
@@ -242,22 +242,2 @@ "use strict"; | ||
| } | ||
| /** | ||
| * Creates an Assessment of the likelihood an event is legitimate. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the assessment will be created, | ||
| * in the format "projects/{project_number}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Assessment} request.assessment | ||
| * Required. The assessment details. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Assessment]{@link google.cloud.recaptchaenterprise.v1beta1.Assessment}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.createAssessment(request); | ||
| */ | ||
| createAssessment(request, optionsOrCallback, callback) { | ||
@@ -283,23 +263,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Annotates a previously created Assessment to provide additional information | ||
| * on whether the event turned out to be authentic or fradulent. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The resource name of the Assessment, in the format | ||
| * "projects/{project_number}/assessments/{assessment_id}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation} request.annotation | ||
| * Required. The annotation that will be assigned to the Event. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [AnnotateAssessmentResponse]{@link google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.annotateAssessment(request); | ||
| */ | ||
| annotateAssessment(request, optionsOrCallback, callback) { | ||
@@ -325,22 +284,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Creates a new reCAPTCHA Enterprise key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project in which the key will be created, in the | ||
| * format "projects/{project_number}". | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Key} request.key | ||
| * Required. Information to create a reCAPTCHA Enterprise key. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.createKey(request); | ||
| */ | ||
| createKey(request, optionsOrCallback, callback) { | ||
@@ -366,20 +305,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Returns the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the requested key, in the format | ||
| * "projects/{project_number}/keys/{key_id}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.getKey(request); | ||
| */ | ||
| getKey(request, optionsOrCallback, callback) { | ||
@@ -405,22 +326,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Updates the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {google.cloud.recaptchaenterprise.v1beta1.Key} request.key | ||
| * Required. The key to update. | ||
| * @param {google.protobuf.FieldMask} [request.updateMask] | ||
| * Optional. The mask to control which field of the key get updated. If the mask is not | ||
| * present, all fields will be updated. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.updateKey(request); | ||
| */ | ||
| updateKey(request, optionsOrCallback, callback) { | ||
@@ -446,20 +347,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Deletes the specified key. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.name | ||
| * Required. The name of the key to be deleted, in the format | ||
| * "projects/{project_number}/keys/{key_id}". | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
| * for more details and examples. | ||
| * @example | ||
| * const [response] = await client.deleteKey(request); | ||
| */ | ||
| deleteKey(request, optionsOrCallback, callback) { | ||
@@ -485,29 +368,2 @@ request = request || {}; | ||
| } | ||
| /** | ||
| * Returns the list of all keys that belong to a project. | ||
| * | ||
| * @param {Object} request | ||
| * The request object that will be sent. | ||
| * @param {string} request.parent | ||
| * Required. The name of the project that contains the keys that will be | ||
| * listed, in the format "projects/{project_number}". | ||
| * @param {number} [request.pageSize] | ||
| * Optional. The maximum number of keys to return. Default is 10. Max limit is | ||
| * 1000. | ||
| * @param {string} [request.pageToken] | ||
| * Optional. The next_page_token value returned from a previous. | ||
| * ListKeysRequest, if any. | ||
| * @param {object} [options] | ||
| * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
| * @returns {Promise} - The promise which resolves to an array. | ||
| * The first element of the array is Array of [Key]{@link google.cloud.recaptchaenterprise.v1beta1.Key}. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed and will merge results from all the pages into this array. | ||
| * Note that it can affect your quota. | ||
| * We recommend using `listKeysAsync()` | ||
| * 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. | ||
| */ | ||
| listKeys(request, optionsOrCallback, callback) { | ||
@@ -597,7 +453,4 @@ request = request || {}; | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listKeysAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| * @example <caption>include:samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.list_keys.js</caption> | ||
| * region_tag:recaptchaenterprise_v1beta1_generated_RecaptchaEnterpriseServiceV1Beta1_ListKeys_async | ||
| */ | ||
@@ -613,3 +466,2 @@ listKeysAsync(request, options) { | ||
| }); | ||
| options = options || {}; | ||
| const defaultCallSettings = this._defaults['listKeys']; | ||
@@ -616,0 +468,0 @@ const callSettings = defaultCallSettings.merge(options); |
@@ -7,2 +7,9 @@ # Changelog | ||
| ## [2.5.0](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/compare/v2.4.0...v2.5.0) (2021-12-10) | ||
| ### Features | ||
| * add new reCAPTCHA Enterprise fraud annotations ([#334](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/issues/334)) ([24fdff1](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/commit/24fdff1520fb8ff3192be7d256f7a7875d5803b6)) | ||
| ## [2.4.0](https://www.github.com/googleapis/nodejs-recaptcha-enterprise/compare/v2.3.0...v2.4.0) (2021-11-09) | ||
@@ -9,0 +16,0 @@ |
| { | ||
| "repository": "googleapis/nodejs-recaptcha-enterprise", | ||
| "name": "@google-cloud/recaptcha-enterprise", | ||
| "version": "2.4.0", | ||
| "version": "2.5.0", | ||
| "author": "Google LLC", | ||
@@ -6,0 +6,0 @@ "description": "reCAPTCHA Enterprise API client for Node.js", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.15%
2322707
Worsened metrics
- Lines of code
- decreased by-0.05%
36160
No dependency changes