From fbf043908e187088c10d98e89bdf74842b01fe1a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 20 Mar 2023 15:47:32 -0700 Subject: [PATCH] feat: add reCAPTCHA Enterprise Fraud Prevention API (#5978) This cl adds API features for Fraud Prevention including the FraudPreventionAssessment. PiperOrigin-RevId: 517508635 Source-Link: https://github.com/googleapis/googleapis/commit/f3c3f3868ae923b6e194185909adf14a56d9754e Source-Link: https://github.com/googleapis/googleapis-gen/commit/892d5396a4232a1effe78f530ded3445d8b9bb8c Copy-Tag: eyJwIjoiUmVjYXB0Y2hhRW50ZXJwcmlzZS8uT3dsQm90LnlhbWwiLCJoIjoiODkyZDUzOTZhNDIzMmExZWZmZTc4ZjUzMGRlZDM0NDVkOGI5YmI4YyJ9 --- .../metadata/V1/Recaptchaenterprise.php | Bin 13639 -> 16205 bytes .../src/V1/AnnotateAssessmentRequest.php | 48 ++ RecaptchaEnterprise/src/V1/Assessment.php | 46 +- RecaptchaEnterprise/src/V1/Event.php | 86 ++- .../src/V1/FraudPreventionAssessment.php | 163 +++++ .../CardTestingVerdict.php | 75 +++ .../StolenInstrumentVerdict.php | 75 +++ ...reventionAssessment_CardTestingVerdict.php | 16 + ...tionAssessment_StolenInstrumentVerdict.php | 16 + .../RecaptchaEnterpriseServiceGapicClient.php | 8 + RecaptchaEnterprise/src/V1/Key.php | 14 +- .../V1/RiskAnalysis/ClassificationReason.php | 14 + .../src/V1/TokenProperties.php | 2 + .../src/V1/TransactionData.php | 570 ++++++++++++++++++ .../src/V1/TransactionData/Address.php | 248 ++++++++ .../src/V1/TransactionData/GatewayInfo.php | 180 ++++++ .../src/V1/TransactionData/Item.php | 180 ++++++ .../src/V1/TransactionData/User.php | 256 ++++++++ .../src/V1/TransactionData_Address.php | 16 + .../src/V1/TransactionData_GatewayInfo.php | 16 + .../src/V1/TransactionData_Item.php | 16 + .../src/V1/TransactionData_User.php | 16 + .../src/V1/TransactionEvent.php | 199 ++++++ .../TransactionEvent/TransactionEventType.php | 214 +++++++ .../TransactionEvent_TransactionEventType.php | 16 + 25 files changed, 2466 insertions(+), 24 deletions(-) create mode 100644 RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php create mode 100644 RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php create mode 100644 RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php create mode 100644 RecaptchaEnterprise/src/V1/FraudPreventionAssessment_CardTestingVerdict.php create mode 100644 RecaptchaEnterprise/src/V1/FraudPreventionAssessment_StolenInstrumentVerdict.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData/Address.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData/Item.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData/User.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData_Address.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData_GatewayInfo.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData_Item.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionData_User.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionEvent.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionEvent/TransactionEventType.php create mode 100644 RecaptchaEnterprise/src/V1/TransactionEvent_TransactionEventType.php diff --git a/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php b/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php index 6612b1846b2a58b4b3c34a8d6d2c22ec90ab6e9f..87e50fbc5c150ab56d6947af524e786b27942cb4 100644 GIT binary patch delta 2366 zcmZ`)OKcle6z%vw&#^szaoUN~qRP;gHjXO-LgJ&+i9JaSspE`45L9V88Bda-_Snpf z4c=gc5U^p>*&qZ6A%xg~K$ei`4kW}11Y(y}g^(&hRAR*j3GRF2U)*LlbKkl5-Ost_ zegDD_uYB>2*K@nmf7kmRbK!;`ab;66EJd~TrXhAT!^SE?8u^gzZcF2t)69d><)Nhnl=4OtSadGT4!i+cbQD&_S}DgV4cuHk%m9?cyx$vH8*kuQjx zA8L#hh3zXOk*rWGS0s@O;01JI$~f`}VuS)&p^z0fxDY;$Fk~sMi7P_(8986rs^ojp zHph|*CJuxRQ7UtYz*i-ql9LOYWvDgl<`>3MgvMxY2A@Ry_#a9uN@58zBw2EisY{`7 zQ7VaC6k`;X#MNx2kOP;kidZUhv4N4;hBb4f0sw-Ii%*;n1L4#k{cHXe<|MA5xIHG8 zObNyNVeH{$M_4?27wh`(2Y&K1|MZQSWzRXF;KHt{v}|N zjZQ|;YcvUV{n%R!16_@_lrBk4ZfN#?vqrau#T*K$idmC)^uZbsB(>BP%a(VWZN;R! zz~VU+QQM}e8ERKnn>CI1k+s2*;l_~G(Tl8oz17l~`)bw>9KzTbjv-DE2XO#rbJ$1ps&hu?@{s_Z7po z_{eE5OrN69+!MWy{JO0*EIv9$rl*m4K;SBx*;8!oC8aCt#%_~GG?B|Bk>0e!nhVSW zF8Kz7g2US5h&44;Z|Q_lMCDi4;7*k zNtU4g_pP@8dxu2jN5pRa@_{BENaM%Vfti$YZu<}Iua90nCYoYK&*YV-lr_kJR zcEHnC)37wRG4!DTy^Sj!OFn!=-V2r-sh!T$5iM^ej$$$l1RgR(Uoz-r>R0FU*vr1( z8I*A1T*A4;ee@8lS-eys&qZ0xfoMy)d|?eln@5QW^GKDsVE-2P9&`1M2OX_5;Cx72 zOx?OpN9Ms@G;i6>x@G`NfiG>U5HNt6uG(~r;pHmf?ADPYmMKyH{K&oPdgCTaP$983 z%cg2Dh)OyYUf!acaCFoxs8ZSW90W{WJ%>&lbr}qBTvaj!57%A(WXNMo>MQ72|5f~U zfVtU^&R=7gN1SHzqMzuixBo%%+o85B|jYak0xRIqT^M*aIQpo;daNpN!)?x3teJI^Qgj z6G~_NnR9!|V4iZSnask05Q6~eb_?WRlN*Y49lr^e=d`-!+*wLHUuVv~9QYrZ0J4(+ delta 250 zcmX?GcRXvu3}&WBNt%ZI0qMVw(I>Fqv`r zc*_Qz?OwQGc?PivH$2 zl|y_?zeP418DC`Nn9j(>>0FeWIJw6{XR^7eHHT)?P~jH&|?y6nA~a+1Jj@d*RYw_(t!;CIVVyJ diff --git a/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php b/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php index 81fee88359e..279d919c408 100644 --- a/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php +++ b/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php @@ -47,6 +47,13 @@ class AnnotateAssessmentRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field bytes hashed_account_id = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $hashed_account_id = ''; + /** + * Optional. If the assessment is part of a payment transaction, provide + * details on payment lifecycle events that occur in the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $transaction_event = null; /** * Constructor. @@ -70,6 +77,9 @@ class AnnotateAssessmentRequest extends \Google\Protobuf\Internal\Message * 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. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent $transaction_event + * Optional. If the assessment is part of a payment transaction, provide + * details on payment lifecycle events that occur in the transaction. * } */ public function __construct($data = NULL) { @@ -197,5 +207,43 @@ public function setHashedAccountId($var) return $this; } + /** + * Optional. If the assessment is part of a payment transaction, provide + * details on payment lifecycle events that occur in the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent|null + */ + public function getTransactionEvent() + { + return $this->transaction_event; + } + + public function hasTransactionEvent() + { + return isset($this->transaction_event); + } + + public function clearTransactionEvent() + { + unset($this->transaction_event); + } + + /** + * Optional. If the assessment is part of a payment transaction, provide + * details on payment lifecycle events that occur in the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent $var + * @return $this + */ + public function setTransactionEvent($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent::class); + $this->transaction_event = $var; + + return $this; + } + } diff --git a/RecaptchaEnterprise/src/V1/Assessment.php b/RecaptchaEnterprise/src/V1/Assessment.php index 08e0b88139f..6cf185900bd 100644 --- a/RecaptchaEnterprise/src/V1/Assessment.php +++ b/RecaptchaEnterprise/src/V1/Assessment.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A recaptcha assessment resource. + * A reCAPTCHA Enterprise assessment resource. * * Generated from protobuf message google.cloud.recaptchaenterprise.v1.Assessment */ @@ -61,6 +61,12 @@ class Assessment extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8; */ private $private_password_leak_verification = null; + /** + * Assessment returned by Fraud Prevention when TransactionData is provided. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + */ + private $fraud_prevention_assessment = null; /** * Constructor. @@ -86,6 +92,8 @@ class Assessment extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\RecaptchaEnterprise\V1\PrivatePasswordLeakVerification $private_password_leak_verification * The private password leak verification field contains the parameters that * are used to to check for leaks privately without sharing user credentials. + * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment $fraud_prevention_assessment + * Assessment returned by Fraud Prevention when TransactionData is provided. * } */ public function __construct($data = NULL) { @@ -343,5 +351,41 @@ public function setPrivatePasswordLeakVerification($var) return $this; } + /** + * Assessment returned by Fraud Prevention when TransactionData is provided. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment|null + */ + public function getFraudPreventionAssessment() + { + return $this->fraud_prevention_assessment; + } + + public function hasFraudPreventionAssessment() + { + return isset($this->fraud_prevention_assessment); + } + + public function clearFraudPreventionAssessment() + { + unset($this->fraud_prevention_assessment); + } + + /** + * Assessment returned by Fraud Prevention when TransactionData is provided. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11; + * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment $var + * @return $this + */ + public function setFraudPreventionAssessment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment::class); + $this->fraud_prevention_assessment = $var; + + return $this; + } + } diff --git a/RecaptchaEnterprise/src/V1/Event.php b/RecaptchaEnterprise/src/V1/Event.php index 1c19f556cf4..9e996c29fa2 100644 --- a/RecaptchaEnterprise/src/V1/Event.php +++ b/RecaptchaEnterprise/src/V1/Event.php @@ -9,20 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** + * The event being assessed. + * * Generated from protobuf message google.cloud.recaptchaenterprise.v1.Event */ class Event extends \Google\Protobuf\Internal\Message { /** - * Optional. The user response token provided by the reCAPTCHA client-side - * integration on your site. + * Optional. The user response token provided by the reCAPTCHA Enterprise + * client-side integration on your site. * * Generated from protobuf field string token = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $token = ''; /** - * Optional. The site key that was used to invoke reCAPTCHA on your site and - * generate the token. + * Optional. The site key that was used to invoke reCAPTCHA Enterprise on your + * site and generate the token. * * Generated from protobuf field string site_key = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -56,6 +58,14 @@ class Event extends \Google\Protobuf\Internal\Message * Generated from protobuf field bytes hashed_account_id = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $hashed_account_id = ''; + /** + * Optional. Data describing a payment transaction to be assessed. Sending + * this data enables reCAPTCHA Enterprise Fraud Prevention and the + * FraudPreventionAssessment component in the response. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $transaction_data = null; /** * Constructor. @@ -64,11 +74,11 @@ class Event extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $token - * Optional. The user response token provided by the reCAPTCHA client-side - * integration on your site. + * Optional. The user response token provided by the reCAPTCHA Enterprise + * client-side integration on your site. * @type string $site_key - * Optional. The site key that was used to invoke reCAPTCHA on your site and - * generate the token. + * Optional. The site key that was used to invoke reCAPTCHA Enterprise on your + * site and generate the token. * @type string $user_agent * Optional. The user agent present in the request from the user's device * related to this event. @@ -82,6 +92,10 @@ class Event extends \Google\Protobuf\Internal\Message * @type string $hashed_account_id * Optional. Unique stable hashed user identifier for the request. The * identifier must be hashed using hmac-sha256 with stable secret. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData $transaction_data + * Optional. Data describing a payment transaction to be assessed. Sending + * this data enables reCAPTCHA Enterprise Fraud Prevention and the + * FraudPreventionAssessment component in the response. * } */ public function __construct($data = NULL) { @@ -90,8 +104,8 @@ public function __construct($data = NULL) { } /** - * Optional. The user response token provided by the reCAPTCHA client-side - * integration on your site. + * Optional. The user response token provided by the reCAPTCHA Enterprise + * client-side integration on your site. * * Generated from protobuf field string token = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -102,8 +116,8 @@ public function getToken() } /** - * Optional. The user response token provided by the reCAPTCHA client-side - * integration on your site. + * Optional. The user response token provided by the reCAPTCHA Enterprise + * client-side integration on your site. * * Generated from protobuf field string token = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -118,8 +132,8 @@ public function setToken($var) } /** - * Optional. The site key that was used to invoke reCAPTCHA on your site and - * generate the token. + * Optional. The site key that was used to invoke reCAPTCHA Enterprise on your + * site and generate the token. * * Generated from protobuf field string site_key = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -130,8 +144,8 @@ public function getSiteKey() } /** - * Optional. The site key that was used to invoke reCAPTCHA on your site and - * generate the token. + * Optional. The site key that was used to invoke reCAPTCHA Enterprise on your + * site and generate the token. * * Generated from protobuf field string site_key = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -259,5 +273,45 @@ public function setHashedAccountId($var) return $this; } + /** + * Optional. Data describing a payment transaction to be assessed. Sending + * this data enables reCAPTCHA Enterprise Fraud Prevention and the + * FraudPreventionAssessment component in the response. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData|null + */ + public function getTransactionData() + { + return $this->transaction_data; + } + + public function hasTransactionData() + { + return isset($this->transaction_data); + } + + public function clearTransactionData() + { + unset($this->transaction_data); + } + + /** + * Optional. Data describing a payment transaction to be assessed. Sending + * this data enables reCAPTCHA Enterprise Fraud Prevention and the + * FraudPreventionAssessment component in the response. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData $var + * @return $this + */ + public function setTransactionData($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData::class); + $this->transaction_data = $var; + + return $this; + } + } diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php new file mode 100644 index 00000000000..0b5eca6a327 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment.php @@ -0,0 +1,163 @@ +google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment + */ +class FraudPreventionAssessment extends \Google\Protobuf\Internal\Message +{ + /** + * Probability (0-1) of this transaction being fraudulent. Summarizes the + * combined risk of attack vectors below. + * + * Generated from protobuf field float transaction_risk = 1; + */ + private $transaction_risk = 0.0; + /** + * Assessment of this transaction for risk of a stolen instrument. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + */ + private $stolen_instrument_verdict = null; + /** + * Assessment of this transaction for risk of being part of a card testing + * attack. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + */ + private $card_testing_verdict = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type float $transaction_risk + * Probability (0-1) of this transaction being fraudulent. Summarizes the + * combined risk of attack vectors below. + * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict $stolen_instrument_verdict + * Assessment of this transaction for risk of a stolen instrument. + * @type \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict $card_testing_verdict + * Assessment of this transaction for risk of being part of a card testing + * attack. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Probability (0-1) of this transaction being fraudulent. Summarizes the + * combined risk of attack vectors below. + * + * Generated from protobuf field float transaction_risk = 1; + * @return float + */ + public function getTransactionRisk() + { + return $this->transaction_risk; + } + + /** + * Probability (0-1) of this transaction being fraudulent. Summarizes the + * combined risk of attack vectors below. + * + * Generated from protobuf field float transaction_risk = 1; + * @param float $var + * @return $this + */ + public function setTransactionRisk($var) + { + GPBUtil::checkFloat($var); + $this->transaction_risk = $var; + + return $this; + } + + /** + * Assessment of this transaction for risk of a stolen instrument. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict|null + */ + public function getStolenInstrumentVerdict() + { + return $this->stolen_instrument_verdict; + } + + public function hasStolenInstrumentVerdict() + { + return isset($this->stolen_instrument_verdict); + } + + public function clearStolenInstrumentVerdict() + { + unset($this->stolen_instrument_verdict); + } + + /** + * Assessment of this transaction for risk of a stolen instrument. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict stolen_instrument_verdict = 2; + * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict $var + * @return $this + */ + public function setStolenInstrumentVerdict($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\StolenInstrumentVerdict::class); + $this->stolen_instrument_verdict = $var; + + return $this; + } + + /** + * Assessment of this transaction for risk of being part of a card testing + * attack. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + * @return \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict|null + */ + public function getCardTestingVerdict() + { + return $this->card_testing_verdict; + } + + public function hasCardTestingVerdict() + { + return isset($this->card_testing_verdict); + } + + public function clearCardTestingVerdict() + { + unset($this->card_testing_verdict); + } + + /** + * Assessment of this transaction for risk of being part of a card testing + * attack. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict card_testing_verdict = 3; + * @param \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict $var + * @return $this + */ + public function setCardTestingVerdict($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment\CardTestingVerdict::class); + $this->card_testing_verdict = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php new file mode 100644 index 00000000000..e14a2c3c23f --- /dev/null +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/CardTestingVerdict.php @@ -0,0 +1,75 @@ +google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict + */ +class CardTestingVerdict extends \Google\Protobuf\Internal\Message +{ + /** + * Probability (0-1) of this transaction attempt being part of a card + * testing attack. + * + * Generated from protobuf field float risk = 1; + */ + private $risk = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type float $risk + * Probability (0-1) of this transaction attempt being part of a card + * testing attack. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Probability (0-1) of this transaction attempt being part of a card + * testing attack. + * + * Generated from protobuf field float risk = 1; + * @return float + */ + public function getRisk() + { + return $this->risk; + } + + /** + * Probability (0-1) of this transaction attempt being part of a card + * testing attack. + * + * Generated from protobuf field float risk = 1; + * @param float $var + * @return $this + */ + public function setRisk($var) + { + GPBUtil::checkFloat($var); + $this->risk = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(CardTestingVerdict::class, \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment_CardTestingVerdict::class); + diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php new file mode 100644 index 00000000000..353e9217d86 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment/StolenInstrumentVerdict.php @@ -0,0 +1,75 @@ +google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict + */ +class StolenInstrumentVerdict extends \Google\Protobuf\Internal\Message +{ + /** + * Probability (0-1) of this transaction being executed with a stolen + * instrument. + * + * Generated from protobuf field float risk = 1; + */ + private $risk = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type float $risk + * Probability (0-1) of this transaction being executed with a stolen + * instrument. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Probability (0-1) of this transaction being executed with a stolen + * instrument. + * + * Generated from protobuf field float risk = 1; + * @return float + */ + public function getRisk() + { + return $this->risk; + } + + /** + * Probability (0-1) of this transaction being executed with a stolen + * instrument. + * + * Generated from protobuf field float risk = 1; + * @param float $var + * @return $this + */ + public function setRisk($var) + { + GPBUtil::checkFloat($var); + $this->risk = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(StolenInstrumentVerdict::class, \Google\Cloud\RecaptchaEnterprise\V1\FraudPreventionAssessment_StolenInstrumentVerdict::class); + diff --git a/RecaptchaEnterprise/src/V1/FraudPreventionAssessment_CardTestingVerdict.php b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment_CardTestingVerdict.php new file mode 100644 index 00000000000..91db3a4a2ba --- /dev/null +++ b/RecaptchaEnterprise/src/V1/FraudPreventionAssessment_CardTestingVerdict.php @@ -0,0 +1,16 @@ +setHashedAccountId($optionalArgs['hashedAccountId']); } + if (isset($optionalArgs['transactionEvent'])) { + $request->setTransactionEvent($optionalArgs['transactionEvent']); + } + $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); diff --git a/RecaptchaEnterprise/src/V1/Key.php b/RecaptchaEnterprise/src/V1/Key.php index b31b8fafa78..aebb1c846df 100644 --- a/RecaptchaEnterprise/src/V1/Key.php +++ b/RecaptchaEnterprise/src/V1/Key.php @@ -37,9 +37,9 @@ class Key extends \Google\Protobuf\Internal\Message */ private $labels; /** - * The timestamp corresponding to the creation of this Key. + * Output only. The timestamp corresponding to the creation of this Key. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 7; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $create_time = null; /** @@ -77,7 +77,7 @@ class Key extends \Google\Protobuf\Internal\Message * See * Creating and managing labels. * @type \Google\Protobuf\Timestamp $create_time - * The timestamp corresponding to the creation of this Key. + * Output only. The timestamp corresponding to the creation of this Key. * @type \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions $testing_options * Options for user acceptance testing. * @type \Google\Cloud\RecaptchaEnterprise\V1\WafSettings $waf_settings @@ -265,9 +265,9 @@ public function setLabels($var) } /** - * The timestamp corresponding to the creation of this Key. + * Output only. The timestamp corresponding to the creation of this Key. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 7; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Timestamp|null */ public function getCreateTime() @@ -286,9 +286,9 @@ public function clearCreateTime() } /** - * The timestamp corresponding to the creation of this Key. + * Output only. The timestamp corresponding to the creation of this Key. * - * Generated from protobuf field .google.protobuf.Timestamp create_time = 7; + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Timestamp $var * @return $this */ diff --git a/RecaptchaEnterprise/src/V1/RiskAnalysis/ClassificationReason.php b/RecaptchaEnterprise/src/V1/RiskAnalysis/ClassificationReason.php index 38d218659b7..159b1c8c8e3 100644 --- a/RecaptchaEnterprise/src/V1/RiskAnalysis/ClassificationReason.php +++ b/RecaptchaEnterprise/src/V1/RiskAnalysis/ClassificationReason.php @@ -51,6 +51,18 @@ class ClassificationReason * Generated from protobuf enum LOW_CONFIDENCE_SCORE = 5; */ const LOW_CONFIDENCE_SCORE = 5; + /** + * The request matches behavioral characteristics of a carding attack. + * + * Generated from protobuf enum SUSPECTED_CARDING = 6; + */ + const SUSPECTED_CARDING = 6; + /** + * The request matches behavioral characteristics of chargebacks for fraud. + * + * Generated from protobuf enum SUSPECTED_CHARGEBACK = 7; + */ + const SUSPECTED_CHARGEBACK = 7; private static $valueToName = [ self::CLASSIFICATION_REASON_UNSPECIFIED => 'CLASSIFICATION_REASON_UNSPECIFIED', @@ -59,6 +71,8 @@ class ClassificationReason self::TOO_MUCH_TRAFFIC => 'TOO_MUCH_TRAFFIC', self::UNEXPECTED_USAGE_PATTERNS => 'UNEXPECTED_USAGE_PATTERNS', self::LOW_CONFIDENCE_SCORE => 'LOW_CONFIDENCE_SCORE', + self::SUSPECTED_CARDING => 'SUSPECTED_CARDING', + self::SUSPECTED_CHARGEBACK => 'SUSPECTED_CHARGEBACK', ]; public static function name($value) diff --git a/RecaptchaEnterprise/src/V1/TokenProperties.php b/RecaptchaEnterprise/src/V1/TokenProperties.php index 83d59b7677d..b45f354b37c 100644 --- a/RecaptchaEnterprise/src/V1/TokenProperties.php +++ b/RecaptchaEnterprise/src/V1/TokenProperties.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Properties of the provided event token. + * * Generated from protobuf message google.cloud.recaptchaenterprise.v1.TokenProperties */ class TokenProperties extends \Google\Protobuf\Internal\Message diff --git a/RecaptchaEnterprise/src/V1/TransactionData.php b/RecaptchaEnterprise/src/V1/TransactionData.php new file mode 100644 index 00000000000..6db049eb630 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData.php @@ -0,0 +1,570 @@ +google.cloud.recaptchaenterprise.v1.TransactionData + */ +class TransactionData extends \Google\Protobuf\Internal\Message +{ + /** + * Unique identifier for the transaction. This custom identifier can be used + * to reference this transaction in the future, for example, labeling a refund + * or chargeback event. Two attempts at the same transaction should use the + * same transaction id. + * + * Generated from protobuf field optional string transaction_id = 11; + */ + private $transaction_id = null; + /** + * The payment method for the transaction. The allowed values are: + * * credit-card + * * debit-card + * * gift-card + * * processor-{name} (If a third-party is used, for example, + * processor-paypal) + * * custom-{name} (If an alternative method is used, for example, + * custom-crypto) + * + * Generated from protobuf field string payment_method = 1; + */ + private $payment_method = ''; + /** + * The Bank Identification Number - generally the first 6 or 8 digits of the + * card. + * + * Generated from protobuf field string card_bin = 2; + */ + private $card_bin = ''; + /** + * The last four digits of the card. + * + * Generated from protobuf field string card_last_four = 3; + */ + private $card_last_four = ''; + /** + * The currency code in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 4; + */ + private $currency_code = ''; + /** + * The decimal value of the transaction in the specified currency. + * + * Generated from protobuf field double value = 5; + */ + private $value = 0.0; + /** + * The value of shipping in the specified currency. 0 for free or no shipping. + * + * Generated from protobuf field double shipping_value = 12; + */ + private $shipping_value = 0.0; + /** + * Destination address if this transaction involves shipping a physical item. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + */ + private $shipping_address = null; + /** + * Address associated with the payment method when applicable. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + */ + private $billing_address = null; + /** + * Information about the user paying/initiating the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + */ + private $user = null; + /** + * Information about the user or users fulfilling the transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + */ + private $merchants; + /** + * Items purchased in this transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + */ + private $items; + /** + * Information about the payment gateway's response to the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + */ + private $gateway_info = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $transaction_id + * Unique identifier for the transaction. This custom identifier can be used + * to reference this transaction in the future, for example, labeling a refund + * or chargeback event. Two attempts at the same transaction should use the + * same transaction id. + * @type string $payment_method + * The payment method for the transaction. The allowed values are: + * * credit-card + * * debit-card + * * gift-card + * * processor-{name} (If a third-party is used, for example, + * processor-paypal) + * * custom-{name} (If an alternative method is used, for example, + * custom-crypto) + * @type string $card_bin + * The Bank Identification Number - generally the first 6 or 8 digits of the + * card. + * @type string $card_last_four + * The last four digits of the card. + * @type string $currency_code + * The currency code in ISO-4217 format. + * @type float $value + * The decimal value of the transaction in the specified currency. + * @type float $shipping_value + * The value of shipping in the specified currency. 0 for free or no shipping. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $shipping_address + * Destination address if this transaction involves shipping a physical item. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $billing_address + * Address associated with the payment method when applicable. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User $user + * Information about the user paying/initiating the transaction. + * @type array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User>|\Google\Protobuf\Internal\RepeatedField $merchants + * Information about the user or users fulfilling the transaction. + * @type array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Item>|\Google\Protobuf\Internal\RepeatedField $items + * Items purchased in this transaction. + * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo $gateway_info + * Information about the payment gateway's response to the transaction. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Unique identifier for the transaction. This custom identifier can be used + * to reference this transaction in the future, for example, labeling a refund + * or chargeback event. Two attempts at the same transaction should use the + * same transaction id. + * + * Generated from protobuf field optional string transaction_id = 11; + * @return string + */ + public function getTransactionId() + { + return isset($this->transaction_id) ? $this->transaction_id : ''; + } + + public function hasTransactionId() + { + return isset($this->transaction_id); + } + + public function clearTransactionId() + { + unset($this->transaction_id); + } + + /** + * Unique identifier for the transaction. This custom identifier can be used + * to reference this transaction in the future, for example, labeling a refund + * or chargeback event. Two attempts at the same transaction should use the + * same transaction id. + * + * Generated from protobuf field optional string transaction_id = 11; + * @param string $var + * @return $this + */ + public function setTransactionId($var) + { + GPBUtil::checkString($var, True); + $this->transaction_id = $var; + + return $this; + } + + /** + * The payment method for the transaction. The allowed values are: + * * credit-card + * * debit-card + * * gift-card + * * processor-{name} (If a third-party is used, for example, + * processor-paypal) + * * custom-{name} (If an alternative method is used, for example, + * custom-crypto) + * + * Generated from protobuf field string payment_method = 1; + * @return string + */ + public function getPaymentMethod() + { + return $this->payment_method; + } + + /** + * The payment method for the transaction. The allowed values are: + * * credit-card + * * debit-card + * * gift-card + * * processor-{name} (If a third-party is used, for example, + * processor-paypal) + * * custom-{name} (If an alternative method is used, for example, + * custom-crypto) + * + * Generated from protobuf field string payment_method = 1; + * @param string $var + * @return $this + */ + public function setPaymentMethod($var) + { + GPBUtil::checkString($var, True); + $this->payment_method = $var; + + return $this; + } + + /** + * The Bank Identification Number - generally the first 6 or 8 digits of the + * card. + * + * Generated from protobuf field string card_bin = 2; + * @return string + */ + public function getCardBin() + { + return $this->card_bin; + } + + /** + * The Bank Identification Number - generally the first 6 or 8 digits of the + * card. + * + * Generated from protobuf field string card_bin = 2; + * @param string $var + * @return $this + */ + public function setCardBin($var) + { + GPBUtil::checkString($var, True); + $this->card_bin = $var; + + return $this; + } + + /** + * The last four digits of the card. + * + * Generated from protobuf field string card_last_four = 3; + * @return string + */ + public function getCardLastFour() + { + return $this->card_last_four; + } + + /** + * The last four digits of the card. + * + * Generated from protobuf field string card_last_four = 3; + * @param string $var + * @return $this + */ + public function setCardLastFour($var) + { + GPBUtil::checkString($var, True); + $this->card_last_four = $var; + + return $this; + } + + /** + * The currency code in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 4; + * @return string + */ + public function getCurrencyCode() + { + return $this->currency_code; + } + + /** + * The currency code in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 4; + * @param string $var + * @return $this + */ + public function setCurrencyCode($var) + { + GPBUtil::checkString($var, True); + $this->currency_code = $var; + + return $this; + } + + /** + * The decimal value of the transaction in the specified currency. + * + * Generated from protobuf field double value = 5; + * @return float + */ + public function getValue() + { + return $this->value; + } + + /** + * The decimal value of the transaction in the specified currency. + * + * Generated from protobuf field double value = 5; + * @param float $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkDouble($var); + $this->value = $var; + + return $this; + } + + /** + * The value of shipping in the specified currency. 0 for free or no shipping. + * + * Generated from protobuf field double shipping_value = 12; + * @return float + */ + public function getShippingValue() + { + return $this->shipping_value; + } + + /** + * The value of shipping in the specified currency. 0 for free or no shipping. + * + * Generated from protobuf field double shipping_value = 12; + * @param float $var + * @return $this + */ + public function setShippingValue($var) + { + GPBUtil::checkDouble($var); + $this->shipping_value = $var; + + return $this; + } + + /** + * Destination address if this transaction involves shipping a physical item. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address|null + */ + public function getShippingAddress() + { + return $this->shipping_address; + } + + public function hasShippingAddress() + { + return isset($this->shipping_address); + } + + public function clearShippingAddress() + { + unset($this->shipping_address); + } + + /** + * Destination address if this transaction involves shipping a physical item. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address shipping_address = 6; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $var + * @return $this + */ + public function setShippingAddress($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address::class); + $this->shipping_address = $var; + + return $this; + } + + /** + * Address associated with the payment method when applicable. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address|null + */ + public function getBillingAddress() + { + return $this->billing_address; + } + + public function hasBillingAddress() + { + return isset($this->billing_address); + } + + public function clearBillingAddress() + { + unset($this->billing_address); + } + + /** + * Address associated with the payment method when applicable. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.Address billing_address = 7; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address $var + * @return $this + */ + public function setBillingAddress($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Address::class); + $this->billing_address = $var; + + return $this; + } + + /** + * Information about the user paying/initiating the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User|null + */ + public function getUser() + { + return $this->user; + } + + public function hasUser() + { + return isset($this->user); + } + + public function clearUser() + { + unset($this->user); + } + + /** + * Information about the user paying/initiating the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.User user = 8; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User $var + * @return $this + */ + public function setUser($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User::class); + $this->user = $var; + + return $this; + } + + /** + * Information about the user or users fulfilling the transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMerchants() + { + return $this->merchants; + } + + /** + * Information about the user or users fulfilling the transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.User merchants = 13; + * @param array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMerchants($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\User::class); + $this->merchants = $arr; + + return $this; + } + + /** + * Items purchased in this transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getItems() + { + return $this->items; + } + + /** + * Items purchased in this transaction. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.TransactionData.Item items = 14; + * @param array<\Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Item>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setItems($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\Item::class); + $this->items = $arr; + + return $this; + } + + /** + * Information about the payment gateway's response to the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + * @return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo|null + */ + public function getGatewayInfo() + { + return $this->gateway_info; + } + + public function hasGatewayInfo() + { + return isset($this->gateway_info); + } + + public function clearGatewayInfo() + { + unset($this->gateway_info); + } + + /** + * Information about the payment gateway's response to the transaction. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo gateway_info = 10; + * @param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo $var + * @return $this + */ + public function setGatewayInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData\GatewayInfo::class); + $this->gateway_info = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/TransactionData/Address.php b/RecaptchaEnterprise/src/V1/TransactionData/Address.php new file mode 100644 index 00000000000..c7608ebdeea --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData/Address.php @@ -0,0 +1,248 @@ +google.cloud.recaptchaenterprise.v1.TransactionData.Address + */ +class Address extends \Google\Protobuf\Internal\Message +{ + /** + * The recipient name, potentially including information such as "care of". + * + * Generated from protobuf field string recipient = 1; + */ + private $recipient = ''; + /** + * The first lines of the address. The first line generally contains the + * street name and number, and further lines may include information such as + * an apartment number. + * + * Generated from protobuf field repeated string address = 2; + */ + private $address; + /** + * The town/city of the address. + * + * Generated from protobuf field string locality = 3; + */ + private $locality = ''; + /** + * The state, province, or otherwise administrative area of the address. + * + * Generated from protobuf field string administrative_area = 4; + */ + private $administrative_area = ''; + /** + * The CLDR country/region of the address. + * + * Generated from protobuf field string region_code = 5; + */ + private $region_code = ''; + /** + * The postal or ZIP code of the address. + * + * Generated from protobuf field string postal_code = 6; + */ + private $postal_code = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $recipient + * The recipient name, potentially including information such as "care of". + * @type array|\Google\Protobuf\Internal\RepeatedField $address + * The first lines of the address. The first line generally contains the + * street name and number, and further lines may include information such as + * an apartment number. + * @type string $locality + * The town/city of the address. + * @type string $administrative_area + * The state, province, or otherwise administrative area of the address. + * @type string $region_code + * The CLDR country/region of the address. + * @type string $postal_code + * The postal or ZIP code of the address. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * The recipient name, potentially including information such as "care of". + * + * Generated from protobuf field string recipient = 1; + * @return string + */ + public function getRecipient() + { + return $this->recipient; + } + + /** + * The recipient name, potentially including information such as "care of". + * + * Generated from protobuf field string recipient = 1; + * @param string $var + * @return $this + */ + public function setRecipient($var) + { + GPBUtil::checkString($var, True); + $this->recipient = $var; + + return $this; + } + + /** + * The first lines of the address. The first line generally contains the + * street name and number, and further lines may include information such as + * an apartment number. + * + * Generated from protobuf field repeated string address = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAddress() + { + return $this->address; + } + + /** + * The first lines of the address. The first line generally contains the + * street name and number, and further lines may include information such as + * an apartment number. + * + * Generated from protobuf field repeated string address = 2; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAddress($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->address = $arr; + + return $this; + } + + /** + * The town/city of the address. + * + * Generated from protobuf field string locality = 3; + * @return string + */ + public function getLocality() + { + return $this->locality; + } + + /** + * The town/city of the address. + * + * Generated from protobuf field string locality = 3; + * @param string $var + * @return $this + */ + public function setLocality($var) + { + GPBUtil::checkString($var, True); + $this->locality = $var; + + return $this; + } + + /** + * The state, province, or otherwise administrative area of the address. + * + * Generated from protobuf field string administrative_area = 4; + * @return string + */ + public function getAdministrativeArea() + { + return $this->administrative_area; + } + + /** + * The state, province, or otherwise administrative area of the address. + * + * Generated from protobuf field string administrative_area = 4; + * @param string $var + * @return $this + */ + public function setAdministrativeArea($var) + { + GPBUtil::checkString($var, True); + $this->administrative_area = $var; + + return $this; + } + + /** + * The CLDR country/region of the address. + * + * Generated from protobuf field string region_code = 5; + * @return string + */ + public function getRegionCode() + { + return $this->region_code; + } + + /** + * The CLDR country/region of the address. + * + * Generated from protobuf field string region_code = 5; + * @param string $var + * @return $this + */ + public function setRegionCode($var) + { + GPBUtil::checkString($var, True); + $this->region_code = $var; + + return $this; + } + + /** + * The postal or ZIP code of the address. + * + * Generated from protobuf field string postal_code = 6; + * @return string + */ + public function getPostalCode() + { + return $this->postal_code; + } + + /** + * The postal or ZIP code of the address. + * + * Generated from protobuf field string postal_code = 6; + * @param string $var + * @return $this + */ + public function setPostalCode($var) + { + GPBUtil::checkString($var, True); + $this->postal_code = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Address::class, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData_Address::class); + diff --git a/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php b/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php new file mode 100644 index 00000000000..ae0020819fd --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData/GatewayInfo.php @@ -0,0 +1,180 @@ +google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo + */ +class GatewayInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the gateway service (for example, stripe, square, paypal). + * + * Generated from protobuf field string name = 1; + */ + private $name = ''; + /** + * Gateway response code describing the state of the transaction. + * + * Generated from protobuf field string gateway_response_code = 2; + */ + private $gateway_response_code = ''; + /** + * AVS response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string avs_response_code = 3; + */ + private $avs_response_code = ''; + /** + * CVV response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string cvv_response_code = 4; + */ + private $cvv_response_code = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Name of the gateway service (for example, stripe, square, paypal). + * @type string $gateway_response_code + * Gateway response code describing the state of the transaction. + * @type string $avs_response_code + * AVS response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * @type string $cvv_response_code + * CVV response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Name of the gateway service (for example, stripe, square, paypal). + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Name of the gateway service (for example, stripe, square, paypal). + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Gateway response code describing the state of the transaction. + * + * Generated from protobuf field string gateway_response_code = 2; + * @return string + */ + public function getGatewayResponseCode() + { + return $this->gateway_response_code; + } + + /** + * Gateway response code describing the state of the transaction. + * + * Generated from protobuf field string gateway_response_code = 2; + * @param string $var + * @return $this + */ + public function setGatewayResponseCode($var) + { + GPBUtil::checkString($var, True); + $this->gateway_response_code = $var; + + return $this; + } + + /** + * AVS response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string avs_response_code = 3; + * @return string + */ + public function getAvsResponseCode() + { + return $this->avs_response_code; + } + + /** + * AVS response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string avs_response_code = 3; + * @param string $var + * @return $this + */ + public function setAvsResponseCode($var) + { + GPBUtil::checkString($var, True); + $this->avs_response_code = $var; + + return $this; + } + + /** + * CVV response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string cvv_response_code = 4; + * @return string + */ + public function getCvvResponseCode() + { + return $this->cvv_response_code; + } + + /** + * CVV response code from the gateway + * (available only when reCAPTCHA Enterprise is called after authorization). + * + * Generated from protobuf field string cvv_response_code = 4; + * @param string $var + * @return $this + */ + public function setCvvResponseCode($var) + { + GPBUtil::checkString($var, True); + $this->cvv_response_code = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(GatewayInfo::class, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData_GatewayInfo::class); + diff --git a/RecaptchaEnterprise/src/V1/TransactionData/Item.php b/RecaptchaEnterprise/src/V1/TransactionData/Item.php new file mode 100644 index 00000000000..f9ba08c87be --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData/Item.php @@ -0,0 +1,180 @@ +google.cloud.recaptchaenterprise.v1.TransactionData.Item + */ +class Item extends \Google\Protobuf\Internal\Message +{ + /** + * The full name of the item. + * + * Generated from protobuf field string name = 1; + */ + private $name = ''; + /** + * The value per item that the user is paying, in the transaction currency, + * after discounts. + * + * Generated from protobuf field double value = 2; + */ + private $value = 0.0; + /** + * The quantity of this item that is being purchased. + * + * Generated from protobuf field int64 quantity = 3; + */ + private $quantity = 0; + /** + * When a merchant is specified, its corresponding account_id. Necessary to + * populate marketplace-style transactions. + * + * Generated from protobuf field string merchant_account_id = 4; + */ + private $merchant_account_id = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The full name of the item. + * @type float $value + * The value per item that the user is paying, in the transaction currency, + * after discounts. + * @type int|string $quantity + * The quantity of this item that is being purchased. + * @type string $merchant_account_id + * When a merchant is specified, its corresponding account_id. Necessary to + * populate marketplace-style transactions. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * The full name of the item. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The full name of the item. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The value per item that the user is paying, in the transaction currency, + * after discounts. + * + * Generated from protobuf field double value = 2; + * @return float + */ + public function getValue() + { + return $this->value; + } + + /** + * The value per item that the user is paying, in the transaction currency, + * after discounts. + * + * Generated from protobuf field double value = 2; + * @param float $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkDouble($var); + $this->value = $var; + + return $this; + } + + /** + * The quantity of this item that is being purchased. + * + * Generated from protobuf field int64 quantity = 3; + * @return int|string + */ + public function getQuantity() + { + return $this->quantity; + } + + /** + * The quantity of this item that is being purchased. + * + * Generated from protobuf field int64 quantity = 3; + * @param int|string $var + * @return $this + */ + public function setQuantity($var) + { + GPBUtil::checkInt64($var); + $this->quantity = $var; + + return $this; + } + + /** + * When a merchant is specified, its corresponding account_id. Necessary to + * populate marketplace-style transactions. + * + * Generated from protobuf field string merchant_account_id = 4; + * @return string + */ + public function getMerchantAccountId() + { + return $this->merchant_account_id; + } + + /** + * When a merchant is specified, its corresponding account_id. Necessary to + * populate marketplace-style transactions. + * + * Generated from protobuf field string merchant_account_id = 4; + * @param string $var + * @return $this + */ + public function setMerchantAccountId($var) + { + GPBUtil::checkString($var, True); + $this->merchant_account_id = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Item::class, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData_Item::class); + diff --git a/RecaptchaEnterprise/src/V1/TransactionData/User.php b/RecaptchaEnterprise/src/V1/TransactionData/User.php new file mode 100644 index 00000000000..e13ea925899 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData/User.php @@ -0,0 +1,256 @@ +google.cloud.recaptchaenterprise.v1.TransactionData.User + */ +class User extends \Google\Protobuf\Internal\Message +{ + /** + * Unique account identifier for this user. If using account defender, + * this should match the hashed_account_id field. Otherwise, a unique and + * persistent identifier for this account. + * + * Generated from protobuf field string account_id = 6; + */ + private $account_id = ''; + /** + * The epoch milliseconds of the user's account creation. + * + * Generated from protobuf field int64 creation_ms = 1; + */ + private $creation_ms = 0; + /** + * The email address of the user. + * + * Generated from protobuf field string email = 2; + */ + private $email = ''; + /** + * Whether the email has been verified to be accessible by the user (OTP or + * similar). + * + * Generated from protobuf field bool email_verified = 3; + */ + private $email_verified = false; + /** + * The phone number of the user, with country code. + * + * Generated from protobuf field string phone_number = 4; + */ + private $phone_number = ''; + /** + * Whether the phone number has been verified to be accessible by the user + * (OTP or similar). + * + * Generated from protobuf field bool phone_verified = 5; + */ + private $phone_verified = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $account_id + * Unique account identifier for this user. If using account defender, + * this should match the hashed_account_id field. Otherwise, a unique and + * persistent identifier for this account. + * @type int|string $creation_ms + * The epoch milliseconds of the user's account creation. + * @type string $email + * The email address of the user. + * @type bool $email_verified + * Whether the email has been verified to be accessible by the user (OTP or + * similar). + * @type string $phone_number + * The phone number of the user, with country code. + * @type bool $phone_verified + * Whether the phone number has been verified to be accessible by the user + * (OTP or similar). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Unique account identifier for this user. If using account defender, + * this should match the hashed_account_id field. Otherwise, a unique and + * persistent identifier for this account. + * + * Generated from protobuf field string account_id = 6; + * @return string + */ + public function getAccountId() + { + return $this->account_id; + } + + /** + * Unique account identifier for this user. If using account defender, + * this should match the hashed_account_id field. Otherwise, a unique and + * persistent identifier for this account. + * + * Generated from protobuf field string account_id = 6; + * @param string $var + * @return $this + */ + public function setAccountId($var) + { + GPBUtil::checkString($var, True); + $this->account_id = $var; + + return $this; + } + + /** + * The epoch milliseconds of the user's account creation. + * + * Generated from protobuf field int64 creation_ms = 1; + * @return int|string + */ + public function getCreationMs() + { + return $this->creation_ms; + } + + /** + * The epoch milliseconds of the user's account creation. + * + * Generated from protobuf field int64 creation_ms = 1; + * @param int|string $var + * @return $this + */ + public function setCreationMs($var) + { + GPBUtil::checkInt64($var); + $this->creation_ms = $var; + + return $this; + } + + /** + * The email address of the user. + * + * Generated from protobuf field string email = 2; + * @return string + */ + public function getEmail() + { + return $this->email; + } + + /** + * The email address of the user. + * + * Generated from protobuf field string email = 2; + * @param string $var + * @return $this + */ + public function setEmail($var) + { + GPBUtil::checkString($var, True); + $this->email = $var; + + return $this; + } + + /** + * Whether the email has been verified to be accessible by the user (OTP or + * similar). + * + * Generated from protobuf field bool email_verified = 3; + * @return bool + */ + public function getEmailVerified() + { + return $this->email_verified; + } + + /** + * Whether the email has been verified to be accessible by the user (OTP or + * similar). + * + * Generated from protobuf field bool email_verified = 3; + * @param bool $var + * @return $this + */ + public function setEmailVerified($var) + { + GPBUtil::checkBool($var); + $this->email_verified = $var; + + return $this; + } + + /** + * The phone number of the user, with country code. + * + * Generated from protobuf field string phone_number = 4; + * @return string + */ + public function getPhoneNumber() + { + return $this->phone_number; + } + + /** + * The phone number of the user, with country code. + * + * Generated from protobuf field string phone_number = 4; + * @param string $var + * @return $this + */ + public function setPhoneNumber($var) + { + GPBUtil::checkString($var, True); + $this->phone_number = $var; + + return $this; + } + + /** + * Whether the phone number has been verified to be accessible by the user + * (OTP or similar). + * + * Generated from protobuf field bool phone_verified = 5; + * @return bool + */ + public function getPhoneVerified() + { + return $this->phone_verified; + } + + /** + * Whether the phone number has been verified to be accessible by the user + * (OTP or similar). + * + * Generated from protobuf field bool phone_verified = 5; + * @param bool $var + * @return $this + */ + public function setPhoneVerified($var) + { + GPBUtil::checkBool($var); + $this->phone_verified = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(User::class, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData_User::class); + diff --git a/RecaptchaEnterprise/src/V1/TransactionData_Address.php b/RecaptchaEnterprise/src/V1/TransactionData_Address.php new file mode 100644 index 00000000000..707ef0812f9 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionData_Address.php @@ -0,0 +1,16 @@ +google.cloud.recaptchaenterprise.v1.TransactionEvent + */ +class TransactionEvent extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The type of this transaction event. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $event_type = 0; + /** + * Optional. The reason or standardized code that corresponds with this + * transaction event, if one exists. For example, a CHARGEBACK event with code + * 6005. + * + * Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $reason = ''; + /** + * 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. + * + * Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $value = 0.0; + /** + * Optional. Timestamp when this transaction event occurred; otherwise assumed + * to be the time of the API call. + * + * Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $event_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $event_type + * Optional. The type of this transaction event. + * @type string $reason + * Optional. The reason or standardized code that corresponds with this + * transaction event, if one exists. For example, a CHARGEBACK event with code + * 6005. + * @type float $value + * 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. + * @type \Google\Protobuf\Timestamp $event_time + * Optional. Timestamp when this transaction event occurred; otherwise assumed + * to be the time of the API call. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The type of this transaction event. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getEventType() + { + return $this->event_type; + } + + /** + * Optional. The type of this transaction event. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setEventType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent\TransactionEventType::class); + $this->event_type = $var; + + return $this; + } + + /** + * Optional. The reason or standardized code that corresponds with this + * transaction event, if one exists. For example, a CHARGEBACK event with code + * 6005. + * + * Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getReason() + { + return $this->reason; + } + + /** + * Optional. The reason or standardized code that corresponds with this + * transaction event, if one exists. For example, a CHARGEBACK event with code + * 6005. + * + * Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setReason($var) + { + GPBUtil::checkString($var, True); + $this->reason = $var; + + return $this; + } + + /** + * 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. + * + * Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return float + */ + public function getValue() + { + return $this->value; + } + + /** + * 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. + * + * Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param float $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkDouble($var); + $this->value = $var; + + return $this; + } + + /** + * Optional. Timestamp when this transaction event occurred; otherwise assumed + * to be the time of the API call. + * + * Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEventTime() + { + return $this->event_time; + } + + public function hasEventTime() + { + return isset($this->event_time); + } + + public function clearEventTime() + { + unset($this->event_time); + } + + /** + * Optional. Timestamp when this transaction event occurred; otherwise assumed + * to be the time of the API call. + * + * Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEventTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->event_time = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/TransactionEvent/TransactionEventType.php b/RecaptchaEnterprise/src/V1/TransactionEvent/TransactionEventType.php new file mode 100644 index 00000000000..04f38508e88 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionEvent/TransactionEventType.php @@ -0,0 +1,214 @@ +google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType + */ +class TransactionEventType +{ + /** + * Default, unspecified event type. + * + * Generated from protobuf enum TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0; + */ + const TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0; + /** + * Indicates that the transaction is approved by the merchant. The + * accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY', + * 'CYBERSOURCE', or 'MANUAL_REVIEW'. + * + * Generated from protobuf enum MERCHANT_APPROVE = 1; + */ + const MERCHANT_APPROVE = 1; + /** + * Indicates that the transaction is denied and concluded due to risks + * detected by the merchant. The accompanying reasons can include terms such + * as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + * + * Generated from protobuf enum MERCHANT_DENY = 2; + */ + const MERCHANT_DENY = 2; + /** + * Indicates that the transaction is being evaluated by a human, due to + * suspicion or risk. + * + * Generated from protobuf enum MANUAL_REVIEW = 3; + */ + const MANUAL_REVIEW = 3; + /** + * Indicates that the authorization attempt with the card issuer succeeded. + * + * Generated from protobuf enum AUTHORIZATION = 4; + */ + const AUTHORIZATION = 4; + /** + * Indicates that the authorization attempt with the card issuer failed. + * The accompanying reasons can include Visa's '54' indicating that the card + * is expired, or '82' indicating that the CVV is incorrect. + * + * Generated from protobuf enum AUTHORIZATION_DECLINE = 5; + */ + const AUTHORIZATION_DECLINE = 5; + /** + * Indicates that the transaction is completed because the funds were + * settled. + * + * Generated from protobuf enum PAYMENT_CAPTURE = 6; + */ + const PAYMENT_CAPTURE = 6; + /** + * Indicates that the transaction could not be completed because the funds + * were not settled. + * + * Generated from protobuf enum PAYMENT_CAPTURE_DECLINE = 7; + */ + const PAYMENT_CAPTURE_DECLINE = 7; + /** + * Indicates that the transaction has been canceled. Specify the reason + * for the cancellation. For example, 'INSUFFICIENT_INVENTORY'. + * + * Generated from protobuf enum CANCEL = 8; + */ + const CANCEL = 8; + /** + * Indicates that the merchant has received a chargeback inquiry due to + * fraud for the transaction, requesting additional information before a + * fraud chargeback is officially issued and a formal chargeback + * notification is sent. + * + * Generated from protobuf enum CHARGEBACK_INQUIRY = 9; + */ + const CHARGEBACK_INQUIRY = 9; + /** + * Indicates that the merchant has received a chargeback alert due to fraud + * for the transaction. The process of resolving the dispute without + * involving the payment network is started. + * + * Generated from protobuf enum CHARGEBACK_ALERT = 10; + */ + const CHARGEBACK_ALERT = 10; + /** + * Indicates that a fraud notification is issued for the transaction, sent + * by the payment instrument's issuing bank because the transaction appears + * to be fraudulent. We recommend including TC40 or SAFE data in the + * `reason` field for this event type. For partial chargebacks, we recommend + * that you include an amount in the `value` field. + * + * Generated from protobuf enum FRAUD_NOTIFICATION = 11; + */ + const FRAUD_NOTIFICATION = 11; + /** + * Indicates that the merchant is informed by the payment network that the + * transaction has entered the chargeback process due to fraud. Reason code + * examples include Discover's '6005' and '6041'. For partial chargebacks, + * we recommend that you include an amount in the `value` field. + * + * Generated from protobuf enum CHARGEBACK = 12; + */ + const CHARGEBACK = 12; + /** + * Indicates that the transaction has entered the chargeback process due to + * fraud, and that the merchant has chosen to enter representment. Reason + * examples include Discover's '6005' and '6041'. For partial chargebacks, + * we recommend that you include an amount in the `value` field. + * + * Generated from protobuf enum CHARGEBACK_REPRESENTMENT = 13; + */ + const CHARGEBACK_REPRESENTMENT = 13; + /** + * Indicates that the transaction has had a fraud chargeback which was + * illegitimate and was reversed as a result. For partial chargebacks, we + * recommend that you include an amount in the `value` field. + * + * Generated from protobuf enum CHARGEBACK_REVERSE = 14; + */ + const CHARGEBACK_REVERSE = 14; + /** + * Indicates that the merchant has received a refund for a completed + * transaction. For partial refunds, we recommend that you include an amount + * in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of + * exempt tax) + * + * Generated from protobuf enum REFUND_REQUEST = 15; + */ + const REFUND_REQUEST = 15; + /** + * Indicates that the merchant has received a refund request for this + * transaction, but that they have declined it. For partial refunds, we + * recommend that you include an amount in the `value` field. Reason + * example: 'TAX_EXEMPT' (partial refund of exempt tax) + * + * Generated from protobuf enum REFUND_DECLINE = 16; + */ + const REFUND_DECLINE = 16; + /** + * Indicates that the completed transaction was refunded by the merchant. + * For partial refunds, we recommend that you include an amount in the + * `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt + * tax) + * + * Generated from protobuf enum REFUND = 17; + */ + const REFUND = 17; + /** + * Indicates that the completed transaction was refunded by the merchant, + * and that this refund was reversed. For partial refunds, we recommend that + * you include an amount in the `value` field. + * + * Generated from protobuf enum REFUND_REVERSE = 18; + */ + const REFUND_REVERSE = 18; + + private static $valueToName = [ + self::TRANSACTION_EVENT_TYPE_UNSPECIFIED => 'TRANSACTION_EVENT_TYPE_UNSPECIFIED', + self::MERCHANT_APPROVE => 'MERCHANT_APPROVE', + self::MERCHANT_DENY => 'MERCHANT_DENY', + self::MANUAL_REVIEW => 'MANUAL_REVIEW', + self::AUTHORIZATION => 'AUTHORIZATION', + self::AUTHORIZATION_DECLINE => 'AUTHORIZATION_DECLINE', + self::PAYMENT_CAPTURE => 'PAYMENT_CAPTURE', + self::PAYMENT_CAPTURE_DECLINE => 'PAYMENT_CAPTURE_DECLINE', + self::CANCEL => 'CANCEL', + self::CHARGEBACK_INQUIRY => 'CHARGEBACK_INQUIRY', + self::CHARGEBACK_ALERT => 'CHARGEBACK_ALERT', + self::FRAUD_NOTIFICATION => 'FRAUD_NOTIFICATION', + self::CHARGEBACK => 'CHARGEBACK', + self::CHARGEBACK_REPRESENTMENT => 'CHARGEBACK_REPRESENTMENT', + self::CHARGEBACK_REVERSE => 'CHARGEBACK_REVERSE', + self::REFUND_REQUEST => 'REFUND_REQUEST', + self::REFUND_DECLINE => 'REFUND_DECLINE', + self::REFUND => 'REFUND', + self::REFUND_REVERSE => 'REFUND_REVERSE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(TransactionEventType::class, \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent_TransactionEventType::class); + diff --git a/RecaptchaEnterprise/src/V1/TransactionEvent_TransactionEventType.php b/RecaptchaEnterprise/src/V1/TransactionEvent_TransactionEventType.php new file mode 100644 index 00000000000..deb84cb8cff --- /dev/null +++ b/RecaptchaEnterprise/src/V1/TransactionEvent_TransactionEventType.php @@ -0,0 +1,16 @@ +