@maxim_mazurok/gapi.client.recaptchaenterprise-v1 0.1.20260310 → 0.2.20260531

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.
Files changed (3) hide show
  1. package/index.d.ts +208 -92
  2. package/package.json +1 -1
  3. package/readme.md +17 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://recaptchaenterprise.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260310
12
+ // Revision: 20260531
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -32,11 +32,21 @@ declare namespace gapi.client {
32
32
  /** Output only. Account takeover risk assessment for this request. */
33
33
  accountTakeoverVerdict?: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict;
34
34
  /** Output only. Labels for this request. */
35
- labels?: string[];
35
+ labels?:
36
+ | 'ACCOUNT_DEFENDER_LABEL_UNSPECIFIED'
37
+ | 'PROFILE_MATCH'
38
+ | 'SUSPICIOUS_LOGIN_ACTIVITY'
39
+ | 'SUSPICIOUS_ACCOUNT_CREATION'
40
+ | 'RELATED_ACCOUNTS_NUMBER_HIGH'[];
36
41
  }
37
42
  interface GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason {
38
43
  /** Output only. A risk reason associated with this request. */
39
- reason?: string;
44
+ reason?:
45
+ | 'RISK_REASON_UNSPECIFIED'
46
+ | 'CLIENT_HISTORICAL_BOT_ACTIVITY'
47
+ | 'ACCOUNT_IN_LARGE_RELATED_GROUP'
48
+ | 'CLIENT_ACCESSED_MANY_ACCOUNTS'
49
+ | 'DISPOSABLE_EMAIL_DOMAIN';
40
50
  }
41
51
  interface GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict {
42
52
  /** Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk). */
@@ -48,7 +58,10 @@ declare namespace gapi.client {
48
58
  }
49
59
  interface GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason {
50
60
  /** Output only. A trust reason associated with this request. */
51
- reason?: string;
61
+ reason?:
62
+ | 'TRUST_REASON_UNSPECIFIED'
63
+ | 'PROFILE_MATCH'
64
+ | 'ACCOUNT_HISTORY_REPUTABLE';
52
65
  }
53
66
  interface GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo {
54
67
  /** Optional. Endpoints that can be used for identity verification. */
@@ -56,7 +69,17 @@ declare namespace gapi.client {
56
69
  /** Optional. Language code preference for the verification message, set as a IETF BCP 47 language code. */
57
70
  languageCode?: string;
58
71
  /** Output only. Result of the latest account verification challenge. */
59
- latestVerificationResult?: string;
72
+ latestVerificationResult?:
73
+ | 'RESULT_UNSPECIFIED'
74
+ | 'SUCCESS_USER_VERIFIED'
75
+ | 'ERROR_USER_NOT_VERIFIED'
76
+ | 'ERROR_SITE_ONBOARDING_INCOMPLETE'
77
+ | 'ERROR_RECIPIENT_NOT_ALLOWED'
78
+ | 'ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED'
79
+ | 'ERROR_CRITICAL_INTERNAL'
80
+ | 'ERROR_CUSTOMER_QUOTA_EXHAUSTED'
81
+ | 'ERROR_VERIFICATION_BYPASSED'
82
+ | 'ERROR_VERDICT_MISMATCH';
60
83
  /** Username of the account that is being verified. Deprecated. Customers should now provide the `account_id` field in `event.user_info`. */
61
84
  username?: string;
62
85
  }
@@ -77,13 +100,33 @@ declare namespace gapi.client {
77
100
  /** Optional. A stable account identifier to apply to the assessment. This is an alternative to setting `account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. */
78
101
  accountId?: string;
79
102
  /** Optional. The annotation that is 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. */
80
- annotation?: string;
103
+ annotation?:
104
+ | 'ANNOTATION_UNSPECIFIED'
105
+ | 'LEGITIMATE'
106
+ | 'FRAUDULENT'
107
+ | 'PASSWORD_CORRECT'
108
+ | 'PASSWORD_INCORRECT';
81
109
  /** Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. */
82
110
  hashedAccountId?: string;
83
111
  /** Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes. */
84
112
  phoneAuthenticationEvent?: GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent;
85
113
  /** Optional. Reasons for the annotation that are assigned to the event. */
86
- reasons?: string[];
114
+ reasons?:
115
+ | 'REASON_UNSPECIFIED'
116
+ | 'CHARGEBACK'
117
+ | 'CHARGEBACK_FRAUD'
118
+ | 'CHARGEBACK_DISPUTE'
119
+ | 'REFUND'
120
+ | 'REFUND_FRAUD'
121
+ | 'TRANSACTION_ACCEPTED'
122
+ | 'TRANSACTION_DECLINED'
123
+ | 'PAYMENT_HEURISTICS'
124
+ | 'INITIATED_TWO_FACTOR'
125
+ | 'PASSED_TWO_FACTOR'
126
+ | 'FAILED_TWO_FACTOR'
127
+ | 'CORRECT_PASSWORD'
128
+ | 'INCORRECT_PASSWORD'
129
+ | 'SOCIAL_SPAM'[];
87
130
  /** Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction. */
88
131
  transactionEvent?: GoogleCloudRecaptchaenterpriseV1TransactionEvent;
89
132
  }
@@ -130,8 +173,12 @@ declare namespace gapi.client {
130
173
  }
131
174
  interface GoogleCloudRecaptchaenterpriseV1Bot {
132
175
  /** Optional. Enumerated field representing the type of bot. */
133
- botType?: string;
134
- /** Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. */
176
+ botType?:
177
+ | 'BOT_TYPE_UNSPECIFIED'
178
+ | 'AI_AGENT'
179
+ | 'CONTENT_SCRAPER'
180
+ | 'SEARCH_INDEXER';
181
+ /** Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. */
135
182
  name?: string;
136
183
  }
137
184
  interface GoogleCloudRecaptchaenterpriseV1ChallengeMetrics {
@@ -162,7 +209,7 @@ declare namespace gapi.client {
162
209
  /** Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response. */
163
210
  firewallPolicyEvaluation?: boolean;
164
211
  /** Optional. The Fraud Prevention setting for this assessment. */
165
- fraudPrevention?: string;
212
+ fraudPrevention?: 'FRAUD_PREVENTION_UNSPECIFIED' | 'ENABLED' | 'DISABLED';
166
213
  /** Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. */
167
214
  hashedAccountId?: string;
168
215
  /** Optional. HTTP header information about the request. */
@@ -257,7 +304,13 @@ declare namespace gapi.client {
257
304
  }
258
305
  interface GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason {
259
306
  /** Output only. Risk reasons applicable to the Fraud Prevention assessment. */
260
- reason?: string;
307
+ reason?:
308
+ | 'REASON_UNSPECIFIED'
309
+ | 'HIGH_TRANSACTION_VELOCITY'
310
+ | 'EXCESSIVE_ENUMERATION_PATTERN'
311
+ | 'SHORT_IDENTITY_HISTORY'
312
+ | 'GEOLOCATION_DISCREPANCY'
313
+ | 'ASSOCIATED_WITH_FRAUD_CLUSTER';
261
314
  }
262
315
  interface GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict {
263
316
  /** Output only. Probability of this transaction being executed with a stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). */
@@ -271,7 +324,11 @@ declare namespace gapi.client {
271
324
  }
272
325
  interface GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals {
273
326
  /** Output only. The labels for the payment card in this transaction. */
274
- cardLabels?: string[];
327
+ cardLabels?:
328
+ | 'CARD_LABEL_UNSPECIFIED'
329
+ | 'PREPAID'
330
+ | 'VIRTUAL'
331
+ | 'UNEXPECTED_LOCATION'[];
275
332
  }
276
333
  interface GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals {
277
334
  /** Output only. This user (based on email, phone, and other identifiers) has been seen on the internet for at least this number of days. */
@@ -291,7 +348,7 @@ declare namespace gapi.client {
291
348
  /** Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48 */
292
349
  ip?: string;
293
350
  /** Required. Describes the type of IP override. */
294
- overrideType?: string;
351
+ overrideType?: 'OVERRIDE_TYPE_UNSPECIFIED' | 'ALLOW';
295
352
  }
296
353
  interface GoogleCloudRecaptchaenterpriseV1Key {
297
354
  /** Settings for keys that can be used by Android apps. */
@@ -407,11 +464,19 @@ declare namespace gapi.client {
407
464
  }
408
465
  interface GoogleCloudRecaptchaenterpriseV1RiskAnalysis {
409
466
  /** Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. */
410
- challenge?: string;
411
- /** Output only. Advanced reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of possible reasons is subject to change. */
467
+ challenge?: 'CHALLENGE_UNSPECIFIED' | 'NOCAPTCHA' | 'PASSED' | 'FAILED';
468
+ /** Output only. Additional reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change. */
412
469
  extendedVerdictReasons?: string[];
413
470
  /** Output only. Reasons contributing to the risk analysis verdict. */
414
- reasons?: string[];
471
+ reasons?:
472
+ | 'CLASSIFICATION_REASON_UNSPECIFIED'
473
+ | 'AUTOMATION'
474
+ | 'UNEXPECTED_ENVIRONMENT'
475
+ | 'TOO_MUCH_TRAFFIC'
476
+ | 'UNEXPECTED_USAGE_PATTERNS'
477
+ | 'LOW_CONFIDENCE_SCORE'
478
+ | 'SUSPECTED_CARDING'
479
+ | 'SUSPECTED_CHARGEBACK'[];
415
480
  /** Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic). */
416
481
  score?: number;
417
482
  /** Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event. */
@@ -447,13 +512,16 @@ declare namespace gapi.client {
447
512
  }
448
513
  interface GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict {
449
514
  /** Output only. Reasons contributing to the SMS toll fraud verdict. */
450
- reasons?: string[];
515
+ reasons?: 'SMS_TOLL_FRAUD_REASON_UNSPECIFIED' | 'INVALID_PHONE_NUMBER'[];
451
516
  /** Output only. Probability of an SMS event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest). */
452
517
  risk?: number;
453
518
  }
454
519
  interface GoogleCloudRecaptchaenterpriseV1TestingOptions {
455
520
  /** Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. */
456
- testingChallenge?: string;
521
+ testingChallenge?:
522
+ | 'TESTING_CHALLENGE_UNSPECIFIED'
523
+ | 'NOCAPTCHA'
524
+ | 'UNSOLVABLE_CHALLENGE';
457
525
  /** Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. */
458
526
  testingScore?: number;
459
527
  }
@@ -467,10 +535,20 @@ declare namespace gapi.client {
467
535
  /** Output only. The hostname of the page on which the token was generated (Web keys only). */
468
536
  hostname?: string;
469
537
  /** Output only. Reason associated with the response when valid = false. */
470
- invalidReason?: string;
538
+ invalidReason?:
539
+ | 'INVALID_REASON_UNSPECIFIED'
540
+ | 'UNKNOWN_INVALID_REASON'
541
+ | 'MALFORMED'
542
+ | 'EXPIRED'
543
+ | 'DUPE'
544
+ | 'MISSING'
545
+ | 'BROWSER_ERROR'
546
+ | 'UNEXPECTED_ACTION'
547
+ | 'KEY_MISMATCH'
548
+ | 'DOMAIN_MISMATCH';
471
549
  /** Output only. The ID of the iOS bundle with which the token was generated (iOS keys only). */
472
550
  iosBundleId?: string;
473
- /** Output only. Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment). */
551
+ /** Output only. Indicates whether the provided user response token is valid. If `false`, the token is invalid, either because the user failed the challenge or for a reason provided in the `invalid_reason` field. */
474
552
  valid?: boolean;
475
553
  }
476
554
  interface GoogleCloudRecaptchaenterpriseV1TransactionData {
@@ -553,7 +631,26 @@ declare namespace gapi.client {
553
631
  /** Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call. */
554
632
  eventTime?: string;
555
633
  /** Optional. The type of this transaction event. */
556
- eventType?: string;
634
+ eventType?:
635
+ | 'TRANSACTION_EVENT_TYPE_UNSPECIFIED'
636
+ | 'MERCHANT_APPROVE'
637
+ | 'MERCHANT_DENY'
638
+ | 'MANUAL_REVIEW'
639
+ | 'AUTHORIZATION'
640
+ | 'AUTHORIZATION_DECLINE'
641
+ | 'PAYMENT_CAPTURE'
642
+ | 'PAYMENT_CAPTURE_DECLINE'
643
+ | 'CANCEL'
644
+ | 'CHARGEBACK_INQUIRY'
645
+ | 'CHARGEBACK_ALERT'
646
+ | 'FRAUD_NOTIFICATION'
647
+ | 'CHARGEBACK'
648
+ | 'CHARGEBACK_REPRESENTMENT'
649
+ | 'CHARGEBACK_REVERSE'
650
+ | 'REFUND_REQUEST'
651
+ | 'REFUND_DECLINE'
652
+ | 'REFUND'
653
+ | 'REFUND_REVERSE';
557
654
  /** Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005. */
558
655
  reason?: string;
559
656
  /** Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data. */
@@ -577,9 +674,19 @@ declare namespace gapi.client {
577
674
  }
578
675
  interface GoogleCloudRecaptchaenterpriseV1WafSettings {
579
676
  /** Required. The Web Application Firewall (WAF) feature for which this key is enabled. */
580
- wafFeature?: string;
677
+ wafFeature?:
678
+ | 'WAF_FEATURE_UNSPECIFIED'
679
+ | 'CHALLENGE_PAGE'
680
+ | 'SESSION_TOKEN'
681
+ | 'ACTION_TOKEN'
682
+ | 'EXPRESS';
581
683
  /** Required. The Web Application Firewall (WAF) service that uses this key. */
582
- wafService?: string;
684
+ wafService?:
685
+ | 'WAF_SERVICE_UNSPECIFIED'
686
+ | 'CA'
687
+ | 'FASTLY'
688
+ | 'CLOUDFLARE'
689
+ | 'AKAMAI';
583
690
  }
584
691
  interface GoogleCloudRecaptchaenterpriseV1WebKeySettings {
585
692
  /** Optional. If set to true, it means allowed_domains are not enforced. */
@@ -589,11 +696,20 @@ declare namespace gapi.client {
589
696
  /** Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each key supports a maximum of 250 domains. To use a key on more domains, set `allow_all_domains` to true. When this is set, you are responsible for validating the hostname by checking the `token_properties.hostname` field in each assessment response against your list of allowed domains. */
590
697
  allowedDomains?: string[];
591
698
  /** Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE. */
592
- challengeSecurityPreference?: string;
699
+ challengeSecurityPreference?:
700
+ | 'CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED'
701
+ | 'USABILITY'
702
+ | 'BALANCE'
703
+ | 'SECURITY';
593
704
  /** Optional. Challenge settings. */
594
705
  challengeSettings?: GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings;
595
706
  /** Required. Describes how this key is integrated with the website. */
596
- integrationType?: string;
707
+ integrationType?:
708
+ | 'INTEGRATION_TYPE_UNSPECIFIED'
709
+ | 'SCORE'
710
+ | 'CHECKBOX'
711
+ | 'INVISIBLE'
712
+ | 'POLICY_BASED_CHALLENGE';
597
713
  }
598
714
  interface GoogleCloudRecaptchaenterpriseV1WebKeySettingsActionSettings {
599
715
  /** Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive). */
@@ -612,7 +728,7 @@ declare namespace gapi.client {
612
728
  /** The status code, which should be an enum value of google.rpc.Code. */
613
729
  code?: number;
614
730
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
615
- details?: Array<{[P in string]: any}>;
731
+ details?: {[P in string]: any}[];
616
732
  /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
617
733
  message?: string;
618
734
  }
@@ -620,11 +736,11 @@ declare namespace gapi.client {
620
736
  /** Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent. */
621
737
  annotate(request: {
622
738
  /** V1 error format. */
623
- '$.xgafv'?: string;
739
+ '$.xgafv'?: '1' | '2';
624
740
  /** OAuth access token. */
625
741
  access_token?: string;
626
742
  /** Data format for response. */
627
- alt?: string;
743
+ alt?: 'json' | 'media' | 'proto';
628
744
  /** JSONP */
629
745
  callback?: string;
630
746
  /** Selector specifying which fields to include in a partial response. */
@@ -649,11 +765,11 @@ declare namespace gapi.client {
649
765
  annotate(
650
766
  request: {
651
767
  /** V1 error format. */
652
- '$.xgafv'?: string;
768
+ '$.xgafv'?: '1' | '2';
653
769
  /** OAuth access token. */
654
770
  access_token?: string;
655
771
  /** Data format for response. */
656
- alt?: string;
772
+ alt?: 'json' | 'media' | 'proto';
657
773
  /** JSONP */
658
774
  callback?: string;
659
775
  /** Selector specifying which fields to include in a partial response. */
@@ -678,11 +794,11 @@ declare namespace gapi.client {
678
794
  /** Creates an Assessment of the likelihood an event is legitimate. */
679
795
  create(request: {
680
796
  /** V1 error format. */
681
- '$.xgafv'?: string;
797
+ '$.xgafv'?: '1' | '2';
682
798
  /** OAuth access token. */
683
799
  access_token?: string;
684
800
  /** Data format for response. */
685
- alt?: string;
801
+ alt?: 'json' | 'media' | 'proto';
686
802
  /** JSONP */
687
803
  callback?: string;
688
804
  /** Selector specifying which fields to include in a partial response. */
@@ -707,11 +823,11 @@ declare namespace gapi.client {
707
823
  create(
708
824
  request: {
709
825
  /** V1 error format. */
710
- '$.xgafv'?: string;
826
+ '$.xgafv'?: '1' | '2';
711
827
  /** OAuth access token. */
712
828
  access_token?: string;
713
829
  /** Data format for response. */
714
- alt?: string;
830
+ alt?: 'json' | 'media' | 'proto';
715
831
  /** JSONP */
716
832
  callback?: string;
717
833
  /** Selector specifying which fields to include in a partial response. */
@@ -738,11 +854,11 @@ declare namespace gapi.client {
738
854
  /** Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies. */
739
855
  create(request: {
740
856
  /** V1 error format. */
741
- '$.xgafv'?: string;
857
+ '$.xgafv'?: '1' | '2';
742
858
  /** OAuth access token. */
743
859
  access_token?: string;
744
860
  /** Data format for response. */
745
- alt?: string;
861
+ alt?: 'json' | 'media' | 'proto';
746
862
  /** JSONP */
747
863
  callback?: string;
748
864
  /** Selector specifying which fields to include in a partial response. */
@@ -767,11 +883,11 @@ declare namespace gapi.client {
767
883
  create(
768
884
  request: {
769
885
  /** V1 error format. */
770
- '$.xgafv'?: string;
886
+ '$.xgafv'?: '1' | '2';
771
887
  /** OAuth access token. */
772
888
  access_token?: string;
773
889
  /** Data format for response. */
774
- alt?: string;
890
+ alt?: 'json' | 'media' | 'proto';
775
891
  /** JSONP */
776
892
  callback?: string;
777
893
  /** Selector specifying which fields to include in a partial response. */
@@ -796,11 +912,11 @@ declare namespace gapi.client {
796
912
  /** Deletes the specified firewall policy. */
797
913
  delete(request?: {
798
914
  /** V1 error format. */
799
- '$.xgafv'?: string;
915
+ '$.xgafv'?: '1' | '2';
800
916
  /** OAuth access token. */
801
917
  access_token?: string;
802
918
  /** Data format for response. */
803
- alt?: string;
919
+ alt?: 'json' | 'media' | 'proto';
804
920
  /** JSONP */
805
921
  callback?: string;
806
922
  /** Selector specifying which fields to include in a partial response. */
@@ -823,11 +939,11 @@ declare namespace gapi.client {
823
939
  /** Returns the specified firewall policy. */
824
940
  get(request?: {
825
941
  /** V1 error format. */
826
- '$.xgafv'?: string;
942
+ '$.xgafv'?: '1' | '2';
827
943
  /** OAuth access token. */
828
944
  access_token?: string;
829
945
  /** Data format for response. */
830
- alt?: string;
946
+ alt?: 'json' | 'media' | 'proto';
831
947
  /** JSONP */
832
948
  callback?: string;
833
949
  /** Selector specifying which fields to include in a partial response. */
@@ -850,11 +966,11 @@ declare namespace gapi.client {
850
966
  /** Returns the list of all firewall policies that belong to a project. */
851
967
  list(request?: {
852
968
  /** V1 error format. */
853
- '$.xgafv'?: string;
969
+ '$.xgafv'?: '1' | '2';
854
970
  /** OAuth access token. */
855
971
  access_token?: string;
856
972
  /** Data format for response. */
857
- alt?: string;
973
+ alt?: 'json' | 'media' | 'proto';
858
974
  /** JSONP */
859
975
  callback?: string;
860
976
  /** Selector specifying which fields to include in a partial response. */
@@ -881,11 +997,11 @@ declare namespace gapi.client {
881
997
  /** Updates the specified firewall policy. */
882
998
  patch(request: {
883
999
  /** V1 error format. */
884
- '$.xgafv'?: string;
1000
+ '$.xgafv'?: '1' | '2';
885
1001
  /** OAuth access token. */
886
1002
  access_token?: string;
887
1003
  /** Data format for response. */
888
- alt?: string;
1004
+ alt?: 'json' | 'media' | 'proto';
889
1005
  /** JSONP */
890
1006
  callback?: string;
891
1007
  /** Selector specifying which fields to include in a partial response. */
@@ -912,11 +1028,11 @@ declare namespace gapi.client {
912
1028
  patch(
913
1029
  request: {
914
1030
  /** V1 error format. */
915
- '$.xgafv'?: string;
1031
+ '$.xgafv'?: '1' | '2';
916
1032
  /** OAuth access token. */
917
1033
  access_token?: string;
918
1034
  /** Data format for response. */
919
- alt?: string;
1035
+ alt?: 'json' | 'media' | 'proto';
920
1036
  /** JSONP */
921
1037
  callback?: string;
922
1038
  /** Selector specifying which fields to include in a partial response. */
@@ -943,11 +1059,11 @@ declare namespace gapi.client {
943
1059
  /** Reorders all firewall policies. */
944
1060
  reorder(request: {
945
1061
  /** V1 error format. */
946
- '$.xgafv'?: string;
1062
+ '$.xgafv'?: '1' | '2';
947
1063
  /** OAuth access token. */
948
1064
  access_token?: string;
949
1065
  /** Data format for response. */
950
- alt?: string;
1066
+ alt?: 'json' | 'media' | 'proto';
951
1067
  /** JSONP */
952
1068
  callback?: string;
953
1069
  /** Selector specifying which fields to include in a partial response. */
@@ -972,11 +1088,11 @@ declare namespace gapi.client {
972
1088
  reorder(
973
1089
  request: {
974
1090
  /** V1 error format. */
975
- '$.xgafv'?: string;
1091
+ '$.xgafv'?: '1' | '2';
976
1092
  /** OAuth access token. */
977
1093
  access_token?: string;
978
1094
  /** Data format for response. */
979
- alt?: string;
1095
+ alt?: 'json' | 'media' | 'proto';
980
1096
  /** JSONP */
981
1097
  callback?: string;
982
1098
  /** Selector specifying which fields to include in a partial response. */
@@ -1003,11 +1119,11 @@ declare namespace gapi.client {
1003
1119
  /** Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned. */
1004
1120
  addIpOverride(request: {
1005
1121
  /** V1 error format. */
1006
- '$.xgafv'?: string;
1122
+ '$.xgafv'?: '1' | '2';
1007
1123
  /** OAuth access token. */
1008
1124
  access_token?: string;
1009
1125
  /** Data format for response. */
1010
- alt?: string;
1126
+ alt?: 'json' | 'media' | 'proto';
1011
1127
  /** JSONP */
1012
1128
  callback?: string;
1013
1129
  /** Selector specifying which fields to include in a partial response. */
@@ -1032,11 +1148,11 @@ declare namespace gapi.client {
1032
1148
  addIpOverride(
1033
1149
  request: {
1034
1150
  /** V1 error format. */
1035
- '$.xgafv'?: string;
1151
+ '$.xgafv'?: '1' | '2';
1036
1152
  /** OAuth access token. */
1037
1153
  access_token?: string;
1038
1154
  /** Data format for response. */
1039
- alt?: string;
1155
+ alt?: 'json' | 'media' | 'proto';
1040
1156
  /** JSONP */
1041
1157
  callback?: string;
1042
1158
  /** Selector specifying which fields to include in a partial response. */
@@ -1061,11 +1177,11 @@ declare namespace gapi.client {
1061
1177
  /** Creates a new reCAPTCHA Enterprise key. */
1062
1178
  create(request: {
1063
1179
  /** V1 error format. */
1064
- '$.xgafv'?: string;
1180
+ '$.xgafv'?: '1' | '2';
1065
1181
  /** OAuth access token. */
1066
1182
  access_token?: string;
1067
1183
  /** Data format for response. */
1068
- alt?: string;
1184
+ alt?: 'json' | 'media' | 'proto';
1069
1185
  /** JSONP */
1070
1186
  callback?: string;
1071
1187
  /** Selector specifying which fields to include in a partial response. */
@@ -1090,11 +1206,11 @@ declare namespace gapi.client {
1090
1206
  create(
1091
1207
  request: {
1092
1208
  /** V1 error format. */
1093
- '$.xgafv'?: string;
1209
+ '$.xgafv'?: '1' | '2';
1094
1210
  /** OAuth access token. */
1095
1211
  access_token?: string;
1096
1212
  /** Data format for response. */
1097
- alt?: string;
1213
+ alt?: 'json' | 'media' | 'proto';
1098
1214
  /** JSONP */
1099
1215
  callback?: string;
1100
1216
  /** Selector specifying which fields to include in a partial response. */
@@ -1119,11 +1235,11 @@ declare namespace gapi.client {
1119
1235
  /** Deletes the specified key. */
1120
1236
  delete(request?: {
1121
1237
  /** V1 error format. */
1122
- '$.xgafv'?: string;
1238
+ '$.xgafv'?: '1' | '2';
1123
1239
  /** OAuth access token. */
1124
1240
  access_token?: string;
1125
1241
  /** Data format for response. */
1126
- alt?: string;
1242
+ alt?: 'json' | 'media' | 'proto';
1127
1243
  /** JSONP */
1128
1244
  callback?: string;
1129
1245
  /** Selector specifying which fields to include in a partial response. */
@@ -1146,11 +1262,11 @@ declare namespace gapi.client {
1146
1262
  /** Returns the specified key. */
1147
1263
  get(request?: {
1148
1264
  /** V1 error format. */
1149
- '$.xgafv'?: string;
1265
+ '$.xgafv'?: '1' | '2';
1150
1266
  /** OAuth access token. */
1151
1267
  access_token?: string;
1152
1268
  /** Data format for response. */
1153
- alt?: string;
1269
+ alt?: 'json' | 'media' | 'proto';
1154
1270
  /** JSONP */
1155
1271
  callback?: string;
1156
1272
  /** Selector specifying which fields to include in a partial response. */
@@ -1173,11 +1289,11 @@ declare namespace gapi.client {
1173
1289
  /** Get some aggregated metrics for a Key. This data can be used to build dashboards. */
1174
1290
  getMetrics(request?: {
1175
1291
  /** V1 error format. */
1176
- '$.xgafv'?: string;
1292
+ '$.xgafv'?: '1' | '2';
1177
1293
  /** OAuth access token. */
1178
1294
  access_token?: string;
1179
1295
  /** Data format for response. */
1180
- alt?: string;
1296
+ alt?: 'json' | 'media' | 'proto';
1181
1297
  /** JSONP */
1182
1298
  callback?: string;
1183
1299
  /** Selector specifying which fields to include in a partial response. */
@@ -1200,11 +1316,11 @@ declare namespace gapi.client {
1200
1316
  /** Returns the list of all keys that belong to a project. */
1201
1317
  list(request?: {
1202
1318
  /** V1 error format. */
1203
- '$.xgafv'?: string;
1319
+ '$.xgafv'?: '1' | '2';
1204
1320
  /** OAuth access token. */
1205
1321
  access_token?: string;
1206
1322
  /** Data format for response. */
1207
- alt?: string;
1323
+ alt?: 'json' | 'media' | 'proto';
1208
1324
  /** JSONP */
1209
1325
  callback?: string;
1210
1326
  /** Selector specifying which fields to include in a partial response. */
@@ -1231,11 +1347,11 @@ declare namespace gapi.client {
1231
1347
  /** Lists all IP overrides for a key. */
1232
1348
  listIpOverrides(request?: {
1233
1349
  /** V1 error format. */
1234
- '$.xgafv'?: string;
1350
+ '$.xgafv'?: '1' | '2';
1235
1351
  /** OAuth access token. */
1236
1352
  access_token?: string;
1237
1353
  /** Data format for response. */
1238
- alt?: string;
1354
+ alt?: 'json' | 'media' | 'proto';
1239
1355
  /** JSONP */
1240
1356
  callback?: string;
1241
1357
  /** Selector specifying which fields to include in a partial response. */
@@ -1262,11 +1378,11 @@ declare namespace gapi.client {
1262
1378
  /** 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 Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project. */
1263
1379
  migrate(request: {
1264
1380
  /** V1 error format. */
1265
- '$.xgafv'?: string;
1381
+ '$.xgafv'?: '1' | '2';
1266
1382
  /** OAuth access token. */
1267
1383
  access_token?: string;
1268
1384
  /** Data format for response. */
1269
- alt?: string;
1385
+ alt?: 'json' | 'media' | 'proto';
1270
1386
  /** JSONP */
1271
1387
  callback?: string;
1272
1388
  /** Selector specifying which fields to include in a partial response. */
@@ -1291,11 +1407,11 @@ declare namespace gapi.client {
1291
1407
  migrate(
1292
1408
  request: {
1293
1409
  /** V1 error format. */
1294
- '$.xgafv'?: string;
1410
+ '$.xgafv'?: '1' | '2';
1295
1411
  /** OAuth access token. */
1296
1412
  access_token?: string;
1297
1413
  /** Data format for response. */
1298
- alt?: string;
1414
+ alt?: 'json' | 'media' | 'proto';
1299
1415
  /** JSONP */
1300
1416
  callback?: string;
1301
1417
  /** Selector specifying which fields to include in a partial response. */
@@ -1320,11 +1436,11 @@ declare namespace gapi.client {
1320
1436
  /** Updates the specified key. */
1321
1437
  patch(request: {
1322
1438
  /** V1 error format. */
1323
- '$.xgafv'?: string;
1439
+ '$.xgafv'?: '1' | '2';
1324
1440
  /** OAuth access token. */
1325
1441
  access_token?: string;
1326
1442
  /** Data format for response. */
1327
- alt?: string;
1443
+ alt?: 'json' | 'media' | 'proto';
1328
1444
  /** JSONP */
1329
1445
  callback?: string;
1330
1446
  /** Selector specifying which fields to include in a partial response. */
@@ -1351,11 +1467,11 @@ declare namespace gapi.client {
1351
1467
  patch(
1352
1468
  request: {
1353
1469
  /** V1 error format. */
1354
- '$.xgafv'?: string;
1470
+ '$.xgafv'?: '1' | '2';
1355
1471
  /** OAuth access token. */
1356
1472
  access_token?: string;
1357
1473
  /** Data format for response. */
1358
- alt?: string;
1474
+ alt?: 'json' | 'media' | 'proto';
1359
1475
  /** JSONP */
1360
1476
  callback?: string;
1361
1477
  /** Selector specifying which fields to include in a partial response. */
@@ -1382,11 +1498,11 @@ declare namespace gapi.client {
1382
1498
  /** Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned. */
1383
1499
  removeIpOverride(request: {
1384
1500
  /** V1 error format. */
1385
- '$.xgafv'?: string;
1501
+ '$.xgafv'?: '1' | '2';
1386
1502
  /** OAuth access token. */
1387
1503
  access_token?: string;
1388
1504
  /** Data format for response. */
1389
- alt?: string;
1505
+ alt?: 'json' | 'media' | 'proto';
1390
1506
  /** JSONP */
1391
1507
  callback?: string;
1392
1508
  /** Selector specifying which fields to include in a partial response. */
@@ -1411,11 +1527,11 @@ declare namespace gapi.client {
1411
1527
  removeIpOverride(
1412
1528
  request: {
1413
1529
  /** V1 error format. */
1414
- '$.xgafv'?: string;
1530
+ '$.xgafv'?: '1' | '2';
1415
1531
  /** OAuth access token. */
1416
1532
  access_token?: string;
1417
1533
  /** Data format for response. */
1418
- alt?: string;
1534
+ alt?: 'json' | 'media' | 'proto';
1419
1535
  /** JSONP */
1420
1536
  callback?: string;
1421
1537
  /** Selector specifying which fields to include in a partial response. */
@@ -1440,11 +1556,11 @@ declare namespace gapi.client {
1440
1556
  /** Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA. */
1441
1557
  retrieveLegacySecretKey(request?: {
1442
1558
  /** V1 error format. */
1443
- '$.xgafv'?: string;
1559
+ '$.xgafv'?: '1' | '2';
1444
1560
  /** OAuth access token. */
1445
1561
  access_token?: string;
1446
1562
  /** Data format for response. */
1447
- alt?: string;
1563
+ alt?: 'json' | 'media' | 'proto';
1448
1564
  /** JSONP */
1449
1565
  callback?: string;
1450
1566
  /** Selector specifying which fields to include in a partial response. */
@@ -1467,11 +1583,11 @@ declare namespace gapi.client {
1467
1583
  /** Search group memberships related to a given account. */
1468
1584
  search(request: {
1469
1585
  /** V1 error format. */
1470
- '$.xgafv'?: string;
1586
+ '$.xgafv'?: '1' | '2';
1471
1587
  /** OAuth access token. */
1472
1588
  access_token?: string;
1473
1589
  /** Data format for response. */
1474
- alt?: string;
1590
+ alt?: 'json' | 'media' | 'proto';
1475
1591
  /** JSONP */
1476
1592
  callback?: string;
1477
1593
  /** Selector specifying which fields to include in a partial response. */
@@ -1496,11 +1612,11 @@ declare namespace gapi.client {
1496
1612
  search(
1497
1613
  request: {
1498
1614
  /** V1 error format. */
1499
- '$.xgafv'?: string;
1615
+ '$.xgafv'?: '1' | '2';
1500
1616
  /** OAuth access token. */
1501
1617
  access_token?: string;
1502
1618
  /** Data format for response. */
1503
- alt?: string;
1619
+ alt?: 'json' | 'media' | 'proto';
1504
1620
  /** JSONP */
1505
1621
  callback?: string;
1506
1622
  /** Selector specifying which fields to include in a partial response. */
@@ -1527,11 +1643,11 @@ declare namespace gapi.client {
1527
1643
  /** Get memberships in a group of related accounts. */
1528
1644
  list(request?: {
1529
1645
  /** V1 error format. */
1530
- '$.xgafv'?: string;
1646
+ '$.xgafv'?: '1' | '2';
1531
1647
  /** OAuth access token. */
1532
1648
  access_token?: string;
1533
1649
  /** Data format for response. */
1534
- alt?: string;
1650
+ alt?: 'json' | 'media' | 'proto';
1535
1651
  /** JSONP */
1536
1652
  callback?: string;
1537
1653
  /** Selector specifying which fields to include in a partial response. */
@@ -1560,11 +1676,11 @@ declare namespace gapi.client {
1560
1676
  /** List groups of related accounts. */
1561
1677
  list(request?: {
1562
1678
  /** V1 error format. */
1563
- '$.xgafv'?: string;
1679
+ '$.xgafv'?: '1' | '2';
1564
1680
  /** OAuth access token. */
1565
1681
  access_token?: string;
1566
1682
  /** Data format for response. */
1567
- alt?: string;
1683
+ alt?: 'json' | 'media' | 'proto';
1568
1684
  /** JSONP */
1569
1685
  callback?: string;
1570
1686
  /** Selector specifying which fields to include in a partial response. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.recaptchaenterprise-v1",
3
- "version": "0.1.20260310",
3
+ "version": "0.2.20260531",
4
4
  "description": "TypeScript typings for reCAPTCHA Enterprise API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -11,6 +11,23 @@ Install typings for reCAPTCHA Enterprise API:
11
11
  npm install @types/gapi.client.recaptchaenterprise-v1 --save-dev
12
12
  ```
13
13
 
14
+ ## TypeScript 6.0+
15
+
16
+ TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
17
+
18
+ ```json
19
+ {
20
+ "compilerOptions": {
21
+ "types": [
22
+ "gapi",
23
+ "gapi.auth2",
24
+ "gapi.client",
25
+ "gapi.client.recaptchaenterprise-v1"
26
+ ]
27
+ }
28
+ }
29
+ ```
30
+
14
31
  ## Usage
15
32
 
16
33
  You need to initialize Google API client in your code: