From 1d1c514c5fae879730c3efe29b0ee28e608e7972 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 4 Oct 2023 15:07:46 +0300 Subject: [PATCH] chore: Publish fraudPreventionV2 [2.1.0] SDK (#248) PR: https://github.com/ExpediaGroup/expediagroup-python-sdk/pull/248 --- release/fraudPreventionV2/docs/AccountRole.md | 41 ++ .../docs/AccountScreenRequest.md | 33 ++ .../docs/AccountScreenResponse.md | 37 ++ .../docs/AccountTakeoverBadRequestError.md | 33 ++ ...rBadRequestErrorDeserializationContract.md | 37 ++ .../docs/AccountTakeoverCustomerAccount.md | 73 +++ .../docs/AccountTakeoverDeviceDetails.md | 51 ++ .../docs/AccountTakeoverError.md | 37 ++ .../docs/AccountTakeoverFraudDecision.md | 41 ++ .../docs/AccountTakeoverName.md | 49 ++ .../docs/AccountTakeoverSiteInfo.md | 45 ++ ...ccountTakeoverTransactionDetailsGeneric.md | 46 ++ .../docs/AccountTakeoverUnauthorizedError.md | 20 + ...nauthorizedErrorDeserializationContract.md | 37 ++ .../docs/AccountTransaction.md | 45 ++ release/fraudPreventionV2/docs/AccountType.md | 39 ++ .../fraudPreventionV2/docs/AccountType1.md | 37 ++ .../docs/AccountUpdateNotFoundError.md | 20 + ...ateNotFoundErrorDeserializationContract.md | 37 ++ .../docs/AccountUpdateRequestGeneric.md | 39 ++ .../docs/AccountUpdateResponse.md | 33 ++ release/fraudPreventionV2/docs/ActionName.md | 41 ++ release/fraudPreventionV2/docs/Address.md | 57 ++ release/fraudPreventionV2/docs/AddressType.md | 35 ++ release/fraudPreventionV2/docs/Air.md | 57 ++ release/fraudPreventionV2/docs/AirSegment.md | 49 ++ release/fraudPreventionV2/docs/Amount.md | 37 ++ .../docs/AuthenticationSubType.md | 57 ++ .../docs/AuthenticationType.md | 57 ++ release/fraudPreventionV2/docs/Authorize.md | 20 + .../docs/AuthorizeReversal.md | 20 + .../fraudPreventionV2/docs/BadGatewayError.md | 20 + .../BadGatewayErrorDeserializationContract.md | 37 ++ .../fraudPreventionV2/docs/BadRequestError.md | 33 ++ .../BadRequestErrorDeserializationContract.md | 37 ++ release/fraudPreventionV2/docs/Brand.md | 235 ++++++++ .../docs/CancellationReason.md | 45 ++ release/fraudPreventionV2/docs/Capture.md | 20 + release/fraudPreventionV2/docs/Car.md | 49 ++ release/fraudPreventionV2/docs/CardType.md | 87 +++ release/fraudPreventionV2/docs/Cause.md | 41 ++ release/fraudPreventionV2/docs/Cause1.md | 41 ++ .../fraudPreventionV2/docs/ChallengeDetail.md | 41 ++ .../docs/ChargebackDetail.md | 49 ++ .../docs/ChargebackFeedback.md | 37 ++ .../docs/ChargebackReason.md | 35 ++ .../docs/ChargebackStatus.md | 37 ++ release/fraudPreventionV2/docs/Code.md | 62 +++ release/fraudPreventionV2/docs/Code1.md | 38 ++ release/fraudPreventionV2/docs/Code2.md | 62 +++ release/fraudPreventionV2/docs/Code3.md | 38 ++ release/fraudPreventionV2/docs/CreditCard.md | 77 +++ release/fraudPreventionV2/docs/Cruise.md | 53 ++ .../docs/CurrentOrderStatus.md | 37 ++ .../docs/CurrentUserSession.md | 42 ++ .../fraudPreventionV2/docs/CustomerAccount.md | 57 ++ .../fraudPreventionV2/docs/DeliveryMethod.md | 41 ++ .../fraudPreventionV2/docs/DeviceDetails.md | 43 ++ release/fraudPreventionV2/docs/DirectDebit.md | 45 ++ release/fraudPreventionV2/docs/Email.md | 33 ++ release/fraudPreventionV2/docs/Error.md | 37 ++ ...AccountTakeoverBadRequestErrorException.md | 20 + ...countTakeoverUnauthorizedErrorException.md | 20 + ...roupAccountUpdateNotFoundErrorException.md | 20 + .../ExpediaGroupBadGatewayErrorException.md | 20 + .../ExpediaGroupBadRequestErrorException.md | 20 + .../ExpediaGroupForbiddenErrorException.md | 20 + ...xpediaGroupGatewayTimeoutErrorException.md | 20 + ...xpediaGroupInternalServerErrorException.md | 20 + .../ExpediaGroupNotFoundErrorException.md | 20 + ...derPurchaseUpdateNotFoundErrorException.md | 20 + ...ableOrderPurchaseScreenFailureException.md | 20 + ...ableOrderPurchaseUpdateFailureException.md | 20 + ...iaGroupServiceUnavailableErrorException.md | 20 + ...pediaGroupTooManyRequestsErrorException.md | 20 + .../ExpediaGroupUnauthorizedErrorException.md | 20 + .../docs/FailedLoginReason.md | 45 ++ release/fraudPreventionV2/docs/FlightType.md | 38 ++ .../fraudPreventionV2/docs/ForbiddenError.md | 20 + .../ForbiddenErrorDeserializationContract.md | 37 ++ .../fraudPreventionV2/docs/FraudDecision.md | 38 ++ .../docs/FraudPreventionV2Client.md | 109 ++++ .../docs/GatewayTimeoutError.md | 20 + ...ewayTimeoutErrorDeserializationContract.md | 37 ++ release/fraudPreventionV2/docs/GiftCard.md | 45 ++ release/fraudPreventionV2/docs/Hotel.md | 61 +++ .../fraudPreventionV2/docs/HotelAddress.md | 20 + .../fraudPreventionV2/docs/InsultDetail.md | 33 ++ .../fraudPreventionV2/docs/InsultFeedback.md | 37 ++ release/fraudPreventionV2/docs/Insurance.md | 33 ++ .../docs/InternalServerError.md | 20 + ...ernalServerErrorDeserializationContract.md | 37 ++ .../docs/InternetBankPayment.md | 45 ++ .../fraudPreventionV2/docs/InventorySource.md | 37 ++ .../docs/IssuedRefundUpdate.md | 37 ++ .../docs/IssuedRefundUpdateDetails.md | 37 ++ .../docs/LoginTransactionDetails.md | 49 ++ .../docs/MultiFactorAuthenticationAttempt.md | 65 +++ .../docs/MultiFactorAuthenticationUpdate.md | 37 ++ release/fraudPreventionV2/docs/Name.md | 49 ++ .../fraudPreventionV2/docs/NotFoundError.md | 20 + .../NotFoundErrorDeserializationContract.md | 37 ++ .../docs/OperatingCompany.md | 33 ++ release/fraudPreventionV2/docs/Operations.md | 59 ++ .../docs/OrderPurchaseScreenRequest.md | 33 ++ .../docs/OrderPurchaseScreenResponse.md | 37 ++ .../docs/OrderPurchaseTransaction.md | 45 ++ .../docs/OrderPurchaseUpdateNotFoundError.md | 20 + ...ateNotFoundErrorDeserializationContract.md | 37 ++ .../docs/OrderPurchaseUpdateRequestGeneric.md | 42 ++ .../docs/OrderPurchaseUpdateResponse.md | 33 ++ release/fraudPreventionV2/docs/OrderType.md | 39 ++ release/fraudPreventionV2/docs/OrderUpdate.md | 45 ++ release/fraudPreventionV2/docs/PayPal.md | 45 ++ .../fraudPreventionV2/docs/PaymentGeneric.md | 75 +++ .../fraudPreventionV2/docs/PaymentMethod.md | 47 ++ .../docs/PaymentOperation.md | 41 ++ .../fraudPreventionV2/docs/PaymentOutcome.md | 41 ++ .../fraudPreventionV2/docs/PaymentReason.md | 49 ++ .../fraudPreventionV2/docs/PaymentStatus.md | 35 ++ .../docs/PaymentThreeDSCriteria.md | 37 ++ .../fraudPreventionV2/docs/PaymentUpdate.md | 37 ++ .../fraudPreventionV2/docs/PlacementName.md | 37 ++ release/fraudPreventionV2/docs/Points.md | 37 ++ release/fraudPreventionV2/docs/Rail.md | 41 ++ .../fraudPreventionV2/docs/RailSegments.md | 53 ++ .../docs/RailwayStationDetails.md | 49 ++ release/fraudPreventionV2/docs/Refund.md | 20 + .../fraudPreventionV2/docs/RefundStatus.md | 37 ++ .../docs/RefundUpdateGeneric.md | 37 ++ .../docs/RemediationUpdate.md | 37 ++ .../docs/RemediationUpdateAction.md | 41 ++ .../RetryableOrderPurchaseScreenFailure.md | 21 + ...aseScreenFailureDeserializationContract.md | 37 ++ .../RetryableOrderPurchaseUpdateFailure.md | 21 + ...aseUpdateFailureDeserializationContract.md | 37 ++ release/fraudPreventionV2/docs/RouteType.md | 41 ++ .../docs/ServiceUnavailableError.md | 21 + ...UnavailableErrorDeserializationContract.md | 37 ++ .../docs/SettledRefundUpdate.md | 37 ++ .../docs/SettledRefundUpdateDetails.md | 49 ++ release/fraudPreventionV2/docs/SiteInfo.md | 37 ++ release/fraudPreventionV2/docs/Status.md | 53 ++ release/fraudPreventionV2/docs/Status1.md | 41 ++ release/fraudPreventionV2/docs/Status2.md | 37 ++ release/fraudPreventionV2/docs/Status3.md | 37 ++ release/fraudPreventionV2/docs/Telephone.md | 65 +++ .../docs/TelephonePlatformType.md | 38 ++ .../fraudPreventionV2/docs/TelephoneType.md | 44 ++ .../docs/TooManyRequestsError.md | 20 + ...anyRequestsErrorDeserializationContract.md | 37 ++ .../docs/TransactionDetails.md | 53 ++ .../docs/TransportationMethod.md | 57 ++ .../docs/TravelProductGeneric.md | 59 ++ .../docs/TravelProductType.md | 47 ++ release/fraudPreventionV2/docs/Traveler.md | 61 +++ .../docs/TravelersReference.md | 33 ++ release/fraudPreventionV2/docs/Type.md | 35 ++ release/fraudPreventionV2/docs/Type1.md | 35 ++ release/fraudPreventionV2/docs/Type2.md | 49 ++ release/fraudPreventionV2/docs/Type3.md | 32 ++ release/fraudPreventionV2/docs/Type4.md | 37 ++ .../docs/UnauthorizedError.md | 20 + ...nauthorizedErrorDeserializationContract.md | 37 ++ release/fraudPreventionV2/docs/UpdateType.md | 44 ++ .../docs/VerificationType.md | 35 ++ release/fraudPreventionV2/docs/Verify.md | 33 ++ ...pediagroup.sdk.fraudpreventionv2.client.md | 17 + .../expediagroup.sdk.fraudpreventionv2.md | 20 + ...xpediagroup.sdk.fraudpreventionv2.model.md | 512 ++++++++++++++++++ release/fraudPreventionV2/docs/index.md | 17 + .../fraudPreventionV2/{ => src}/__init__.py | 0 release/fraudPreventionV2/{ => src}/client.py | 0 release/fraudPreventionV2/{ => src}/model.py | 122 ++--- release/fraudPreventionV2/{ => src}/setup.py | 2 +- .../fraudPreventionV2/{ => src}/specs.yaml | 0 176 files changed, 7336 insertions(+), 62 deletions(-) create mode 100644 release/fraudPreventionV2/docs/AccountRole.md create mode 100644 release/fraudPreventionV2/docs/AccountScreenRequest.md create mode 100644 release/fraudPreventionV2/docs/AccountScreenResponse.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverError.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverFraudDecision.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverName.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverSiteInfo.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverTransactionDetailsGeneric.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedError.md create mode 100644 release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/AccountTransaction.md create mode 100644 release/fraudPreventionV2/docs/AccountType.md create mode 100644 release/fraudPreventionV2/docs/AccountType1.md create mode 100644 release/fraudPreventionV2/docs/AccountUpdateNotFoundError.md create mode 100644 release/fraudPreventionV2/docs/AccountUpdateNotFoundErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/AccountUpdateRequestGeneric.md create mode 100644 release/fraudPreventionV2/docs/AccountUpdateResponse.md create mode 100644 release/fraudPreventionV2/docs/ActionName.md create mode 100644 release/fraudPreventionV2/docs/Address.md create mode 100644 release/fraudPreventionV2/docs/AddressType.md create mode 100644 release/fraudPreventionV2/docs/Air.md create mode 100644 release/fraudPreventionV2/docs/AirSegment.md create mode 100644 release/fraudPreventionV2/docs/Amount.md create mode 100644 release/fraudPreventionV2/docs/AuthenticationSubType.md create mode 100644 release/fraudPreventionV2/docs/AuthenticationType.md create mode 100644 release/fraudPreventionV2/docs/Authorize.md create mode 100644 release/fraudPreventionV2/docs/AuthorizeReversal.md create mode 100644 release/fraudPreventionV2/docs/BadGatewayError.md create mode 100644 release/fraudPreventionV2/docs/BadGatewayErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/BadRequestError.md create mode 100644 release/fraudPreventionV2/docs/BadRequestErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/Brand.md create mode 100644 release/fraudPreventionV2/docs/CancellationReason.md create mode 100644 release/fraudPreventionV2/docs/Capture.md create mode 100644 release/fraudPreventionV2/docs/Car.md create mode 100644 release/fraudPreventionV2/docs/CardType.md create mode 100644 release/fraudPreventionV2/docs/Cause.md create mode 100644 release/fraudPreventionV2/docs/Cause1.md create mode 100644 release/fraudPreventionV2/docs/ChallengeDetail.md create mode 100644 release/fraudPreventionV2/docs/ChargebackDetail.md create mode 100644 release/fraudPreventionV2/docs/ChargebackFeedback.md create mode 100644 release/fraudPreventionV2/docs/ChargebackReason.md create mode 100644 release/fraudPreventionV2/docs/ChargebackStatus.md create mode 100644 release/fraudPreventionV2/docs/Code.md create mode 100644 release/fraudPreventionV2/docs/Code1.md create mode 100644 release/fraudPreventionV2/docs/Code2.md create mode 100644 release/fraudPreventionV2/docs/Code3.md create mode 100644 release/fraudPreventionV2/docs/CreditCard.md create mode 100644 release/fraudPreventionV2/docs/Cruise.md create mode 100644 release/fraudPreventionV2/docs/CurrentOrderStatus.md create mode 100644 release/fraudPreventionV2/docs/CurrentUserSession.md create mode 100644 release/fraudPreventionV2/docs/CustomerAccount.md create mode 100644 release/fraudPreventionV2/docs/DeliveryMethod.md create mode 100644 release/fraudPreventionV2/docs/DeviceDetails.md create mode 100644 release/fraudPreventionV2/docs/DirectDebit.md create mode 100644 release/fraudPreventionV2/docs/Email.md create mode 100644 release/fraudPreventionV2/docs/Error.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverBadRequestErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverUnauthorizedErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupAccountUpdateNotFoundErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupBadGatewayErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupBadRequestErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupForbiddenErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupGatewayTimeoutErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupInternalServerErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupNotFoundErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseScreenFailureException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupServiceUnavailableErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupTooManyRequestsErrorException.md create mode 100644 release/fraudPreventionV2/docs/ExpediaGroupUnauthorizedErrorException.md create mode 100644 release/fraudPreventionV2/docs/FailedLoginReason.md create mode 100644 release/fraudPreventionV2/docs/FlightType.md create mode 100644 release/fraudPreventionV2/docs/ForbiddenError.md create mode 100644 release/fraudPreventionV2/docs/ForbiddenErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/FraudDecision.md create mode 100644 release/fraudPreventionV2/docs/FraudPreventionV2Client.md create mode 100644 release/fraudPreventionV2/docs/GatewayTimeoutError.md create mode 100644 release/fraudPreventionV2/docs/GatewayTimeoutErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/GiftCard.md create mode 100644 release/fraudPreventionV2/docs/Hotel.md create mode 100644 release/fraudPreventionV2/docs/HotelAddress.md create mode 100644 release/fraudPreventionV2/docs/InsultDetail.md create mode 100644 release/fraudPreventionV2/docs/InsultFeedback.md create mode 100644 release/fraudPreventionV2/docs/Insurance.md create mode 100644 release/fraudPreventionV2/docs/InternalServerError.md create mode 100644 release/fraudPreventionV2/docs/InternalServerErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/InternetBankPayment.md create mode 100644 release/fraudPreventionV2/docs/InventorySource.md create mode 100644 release/fraudPreventionV2/docs/IssuedRefundUpdate.md create mode 100644 release/fraudPreventionV2/docs/IssuedRefundUpdateDetails.md create mode 100644 release/fraudPreventionV2/docs/LoginTransactionDetails.md create mode 100644 release/fraudPreventionV2/docs/MultiFactorAuthenticationAttempt.md create mode 100644 release/fraudPreventionV2/docs/MultiFactorAuthenticationUpdate.md create mode 100644 release/fraudPreventionV2/docs/Name.md create mode 100644 release/fraudPreventionV2/docs/NotFoundError.md create mode 100644 release/fraudPreventionV2/docs/NotFoundErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/OperatingCompany.md create mode 100644 release/fraudPreventionV2/docs/Operations.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseScreenRequest.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseScreenResponse.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseTransaction.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundError.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseUpdateRequestGeneric.md create mode 100644 release/fraudPreventionV2/docs/OrderPurchaseUpdateResponse.md create mode 100644 release/fraudPreventionV2/docs/OrderType.md create mode 100644 release/fraudPreventionV2/docs/OrderUpdate.md create mode 100644 release/fraudPreventionV2/docs/PayPal.md create mode 100644 release/fraudPreventionV2/docs/PaymentGeneric.md create mode 100644 release/fraudPreventionV2/docs/PaymentMethod.md create mode 100644 release/fraudPreventionV2/docs/PaymentOperation.md create mode 100644 release/fraudPreventionV2/docs/PaymentOutcome.md create mode 100644 release/fraudPreventionV2/docs/PaymentReason.md create mode 100644 release/fraudPreventionV2/docs/PaymentStatus.md create mode 100644 release/fraudPreventionV2/docs/PaymentThreeDSCriteria.md create mode 100644 release/fraudPreventionV2/docs/PaymentUpdate.md create mode 100644 release/fraudPreventionV2/docs/PlacementName.md create mode 100644 release/fraudPreventionV2/docs/Points.md create mode 100644 release/fraudPreventionV2/docs/Rail.md create mode 100644 release/fraudPreventionV2/docs/RailSegments.md create mode 100644 release/fraudPreventionV2/docs/RailwayStationDetails.md create mode 100644 release/fraudPreventionV2/docs/Refund.md create mode 100644 release/fraudPreventionV2/docs/RefundStatus.md create mode 100644 release/fraudPreventionV2/docs/RefundUpdateGeneric.md create mode 100644 release/fraudPreventionV2/docs/RemediationUpdate.md create mode 100644 release/fraudPreventionV2/docs/RemediationUpdateAction.md create mode 100644 release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailure.md create mode 100644 release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailureDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailure.md create mode 100644 release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailureDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/RouteType.md create mode 100644 release/fraudPreventionV2/docs/ServiceUnavailableError.md create mode 100644 release/fraudPreventionV2/docs/ServiceUnavailableErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/SettledRefundUpdate.md create mode 100644 release/fraudPreventionV2/docs/SettledRefundUpdateDetails.md create mode 100644 release/fraudPreventionV2/docs/SiteInfo.md create mode 100644 release/fraudPreventionV2/docs/Status.md create mode 100644 release/fraudPreventionV2/docs/Status1.md create mode 100644 release/fraudPreventionV2/docs/Status2.md create mode 100644 release/fraudPreventionV2/docs/Status3.md create mode 100644 release/fraudPreventionV2/docs/Telephone.md create mode 100644 release/fraudPreventionV2/docs/TelephonePlatformType.md create mode 100644 release/fraudPreventionV2/docs/TelephoneType.md create mode 100644 release/fraudPreventionV2/docs/TooManyRequestsError.md create mode 100644 release/fraudPreventionV2/docs/TooManyRequestsErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/TransactionDetails.md create mode 100644 release/fraudPreventionV2/docs/TransportationMethod.md create mode 100644 release/fraudPreventionV2/docs/TravelProductGeneric.md create mode 100644 release/fraudPreventionV2/docs/TravelProductType.md create mode 100644 release/fraudPreventionV2/docs/Traveler.md create mode 100644 release/fraudPreventionV2/docs/TravelersReference.md create mode 100644 release/fraudPreventionV2/docs/Type.md create mode 100644 release/fraudPreventionV2/docs/Type1.md create mode 100644 release/fraudPreventionV2/docs/Type2.md create mode 100644 release/fraudPreventionV2/docs/Type3.md create mode 100644 release/fraudPreventionV2/docs/Type4.md create mode 100644 release/fraudPreventionV2/docs/UnauthorizedError.md create mode 100644 release/fraudPreventionV2/docs/UnauthorizedErrorDeserializationContract.md create mode 100644 release/fraudPreventionV2/docs/UpdateType.md create mode 100644 release/fraudPreventionV2/docs/VerificationType.md create mode 100644 release/fraudPreventionV2/docs/Verify.md create mode 100644 release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.client.md create mode 100644 release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.md create mode 100644 release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.model.md create mode 100644 release/fraudPreventionV2/docs/index.md rename release/fraudPreventionV2/{ => src}/__init__.py (100%) rename release/fraudPreventionV2/{ => src}/client.py (100%) rename release/fraudPreventionV2/{ => src}/model.py (100%) rename release/fraudPreventionV2/{ => src}/setup.py (96%) rename release/fraudPreventionV2/{ => src}/specs.yaml (100%) diff --git a/release/fraudPreventionV2/docs/AccountRole.md b/release/fraudPreventionV2/docs/AccountRole.md new file mode 100644 index 00000000..a6d170de --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountRole.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountRole](AccountRole.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountRole` +``` +AccountRole( +) +``` + +pydantic model AccountRole: Identifies the account role and associated permissions of a user''s account. Possible values are: +- `USER`: Basic account with no special privileges. +- `MANAGER`: Account with additional privileges, such as the ability to make bookings for others. +- `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| ADMIN | Any | True | ... | +| MANAGER | Any | True | ... | +| USER | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AccountRole \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountScreenRequest.md b/release/fraudPreventionV2/docs/AccountScreenRequest.md new file mode 100644 index 00000000..9bf28cc3 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountScreenRequest.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountScreenRequest](AccountScreenRequest.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountScreenRequest` +``` +AccountScreenRequest( + transaction: AccountTransaction, +) +``` + +pydantic model AccountScreenRequest: Information for account screening by Expedia's Fraud Prevention Service. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|-------------|---------------------------------------------|----------|-------------| +| transaction | [AccountTransaction](AccountTransaction.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountScreenRequest \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountScreenResponse.md b/release/fraudPreventionV2/docs/AccountScreenResponse.md new file mode 100644 index 00000000..338818e8 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountScreenResponse.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountScreenResponse](AccountScreenResponse.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountScreenResponse` +``` +AccountScreenResponse( + risk_id: Optional[constr(max_length=200)], + decision: Optional[AccountTakeoverFraudDecision], +) +``` + +pydantic model AccountScreenResponse: Response for an account transaction provided by Expedia's Fraud Prevention Service. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------|---------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------| +| decision | Optional[[AccountTakeoverFraudDecision](AccountTakeoverFraudDecision.md)] | False | ... | +| risk_id | Optional[constr(max_length=200)] | False | Unique identifier assigned to the transaction by Expedia's Fraud Prevention Service. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountScreenResponse \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md b/release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md new file mode 100644 index 00000000..a2d0cc3f --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverBadRequestError.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverBadRequestError](AccountTakeoverBadRequestError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverBadRequestError` +``` +AccountTakeoverBadRequestError( + causes: Optional[list[Cause1]], +) +``` + +pydantic model AccountTakeoverBadRequestError: Indicates that a bad request occurred. Typically it is an invalid parameter. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|--------|-------------------------------------|----------|-------------| +| causes | Optional[list[[Cause1](Cause1.md)]] | False | ... | + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > AccountTakeoverBadRequestError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md b/release/fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md new file mode 100644 index 00000000..7ab8c1c1 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverBadRequestErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverBadRequestErrorDeserializationContract](AccountTakeoverBadRequestErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverBadRequestErrorDeserializationContract` +``` +AccountTakeoverBadRequestErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > AccountTakeoverBadRequestErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md b/release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md new file mode 100644 index 00000000..f68d57df --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverCustomerAccount.md @@ -0,0 +1,73 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverCustomerAccount](AccountTakeoverCustomerAccount.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverCustomerAccount` +``` +AccountTakeoverCustomerAccount( + user_id: constr(max_length=200), + account_type: AccountType1, + account_role: Optional[AccountRole], + name: Optional[AccountTakeoverName], + username: constr(max_length=200), + email_address: EmailStr, + telephones: Optional[list[Telephone]], + address: Optional[Address], + registered_time: datetime, + active_flag: bool, + loyalty_member_id: Optional[constr(max_length=200)], +) +``` + +pydantic model AccountTakeoverCustomerAccount: Information about a user's account. + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------------|---------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_role | Optional[[AccountRole](AccountRole.md)] | False | Identifies the account role and associated permissions of a user''s account. Possible values are:
- `USER`: Basic account with no special privileges.
- `MANAGER`: Account with additional privileges, such as the ability to make bookings for others.
- `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. | +| account_type | [AccountType1](AccountType1.md) | True | Identifies the account type of a user''s account. Possible values are:
- `INDIVIDUAL` - Applicable if this account is for an individual traveler.
- `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners. | +| active_flag | bool | True | Indicator for if this account is an active account or not. | +| address | Optional[[Address](Address.md)] | False | ... | +| email_address | EmailStr | True | Email address for the account owner. | +| loyalty_member_id | Optional[constr(max_length=200)] | False | Unique loyalty identifier for a user. | +| name | Optional[[AccountTakeoverName](AccountTakeoverName.md)] | False | ... | +| registered_time | datetime | True | The local date and time that the customer first registered on the Partner's site, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| telephones | Optional[list[[Telephone](Telephone.md)]] | False | ... | +| user_id | constr(max_length=200) | True | Unique account identifier provided by the Partner's Identity Provider/System assigned to the account owner by the partner. `user_id` is specific to the Partner's namespace. Used to track repeat account activity by the same user. | +| username | constr(max_length=200) | True | Username of the account. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverCustomerAccount \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md b/release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md new file mode 100644 index 00000000..c68de6a6 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverDeviceDetails.md @@ -0,0 +1,51 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverDeviceDetails](AccountTakeoverDeviceDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverDeviceDetails` +``` +AccountTakeoverDeviceDetails( + source: Optional[constr(max_length=50)], + device_box: constr(max_length=16000), + ip_address: constr( + regex=r"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" + ), + user_agent: constr(max_length=200), + type: Optional[Type2], +) +``` + +pydantic model AccountTakeoverDeviceDetails: Information specific to the Partner's device through which a transaction was made. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| device_box | constr(max_length=16000) | True | Device related information retrieved from TrustWidget. | +| ip_address | constr(
regex=r"^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$"
) | True | IP address of the device used for this event. | +| source | Optional[constr(max_length=50)] | False | Source of the device_box. Default value is `TrustWidget`. | +| type | Optional[[Type2](Type2.md)] | False | The categorized type of device used by a user. Possible values are:
- `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer.
- `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone.
- `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet.
- `PHONE_APP` - Applicable if the user initiated this event from an app on a phone.
- `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. | +| user_agent | constr(max_length=200) | True | The application type, operating system, software vendor, or software version of the originating request. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverDeviceDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverError.md b/release/fraudPreventionV2/docs/AccountTakeoverError.md new file mode 100644 index 00000000..96aef38a --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverError.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverError](AccountTakeoverError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverError` +``` +AccountTakeoverError( + code: Code2, + message: str, +) +``` + +pydantic model AccountTakeoverError: The object used to describe an error, containing both human-readable and machine-readable information. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|-------------------|----------|----------------------------------------------------------------------------------------------------------------| +| code | [Code2](Code2.md) | True | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| message | str | True | A human-readable explanation of the error, specific to this error occurrence. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverFraudDecision.md b/release/fraudPreventionV2/docs/AccountTakeoverFraudDecision.md new file mode 100644 index 00000000..e54f12eb --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverFraudDecision.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverFraudDecision](AccountTakeoverFraudDecision.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverFraudDecision` +``` +AccountTakeoverFraudDecision( +) +``` + +pydantic model AccountTakeoverFraudDecision: Fraud recommendation for an account transaction. A recommendation can be ACCEPT, CHALLENGE, or REJECT. +- `ACCEPT` - Represents an account transaction where the user’’s account activity is accepted. +- `CHALLENGE` - Represents an account transaction that requires additional verification or challenges the user’’s identity (example: CAPTCHA, MULTI_FACTOR_AUTHENTICATION, etc). +- `REJECT` - Represents a suspicious account transaction where the user’’s credentials or their behavior requires us to block the account activity. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| ACCEPT | Any | True | ... | +| CHALLENGE | Any | True | ... | +| REJECT | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AccountTakeoverFraudDecision \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverName.md b/release/fraudPreventionV2/docs/AccountTakeoverName.md new file mode 100644 index 00000000..9d2265a3 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverName.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverName](AccountTakeoverName.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverName` +``` +AccountTakeoverName( + last_name: constr(max_length=200), + first_name: constr(max_length=200), + middle_name: Optional[constr(max_length=200)], + title: Optional[constr(max_length=200)], + suffix: Optional[constr(max_length=50)], +) +``` + +pydantic model AccountTakeoverName: Group of attributes intended to hold information about a customer or traveler''s name for the account. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| first_name | constr(max_length=200) | True | Given, or first name, of the person. | +| last_name | constr(max_length=200) | True | Surname, or last name, of the person. | +| middle_name | Optional[constr(max_length=200)] | False | Middle name of the person. | +| suffix | Optional[constr(max_length=50)] | False | Generational designations (e.g. Sr, Jr, III) or values indicate that the individual holds a position, educational degree, accreditation, office, or honor (e.g. PhD, CCNA, OBE). | +| title | Optional[constr(max_length=200)] | False | Title of the person for name (e.g. Mr., Ms. etc). | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverName \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverSiteInfo.md b/release/fraudPreventionV2/docs/AccountTakeoverSiteInfo.md new file mode 100644 index 00000000..88bd3517 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverSiteInfo.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverSiteInfo](AccountTakeoverSiteInfo.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverSiteInfo` +``` +AccountTakeoverSiteInfo( + locale: Optional[constr(regex=r"^([a-z]{2}-[A-Z]{2})$")], + name: Optional[constr(max_length=200)], + brand_name: constr(max_length=200), + placement_name: Optional[PlacementName], +) +``` + +pydantic model AccountTakeoverSiteInfo: Information specific to the Partner's website through which a transaction was made. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------|--------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| brand_name | constr(max_length=200) | True | The trademark brand name that is displayed to a user on the website. | +| locale | Optional[constr(regex=r"^([a-z]{2}-[A-Z]{2})$")] | False | The locale of the website a user is accessing, which is separate from the user configured browser locale, in ISO 639-2 language code format and in ISO 3166-1 country code format. | +| name | Optional[constr(max_length=200)] | False | Name of the website from which the event is generated. | +| placement_name | Optional[[PlacementName](PlacementName.md)] | False | The categorized name of the page where a user initiated event is being evaluated.
- `LOGIN` - Applicable if the user initiated this account event from a login web page.
- `PASSWORD_RESET` - Applicable if the user initiated this account event from a password reset web page. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverSiteInfo \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverTransactionDetailsGeneric.md b/release/fraudPreventionV2/docs/AccountTakeoverTransactionDetailsGeneric.md new file mode 100644 index 00000000..7d794701 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverTransactionDetailsGeneric.md @@ -0,0 +1,46 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverTransactionDetailsGeneric](AccountTakeoverTransactionDetailsGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverTransactionDetailsGeneric` +``` +AccountTakeoverTransactionDetailsGeneric( + type: Type3, + transaction_date_time: datetime, + transaction_id: constr(max_length=200), + current_user_session: Optional[CurrentUserSession], +) +``` + +pydantic model AccountTakeoverTransactionDetails: The `transaction_type` field value is used as a discriminator, with the following mapping: +* `LOGIN`: `LoginTransactionDetails` + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------|-------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------| +| current_user_session | Optional[[CurrentUserSession](CurrentUserSession.md)] | False | ... | +| transaction_date_time | datetime | True | The local date and time the transaction occured in the Partner's system, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| transaction_id | constr(max_length=200) | True | Unique identifier to identify a transaction attempt in the Partner's system. | +| type | [Type3](Type3.md) | True | The categorized type of account event related to a user's action. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTakeoverTransactionDetailsGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedError.md b/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedError.md new file mode 100644 index 00000000..d3eb49e3 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverUnauthorizedError](AccountTakeoverUnauthorizedError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverUnauthorizedError` +``` +AccountTakeoverUnauthorizedError( +) +``` + +pydantic model AccountTakeoverUnauthorizedError: Indicates that the token sent in the 'Authorization' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > AccountTakeoverUnauthorizedError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedErrorDeserializationContract.md b/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedErrorDeserializationContract.md new file mode 100644 index 00000000..a0cf06d1 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTakeoverUnauthorizedErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTakeoverUnauthorizedErrorDeserializationContract](AccountTakeoverUnauthorizedErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTakeoverUnauthorizedErrorDeserializationContract` +``` +AccountTakeoverUnauthorizedErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > AccountTakeoverUnauthorizedErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountTransaction.md b/release/fraudPreventionV2/docs/AccountTransaction.md new file mode 100644 index 00000000..cc095caf --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountTransaction.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountTransaction](AccountTransaction.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountTransaction` +``` +AccountTransaction( + site_info: AccountTakeoverSiteInfo, + device_details: AccountTakeoverDeviceDetails, + customer_account: AccountTakeoverCustomerAccount, + transaction_details: AccountTakeoverTransactionDetails, +) +``` + +pydantic model AccountTransaction: Information for an account transaction. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------| +| customer_account | [AccountTakeoverCustomerAccount](AccountTakeoverCustomerAccount.md) | True | ... | +| device_details | [AccountTakeoverDeviceDetails](AccountTakeoverDeviceDetails.md) | True | ... | +| site_info | [AccountTakeoverSiteInfo](AccountTakeoverSiteInfo.md) | True | ... | +| transaction_details | Union[[LoginTransactionDetails](LoginTransactionDetails.md), [AccountTakeoverTransactionDetailsGeneric](AccountTakeoverTransactionDetailsGeneric.md)] | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountTransaction \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountType.md b/release/fraudPreventionV2/docs/AccountType.md new file mode 100644 index 00000000..dfba1c80 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountType.md @@ -0,0 +1,39 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountType](AccountType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountType` +``` +AccountType( +) +``` + +pydantic model AccountType: Identifies if the customer account is known to the client. Possible values are: + +-`GUEST` - Applicable if the partner maintains record to distinguish whether the transaction was booked via a guest account. + +-`STANDARD` - Default account type. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| GUEST | Any | True | ... | +| STANDARD | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AccountType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountType1.md b/release/fraudPreventionV2/docs/AccountType1.md new file mode 100644 index 00000000..103e5936 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountType1.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountType1](AccountType1.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountType1` +``` +AccountType1( +) +``` + +pydantic model AccountType1: Identifies the account type of a user''s account. Possible values are: +- `INDIVIDUAL` - Applicable if this account is for an individual traveler. +- `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|------------|------|----------|-------------| +| BUSINESS | Any | True | ... | +| INDIVIDUAL | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AccountType1 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountUpdateNotFoundError.md b/release/fraudPreventionV2/docs/AccountUpdateNotFoundError.md new file mode 100644 index 00000000..7be5256a --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountUpdateNotFoundError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountUpdateNotFoundError](AccountUpdateNotFoundError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountUpdateNotFoundError` +``` +AccountUpdateNotFoundError( +) +``` + +pydantic model AccountUpdateNotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > AccountUpdateNotFoundError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountUpdateNotFoundErrorDeserializationContract.md b/release/fraudPreventionV2/docs/AccountUpdateNotFoundErrorDeserializationContract.md new file mode 100644 index 00000000..9d28ba24 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountUpdateNotFoundErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountUpdateNotFoundErrorDeserializationContract](AccountUpdateNotFoundErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountUpdateNotFoundErrorDeserializationContract` +``` +AccountUpdateNotFoundErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > AccountUpdateNotFoundErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountUpdateRequestGeneric.md b/release/fraudPreventionV2/docs/AccountUpdateRequestGeneric.md new file mode 100644 index 00000000..774c93ae --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountUpdateRequestGeneric.md @@ -0,0 +1,39 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountUpdateRequestGeneric](AccountUpdateRequestGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountUpdateRequestGeneric` +``` +AccountUpdateRequestGeneric( + type: Type1, + risk_id: constr(max_length=200), +) +``` + +pydantic model AccountUpdateRequest: The `type` field value is used as a discriminator, with the following mapping: +* `MULTI_FACTOR_AUTHENTICATION_UPDATE`: `MultiFactorAuthenticationUpdate` +* `REMEDIATION_UPDATE`: `RemediationUpdate` + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|------------------------|----------|----------------------------------------------------------------------------------------------| +| risk_id | constr(max_length=200) | True | The `risk_id` provided by Expedia's Fraud Prevention Service in the `AccountScreenResponse`. | +| type | [Type1](Type1.md) | True | The categorized type of account update event from the Partner's system. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountUpdateRequestGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AccountUpdateResponse.md b/release/fraudPreventionV2/docs/AccountUpdateResponse.md new file mode 100644 index 00000000..af6efa87 --- /dev/null +++ b/release/fraudPreventionV2/docs/AccountUpdateResponse.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AccountUpdateResponse](AccountUpdateResponse.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AccountUpdateResponse` +``` +AccountUpdateResponse( + risk_id: Optional[constr(max_length=200)], +) +``` + +pydantic model AccountUpdateResponse + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|---------|----------------------------------|----------|----------------------------------------------------| +| risk_id | Optional[constr(max_length=200)] | False | Unique identifier of transaction that was updated. | + + + + + + + + + + +# Inheritance +object > BaseModel > AccountUpdateResponse \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ActionName.md b/release/fraudPreventionV2/docs/ActionName.md new file mode 100644 index 00000000..4a85c3c7 --- /dev/null +++ b/release/fraudPreventionV2/docs/ActionName.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ActionName](ActionName.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ActionName` +``` +ActionName( +) +``` + +pydantic model ActionName: The categorized remediation action initiated by the Partner''s system to a user. Possible values are: +- `PASSWORD_RESET` - Applicable if this event is the result of a password reset by the Partner''s system. +- `DISABLE_ACCOUNT` - Applicable if this event is the result of disabling an account by the Partner''s system. +- `TERMINATE_ALL_SESSIONS` - Applicable if this event is the result of terminating all active user sessions of an account by the Partner''s system. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|------------------------|------|----------|-------------| +| DISABLE_ACCOUNT | Any | True | ... | +| PASSWORD_RESET | Any | True | ... | +| TERMINATE_ALL_SESSIONS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > ActionName \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Address.md b/release/fraudPreventionV2/docs/Address.md new file mode 100644 index 00000000..12edfc07 --- /dev/null +++ b/release/fraudPreventionV2/docs/Address.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Address](Address.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Address` +``` +Address( + address_type: Optional[AddressType], + address_line1: Optional[constr(max_length=200)], + address_line2: Optional[constr(max_length=200)], + city: Optional[constr(max_length=200)], + state: Optional[constr(regex=r"^[A-Z]{2}$")], + zip_code: Optional[constr(max_length=20)], + country_code: Optional[constr(regex=r"^[A-Z]{3}$")], +) +``` + +pydantic model Address + + + +## Attributes + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------|-----------------------------------------|----------|-----------------------------------------------------------------------| +| address_line1 | Optional[constr(max_length=200)] | False | Address line 1 of the address provided. | +| address_line2 | Optional[constr(max_length=200)] | False | Address line 2 of the address provided. | +| address_type | Optional[[AddressType](AddressType.md)] | False | ... | +| city | Optional[constr(max_length=200)] | False | City of the address provided. | +| country_code | Optional[constr(regex=r"^[A-Z]{3}$")] | False | ISO alpha-3 country code of the address provided. | +| state | Optional[constr(regex=r"^[A-Z]{2}$")] | False | The two-characters ISO code for the state or province of the address. | +| zip_code | Optional[constr(max_length=20)] | False | Zip code of the address provided. | + + + + + + + + + + +# Inheritance +object > BaseModel > Address \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AddressType.md b/release/fraudPreventionV2/docs/AddressType.md new file mode 100644 index 00000000..58ccaec4 --- /dev/null +++ b/release/fraudPreventionV2/docs/AddressType.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AddressType](AddressType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AddressType` +``` +AddressType( +) +``` + +pydantic model AddressType + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|------|------|----------|-------------| +| HOME | Any | True | ... | +| WORK | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AddressType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Air.md b/release/fraudPreventionV2/docs/Air.md new file mode 100644 index 00000000..85382495 --- /dev/null +++ b/release/fraudPreventionV2/docs/Air.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Air](Air.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Air` +``` +Air( + departure_time: datetime, + arrival_time: datetime, + air_segments: list[AirSegment], + flight_type: Optional[FlightType], + passenger_name_record: Optional[constr(max_length=100)], + global_distribution_system_type: Optional[constr(max_length=100)], + type: Literal["AIR"], +) +``` + +pydantic model Air + + + +## Attributes + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------------------|---------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------| +| air_segments | list[[AirSegment](AirSegment.md)] | True | Additional airline and flight details for each of the trip segments. | +| arrival_time | datetime | True | Local date and time of arrival to final destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| departure_time | datetime | True | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| flight_type | Optional[[FlightType](FlightType.md)] | False | Identifies the type of air trip based on the air destinations. | +| global_distribution_system_type | Optional[constr(max_length=100)] | False | Associated with Passenger Name Record (PNR). | +| passenger_name_record | Optional[constr(max_length=100)] | False | Airline booking confirmation code for the trip. | +| type | Literal["AIR"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Air \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AirSegment.md b/release/fraudPreventionV2/docs/AirSegment.md new file mode 100644 index 00000000..288f235f --- /dev/null +++ b/release/fraudPreventionV2/docs/AirSegment.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AirSegment](AirSegment.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AirSegment` +``` +AirSegment( + airline_code: constr(max_length=10), + departure_airport_code: constr(max_length=10), + arrival_airport_code: constr(max_length=10), + departure_time: Optional[datetime], + arrival_time: Optional[datetime], +) +``` + +pydantic model AirSegment + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------------|-----------------------|----------|------------------------------------------------------------------------------------------------------------------------| +| airline_code | constr(max_length=10) | True | Airline code of the trip segment | +| arrival_airport_code | constr(max_length=10) | True | Arrival airport of the trip segment | +| arrival_time | Optional[datetime] | False | Local date and time of arrival to destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| departure_airport_code | constr(max_length=10) | True | Departure airport of the trip segment | +| departure_time | Optional[datetime] | False | Local date and time of departure from departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | + + + + + + + + + + +# Inheritance +object > BaseModel > AirSegment \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Amount.md b/release/fraudPreventionV2/docs/Amount.md new file mode 100644 index 00000000..f27e3b15 --- /dev/null +++ b/release/fraudPreventionV2/docs/Amount.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Amount](Amount.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Amount` +``` +Amount( + value: float, + currency_code: constr(regex=r"^[A-Z]{3}$", max_length=3), +) +``` + +pydantic model Amount + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------| +| currency_code | constr(regex=r"^[A-Z]{3}$", max_length=3) | True | The ISO alpha-3 country code for the amount currency. | +| value | float | True | The amount required in payment for the product/order in local currency (including any taxes and fees). | + + + + + + + + + + +# Inheritance +object > BaseModel > Amount \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AuthenticationSubType.md b/release/fraudPreventionV2/docs/AuthenticationSubType.md new file mode 100644 index 00000000..a62acc72 --- /dev/null +++ b/release/fraudPreventionV2/docs/AuthenticationSubType.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AuthenticationSubType](AuthenticationSubType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AuthenticationSubType` +``` +AuthenticationSubType( +) +``` + +pydantic model AuthenticationSubType: The sub type of login authentication method used by a user. +For `authentication_sub_type` ensure attributes mentioned in dictionary below are set to corresponding values only. +`authentication_sub_type` is an enum value with the following mapping with `authentication_type` attribute: +* authentication_sub_type : authentication_type +* ------------------------------------------------------------------------------- +* `EMAIL` : `CREDENTIALS` +* `EMAIL` : `PASSWORD_RESET` +* `EMAIL` : `SINGLE_SIGN_ON` +* `EMAIL` : `MULTI_FACTOR_AUTHENTICATION` +* `PHONE` : `MULTI_FACTOR_AUTHENTICATION` +* `GOOGLE` : `SOCIAL` +* `FACEBOOK` : `SOCIAL` +* `APPLE` : `SOCIAL` +* : `CREDENTIALS` + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| APPLE | Any | True | ... | +| EMAIL | Any | True | ... | +| FACEBOOK | Any | True | ... | +| GOOGLE | Any | True | ... | +| PHONE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AuthenticationSubType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AuthenticationType.md b/release/fraudPreventionV2/docs/AuthenticationType.md new file mode 100644 index 00000000..3f9c68ae --- /dev/null +++ b/release/fraudPreventionV2/docs/AuthenticationType.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AuthenticationType](AuthenticationType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AuthenticationType` +``` +AuthenticationType( +) +``` + +pydantic model AuthenticationType: The type of login authentication method used by a user. +For `authentication_type` ensure attributes mentioned in dictionary below are set to corresponding values only. +`authentication_type` is an enum value with the following mapping with `authentication_sub_type` attribute: +* authentication_type : authentication_sub_type +* ------------------------------------------------------------------------------- +* `CREDENTIALS` : `EMAIL` +* `CREDENTIALS` : +* `PASSWORD_RESET` : `EMAIL` +* `SINGLE_SIGN_ON` : `EMAIL` +* `MULTI_FACTOR_AUTHENTICATION` : `EMAIL` +* `MULTI_FACTOR_AUTHENTICATION` : `PHONE` +* `SOCIAL` : `GOOGLE` +* `SOCIAL` : `FACEBOOK` +* `SOCIAL` : `APPLE` + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------------|------|----------|-------------| +| CREDENTIALS | Any | True | ... | +| MULTI_FACTOR_AUTHENTICATION | Any | True | ... | +| PASSWORD_RESET | Any | True | ... | +| SINGLE_SIGN_ON | Any | True | ... | +| SOCIAL | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > AuthenticationType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Authorize.md b/release/fraudPreventionV2/docs/Authorize.md new file mode 100644 index 00000000..76c7b7c5 --- /dev/null +++ b/release/fraudPreventionV2/docs/Authorize.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Authorize](Authorize.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Authorize` +``` +Authorize( +) +``` + +pydantic model Authorize: Authorize operation on the payment. An authorize operation represents placing the funds on hold with the specified form of payment. + + + + + + + + + + +# Inheritance +object > [PaymentOperation](PaymentOperation.md) > Authorize \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/AuthorizeReversal.md b/release/fraudPreventionV2/docs/AuthorizeReversal.md new file mode 100644 index 00000000..0067ac32 --- /dev/null +++ b/release/fraudPreventionV2/docs/AuthorizeReversal.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [AuthorizeReversal](AuthorizeReversal.md) +# class `expediagroup.sdk.fraudpreventionv2.model.AuthorizeReversal` +``` +AuthorizeReversal( +) +``` + +pydantic model AuthorizeReversal: Authorize Reversal operation on the payment. An authorize reversal operation represents a notification received usually from a 3rd party payment processor to indicate that an authorization hold should be released as a result of a sale being partially or completely cancelled. + + + + + + + + + + +# Inheritance +object > [PaymentOperation](PaymentOperation.md) > AuthorizeReversal \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/BadGatewayError.md b/release/fraudPreventionV2/docs/BadGatewayError.md new file mode 100644 index 00000000..ac913ea8 --- /dev/null +++ b/release/fraudPreventionV2/docs/BadGatewayError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [BadGatewayError](BadGatewayError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.BadGatewayError` +``` +BadGatewayError( +) +``` + +pydantic model BadGatewayError: Indicates that the server received an invalid response from the upstream server. Causes could be incorrectly configured target server at gateway, EOF exception, incorrectly configured keep-alive timeouts. Please reach out to support team as next step for this error resolution. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > BadGatewayError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/BadGatewayErrorDeserializationContract.md b/release/fraudPreventionV2/docs/BadGatewayErrorDeserializationContract.md new file mode 100644 index 00000000..c95a0d26 --- /dev/null +++ b/release/fraudPreventionV2/docs/BadGatewayErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [BadGatewayErrorDeserializationContract](BadGatewayErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.BadGatewayErrorDeserializationContract` +``` +BadGatewayErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > BadGatewayErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/BadRequestError.md b/release/fraudPreventionV2/docs/BadRequestError.md new file mode 100644 index 00000000..5966d752 --- /dev/null +++ b/release/fraudPreventionV2/docs/BadRequestError.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [BadRequestError](BadRequestError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.BadRequestError` +``` +BadRequestError( + causes: Optional[list[Cause]], +) +``` + +pydantic model BadRequestError: Indicates that a bad request occurred. Typically it is an invalid parameter. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|--------|-----------------------------------|----------|-------------| +| causes | Optional[list[[Cause](Cause.md)]] | False | ... | + + + + + + + + + + +# Inheritance +object > [Error](Error.md) > BadRequestError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/BadRequestErrorDeserializationContract.md b/release/fraudPreventionV2/docs/BadRequestErrorDeserializationContract.md new file mode 100644 index 00000000..32e59890 --- /dev/null +++ b/release/fraudPreventionV2/docs/BadRequestErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [BadRequestErrorDeserializationContract](BadRequestErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.BadRequestErrorDeserializationContract` +``` +BadRequestErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > BadRequestErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Brand.md b/release/fraudPreventionV2/docs/Brand.md new file mode 100644 index 00000000..1bad14e7 --- /dev/null +++ b/release/fraudPreventionV2/docs/Brand.md @@ -0,0 +1,235 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Brand](Brand.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Brand` +``` +Brand( +) +``` + +pydantic model Brand: The `brand` field value is the payment brand used for payment on this transaction. +For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only. +Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API. +Incorrect `brand` - `card_type` combination will result in data quality issues and result in degraded risk recommendation. +'brand' is an enum value with the following mapping with CreditCard 'card_type' attribute: +* brand : card_type +* ------------------------------------------------------- +* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS` +* `DINERS_CLUB_INTERNATIONAL` : `DINERS_CLUB` +* `BC_CARD` : `DINERS_CLUB` +* `DISCOVER` : `DISCOVER` +* `BC_CARD` : `DISCOVER` +* `DINERS_CLUB_INTERNATIONAL` : `DISCOVER` +* `JCB` : `DISCOVER` +* `JCB` : `JCB` +* `MASTER_CARD` : `MASTER_CARD` +* `MAESTRO` : `MASTER_CARD` +* `POSTEPAY_MASTERCARD` : `MASTER_CARD` +* `SOLO` : `SOLO` +* `SWITCH` : `SWITCH` +* `MAESTRO` : `MAESTRO` +* `CHINA_UNION_PAY` : `CHINA_UNION_PAY` +* `VISA` : `VISA` +* `VISA_DELTA` : `VISA` +* `VISA_ELECTRON` : `VISA` +* `CARTA_SI` : `VISA` +* `CARTE_BLEUE` : `VISA` +* `VISA_DANKORT` : `VISA` +* `POSTEPAY_VISA_ELECTRON` : `VISA` +* `PAYPAL` : + +'brand' with 'Points' payment_type is an enum value with following: +* `EXPEDIA_REWARDS` +* `AMEX_POINTS` +* `BANK_OF_AMERICA_REWARDS` +* `DISCOVER_POINTS` +* `MASTER_CARD_POINTS` +* `CITI_THANK_YOU_POINTS` +* `MERRILL_LYNCH_REWARDS` +* `WELLS_FARGO_POINTS` +* `DELTA_SKY_MILES` +* `UNITED_POINTS` +* `DISCOVER_MILES` +* `ALASKA_MILES` +* `RBC_REWARDS` +* `BILT_REWARDS` +* `ORBUCKS` +* `CHEAP_CASH` +* `BONUS_PLUS` +* `ULTIMATE_REWARDS` + +'brand' with 'GiftCard' payment_type is an enum value with following: +* `GIFT_CARD` + +'brand' with 'InternetBankPayment' payment_type is an enum value with following: +* `IBP` +* `LOCAL_DEBIT_CARD` +* `SOFORT` +* `YANDEX` +* `WEB_MONEY` +* `QIWI` +* `BITCOIN` + +'brand' with 'DirectDebit' payment_type is an enum value with following: +* `ELV` +* `INTER_COMPANY` + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------------|------|----------|-------------| +| ALASKA_MILES | Any | True | ... | +| AMERICAN_EXPRESS | Any | True | ... | +| AMEX_POINTS | Any | True | ... | +| BANK_OF_AMERICA_REWARDS | Any | True | ... | +| BC_CARD | Any | True | ... | +| BILT_REWARDS | Any | True | ... | +| BITCOIN | Any | True | ... | +| BONUS_PLUS | Any | True | ... | +| CARTA_SI | Any | True | ... | +| CARTE_BLEUE | Any | True | ... | +| CHEAP_CASH | Any | True | ... | +| CHINA_UNION_PAY | Any | True | ... | +| CITI_THANK_YOU_POINTS | Any | True | ... | +| DELTA_SKY_MILES | Any | True | ... | +| DINERS_CLUB_INTERNATIONAL | Any | True | ... | +| DISCOVER | Any | True | ... | +| DISCOVER_MILES | Any | True | ... | +| DISCOVER_POINTS | Any | True | ... | +| ELV | Any | True | ... | +| EXPEDIA_REWARDS | Any | True | ... | +| GIFT_CARD | Any | True | ... | +| IBP | Any | True | ... | +| INTER_COMPANY | Any | True | ... | +| JCB | Any | True | ... | +| LOCAL_DEBIT_CARD | Any | True | ... | +| MAESTRO | Any | True | ... | +| MASTER_CARD | Any | True | ... | +| MASTER_CARD_POINTS | Any | True | ... | +| MERRILL_LYNCH_REWARDS | Any | True | ... | +| ORBUCKS | Any | True | ... | +| PAYPAL | Any | True | ... | +| POSTEPAY_MASTERCARD | Any | True | ... | +| POSTEPAY_VISA_ELECTRON | Any | True | ... | +| QIWI | Any | True | ... | +| RBC_REWARDS | Any | True | ... | +| SOFORT | Any | True | ... | +| SOLO | Any | True | ... | +| SWITCH | Any | True | ... | +| ULTIMATE_REWARDS | Any | True | ... | +| UNITED_POINTS | Any | True | ... | +| VISA | Any | True | ... | +| VISA_DANKORT | Any | True | ... | +| VISA_DELTA | Any | True | ... | +| VISA_ELECTRON | Any | True | ... | +| WEB_MONEY | Any | True | ... | +| WELLS_FARGO_POINTS | Any | True | ... | +| YANDEX | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Brand \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CancellationReason.md b/release/fraudPreventionV2/docs/CancellationReason.md new file mode 100644 index 00000000..46d2cfff --- /dev/null +++ b/release/fraudPreventionV2/docs/CancellationReason.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CancellationReason](CancellationReason.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CancellationReason` +``` +CancellationReason( + primary_reason_code: Optional[constr(max_length=200)], + sub_reason_code: Optional[constr(max_length=200)], + primary_reason_description: Optional[constr(max_length=200)], + sub_reason_description: Optional[constr(max_length=200)], +) +``` + +pydantic model CancellationReason: Reason of order update cancellation. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------------------|----------------------------------|----------|---------------------------------------------------------------------------| +| primary_reason_code | Optional[constr(max_length=200)] | False | Primary cancellation reason code. | +| primary_reason_description | Optional[constr(max_length=200)] | False | Primary cancellation reason code. Required if `order_status = CANCELLED`. | +| sub_reason_code | Optional[constr(max_length=200)] | False | Substitute cancellation reason code. | +| sub_reason_description | Optional[constr(max_length=200)] | False | Substitute cancellation reason description. | + + + + + + + + + + +# Inheritance +object > BaseModel > CancellationReason \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Capture.md b/release/fraudPreventionV2/docs/Capture.md new file mode 100644 index 00000000..4d4263f3 --- /dev/null +++ b/release/fraudPreventionV2/docs/Capture.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Capture](Capture.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Capture` +``` +Capture( +) +``` + +pydantic model Capture: Capture operation on the payment. A capture operation represents a notification received usually from a 3rd party payment processor to indicate that the funds placed on hold will be captured and the funds transfer process will occur from the customer's funds to the merchant's funds. + + + + + + + + + + +# Inheritance +object > [PaymentOperation](PaymentOperation.md) > Capture \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Car.md b/release/fraudPreventionV2/docs/Car.md new file mode 100644 index 00000000..64556d07 --- /dev/null +++ b/release/fraudPreventionV2/docs/Car.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Car](Car.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Car` +``` +Car( + pick_up_location: constr(max_length=200), + drop_off_location: constr(max_length=200), + pickup_time: datetime, + return_time: datetime, + type: Literal["CAR"], +) +``` + +pydantic model Car + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------------|------------------------|----------|--------------------------------------------------------------------------------------------------------------------| +| drop_off_location | constr(max_length=200) | True | Location at which the automobile will be returned. | +| pick_up_location | constr(max_length=200) | True | Location where the automobile will be picked up. | +| pickup_time | datetime | True | Local date and time the automobile will be picked-up, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| return_time | datetime | True | Local date and time the automobile will be returned, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| type | Literal["CAR"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Car \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CardType.md b/release/fraudPreventionV2/docs/CardType.md new file mode 100644 index 00000000..80639097 --- /dev/null +++ b/release/fraudPreventionV2/docs/CardType.md @@ -0,0 +1,87 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CardType](CardType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CardType` +``` +CardType( +) +``` + +pydantic model CardType: The 'card_type' field value is an enum value which is associated with the payment method of the specific payment instrument. +For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only. +Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API. +Incorrect `card_type` - `brand` combination will result in data quality issues and result in degraded risk recommendation. +'card_type' is an enum value with the following mapping with Payment `brand` attribute: +* card_type : brand +* -------------------------------------------------------- +* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS` +* `DINERS_CLUB` : `DINERS_CLUB_INTERNATIONAL` +* `DINERS_CLUB` : `BC_CARD` +* `DISCOVER` : `DISCOVER` +* `DISCOVER` : `BC_CARD` +* `DISCOVER` : `DINERS_CLUB_INTERNATIONAL` +* `DISCOVER` : `JCB` +* `JCB` : `JCB` +* `MASTER_CARD` : `MASTER_CARD` +* `MASTER_CARD` : `MAESTRO` +* `MASTER_CARD` : `POSTEPAY_MASTERCARD` +* `SOLO` : `SOLO` +* `SWITCH` : `SWITCH` +* `MAESTRO` : `MAESTRO` +* `CHINA_UNION_PAY` : `CHINA_UNION_PAY` +* `VISA` : `VISA` +* `VISA` : `VISA_DELTA` +* `VISA` : `VISA_ELECTRON` +* `VISA` : `CARTA_SI` +* `VISA` : `CARTE_BLEUE` +* `VISA` : `VISA_DANKORT` +* `VISA` : `POSTEPAY_VISA_ELECTRON` + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------|------|----------|-------------| +| AMERICAN_EXPRESS | Any | True | ... | +| CHINA_UNION_PAY | Any | True | ... | +| DINERS_CLUB | Any | True | ... | +| DISCOVER | Any | True | ... | +| JCB | Any | True | ... | +| MAESTRO | Any | True | ... | +| MASTER_CARD | Any | True | ... | +| SOLO | Any | True | ... | +| SWITCH | Any | True | ... | +| VISA | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > CardType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Cause.md b/release/fraudPreventionV2/docs/Cause.md new file mode 100644 index 00000000..2518d891 --- /dev/null +++ b/release/fraudPreventionV2/docs/Cause.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Cause](Cause.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Cause` +``` +Cause( + code: Optional[Code1], + field: Optional[str], + message: Optional[str], +) +``` + +pydantic model Cause + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------|-----------------------------|----------|---------------------------------------------------------------------------------------| +| code | Optional[[Code1](Code1.md)] | False | ... | +| field | Optional[str] | False | A JSON Path expression indicating which field, in the request body, caused the error. | +| message | Optional[str] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > Cause \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Cause1.md b/release/fraudPreventionV2/docs/Cause1.md new file mode 100644 index 00000000..1c344b33 --- /dev/null +++ b/release/fraudPreventionV2/docs/Cause1.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Cause1](Cause1.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Cause1` +``` +Cause1( + code: Optional[Code3], + field: Optional[str], + message: Optional[str], +) +``` + +pydantic model Cause1 + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------|-----------------------------|----------|---------------------------------------------------------------------------------------| +| code | Optional[[Code3](Code3.md)] | False | ... | +| field | Optional[str] | False | A JSON Path expression indicating which field, in the request body, caused the error. | +| message | Optional[str] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > Cause1 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ChallengeDetail.md b/release/fraudPreventionV2/docs/ChallengeDetail.md new file mode 100644 index 00000000..a705544a --- /dev/null +++ b/release/fraudPreventionV2/docs/ChallengeDetail.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ChallengeDetail](ChallengeDetail.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ChallengeDetail` +``` +ChallengeDetail( + displayed_flag: bool, + type: Type4, + status: Status3, +) +``` + +pydantic model ChallengeDetail: Information related to challenges initiated by the Partner's system to a user before calling Expedia's Fraud Prevention Service. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|----------------|-----------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| displayed_flag | bool | True | Indicates that there was a challenge initiated by the Partner's system to a user before calling Expedia's Fraud Prevention Service. | +| status | [Status3](Status3.md) | True | The status of the challenge served by the Partner''s system to a user before calling Expedia''s Fraud Prevention Service.
- `SUCCESS` - Applicable if the user successfully passed the challenge.
- `FAILED` - Applicable if the user failed the challenge. | +| type | [Type4](Type4.md) | True | The kind of challenge served by the Partner''s system to a user prior to calling Expedia''s Fraud Prevention Service.
- `CAPTCHA` - Applicable if the challenge served by the Partner''s system was a Captcha challenge.
- `TWO_FACTOR` - Applicable if the challenge served by the Partner''s system was a two-factor challenge including (Email verification, One Time Password, Okta, etc). | + + + + + + + + + + +# Inheritance +object > BaseModel > ChallengeDetail \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ChargebackDetail.md b/release/fraudPreventionV2/docs/ChargebackDetail.md new file mode 100644 index 00000000..96ee3344 --- /dev/null +++ b/release/fraudPreventionV2/docs/ChargebackDetail.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ChargebackDetail](ChargebackDetail.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ChargebackDetail` +``` +ChargebackDetail( + chargeback_status: ChargebackStatus, + chargeback_reason: ChargebackReason, + chargeback_amount: Amount, + bank_reason_code: Optional[constr(max_length=200)], + chargeback_reported_date_time: Optional[datetime], +) +``` + +pydantic model ChargebackDetail: Details related to the chargeback. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------------------------|-----------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bank_reason_code | Optional[constr(max_length=200)] | False | Unique code provided by the acquiring bank for the category of fraud. | +| chargeback_amount | [Amount](Amount.md) | True | ... | +| chargeback_reason | [ChargebackReason](ChargebackReason.md) | True | Reason for chargeback which can be `Fraud` or `Non Fraud`. | +| chargeback_reported_date_time | Optional[datetime] | False | Date and time when the chargeback was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| chargeback_status | [ChargebackStatus](ChargebackStatus.md) | True | Identifies the chargeback status. Possible values are:
-`RECEIVED` - The chargeback was received.
-`REVERSAL` - The chargeback reversal was received. | + + + + + + + + + + +# Inheritance +object > BaseModel > ChargebackDetail \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ChargebackFeedback.md b/release/fraudPreventionV2/docs/ChargebackFeedback.md new file mode 100644 index 00000000..32742076 --- /dev/null +++ b/release/fraudPreventionV2/docs/ChargebackFeedback.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ChargebackFeedback](ChargebackFeedback.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ChargebackFeedback` +``` +ChargebackFeedback( + chargeback_detail: Optional[ChargebackDetail], + type: Literal["CHARGEBACK_FEEDBACK"], +) +``` + +pydantic model ChargebackFeedback: Feedback from EG external partners if they receive a chargeback for a false negative recommendation from Fraud Prevention system. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-------------------|---------------------------------------------------|----------|-------------| +| chargeback_detail | Optional[[ChargebackDetail](ChargebackDetail.md)] | False | ... | +| type | Literal["CHARGEBACK_FEEDBACK"] | True | ... | + + + + + + + + + + +# Inheritance +object > [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) > ChargebackFeedback \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ChargebackReason.md b/release/fraudPreventionV2/docs/ChargebackReason.md new file mode 100644 index 00000000..29acf7ec --- /dev/null +++ b/release/fraudPreventionV2/docs/ChargebackReason.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ChargebackReason](ChargebackReason.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ChargebackReason` +``` +ChargebackReason( +) +``` + +pydantic model ChargebackReason: Reason for chargeback which can be `Fraud` or `Non Fraud`. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| FRAUD | Any | True | ... | +| NON_FRAUD | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > ChargebackReason \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ChargebackStatus.md b/release/fraudPreventionV2/docs/ChargebackStatus.md new file mode 100644 index 00000000..8b14c678 --- /dev/null +++ b/release/fraudPreventionV2/docs/ChargebackStatus.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ChargebackStatus](ChargebackStatus.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ChargebackStatus` +``` +ChargebackStatus( +) +``` + +pydantic model ChargebackStatus: Identifies the chargeback status. Possible values are: +-`RECEIVED` - The chargeback was received. +-`REVERSAL` - The chargeback reversal was received. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| RECEIVED | Any | True | ... | +| REVERSAL | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > ChargebackStatus \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Code.md b/release/fraudPreventionV2/docs/Code.md new file mode 100644 index 00000000..52d328f2 --- /dev/null +++ b/release/fraudPreventionV2/docs/Code.md @@ -0,0 +1,62 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Code](Code.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Code` +``` +Code( +) +``` + +pydantic model Code: Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------------------------|------|----------|-------------| +| BAD_GATEWAY | Any | True | ... | +| BAD_REQUEST | Any | True | ... | +| FORBIDDEN | Any | True | ... | +| GATEWAY_TIMEOUT | Any | True | ... | +| INTERNAL_SERVER_ERROR | Any | True | ... | +| NOT_FOUND | Any | True | ... | +| ORDER_PURCHASE_UPDATE_NOT_FOUND | Any | True | ... | +| RETRYABLE_ORDER_PURCHASE_SCREEN_FAILURE | Any | True | ... | +| RETRYABLE_ORDER_PURCHASE_UPDATE_FAILURE | Any | True | ... | +| TOO_MANY_REQUESTS | Any | True | ... | +| UNAUTHORIZED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Code \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Code1.md b/release/fraudPreventionV2/docs/Code1.md new file mode 100644 index 00000000..b46c1cd9 --- /dev/null +++ b/release/fraudPreventionV2/docs/Code1.md @@ -0,0 +1,38 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Code1](Code1.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Code1` +``` +Code1( +) +``` + +pydantic model Code1 + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|-------------------------|------|----------|-------------| +| INVALID_FORMAT | Any | True | ... | +| INVALID_PARAM | Any | True | ... | +| MISSING_MANDATORY_PARAM | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Code1 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Code2.md b/release/fraudPreventionV2/docs/Code2.md new file mode 100644 index 00000000..c937c2b3 --- /dev/null +++ b/release/fraudPreventionV2/docs/Code2.md @@ -0,0 +1,62 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Code2](Code2.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Code2` +``` +Code2( +) +``` + +pydantic model Code2: Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------------------------|------|----------|-------------| +| ACCOUNT_UPDATE_NOT_FOUND | Any | True | ... | +| BAD_GATEWAY | Any | True | ... | +| BAD_REQUEST | Any | True | ... | +| FORBIDDEN | Any | True | ... | +| GATEWAY_TIMEOUT | Any | True | ... | +| INTERNAL_SERVER_ERROR | Any | True | ... | +| NOT_FOUND | Any | True | ... | +| RETRYABLE_ACCOUNT_SCREEN_FAILURE | Any | True | ... | +| RETRYABLE_ACCOUNT_UPDATE_FAILURE | Any | True | ... | +| TOO_MANY_REQUESTS | Any | True | ... | +| UNAUTHORIZED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Code2 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Code3.md b/release/fraudPreventionV2/docs/Code3.md new file mode 100644 index 00000000..8c6f7f8a --- /dev/null +++ b/release/fraudPreventionV2/docs/Code3.md @@ -0,0 +1,38 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Code3](Code3.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Code3` +``` +Code3( +) +``` + +pydantic model Code3 + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|-------------------------|------|----------|-------------| +| INVALID_FORMAT | Any | True | ... | +| INVALID_PARAM | Any | True | ... | +| MISSING_MANDATORY_PARAM | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Code3 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CreditCard.md b/release/fraudPreventionV2/docs/CreditCard.md new file mode 100644 index 00000000..27d445e8 --- /dev/null +++ b/release/fraudPreventionV2/docs/CreditCard.md @@ -0,0 +1,77 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CreditCard](CreditCard.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CreditCard` +``` +CreditCard( + card_type: CardType, + card_number: constr(max_length=200), + expiry_date: datetime, + electronic_commerce_indicator: Optional[constr(max_length=200)], + virtual_credit_card_flag: Optional[bool], + wallet_type: Optional[constr(max_length=200)], + card_avs_response: Optional[constr(max_length=50)], + card_cvv_response: Optional[constr(max_length=20)], + telephones: list[Telephone], + merchant_order_code: Optional[constr(max_length=200)], + card_authentication_failure_count: Optional[int], + method: Literal["CREDIT_CARD"], +) +``` + +pydantic model CreditCard + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------------------|----------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| card_authentication_failure_count | Optional[int] | False | Total authentication failure count for given card. | +| card_avs_response | Optional[constr(max_length=50)] | False | A field used to confirm if the address provided at the time of purchase matches what the bank has on file for the Credit Card. | +| card_cvv_response | Optional[constr(max_length=20)] | False | A field used to confirm the Card Verification Value on the Credit Card matches the Credit Card used at the time of purchase. | +| card_number | constr(max_length=200) | True | All the digits (unencrypted) of the credit card number associated with the payment. | +| card_type | [CardType](CardType.md) | True | The 'card_type' field value is an enum value which is associated with the payment method of the specific payment instrument.
For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only.
Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API.
Incorrect `card_type` - `brand` combination will result in data quality issues and result in degraded risk recommendation.
'card_type' is an enum value with the following mapping with Payment `brand` attribute:
* card_type : brand
* --------------------------------------------------------
* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS`
* `DINERS_CLUB` : `DINERS_CLUB_INTERNATIONAL`
* `DINERS_CLUB` : `BC_CARD`
* `DISCOVER` : `DISCOVER`
* `DISCOVER` : `BC_CARD`
* `DISCOVER` : `DINERS_CLUB_INTERNATIONAL`
* `DISCOVER` : `JCB`
* `JCB` : `JCB`
* `MASTER_CARD` : `MASTER_CARD`
* `MASTER_CARD` : `MAESTRO`
* `MASTER_CARD` : `POSTEPAY_MASTERCARD`
* `SOLO` : `SOLO`
* `SWITCH` : `SWITCH`
* `MAESTRO` : `MAESTRO`
* `CHINA_UNION_PAY` : `CHINA_UNION_PAY`
* `VISA` : `VISA`
* `VISA` : `VISA_DELTA`
* `VISA` : `VISA_ELECTRON`
* `VISA` : `CARTA_SI`
* `VISA` : `CARTE_BLEUE`
* `VISA` : `VISA_DANKORT`
* `VISA` : `POSTEPAY_VISA_ELECTRON` | +| electronic_commerce_indicator | Optional[constr(max_length=200)] | False | Electronic Commerce Indicator, a two or three digit number usually returned by a 3rd party payment processor in regards to the authentication used when gathering the cardholder's payment credentials. | +| expiry_date | datetime | True | Expiration date of the credit card used for payment, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| merchant_order_code | Optional[constr(max_length=200)] | False | Reference code passed to acquiring bank at the time of payment. This code is the key ID that ties back to payments data at the payment level. | +| method | Literal["CREDIT_CARD"] | True | ... | +| telephones | list[[Telephone](Telephone.md)] | True | Telephone(s) associated with card holder and credit card. | +| virtual_credit_card_flag | Optional[bool] | False | A flag to indicate that the bank card being used for the charge is a virtual credit card. | +| wallet_type | Optional[constr(max_length=200)] | False | If a virtual/digital form of payment was used, the type of digital wallet should be specified here. Possible `wallet_type`'s include: `Google` or `ApplePay`. | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > CreditCard \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Cruise.md b/release/fraudPreventionV2/docs/Cruise.md new file mode 100644 index 00000000..fa77f975 --- /dev/null +++ b/release/fraudPreventionV2/docs/Cruise.md @@ -0,0 +1,53 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Cruise](Cruise.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Cruise` +``` +Cruise( + departure_time: datetime, + arrival_time: datetime, + embarkation_port: constr(max_length=200), + disembarkation_port: constr(max_length=200), + ship_name: constr(max_length=200), + type: Literal["CRUISE"], +) +``` + +pydantic model Cruise + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------| +| arrival_time | datetime | True | Local date and time of arrival from original arrival location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| departure_time | datetime | True | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| disembarkation_port | constr(max_length=200) | True | The cruise's final destination. | +| embarkation_port | constr(max_length=200) | True | Location from where cruise will depart. | +| ship_name | constr(max_length=200) | True | Name of the cruise ship. | +| type | Literal["CRUISE"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Cruise \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CurrentOrderStatus.md b/release/fraudPreventionV2/docs/CurrentOrderStatus.md new file mode 100644 index 00000000..ac6086f9 --- /dev/null +++ b/release/fraudPreventionV2/docs/CurrentOrderStatus.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CurrentOrderStatus](CurrentOrderStatus.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CurrentOrderStatus` +``` +CurrentOrderStatus( +) +``` + +pydantic model CurrentOrderStatus: Status of the order: +* `IN_PROGRESS` is used when order has not processed fully. For example, inventory has not yet been reserved, or payment has not yet been settled. +* `COMPLETED` is used when an order has been processed fully. For example, inventory has been reserved, and the payment has been settled. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-------------|------|----------|-------------| +| COMPLETED | Any | True | ... | +| IN_PROGRESS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > CurrentOrderStatus \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CurrentUserSession.md b/release/fraudPreventionV2/docs/CurrentUserSession.md new file mode 100644 index 00000000..ffe4806e --- /dev/null +++ b/release/fraudPreventionV2/docs/CurrentUserSession.md @@ -0,0 +1,42 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CurrentUserSession](CurrentUserSession.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CurrentUserSession` +``` +CurrentUserSession( + session_id: Optional[constr(max_length=200)], + start_date_time: Optional[datetime], + challenge_detail: Optional[ChallengeDetail], +) +``` + +pydantic model CurrentUserSession: The current user session prior to this transaction, which contains details related to any challenge initiated by the Partner''s system to a user before calling Expedia''s Fraud Prevention Service. +An example is if the Partner''s system sent a Captcha challenge to the user before calling Expedia''s Fraud Prevention Service. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|------------------|-------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------| +| challenge_detail | Optional[[ChallengeDetail](ChallengeDetail.md)] | False | ... | +| session_id | Optional[constr(max_length=200)] | False | Unique identifier for a user's session on their device | +| start_date_time | Optional[datetime] | False | The local date and time a user's session started, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | + + + + + + + + + + +# Inheritance +object > BaseModel > CurrentUserSession \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/CustomerAccount.md b/release/fraudPreventionV2/docs/CustomerAccount.md new file mode 100644 index 00000000..a22da6fe --- /dev/null +++ b/release/fraudPreventionV2/docs/CustomerAccount.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [CustomerAccount](CustomerAccount.md) +# class `expediagroup.sdk.fraudpreventionv2.model.CustomerAccount` +``` +CustomerAccount( + user_id: Optional[str], + account_type: AccountType, + name: Name, + email_address: EmailStr, + telephones: Optional[list[Telephone]], + address: Optional[Address], + registered_time: Optional[datetime], +) +``` + +pydantic model CustomerAccount + + + +## Attributes + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_type | [AccountType](AccountType.md) | True | Identifies if the customer account is known to the client. Possible values are:

-`GUEST` - Applicable if the partner maintains record to distinguish whether the transaction was booked via a guest account.

-`STANDARD` - Default account type. | +| address | Optional[[Address](Address.md)] | False | ... | +| email_address | EmailStr | True | Email address for the account owner. | +| name | [Name](Name.md) | True | ... | +| registered_time | Optional[datetime] | False | The local date and time that the customer first registered on the client site, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| telephones | Optional[list[[Telephone](Telephone.md)]] | False | ... | +| user_id | Optional[str] | False | Unique account identifier provided by the partner's Identity Provider/System assigned to the account owner by the partner. `user_id` is specific to the partner namespace. Used to track repeat purchases by the same user. | + + + + + + + + + + +# Inheritance +object > BaseModel > CustomerAccount \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/DeliveryMethod.md b/release/fraudPreventionV2/docs/DeliveryMethod.md new file mode 100644 index 00000000..8f9cb389 --- /dev/null +++ b/release/fraudPreventionV2/docs/DeliveryMethod.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [DeliveryMethod](DeliveryMethod.md) +# class `expediagroup.sdk.fraudpreventionv2.model.DeliveryMethod` +``` +DeliveryMethod( +) +``` + +pydantic model DeliveryMethod: The delivery method of the Multi-Factor Authentication to a user. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|-------|------|----------|-------------| +| EMAIL | Any | True | ... | +| PUSH | Any | True | ... | +| SMS | Any | True | ... | +| VOICE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > DeliveryMethod \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/DeviceDetails.md b/release/fraudPreventionV2/docs/DeviceDetails.md new file mode 100644 index 00000000..f98de1ed --- /dev/null +++ b/release/fraudPreventionV2/docs/DeviceDetails.md @@ -0,0 +1,43 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [DeviceDetails](DeviceDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.DeviceDetails` +``` +DeviceDetails( + source: Optional[constr(max_length=50)], + device_box: Optional[constr(max_length=16000)], + ip_address: constr( + regex=r"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" + ), +) +``` + +pydantic model DeviceDetails + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------| +| device_box | Optional[constr(max_length=16000)] | False | Device related information retrieved from TrustWidget. | +| ip_address | constr(
regex=r"^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$\|^(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$"
) | True | IP address of the device used for booking. | +| source | Optional[constr(max_length=50)] | False | Source of the device_box. Default value is `TrustWidget`. | + + + + + + + + + + +# Inheritance +object > BaseModel > DeviceDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/DirectDebit.md b/release/fraudPreventionV2/docs/DirectDebit.md new file mode 100644 index 00000000..61bcc2e5 --- /dev/null +++ b/release/fraudPreventionV2/docs/DirectDebit.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [DirectDebit](DirectDebit.md) +# class `expediagroup.sdk.fraudpreventionv2.model.DirectDebit` +``` +DirectDebit( + routing_number: constr(max_length=15), + account_number: constr(max_length=100), + telephones: list[Telephone], + method: Literal["DIRECT_DEBIT"], +) +``` + +pydantic model DirectDebit + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------|---------------------------------|----------|-------------------------------------------------------------------------------------------------| +| account_number | constr(max_length=100) | True | Cleartext (unencrypted) DirectDebit bank account number associated with the payment instrument. | +| method | Literal["DIRECT_DEBIT"] | True | ... | +| routing_number | constr(max_length=15) | True | A code that identifies the financial institution for a specific bank account. | +| telephones | list[[Telephone](Telephone.md)] | True | Telephone(s) associated with direct debit payment provider. | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > DirectDebit \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Email.md b/release/fraudPreventionV2/docs/Email.md new file mode 100644 index 00000000..d95eea5d --- /dev/null +++ b/release/fraudPreventionV2/docs/Email.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Email](Email.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Email` +``` +Email( + email_address: Optional[EmailStr], +) +``` + +pydantic model Email: Group of attributes intended to hold information about email address associated with the transaction. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|---------------|--------------------|----------|----------------------------------------------------------------------------| +| email_address | Optional[EmailStr] | False | Full email address including the alias, @ symbol, domain, and root domain. | + + + + + + + + + + +# Inheritance +object > BaseModel > Email \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Error.md b/release/fraudPreventionV2/docs/Error.md new file mode 100644 index 00000000..393dba56 --- /dev/null +++ b/release/fraudPreventionV2/docs/Error.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Error](Error.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Error` +``` +Error( + code: Code, + message: str, +) +``` + +pydantic model Error: The object used to describe an error, containing both human-readable and machine-readable information. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|-----------------|----------|----------------------------------------------------------------------------------------------------------------| +| code | [Code](Code.md) | True | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| message | str | True | A human-readable explanation of the error, specific to this error occurrence. | + + + + + + + + + + +# Inheritance +object > BaseModel > Error \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverBadRequestErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverBadRequestErrorException.md new file mode 100644 index 00000000..0e9ff687 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverBadRequestErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupAccountTakeoverBadRequestErrorException](ExpediaGroupAccountTakeoverBadRequestErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupAccountTakeoverBadRequestErrorException` +``` +ExpediaGroupAccountTakeoverBadRequestErrorException( +) +``` + +Exception wrapping a AccountTakeoverBadRequestError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupAccountTakeoverBadRequestErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverUnauthorizedErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverUnauthorizedErrorException.md new file mode 100644 index 00000000..d67aee38 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupAccountTakeoverUnauthorizedErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupAccountTakeoverUnauthorizedErrorException](ExpediaGroupAccountTakeoverUnauthorizedErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupAccountTakeoverUnauthorizedErrorException` +``` +ExpediaGroupAccountTakeoverUnauthorizedErrorException( +) +``` + +Exception wrapping a AccountTakeoverUnauthorizedError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupAccountTakeoverUnauthorizedErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupAccountUpdateNotFoundErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupAccountUpdateNotFoundErrorException.md new file mode 100644 index 00000000..8282d45b --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupAccountUpdateNotFoundErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupAccountUpdateNotFoundErrorException](ExpediaGroupAccountUpdateNotFoundErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupAccountUpdateNotFoundErrorException` +``` +ExpediaGroupAccountUpdateNotFoundErrorException( +) +``` + +Exception wrapping a AccountUpdateNotFoundError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupAccountUpdateNotFoundErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupBadGatewayErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupBadGatewayErrorException.md new file mode 100644 index 00000000..b6c940e9 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupBadGatewayErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupBadGatewayErrorException](ExpediaGroupBadGatewayErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupBadGatewayErrorException` +``` +ExpediaGroupBadGatewayErrorException( +) +``` + +Exception wrapping a BadGatewayError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupBadGatewayErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupBadRequestErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupBadRequestErrorException.md new file mode 100644 index 00000000..09bae159 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupBadRequestErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupBadRequestErrorException](ExpediaGroupBadRequestErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupBadRequestErrorException` +``` +ExpediaGroupBadRequestErrorException( +) +``` + +Exception wrapping a BadRequestError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupBadRequestErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupForbiddenErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupForbiddenErrorException.md new file mode 100644 index 00000000..667e3b3b --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupForbiddenErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupForbiddenErrorException](ExpediaGroupForbiddenErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupForbiddenErrorException` +``` +ExpediaGroupForbiddenErrorException( +) +``` + +Exception wrapping a ForbiddenError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupForbiddenErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupGatewayTimeoutErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupGatewayTimeoutErrorException.md new file mode 100644 index 00000000..b1653e1f --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupGatewayTimeoutErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupGatewayTimeoutErrorException](ExpediaGroupGatewayTimeoutErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupGatewayTimeoutErrorException` +``` +ExpediaGroupGatewayTimeoutErrorException( +) +``` + +Exception wrapping a GatewayTimeoutError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupGatewayTimeoutErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupInternalServerErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupInternalServerErrorException.md new file mode 100644 index 00000000..4f30cb3e --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupInternalServerErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupInternalServerErrorException](ExpediaGroupInternalServerErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupInternalServerErrorException` +``` +ExpediaGroupInternalServerErrorException( +) +``` + +Exception wrapping a InternalServerError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupInternalServerErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupNotFoundErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupNotFoundErrorException.md new file mode 100644 index 00000000..0c4d1a10 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupNotFoundErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupNotFoundErrorException](ExpediaGroupNotFoundErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupNotFoundErrorException` +``` +ExpediaGroupNotFoundErrorException( +) +``` + +Exception wrapping a NotFoundError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupNotFoundErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md new file mode 100644 index 00000000..1408317e --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupOrderPurchaseUpdateNotFoundErrorException](ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupOrderPurchaseUpdateNotFoundErrorException` +``` +ExpediaGroupOrderPurchaseUpdateNotFoundErrorException( +) +``` + +Exception wrapping a OrderPurchaseUpdateNotFoundError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupOrderPurchaseUpdateNotFoundErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseScreenFailureException.md b/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseScreenFailureException.md new file mode 100644 index 00000000..0eb2786a --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseScreenFailureException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupRetryableOrderPurchaseScreenFailureException](ExpediaGroupRetryableOrderPurchaseScreenFailureException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupRetryableOrderPurchaseScreenFailureException` +``` +ExpediaGroupRetryableOrderPurchaseScreenFailureException( +) +``` + +Exception wrapping a RetryableOrderPurchaseScreenFailure object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupRetryableOrderPurchaseScreenFailureException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md b/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md new file mode 100644 index 00000000..c597d611 --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupRetryableOrderPurchaseUpdateFailureException](ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupRetryableOrderPurchaseUpdateFailureException` +``` +ExpediaGroupRetryableOrderPurchaseUpdateFailureException( +) +``` + +Exception wrapping a RetryableOrderPurchaseUpdateFailure object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupRetryableOrderPurchaseUpdateFailureException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupServiceUnavailableErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupServiceUnavailableErrorException.md new file mode 100644 index 00000000..6fbd38ca --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupServiceUnavailableErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupServiceUnavailableErrorException](ExpediaGroupServiceUnavailableErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupServiceUnavailableErrorException` +``` +ExpediaGroupServiceUnavailableErrorException( +) +``` + +Exception wrapping a ServiceUnavailableError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupServiceUnavailableErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupTooManyRequestsErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupTooManyRequestsErrorException.md new file mode 100644 index 00000000..f4b639ee --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupTooManyRequestsErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupTooManyRequestsErrorException](ExpediaGroupTooManyRequestsErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupTooManyRequestsErrorException` +``` +ExpediaGroupTooManyRequestsErrorException( +) +``` + +Exception wrapping a TooManyRequestsError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupTooManyRequestsErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ExpediaGroupUnauthorizedErrorException.md b/release/fraudPreventionV2/docs/ExpediaGroupUnauthorizedErrorException.md new file mode 100644 index 00000000..6a46f1dd --- /dev/null +++ b/release/fraudPreventionV2/docs/ExpediaGroupUnauthorizedErrorException.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ExpediaGroupUnauthorizedErrorException](ExpediaGroupUnauthorizedErrorException.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ExpediaGroupUnauthorizedErrorException` +``` +ExpediaGroupUnauthorizedErrorException( +) +``` + +Exception wrapping a UnauthorizedError object. + + + + + + + + + + +# Inheritance +object > ExpediaGroupApiException > ExpediaGroupUnauthorizedErrorException \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/FailedLoginReason.md b/release/fraudPreventionV2/docs/FailedLoginReason.md new file mode 100644 index 00000000..325d55c8 --- /dev/null +++ b/release/fraudPreventionV2/docs/FailedLoginReason.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [FailedLoginReason](FailedLoginReason.md) +# class `expediagroup.sdk.fraudpreventionv2.model.FailedLoginReason` +``` +FailedLoginReason( +) +``` + +pydantic model FailedLoginReason: The reason for the failed login attempt in the Partner''s system, related to user failure or Partner''s system failure. +- `INVALID_CREDENTIALS` - Applicable if the user provided invalid login credentials for this login attempt. +- `ACCOUNT_NOT_FOUND` - Applicable if the user attempted to login to an account that doesn't exist. +- `VERIFICATION_FAILED` - Applicable if the user failed the verification for this login, or any authentication exception occured in the Partner system for this login attempt. +- `ACCOUNT_LOCKED` - Applicable if the user attempted to login to an account that is locked. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|------|----------|-------------| +| ACCOUNT_LOCKED | Any | True | ... | +| ACCOUNT_NOT_FOUND | Any | True | ... | +| INVALID_CREDENTIALS | Any | True | ... | +| VERIFICATION_FAILED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > FailedLoginReason \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/FlightType.md b/release/fraudPreventionV2/docs/FlightType.md new file mode 100644 index 00000000..15574546 --- /dev/null +++ b/release/fraudPreventionV2/docs/FlightType.md @@ -0,0 +1,38 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [FlightType](FlightType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.FlightType` +``` +FlightType( +) +``` + +pydantic model FlightType: Identifies the type of air trip based on the air destinations. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|----------------------|------|----------|-------------| +| MULTIPLE_DESTINATION | Any | True | ... | +| ONEWAY | Any | True | ... | +| ROUNDTRIP | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > FlightType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ForbiddenError.md b/release/fraudPreventionV2/docs/ForbiddenError.md new file mode 100644 index 00000000..4c073f61 --- /dev/null +++ b/release/fraudPreventionV2/docs/ForbiddenError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ForbiddenError](ForbiddenError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ForbiddenError` +``` +ForbiddenError( +) +``` + +pydantic model ForbiddenError: Indicates that the API cannot fulfill the request because while the client is correctly authenticated, the client doesn't have the permission to execute the specified operation. This error type does not imply that the request is valid, or that the resource against which the operation being performed exists or satisfies other pre-conditions. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > ForbiddenError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ForbiddenErrorDeserializationContract.md b/release/fraudPreventionV2/docs/ForbiddenErrorDeserializationContract.md new file mode 100644 index 00000000..1b9a2caa --- /dev/null +++ b/release/fraudPreventionV2/docs/ForbiddenErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ForbiddenErrorDeserializationContract](ForbiddenErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ForbiddenErrorDeserializationContract` +``` +ForbiddenErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > ForbiddenErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/FraudDecision.md b/release/fraudPreventionV2/docs/FraudDecision.md new file mode 100644 index 00000000..29b9a79d --- /dev/null +++ b/release/fraudPreventionV2/docs/FraudDecision.md @@ -0,0 +1,38 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [FraudDecision](FraudDecision.md) +# class `expediagroup.sdk.fraudpreventionv2.model.FraudDecision` +``` +FraudDecision( +) +``` + +pydantic model FraudDecision + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|--------|------|----------|-------------| +| ACCEPT | Any | True | ... | +| REJECT | Any | True | ... | +| REVIEW | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > FraudDecision \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/FraudPreventionV2Client.md b/release/fraudPreventionV2/docs/FraudPreventionV2Client.md new file mode 100644 index 00000000..5cb940a1 --- /dev/null +++ b/release/fraudPreventionV2/docs/FraudPreventionV2Client.md @@ -0,0 +1,109 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.client](expediagroup.sdk.fraudpreventionv2.client.md) / [FraudPreventionV2Client](FraudPreventionV2Client.md) +# class `expediagroup.sdk.fraudpreventionv2.client.FraudPreventionV2Client` +``` +FraudPreventionV2Client( + client_config: ClientConfig, +) +``` + + +Fraud Prevention V2 API Client. + + + + + + + +## Methods + +### screen_account +``` +screen_account( + body: AccountScreenRequest, +) +``` + + + + + + +#### Parameters + +| Name | Type | Required | Description | +|------|-------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| body | [AccountScreenRequest](AccountScreenRequest.md) | True | The Account Screen API gives a Fraud recommendation for an account transaction. A recommendation can be ACCEPT, CHALLENGE, or REJECT. A transaction is marked as CHALLENGE whenever there are insufficient signals to recommend ACCEPT or REJECT. These CHALLENGE incidents are manually reviewed, and a corrected recommendation is made asynchronously. | + + + + +### notify_with_account_update +``` +notify_with_account_update( + body: AccountUpdateRequest, +) +``` + + + + + + +#### Parameters + +| Name | Type | Required | Description | +|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| body | Union[[MultiFactorAuthenticationUpdate](MultiFactorAuthenticationUpdate.md), [RemediationUpdate](RemediationUpdate.md), [AccountUpdateRequestGeneric](AccountUpdateRequestGeneric.md)] | True | The Account Update API is called when there is an account lifecycle transition such as a challenge outcome, account restoration, or remediation action completion. For example, if a user's account is disabled, deleted, or restored, the Account Update API is called to notify Expedia Group about the change. The Account Update API is also called when a user responds to a login Multi-Factor Authentication based on a Fraud recommendation. | + + + + +### screen_order +``` +screen_order( + body: OrderPurchaseScreenRequest, +) +``` + + + + + + +#### Parameters + +| Name | Type | Required | Description | +|------|-------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| body | [OrderPurchaseScreenRequest](OrderPurchaseScreenRequest.md) | True | The Order Purchase API gives a Fraud recommendation for a transaction. A recommendation can be Accept, Reject, or Review. A transaction is marked as Review whenever there are insufficient signals to recommend Accept or Reject. These incidents are manually reviewed, and a corrected recommendation is made asynchronously. | + + + + +### notify_with_order_update +``` +notify_with_order_update( + body: OrderPurchaseUpdateRequest, +) +``` + + + + + + +#### Parameters + +| Name | Type | Required | Description | +|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| body | Union[[OrderUpdate](OrderUpdate.md), [ChargebackFeedback](ChargebackFeedback.md), [InsultFeedback](InsultFeedback.md), Union[[IssuedRefundUpdate](IssuedRefundUpdate.md), [SettledRefundUpdate](SettledRefundUpdate.md), [RefundUpdateGeneric](RefundUpdateGeneric.md)], [PaymentUpdate](PaymentUpdate.md), [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md)] | True | For example, if the customer cancels the reservation, changes reservation in any way, or adds additional products or travelers to the reservation, the Order Purchase Update API is called to notify Expedia Group about the change.

The Order Purchase Update API is also called when the merchant cancels or changes an order based on a Fraud recommendation. | + + + + + + + + +# Inheritance +object > FraudPreventionV2Client \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/GatewayTimeoutError.md b/release/fraudPreventionV2/docs/GatewayTimeoutError.md new file mode 100644 index 00000000..4038d94c --- /dev/null +++ b/release/fraudPreventionV2/docs/GatewayTimeoutError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [GatewayTimeoutError](GatewayTimeoutError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.GatewayTimeoutError` +``` +GatewayTimeoutError( +) +``` + +pydantic model GatewayTimeoutError: Indicates that the API gateway has issues completing the request on time. Request can be retried if it is idempotent, If the issue persists, please reach out to support. For non-idempotent requests, please reach out to to know the status of your request before attempting retries. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > GatewayTimeoutError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/GatewayTimeoutErrorDeserializationContract.md b/release/fraudPreventionV2/docs/GatewayTimeoutErrorDeserializationContract.md new file mode 100644 index 00000000..186ef0a8 --- /dev/null +++ b/release/fraudPreventionV2/docs/GatewayTimeoutErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [GatewayTimeoutErrorDeserializationContract](GatewayTimeoutErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.GatewayTimeoutErrorDeserializationContract` +``` +GatewayTimeoutErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > GatewayTimeoutErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/GiftCard.md b/release/fraudPreventionV2/docs/GiftCard.md new file mode 100644 index 00000000..157eb76e --- /dev/null +++ b/release/fraudPreventionV2/docs/GiftCard.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [GiftCard](GiftCard.md) +# class `expediagroup.sdk.fraudpreventionv2.model.GiftCard` +``` +GiftCard( + card_number: constr(regex=r"^[0-9A-Za-z]{4,16}$", max_length=16), + card_holder_name: constr(max_length=200), + pin: constr(regex=r"^[0-9]{4,8}$", max_length=8), + method: Literal["GIFT_CARD"], +) +``` + +pydantic model GiftCard + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------|-----------------------------------------------------|----------|-------------------------------| +| card_holder_name | constr(max_length=200) | True | The name of gift card holder. | +| card_number | constr(regex=r"^[0-9A-Za-z]{4,16}$", max_length=16) | True | Gift card number. | +| method | Literal["GIFT_CARD"] | True | ... | +| pin | constr(regex=r"^[0-9]{4,8}$", max_length=8) | True | The PIN of gift card. | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > GiftCard \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Hotel.md b/release/fraudPreventionV2/docs/Hotel.md new file mode 100644 index 00000000..c800d279 --- /dev/null +++ b/release/fraudPreventionV2/docs/Hotel.md @@ -0,0 +1,61 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Hotel](Hotel.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Hotel` +``` +Hotel( + hotel_id: constr(max_length=200), + price_withheld: Optional[bool], + hotel_name: constr(max_length=200), + room_count: Optional[int], + address: HotelAddress, + checkin_time: datetime, + checkout_time: datetime, + type: Literal["HOTEL"], +) +``` + +pydantic model Hotel + + + +## Attributes + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------|---------------------------------|----------|----------------------------------------------------------------------------------------------------------| +| address | [HotelAddress](HotelAddress.md) | True | ... | +| checkin_time | datetime | True | Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| checkout_time | datetime | True | Local date and time of the hotel check-out, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| hotel_id | constr(max_length=200) | True | Unique hotel identifier assigned by the partner. | +| hotel_name | constr(max_length=200) | True | Name of the hotel. | +| price_withheld | Optional[bool] | False | Identifies if the product price was withheld from the customer during the booking process. | +| room_count | Optional[int] | False | Total number of rooms booked within the hotel product collection. | +| type | Literal["HOTEL"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Hotel \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/HotelAddress.md b/release/fraudPreventionV2/docs/HotelAddress.md new file mode 100644 index 00000000..7903f0ff --- /dev/null +++ b/release/fraudPreventionV2/docs/HotelAddress.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [HotelAddress](HotelAddress.md) +# class `expediagroup.sdk.fraudpreventionv2.model.HotelAddress` +``` +HotelAddress( +) +``` + +pydantic model HotelAddress: Address of a hotel. + + + + + + + + + + +# Inheritance +object > [Address](Address.md) > HotelAddress \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InsultDetail.md b/release/fraudPreventionV2/docs/InsultDetail.md new file mode 100644 index 00000000..9ad45835 --- /dev/null +++ b/release/fraudPreventionV2/docs/InsultDetail.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InsultDetail](InsultDetail.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InsultDetail` +``` +InsultDetail( + insult_reported_date_time: Optional[datetime], +) +``` + +pydantic model InsultDetail: Details related to the insult. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|---------------------------|--------------------|----------|-------------------------------------------------------------------------------------------------------------------------| +| insult_reported_date_time | Optional[datetime] | False | Date and time when the insult was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | + + + + + + + + + + +# Inheritance +object > BaseModel > InsultDetail \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InsultFeedback.md b/release/fraudPreventionV2/docs/InsultFeedback.md new file mode 100644 index 00000000..3a12a483 --- /dev/null +++ b/release/fraudPreventionV2/docs/InsultFeedback.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InsultFeedback](InsultFeedback.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InsultFeedback` +``` +InsultFeedback( + insult_detail: Optional[InsultDetail], + type: Literal["INSULT_FEEDBACK"], +) +``` + +pydantic model InsultFeedback: Feedback from EG external partners regarding a false positive recommendation that from Fraud Prevention system gave for their customer. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------------|-------------------------------------------|----------|-------------| +| insult_detail | Optional[[InsultDetail](InsultDetail.md)] | False | ... | +| type | Literal["INSULT_FEEDBACK"] | True | ... | + + + + + + + + + + +# Inheritance +object > [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) > InsultFeedback \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Insurance.md b/release/fraudPreventionV2/docs/Insurance.md new file mode 100644 index 00000000..5dce54d0 --- /dev/null +++ b/release/fraudPreventionV2/docs/Insurance.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Insurance](Insurance.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Insurance` +``` +Insurance( + type: Literal["INSURANCE"], +) +``` + +pydantic model Insurance + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|------|----------------------|----------|-------------| +| type | Literal["INSURANCE"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Insurance \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InternalServerError.md b/release/fraudPreventionV2/docs/InternalServerError.md new file mode 100644 index 00000000..42b59772 --- /dev/null +++ b/release/fraudPreventionV2/docs/InternalServerError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InternalServerError](InternalServerError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InternalServerError` +``` +InternalServerError( +) +``` + +pydantic model InternalServerError: Indicates that the API encountered an unexpected condition that prevented it from fulfilling the request. Sometimes used as a generic catch-allerror type when no other error types can be used. Retrying the same request will usually result in the same error. Please reach out to support team as next step for this error resolution. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > InternalServerError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InternalServerErrorDeserializationContract.md b/release/fraudPreventionV2/docs/InternalServerErrorDeserializationContract.md new file mode 100644 index 00000000..3234681d --- /dev/null +++ b/release/fraudPreventionV2/docs/InternalServerErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InternalServerErrorDeserializationContract](InternalServerErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InternalServerErrorDeserializationContract` +``` +InternalServerErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > InternalServerErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InternetBankPayment.md b/release/fraudPreventionV2/docs/InternetBankPayment.md new file mode 100644 index 00000000..0858ac1f --- /dev/null +++ b/release/fraudPreventionV2/docs/InternetBankPayment.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InternetBankPayment](InternetBankPayment.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InternetBankPayment` +``` +InternetBankPayment( + bank_id: constr(max_length=15), + bank_branch_code: constr(max_length=15), + telephones: list[Telephone], + method: Literal["INTERNET_BANK_PAYMENT"], +) +``` + +pydantic model InternetBankPayment + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------| +| bank_branch_code | constr(max_length=15) | True | A code that identifies the bank branch for internet bank payment(IBP). | +| bank_id | constr(max_length=15) | True | The bank_id provided by the internet bank payment(IBP) provider (DRWP aka NetGiro) for the bank used for processing the payment. | +| method | Literal["INTERNET_BANK_PAYMENT"] | True | ... | +| telephones | list[[Telephone](Telephone.md)] | True | Telephone(s) associated with internet bank payment(IBP) provider. | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > InternetBankPayment \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/InventorySource.md b/release/fraudPreventionV2/docs/InventorySource.md new file mode 100644 index 00000000..6db4055c --- /dev/null +++ b/release/fraudPreventionV2/docs/InventorySource.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [InventorySource](InventorySource.md) +# class `expediagroup.sdk.fraudpreventionv2.model.InventorySource` +``` +InventorySource( +) +``` + +pydantic model InventorySource: Identifies the business model through which the supply is being sold. Merchant/Agency. +* `MERCHANT` is used when Partner is the merchant of record for this order. +* `AGENCY` is used when this order is through an agency booking. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| AGENCY | Any | True | ... | +| MERCHANT | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > InventorySource \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/IssuedRefundUpdate.md b/release/fraudPreventionV2/docs/IssuedRefundUpdate.md new file mode 100644 index 00000000..5befe5df --- /dev/null +++ b/release/fraudPreventionV2/docs/IssuedRefundUpdate.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [IssuedRefundUpdate](IssuedRefundUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.IssuedRefundUpdate` +``` +IssuedRefundUpdate( + refund_details: Optional[IssuedRefundUpdateDetails], + refund_status: Literal["ISSUED"], +) +``` + +pydantic model IssuedRefundUpdate: Data related to the issued refund that should be updated. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------------|---------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------| +| refund_details | Optional[[IssuedRefundUpdateDetails](IssuedRefundUpdateDetails.md)] | False | ... | +| refund_status | Literal["ISSUED"] | True | Identifies the refund status. Possible values are:
-`ISSUED` - The refund was issued.
-`SETTLED` - The refund was settled. | + + + + + + + + + + +# Inheritance +object > [RefundUpdateGeneric](RefundUpdateGeneric.md) > IssuedRefundUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/IssuedRefundUpdateDetails.md b/release/fraudPreventionV2/docs/IssuedRefundUpdateDetails.md new file mode 100644 index 00000000..e8d71135 --- /dev/null +++ b/release/fraudPreventionV2/docs/IssuedRefundUpdateDetails.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [IssuedRefundUpdateDetails](IssuedRefundUpdateDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.IssuedRefundUpdateDetails` +``` +IssuedRefundUpdateDetails( + refund_issued_date_time: datetime, + refund_issued_amount: Amount, +) +``` + +pydantic model IssuedRefundUpdateDetails: Data that describes issued refund that should be updated. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-------------------------|---------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| refund_issued_amount | [Amount](Amount.md) | True | ... | +| refund_issued_date_time | datetime | True | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has issued at the participating financial institutions. | + + + + + + + + + + +# Inheritance +object > BaseModel > IssuedRefundUpdateDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/LoginTransactionDetails.md b/release/fraudPreventionV2/docs/LoginTransactionDetails.md new file mode 100644 index 00000000..3dd15c73 --- /dev/null +++ b/release/fraudPreventionV2/docs/LoginTransactionDetails.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [LoginTransactionDetails](LoginTransactionDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.LoginTransactionDetails` +``` +LoginTransactionDetails( + authentication_type: AuthenticationType, + authentication_sub_type: Optional[AuthenticationSubType], + successful_login_flag: bool, + failed_login_reason: Optional[FailedLoginReason], + type: Literal["LOGIN"], +) +``` + +pydantic model LoginTransactionDetails + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------------------|-------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authentication_sub_type | Optional[[AuthenticationSubType](AuthenticationSubType.md)] | False | The sub type of login authentication method used by a user.
For `authentication_sub_type` ensure attributes mentioned in dictionary below are set to corresponding values only.
`authentication_sub_type` is an enum value with the following mapping with `authentication_type` attribute:
* authentication_sub_type : authentication_type
* -------------------------------------------------------------------------------
* `EMAIL` : `CREDENTIALS`
* `EMAIL` : `PASSWORD_RESET`
* `EMAIL` : `SINGLE_SIGN_ON`
* `EMAIL` : `MULTI_FACTOR_AUTHENTICATION`
* `PHONE` : `MULTI_FACTOR_AUTHENTICATION`
* `GOOGLE` : `SOCIAL`
* `FACEBOOK` : `SOCIAL`
* `APPLE` : `SOCIAL`
* : `CREDENTIALS` | +| authentication_type | [AuthenticationType](AuthenticationType.md) | True | The type of login authentication method used by a user.
For `authentication_type` ensure attributes mentioned in dictionary below are set to corresponding values only.
`authentication_type` is an enum value with the following mapping with `authentication_sub_type` attribute:
* authentication_type : authentication_sub_type
* -------------------------------------------------------------------------------
* `CREDENTIALS` : `EMAIL`
* `CREDENTIALS` :
* `PASSWORD_RESET` : `EMAIL`
* `SINGLE_SIGN_ON` : `EMAIL`
* `MULTI_FACTOR_AUTHENTICATION` : `EMAIL`
* `MULTI_FACTOR_AUTHENTICATION` : `PHONE`
* `SOCIAL` : `GOOGLE`
* `SOCIAL` : `FACEBOOK`
* `SOCIAL` : `APPLE` | +| failed_login_reason | Optional[[FailedLoginReason](FailedLoginReason.md)] | False | The reason for the failed login attempt in the Partner''s system, related to user failure or Partner''s system failure.
- `INVALID_CREDENTIALS` - Applicable if the user provided invalid login credentials for this login attempt.
- `ACCOUNT_NOT_FOUND` - Applicable if the user attempted to login to an account that doesn't exist.
- `VERIFICATION_FAILED` - Applicable if the user failed the verification for this login, or any authentication exception occured in the Partner system for this login attempt.
- `ACCOUNT_LOCKED` - Applicable if the user attempted to login to an account that is locked. | +| successful_login_flag | bool | True | Identifies if a login attempt by a user was successful or not. | +| type | Literal["LOGIN"] | True | The categorized type of account event related to a user's action. | + + + + + + + + + + +# Inheritance +object > [AccountTakeoverTransactionDetailsGeneric](AccountTakeoverTransactionDetailsGeneric.md) > LoginTransactionDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/MultiFactorAuthenticationAttempt.md b/release/fraudPreventionV2/docs/MultiFactorAuthenticationAttempt.md new file mode 100644 index 00000000..03907a95 --- /dev/null +++ b/release/fraudPreventionV2/docs/MultiFactorAuthenticationAttempt.md @@ -0,0 +1,65 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [MultiFactorAuthenticationAttempt](MultiFactorAuthenticationAttempt.md) +# class `expediagroup.sdk.fraudpreventionv2.model.MultiFactorAuthenticationAttempt` +``` +MultiFactorAuthenticationAttempt( + delivery_method: DeliveryMethod, + status: Status1, + reference_id: constr(max_length=200), + provider_name: constr(max_length=200), + attempt_count: float, + update_start_date_time: Optional[datetime], + update_end_date_time: Optional[datetime], + telephone: Optional[Telephone], + email_address: Optional[EmailStr], +) +``` + +pydantic model MultiFactorAuthenticationAttempt: Information specific to the update event by a user. + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------------|-------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| attempt_count | float | True | The number of attempts a user tried for this Multi-Factor Authentication. | +| delivery_method | [DeliveryMethod](DeliveryMethod.md) | True | The delivery method of the Multi-Factor Authentication to a user. | +| email_address | Optional[EmailStr] | False | Email address used for the Multi-Factor Authentication by a user. | +| provider_name | constr(max_length=200) | True | The vendor providing the Multi-Factor Authentication verification. | +| reference_id | constr(max_length=200) | True | The identifier related to a Multi-Factor Authentication attempt by the Partner's system to the Multi-Factor Authentication provider. | +| status | [Status1](Status1.md) | True | The status of a user''s response to the Multi-Factor Authentication initiated by the Partner''s system to the user.'
- `SUCCESS` - Applicable if the user successfully passed the challenge.
- `ABANDON` - Applicable if the user did not complete the challenge.
- `FAILED` - Applicable if the user failed the challenge. | +| telephone | Optional[[Telephone](Telephone.md)] | False | ... | +| update_end_date_time | Optional[datetime] | False | The local date and time the Multi-Factor Authentication to a user ended in the Partner's system, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| update_start_date_time | Optional[datetime] | False | The local date and time the Multi-Factor Authentication was initiated to a user from the Partner's system, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | + + + + + + + + + + +# Inheritance +object > BaseModel > MultiFactorAuthenticationAttempt \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/MultiFactorAuthenticationUpdate.md b/release/fraudPreventionV2/docs/MultiFactorAuthenticationUpdate.md new file mode 100644 index 00000000..4b53a2e3 --- /dev/null +++ b/release/fraudPreventionV2/docs/MultiFactorAuthenticationUpdate.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [MultiFactorAuthenticationUpdate](MultiFactorAuthenticationUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.MultiFactorAuthenticationUpdate` +``` +MultiFactorAuthenticationUpdate( + multi_factor_authentication_attempts: list[MultiFactorAuthenticationAttempt], + type: Literal["MULTI_FACTOR_AUTHENTICATION_UPDATE"], +) +``` + +pydantic model MultiFactorAuthenticationUpdate: Information specific to a user's response to a Multi-Factor Authentication initiated by the Partner's system as a result of a fraud recommendation. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|--------------------------------------|-------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------| +| multi_factor_authentication_attempts | list[[MultiFactorAuthenticationAttempt](MultiFactorAuthenticationAttempt.md)] | True | ... | +| type | Literal["MULTI_FACTOR_AUTHENTICATION_UPDATE"] | True | The categorized type of account update event from the Partner's system. | + + + + + + + + + + +# Inheritance +object > [AccountUpdateRequestGeneric](AccountUpdateRequestGeneric.md) > MultiFactorAuthenticationUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Name.md b/release/fraudPreventionV2/docs/Name.md new file mode 100644 index 00000000..dfdc6dfc --- /dev/null +++ b/release/fraudPreventionV2/docs/Name.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Name](Name.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Name` +``` +Name( + last_name: constr(max_length=200), + first_name: constr(max_length=200), + middle_name: Optional[constr(max_length=200)], + title: Optional[constr(max_length=200)], + suffix: Optional[constr(max_length=50)], +) +``` + +pydantic model Name: Group of attributes intended to hold information about a customer or traveler's name for the order. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| first_name | constr(max_length=200) | True | Given, or first name, of the person. | +| last_name | constr(max_length=200) | True | Surname, or last name, of the person. | +| middle_name | Optional[constr(max_length=200)] | False | Middle name of the person. | +| suffix | Optional[constr(max_length=50)] | False | Generational designations (e.g. Sr, Jr, III) or values that indicate the individual holds a position, educational degree, accreditation, office, or honor (e.g. PhD, CCNA, OBE). | +| title | Optional[constr(max_length=200)] | False | Title of the person for name (e.g. Mr., Ms. etc). | + + + + + + + + + + +# Inheritance +object > BaseModel > Name \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/NotFoundError.md b/release/fraudPreventionV2/docs/NotFoundError.md new file mode 100644 index 00000000..6855f1e8 --- /dev/null +++ b/release/fraudPreventionV2/docs/NotFoundError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [NotFoundError](NotFoundError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.NotFoundError` +``` +NotFoundError( +) +``` + +pydantic model NotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. Please check the request again to make sure that the request is valid. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > NotFoundError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/NotFoundErrorDeserializationContract.md b/release/fraudPreventionV2/docs/NotFoundErrorDeserializationContract.md new file mode 100644 index 00000000..4e03f11f --- /dev/null +++ b/release/fraudPreventionV2/docs/NotFoundErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [NotFoundErrorDeserializationContract](NotFoundErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.NotFoundErrorDeserializationContract` +``` +NotFoundErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > NotFoundErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OperatingCompany.md b/release/fraudPreventionV2/docs/OperatingCompany.md new file mode 100644 index 00000000..74ec4870 --- /dev/null +++ b/release/fraudPreventionV2/docs/OperatingCompany.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OperatingCompany](OperatingCompany.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OperatingCompany` +``` +OperatingCompany( + marketing_name: Optional[constr(max_length=200)], +) +``` + +pydantic model OperatingCompany: This attribute captures the name or identifier of the company responsible for operating the Rail product. It represents the specific operating entity, such as Amtrak, British Railways, or a bus company. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|----------------|----------------------------------|----------|------------------------------------------------------------------------------------------------------------------------| +| marketing_name | Optional[constr(max_length=200)] | False | The name used by the transportation carrier for marketing purposes in the travel segment. Example: ARX, AMTRAC, ARRIVA | + + + + + + + + + + +# Inheritance +object > BaseModel > OperatingCompany \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Operations.md b/release/fraudPreventionV2/docs/Operations.md new file mode 100644 index 00000000..133aaafa --- /dev/null +++ b/release/fraudPreventionV2/docs/Operations.md @@ -0,0 +1,59 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Operations](Operations.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Operations` +``` +Operations( + verify: Optional[Verify], + authorize: Optional[Authorize], + authorize_reversal: Optional[AuthorizeReversal], + capture: Optional[Capture], + refunds: Optional[list[Refund]], +) +``` + +pydantic model Operations: All operations related to a payment throughout its lifespan. An operation represents an event external to Fraud Prevention Service that specifies to perform a payment operation. Possible operation types include: + +- `Verify` + +- `Authorize` + +- `AuthorizeReversal` + +- `Capture` + +- `Refund` + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|--------------------|-----------------------------------------------------|----------|-------------| +| authorize | Optional[[Authorize](Authorize.md)] | False | ... | +| authorize_reversal | Optional[[AuthorizeReversal](AuthorizeReversal.md)] | False | ... | +| capture | Optional[[Capture](Capture.md)] | False | ... | +| refunds | Optional[list[[Refund](Refund.md)]] | False | ... | +| verify | Optional[[Verify](Verify.md)] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > Operations \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseScreenRequest.md b/release/fraudPreventionV2/docs/OrderPurchaseScreenRequest.md new file mode 100644 index 00000000..a8efdc23 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseScreenRequest.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseScreenRequest](OrderPurchaseScreenRequest.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseScreenRequest` +``` +OrderPurchaseScreenRequest( + transaction: OrderPurchaseTransaction, +) +``` + +pydantic model OrderPurchaseScreenRequest + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|-------------|---------------------------------------------------------|----------|-------------| +| transaction | [OrderPurchaseTransaction](OrderPurchaseTransaction.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > OrderPurchaseScreenRequest \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseScreenResponse.md b/release/fraudPreventionV2/docs/OrderPurchaseScreenResponse.md new file mode 100644 index 00000000..679e6568 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseScreenResponse.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseScreenResponse](OrderPurchaseScreenResponse.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseScreenResponse` +``` +OrderPurchaseScreenResponse( + risk_id: Optional[constr(max_length=200)], + decision: Optional[FraudDecision], +) +``` + +pydantic model OrderPurchaseScreenResponse + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------|---------------------------------------------|----------|--------------------------------------------------------------------------------------| +| decision | Optional[[FraudDecision](FraudDecision.md)] | False | ... | +| risk_id | Optional[constr(max_length=200)] | False | Unique identifier assigned to the transaction by Expedia's Fraud Prevention Service. | + + + + + + + + + + +# Inheritance +object > BaseModel > OrderPurchaseScreenResponse \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseTransaction.md b/release/fraudPreventionV2/docs/OrderPurchaseTransaction.md new file mode 100644 index 00000000..2c22611b --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseTransaction.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseTransaction](OrderPurchaseTransaction.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseTransaction` +``` +OrderPurchaseTransaction( + site_info: SiteInfo, + device_details: DeviceDetails, + customer_account: CustomerAccount, + transaction_details: TransactionDetails, +) +``` + +pydantic model OrderPurchaseTransaction + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|---------------------------------------------|----------|-------------| +| customer_account | [CustomerAccount](CustomerAccount.md) | True | ... | +| device_details | [DeviceDetails](DeviceDetails.md) | True | ... | +| site_info | [SiteInfo](SiteInfo.md) | True | ... | +| transaction_details | [TransactionDetails](TransactionDetails.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > OrderPurchaseTransaction \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundError.md b/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundError.md new file mode 100644 index 00000000..e72da7e2 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseUpdateNotFoundError](OrderPurchaseUpdateNotFoundError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseUpdateNotFoundError` +``` +OrderPurchaseUpdateNotFoundError( +) +``` + +pydantic model OrderPurchaseUpdateNotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. + + + + + + + + + + +# Inheritance +object > [Error](Error.md) > OrderPurchaseUpdateNotFoundError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundErrorDeserializationContract.md b/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundErrorDeserializationContract.md new file mode 100644 index 00000000..7f724c48 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseUpdateNotFoundErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseUpdateNotFoundErrorDeserializationContract](OrderPurchaseUpdateNotFoundErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseUpdateNotFoundErrorDeserializationContract` +``` +OrderPurchaseUpdateNotFoundErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > OrderPurchaseUpdateNotFoundErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseUpdateRequestGeneric.md b/release/fraudPreventionV2/docs/OrderPurchaseUpdateRequestGeneric.md new file mode 100644 index 00000000..3ec75434 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseUpdateRequestGeneric.md @@ -0,0 +1,42 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseUpdateRequestGeneric` +``` +OrderPurchaseUpdateRequestGeneric( + type: UpdateType, + risk_id: constr(max_length=200), +) +``` + +pydantic model OrderPurchaseUpdateRequest: The `type` field value is used as a discriminator, with the following mapping: +* `ORDER_UPDATE`: `OrderUpdate` +* `CHARGEBACK_FEEDBACK`: `ChargebackFeedback` +* `INSULT_FEEDBACK`: `InsultFeedback` +* `REFUND_UPDATE`: `RefundUpdate` +* `PAYMENT_UPDATE`: `PaymentUpdate` + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|-----------------------------|----------|----------------------------------------------------------------------------------------------------| +| risk_id | constr(max_length=200) | True | The `risk_id` provided by Expedia's Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | +| type | [UpdateType](UpdateType.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > OrderPurchaseUpdateRequestGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderPurchaseUpdateResponse.md b/release/fraudPreventionV2/docs/OrderPurchaseUpdateResponse.md new file mode 100644 index 00000000..73136cf7 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderPurchaseUpdateResponse.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderPurchaseUpdateResponse](OrderPurchaseUpdateResponse.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderPurchaseUpdateResponse` +``` +OrderPurchaseUpdateResponse( + risk_id: Optional[constr(max_length=200)], +) +``` + +pydantic model OrderPurchaseUpdateResponse + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|---------|----------------------------------|----------|----------------------------------------------------| +| risk_id | Optional[constr(max_length=200)] | False | Unique identifier of transaction that was updated. | + + + + + + + + + + +# Inheritance +object > BaseModel > OrderPurchaseUpdateResponse \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderType.md b/release/fraudPreventionV2/docs/OrderType.md new file mode 100644 index 00000000..26b0fe59 --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderType.md @@ -0,0 +1,39 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderType](OrderType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderType` +``` +OrderType( +) +``` + +pydantic model OrderType: Type of order. Possible `order_types`. + +`CREATE` - Initial type of a brand new order. + +`CHANGE` - If a `OrderPurchaseScreenRequest` has already been submitted for the initial booking with `order_type = CREATE`, but has now been modified and partner wishes to resubmit for Fraud screening then the `order_type = CHANGE`. Examples of changes that are supported are changes made to `check-in/checkout dates` or `price of a TravelProduct`. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|--------|------|----------|-------------| +| CHANGE | Any | True | ... | +| CREATE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > OrderType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/OrderUpdate.md b/release/fraudPreventionV2/docs/OrderUpdate.md new file mode 100644 index 00000000..bb1ffc8d --- /dev/null +++ b/release/fraudPreventionV2/docs/OrderUpdate.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [OrderUpdate](OrderUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.OrderUpdate` +``` +OrderUpdate( + order_status: Status, + acquirer_reference_number: Optional[constr(max_length=200)], + cancellation_reason: Optional[CancellationReason], + type: Literal["ORDER_UPDATE"], +) +``` + +pydantic model OrderUpdate: Order related data that should be updated. + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------------|-------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| acquirer_reference_number | Optional[constr(max_length=200)] | False | A unique number that tags a credit or debit card transaction when it goes from the merchant's bank through to the cardholder's bank.
`acquirer_reference_number` is a required field only if `order_status` = `COMPLETED`
Typically, merchants can get this number from their payment processors.
This number is used when dealing with disputes/chargebacks on original transactions. | +| cancellation_reason | Optional[[CancellationReason](CancellationReason.md)] | False | ... | +| order_status | [Status](Status.md) | True | ... | +| type | Literal["ORDER_UPDATE"] | True | ... | + + + + + + + + + + +# Inheritance +object > [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) > OrderUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PayPal.md b/release/fraudPreventionV2/docs/PayPal.md new file mode 100644 index 00000000..762164ff --- /dev/null +++ b/release/fraudPreventionV2/docs/PayPal.md @@ -0,0 +1,45 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PayPal](PayPal.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PayPal` +``` +PayPal( + payer_id: constr(max_length=200), + transaction_id: constr(max_length=200), + merchant_order_code: Optional[constr(max_length=200)], + method: Literal["PAYPAL"], +) +``` + +pydantic model PayPal + + + +## Attributes + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|----------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| merchant_order_code | Optional[constr(max_length=200)] | False | Reference code passed to acquiring bank at the time of payment. This code is the key ID that ties back to payments data at the payment level. | +| method | Literal["PAYPAL"] | True | ... | +| payer_id | constr(max_length=200) | True | Unique PayPal Customer Account identification number. | +| transaction_id | constr(max_length=200) | True | Unique transaction number to identify Auth calls at PayPal. | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > PayPal \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentGeneric.md b/release/fraudPreventionV2/docs/PaymentGeneric.md new file mode 100644 index 00000000..33634fc6 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentGeneric.md @@ -0,0 +1,75 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentGeneric](PaymentGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentGeneric` +``` +PaymentGeneric( + brand: Brand, + method: PaymentMethod, + reason: Optional[PaymentReason], + billing_name: Name, + billing_address: Address, + billing_email_address: EmailStr, + authorized_amount: Optional[Amount], + verified_amount: Optional[Amount], + three_digits_secure_criteria: Optional[PaymentThreeDSCriteria], + operations: Optional[Operations], +) +``` + +pydantic model Payment: The `method` field value is used as a discriminator, with the following mapping: +* `CREDIT_CARD`: `CreditCard` +* `PAYPAL`: `PayPal` +* `POINTS`: `Points` +* `GIFT_CARD`: `GiftCard` +* `INTERNET_BANK_PAYMENT`: `InternetBankPayment` +* `DIRECT_DEBIT`: `DirectDebit` + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------------------|---------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authorized_amount | Optional[[Amount](Amount.md)] | False | ... | +| billing_address | [Address](Address.md) | True | ... | +| billing_email_address | EmailStr | True | Email address associated with the payment. | +| billing_name | [Name](Name.md) | True | ... | +| brand | [Brand](Brand.md) | True | The `brand` field value is the payment brand used for payment on this transaction.
For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only.
Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API.
Incorrect `brand` - `card_type` combination will result in data quality issues and result in degraded risk recommendation.
'brand' is an enum value with the following mapping with CreditCard 'card_type' attribute:
* brand : card_type
* -------------------------------------------------------
* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS`
* `DINERS_CLUB_INTERNATIONAL` : `DINERS_CLUB`
* `BC_CARD` : `DINERS_CLUB`
* `DISCOVER` : `DISCOVER`
* `BC_CARD` : `DISCOVER`
* `DINERS_CLUB_INTERNATIONAL` : `DISCOVER`
* `JCB` : `DISCOVER`
* `JCB` : `JCB`
* `MASTER_CARD` : `MASTER_CARD`
* `MAESTRO` : `MASTER_CARD`
* `POSTEPAY_MASTERCARD` : `MASTER_CARD`
* `SOLO` : `SOLO`
* `SWITCH` : `SWITCH`
* `MAESTRO` : `MAESTRO`
* `CHINA_UNION_PAY` : `CHINA_UNION_PAY`
* `VISA` : `VISA`
* `VISA_DELTA` : `VISA`
* `VISA_ELECTRON` : `VISA`
* `CARTA_SI` : `VISA`
* `CARTE_BLEUE` : `VISA`
* `VISA_DANKORT` : `VISA`
* `POSTEPAY_VISA_ELECTRON` : `VISA`
* `PAYPAL` :

'brand' with 'Points' payment_type is an enum value with following:
* `EXPEDIA_REWARDS`
* `AMEX_POINTS`
* `BANK_OF_AMERICA_REWARDS`
* `DISCOVER_POINTS`
* `MASTER_CARD_POINTS`
* `CITI_THANK_YOU_POINTS`
* `MERRILL_LYNCH_REWARDS`
* `WELLS_FARGO_POINTS`
* `DELTA_SKY_MILES`
* `UNITED_POINTS`
* `DISCOVER_MILES`
* `ALASKA_MILES`
* `RBC_REWARDS`
* `BILT_REWARDS`
* `ORBUCKS`
* `CHEAP_CASH`
* `BONUS_PLUS`
* `ULTIMATE_REWARDS`

'brand' with 'GiftCard' payment_type is an enum value with following:
* `GIFT_CARD`

'brand' with 'InternetBankPayment' payment_type is an enum value with following:
* `IBP`
* `LOCAL_DEBIT_CARD`
* `SOFORT`
* `YANDEX`
* `WEB_MONEY`
* `QIWI`
* `BITCOIN`

'brand' with 'DirectDebit' payment_type is an enum value with following:
* `ELV`
* `INTER_COMPANY` | +| method | [PaymentMethod](PaymentMethod.md) | True | ... | +| operations | Optional[[Operations](Operations.md)] | False | ... | +| reason | Optional[[PaymentReason](PaymentReason.md)] | False | ... | +| three_digits_secure_criteria | Optional[[PaymentThreeDSCriteria](PaymentThreeDSCriteria.md)] | False | ... | +| verified_amount | Optional[[Amount](Amount.md)] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > PaymentGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentMethod.md b/release/fraudPreventionV2/docs/PaymentMethod.md new file mode 100644 index 00000000..ff3c5a17 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentMethod.md @@ -0,0 +1,47 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentMethod](PaymentMethod.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentMethod` +``` +PaymentMethod( +) +``` + +pydantic model PaymentMethod: The payment method used at the time of purchase for the transaction. Supported `method`'s are: `CREDIT_CARD`, `PAYPAL`, `POINTS`, `GIFT_CARD`, `INTERNET_BANK_PAYMENT`, `DIRECT_DEBIT`. + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------|------|----------|-------------| +| CREDIT_CARD | Any | True | ... | +| DIRECT_DEBIT | Any | True | ... | +| GIFT_CARD | Any | True | ... | +| INTERNET_BANK_PAYMENT | Any | True | ... | +| PAYPAL | Any | True | ... | +| POINTS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > PaymentMethod \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentOperation.md b/release/fraudPreventionV2/docs/PaymentOperation.md new file mode 100644 index 00000000..a3073496 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentOperation.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentOperation](PaymentOperation.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentOperation` +``` +PaymentOperation( + id: Optional[constr(max_length=200)], + amount: Optional[Amount], + outcome: Optional[PaymentOutcome], +) +``` + +pydantic model PaymentOperation + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------|-----------------------------------------------|----------|-------------| +| amount | Optional[[Amount](Amount.md)] | False | ... | +| id | Optional[constr(max_length=200)] | False | ... | +| outcome | Optional[[PaymentOutcome](PaymentOutcome.md)] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > PaymentOperation \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentOutcome.md b/release/fraudPreventionV2/docs/PaymentOutcome.md new file mode 100644 index 00000000..f4d6d7ef --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentOutcome.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentOutcome](PaymentOutcome.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentOutcome` +``` +PaymentOutcome( + status: Optional[PaymentStatus], + code: Optional[constr(max_length=200)], + description: Optional[constr(max_length=200)], +) +``` + +pydantic model PaymentOutcome + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|-------------|---------------------------------------------|----------|-----------------------------------------------------------------------------------| +| code | Optional[constr(max_length=200)] | False | A mnemonic code for the payment processing. | +| description | Optional[constr(max_length=200)] | False | A short description providing additional explanation regarding the mnemonic code. | +| status | Optional[[PaymentStatus](PaymentStatus.md)] | False | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > PaymentOutcome \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentReason.md b/release/fraudPreventionV2/docs/PaymentReason.md new file mode 100644 index 00000000..41279281 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentReason.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentReason](PaymentReason.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentReason` +``` +PaymentReason( +) +``` + +pydantic model PaymentReason: The reason of payment. Possible values: +- `FULL` - If the amount is paid i full for the order +- `DEPOSIT` - The initial payment. Amount to be paid up front. +- `SCHEDULED` - The amount to be payment based on a schedule for the remaining portion of the booking amount. +- `SUBSEQUENT` - An additional amount paid that was not originally scheduled. +- `DEFERRED` + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------|------|----------|-------------| +| DEFERRED | Any | True | ... | +| DEPOSIT | Any | True | ... | +| FULL | Any | True | ... | +| SCHEDULED | Any | True | ... | +| SUBSEQUENT | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > PaymentReason \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentStatus.md b/release/fraudPreventionV2/docs/PaymentStatus.md new file mode 100644 index 00000000..137898b0 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentStatus.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentStatus](PaymentStatus.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentStatus` +``` +PaymentStatus( +) +``` + +pydantic model PaymentStatus: The status of the payment operation. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| COMPLETED | Any | True | ... | +| FAILED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > PaymentStatus \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentThreeDSCriteria.md b/release/fraudPreventionV2/docs/PaymentThreeDSCriteria.md new file mode 100644 index 00000000..311708f9 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentThreeDSCriteria.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentThreeDSCriteria](PaymentThreeDSCriteria.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentThreeDSCriteria` +``` +PaymentThreeDSCriteria( + probable_flag: Optional[bool], + transaction_model: Optional[constr(max_length=200)], +) +``` + +pydantic model PaymentThreeDSCriteria: Payment ThreeDS criteria attributes. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-------------------|----------------------------------|----------|----------------------------------------------------------------------------------------------| +| probable_flag | Optional[bool] | False | This is a flag passed that indicates that this transaction could potentially go through 3DS. | +| transaction_model | Optional[constr(max_length=200)] | False | Model used to process payment transaction. | + + + + + + + + + + +# Inheritance +object > BaseModel > PaymentThreeDSCriteria \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PaymentUpdate.md b/release/fraudPreventionV2/docs/PaymentUpdate.md new file mode 100644 index 00000000..3ebcf9a8 --- /dev/null +++ b/release/fraudPreventionV2/docs/PaymentUpdate.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PaymentUpdate](PaymentUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PaymentUpdate` +``` +PaymentUpdate( + merchant_order_code: constr(max_length=200), + type: Literal["PAYMENT_UPDATE"], +) +``` + +pydantic model PaymentUpdate: Payment related data that should be updated. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| merchant_order_code | constr(max_length=200) | True | Reference code passed to acquiring bank at the time of payment. This code is the key ID that ties back to payments data at the payment level. | +| type | Literal["PAYMENT_UPDATE"] | True | ... | + + + + + + + + + + +# Inheritance +object > [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) > PaymentUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/PlacementName.md b/release/fraudPreventionV2/docs/PlacementName.md new file mode 100644 index 00000000..7b111d3e --- /dev/null +++ b/release/fraudPreventionV2/docs/PlacementName.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [PlacementName](PlacementName.md) +# class `expediagroup.sdk.fraudpreventionv2.model.PlacementName` +``` +PlacementName( +) +``` + +pydantic model PlacementName: The categorized name of the page where a user initiated event is being evaluated. +- `LOGIN` - Applicable if the user initiated this account event from a login web page. +- `PASSWORD_RESET` - Applicable if the user initiated this account event from a password reset web page. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------------|------|----------|-------------| +| LOGIN | Any | True | ... | +| PASSWORD_RESET | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > PlacementName \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Points.md b/release/fraudPreventionV2/docs/Points.md new file mode 100644 index 00000000..b9f2ea2e --- /dev/null +++ b/release/fraudPreventionV2/docs/Points.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Points](Points.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Points` +``` +Points( + account_id: constr(max_length=200), + method: Literal["POINTS"], +) +``` + +pydantic model Points + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|------------|------------------------|----------|--------------------| +| account_id | constr(max_length=200) | True | Points account id. | +| method | Literal["POINTS"] | True | ... | + + + + + + + + + + +# Inheritance +object > [PaymentGeneric](PaymentGeneric.md) > Points \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Rail.md b/release/fraudPreventionV2/docs/Rail.md new file mode 100644 index 00000000..aaf68df3 --- /dev/null +++ b/release/fraudPreventionV2/docs/Rail.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Rail](Rail.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Rail` +``` +Rail( + route_type: RouteType, + rail_segments: list[RailSegments], + type: Literal["RAIL"], +) +``` + +pydantic model Rail + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------------|---------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| rail_segments | list[[RailSegments](RailSegments.md)] | True | ... | +| route_type | [RouteType](RouteType.md) | True | The type of route or itinerary for the Rail product, indicating the travel arrangement and pattern. Possible values are:
- `MULTIPLE_DESTINATIONS` - The Rail product includes multiple destinations in its itinerary.
- `ONE_WAY` - The Rail product represents a one-way journey.
- `ROUNDTRIP` - The Rail product represents a roundtrip journey. | +| type | Literal["RAIL"] | True | ... | + + + + + + + + + + +# Inheritance +object > [TravelProductGeneric](TravelProductGeneric.md) > Rail \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RailSegments.md b/release/fraudPreventionV2/docs/RailSegments.md new file mode 100644 index 00000000..1eff6329 --- /dev/null +++ b/release/fraudPreventionV2/docs/RailSegments.md @@ -0,0 +1,53 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RailSegments](RailSegments.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RailSegments` +``` +RailSegments( + departure_time: datetime, + arrival_time: datetime, + departure_station: RailwayStationDetails, + arrival_station: RailwayStationDetails, + transportation_method: TransportationMethod, + operating_company: Optional[OperatingCompany], +) +``` + +pydantic model RailSegments + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------|---------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| arrival_station | [RailwayStationDetails](RailwayStationDetails.md) | True | ... | +| arrival_time | datetime | True | The local date and time of the scheduled arrival at the destination station, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| departure_station | [RailwayStationDetails](RailwayStationDetails.md) | True | ... | +| departure_time | datetime | True | The local date and time of the scheduled departure from the departure station, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| operating_company | Optional[[OperatingCompany](OperatingCompany.md)] | False | This attribute captures the name or identifier of the company responsible for operating the Rail product. It represents the specific operating entity, such as Amtrak, British Railways, or a bus company. | +| transportation_method | [TransportationMethod](TransportationMethod.md) | True | This attribute represents the specific transportation method by which the passenger is traveling. It captures the mode of transportation used during the Rail product journey, Possible values are:
- `BUS` - The Rail product includes bus transportation for certain segments of the itinerary.
- `FERRY` - The Rail product involves ferry transportation as part of the journey.
- `PUBLIC_TRANSPORT` - The Rail product represents the use of public transportation modes for the journey.
- `TRAM` - The Rail product includes tram transportation as part of the journey.
- `RAIL` - The Rail product specifically utilizes train transportation for the journey.
- `TRANSFER` - The Rail product involves transfers between different modes of transportation.
- `OTHER` - The Rail product utilizes transportation methods not covered by the aforementioned categories. | + + + + + + + + + + +# Inheritance +object > BaseModel > RailSegments \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RailwayStationDetails.md b/release/fraudPreventionV2/docs/RailwayStationDetails.md new file mode 100644 index 00000000..73d27049 --- /dev/null +++ b/release/fraudPreventionV2/docs/RailwayStationDetails.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RailwayStationDetails](RailwayStationDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RailwayStationDetails` +``` +RailwayStationDetails( + name: constr(max_length=200), + type: Optional[Type], + station_code: constr(max_length=200), + address: Address, + timezone: Optional[constr(max_length=200)], +) +``` + +pydantic model RailwayStationDetails + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|--------------|----------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| address | [Address](Address.md) | True | ... | +| name | constr(max_length=200) | True | The popularly known name or title by which the railway station is identified. | +| station_code | constr(max_length=200) | True | The unique identifier or code assigned to an individual rail station or a pseudo-station representing all the stations within a specific city, from which rail travel originates. | +| timezone | Optional[constr(max_length=200)] | False | The timezone associated with the location of the station, specifying the local time offset from Coordinated Universal Time (UTC). | +| type | Optional[[Type](Type.md)] | False | This attribute provides information about the specific classification assigned to the rail station. It helps differentiate between different types of stations, such as major stations (STATION) or stations located within a city (city). | + + + + + + + + + + +# Inheritance +object > BaseModel > RailwayStationDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Refund.md b/release/fraudPreventionV2/docs/Refund.md new file mode 100644 index 00000000..06b71dc2 --- /dev/null +++ b/release/fraudPreventionV2/docs/Refund.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Refund](Refund.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Refund` +``` +Refund( +) +``` + +pydantic model Refund: Refund operation on the payment. A refund operation represents the intent to refund a previous charge. + + + + + + + + + + +# Inheritance +object > [PaymentOperation](PaymentOperation.md) > Refund \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RefundStatus.md b/release/fraudPreventionV2/docs/RefundStatus.md new file mode 100644 index 00000000..4d563a4b --- /dev/null +++ b/release/fraudPreventionV2/docs/RefundStatus.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RefundStatus](RefundStatus.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RefundStatus` +``` +RefundStatus( +) +``` + +pydantic model RefundStatus: Identifies the refund status. Possible values are: +-`ISSUED` - The refund was issued. +-`SETTLED` - The refund was settled. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| ISSUED | Any | True | ... | +| SETTLED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > RefundStatus \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RefundUpdateGeneric.md b/release/fraudPreventionV2/docs/RefundUpdateGeneric.md new file mode 100644 index 00000000..b307b982 --- /dev/null +++ b/release/fraudPreventionV2/docs/RefundUpdateGeneric.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RefundUpdateGeneric](RefundUpdateGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RefundUpdateGeneric` +``` +RefundUpdateGeneric( + refund_status: RefundStatus, + type: Literal["REFUND_UPDATE"], +) +``` + +pydantic model RefundUpdate: Refund related data. Update should be sent when refund is issued or settled. Amounts should include all fees and taxes. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------------|---------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------| +| refund_status | [RefundStatus](RefundStatus.md) | True | Identifies the refund status. Possible values are:
-`ISSUED` - The refund was issued.
-`SETTLED` - The refund was settled. | +| type | Literal["REFUND_UPDATE"] | True | ... | + + + + + + + + + + +# Inheritance +object > [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) > RefundUpdateGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RemediationUpdate.md b/release/fraudPreventionV2/docs/RemediationUpdate.md new file mode 100644 index 00000000..7bf76a1a --- /dev/null +++ b/release/fraudPreventionV2/docs/RemediationUpdate.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RemediationUpdate](RemediationUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RemediationUpdate` +``` +RemediationUpdate( + remediation_update_actions: list[RemediationUpdateAction], + type: Literal["REMEDIATION_UPDATE"], +) +``` + +pydantic model RemediationUpdate: Information specific to remediation actions initiated by the Partner's system to a user as a result of a fraud recommendation. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------------------------|-------------------------------------------------------------|----------|-------------------------------------------------------------------------| +| remediation_update_actions | list[[RemediationUpdateAction](RemediationUpdateAction.md)] | True | ... | +| type | Literal["REMEDIATION_UPDATE"] | True | The categorized type of account update event from the Partner's system. | + + + + + + + + + + +# Inheritance +object > [AccountUpdateRequestGeneric](AccountUpdateRequestGeneric.md) > RemediationUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RemediationUpdateAction.md b/release/fraudPreventionV2/docs/RemediationUpdateAction.md new file mode 100644 index 00000000..ab59b7b3 --- /dev/null +++ b/release/fraudPreventionV2/docs/RemediationUpdateAction.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RemediationUpdateAction](RemediationUpdateAction.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RemediationUpdateAction` +``` +RemediationUpdateAction( + action_name: ActionName, + status: Status2, + update_end_date_time: Optional[datetime], +) +``` + +pydantic model RemediationUpdateAction: Information specific to the remediation action initiated by the Partner's system to a user. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|----------------------|-----------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| action_name | [ActionName](ActionName.md) | True | The categorized remediation action initiated by the Partner''s system to a user. Possible values are:
- `PASSWORD_RESET` - Applicable if this event is the result of a password reset by the Partner''s system.
- `DISABLE_ACCOUNT` - Applicable if this event is the result of disabling an account by the Partner''s system.
- `TERMINATE_ALL_SESSIONS` - Applicable if this event is the result of terminating all active user sessions of an account by the Partner''s system. | +| status | [Status2](Status2.md) | True | The status of the remediation action.
- `SUCCESS` - Applicable if the Partner''s system was successfully able to perform the remediation action.
- `FAILED` - Applicable if the Partner''s system failed to perform the remediation action. | +| update_end_date_time | Optional[datetime] | False | The local date and time the remediation action to a user ended in the Partner's system, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | + + + + + + + + + + +# Inheritance +object > BaseModel > RemediationUpdateAction \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailure.md b/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailure.md new file mode 100644 index 00000000..ec5f6358 --- /dev/null +++ b/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailure.md @@ -0,0 +1,21 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RetryableOrderPurchaseScreenFailure](RetryableOrderPurchaseScreenFailure.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RetryableOrderPurchaseScreenFailure` +``` +RetryableOrderPurchaseScreenFailure( +) +``` + +pydantic model RetryableOrderPurchaseScreenFailure: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success. +There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." + + + + + + + + + + +# Inheritance +object > [Error](Error.md) > RetryableOrderPurchaseScreenFailure \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailureDeserializationContract.md b/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailureDeserializationContract.md new file mode 100644 index 00000000..78b2df3f --- /dev/null +++ b/release/fraudPreventionV2/docs/RetryableOrderPurchaseScreenFailureDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RetryableOrderPurchaseScreenFailureDeserializationContract](RetryableOrderPurchaseScreenFailureDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RetryableOrderPurchaseScreenFailureDeserializationContract` +``` +RetryableOrderPurchaseScreenFailureDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > RetryableOrderPurchaseScreenFailureDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailure.md b/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailure.md new file mode 100644 index 00000000..3b47ac16 --- /dev/null +++ b/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailure.md @@ -0,0 +1,21 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RetryableOrderPurchaseUpdateFailure](RetryableOrderPurchaseUpdateFailure.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RetryableOrderPurchaseUpdateFailure` +``` +RetryableOrderPurchaseUpdateFailure( +) +``` + +pydantic model RetryableOrderPurchaseUpdateFailure: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success. +There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." + + + + + + + + + + +# Inheritance +object > [Error](Error.md) > RetryableOrderPurchaseUpdateFailure \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailureDeserializationContract.md b/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailureDeserializationContract.md new file mode 100644 index 00000000..2497ad50 --- /dev/null +++ b/release/fraudPreventionV2/docs/RetryableOrderPurchaseUpdateFailureDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RetryableOrderPurchaseUpdateFailureDeserializationContract](RetryableOrderPurchaseUpdateFailureDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RetryableOrderPurchaseUpdateFailureDeserializationContract` +``` +RetryableOrderPurchaseUpdateFailureDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > RetryableOrderPurchaseUpdateFailureDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/RouteType.md b/release/fraudPreventionV2/docs/RouteType.md new file mode 100644 index 00000000..ba3b30bc --- /dev/null +++ b/release/fraudPreventionV2/docs/RouteType.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [RouteType](RouteType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.RouteType` +``` +RouteType( +) +``` + +pydantic model RouteType: The type of route or itinerary for the Rail product, indicating the travel arrangement and pattern. Possible values are: +- `MULTIPLE_DESTINATIONS` - The Rail product includes multiple destinations in its itinerary. +- `ONE_WAY` - The Rail product represents a one-way journey. +- `ROUNDTRIP` - The Rail product represents a roundtrip journey. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------|------|----------|-------------| +| MULTIPLE_DESTINATIONS | Any | True | ... | +| ONE_WAY | Any | True | ... | +| ROUND_TRIP | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > RouteType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ServiceUnavailableError.md b/release/fraudPreventionV2/docs/ServiceUnavailableError.md new file mode 100644 index 00000000..f6cb8bb8 --- /dev/null +++ b/release/fraudPreventionV2/docs/ServiceUnavailableError.md @@ -0,0 +1,21 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ServiceUnavailableError](ServiceUnavailableError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ServiceUnavailableError` +``` +ServiceUnavailableError( +) +``` + +pydantic model ServiceUnavailableError: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success. +There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > ServiceUnavailableError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/ServiceUnavailableErrorDeserializationContract.md b/release/fraudPreventionV2/docs/ServiceUnavailableErrorDeserializationContract.md new file mode 100644 index 00000000..f87bfdd9 --- /dev/null +++ b/release/fraudPreventionV2/docs/ServiceUnavailableErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [ServiceUnavailableErrorDeserializationContract](ServiceUnavailableErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.ServiceUnavailableErrorDeserializationContract` +``` +ServiceUnavailableErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > ServiceUnavailableErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/SettledRefundUpdate.md b/release/fraudPreventionV2/docs/SettledRefundUpdate.md new file mode 100644 index 00000000..300fe91b --- /dev/null +++ b/release/fraudPreventionV2/docs/SettledRefundUpdate.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [SettledRefundUpdate](SettledRefundUpdate.md) +# class `expediagroup.sdk.fraudpreventionv2.model.SettledRefundUpdate` +``` +SettledRefundUpdate( + refund_details: Optional[SettledRefundUpdateDetails], + refund_status: Literal["SETTLED"], +) +``` + +pydantic model SettledRefundUpdate: Data related to the settled refund that should be updated. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------------|-----------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------| +| refund_details | Optional[[SettledRefundUpdateDetails](SettledRefundUpdateDetails.md)] | False | ... | +| refund_status | Literal["SETTLED"] | True | Identifies the refund status. Possible values are:
-`ISSUED` - The refund was issued.
-`SETTLED` - The refund was settled. | + + + + + + + + + + +# Inheritance +object > [RefundUpdateGeneric](RefundUpdateGeneric.md) > SettledRefundUpdate \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/SettledRefundUpdateDetails.md b/release/fraudPreventionV2/docs/SettledRefundUpdateDetails.md new file mode 100644 index 00000000..81d19814 --- /dev/null +++ b/release/fraudPreventionV2/docs/SettledRefundUpdateDetails.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [SettledRefundUpdateDetails](SettledRefundUpdateDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.SettledRefundUpdateDetails` +``` +SettledRefundUpdateDetails( + refund_settlement_date_time: datetime, + refund_deposit_date_time: datetime, + acquirer_reference_number: constr(max_length=200), + settlement_id: constr(max_length=200), + refund_settled_amount: Amount, +) +``` + +pydantic model SettledRefundUpdateDetails: Data that describes settled refund that should be updated. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------------------------|------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| acquirer_reference_number | constr(max_length=200) | True | A unique number that tags a credit or debit card transaction when it goes from the merchant's bank through to the cardholder's bank.
Typically, merchants can get this number from their payment processors.
This number is used when dealing with disputes/chargebacks on original transactions. | +| refund_deposit_date_time | datetime | True | Date and time when the refund was deposited to the original form of payment. | +| refund_settled_amount | [Amount](Amount.md) | True | ... | +| refund_settlement_date_time | datetime | True | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has settled at the participating financial institutions. | +| settlement_id | constr(max_length=200) | True | Unique settlement identifier specific to the payment processor for the settlement transaction generated for a previously submitted payment refund. | + + + + + + + + + + +# Inheritance +object > BaseModel > SettledRefundUpdateDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/SiteInfo.md b/release/fraudPreventionV2/docs/SiteInfo.md new file mode 100644 index 00000000..055ac391 --- /dev/null +++ b/release/fraudPreventionV2/docs/SiteInfo.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [SiteInfo](SiteInfo.md) +# class `expediagroup.sdk.fraudpreventionv2.model.SiteInfo` +``` +SiteInfo( + country_code: constr(regex=r"^[A-Z]{3}$"), + agent_assisted: bool, +) +``` + +pydantic model SiteInfo + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|----------------|-----------------------------|----------|---------------------------------------------------------------------------------------------------------------------------| +| agent_assisted | bool | True | Identifies if an agent assisted in booking travel for the customer. `False` if the order was directly booked by customer. | +| country_code | constr(regex=r"^[A-Z]{3}$") | True | The alpha-3 ISO code that represents a country name. | + + + + + + + + + + +# Inheritance +object > BaseModel > SiteInfo \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Status.md b/release/fraudPreventionV2/docs/Status.md new file mode 100644 index 00000000..afb15af1 --- /dev/null +++ b/release/fraudPreventionV2/docs/Status.md @@ -0,0 +1,53 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Status](Status.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Status` +``` +Status( +) +``` + +pydantic model Status: Defines the current state of the Order. +Generally, OrderPurchaseScreenRequest is followed by an OrderUpdate reflecting the change in current order status. From `IN_PROGRESS` to any of below possible values: +* `COMPLETED` is used when the order has been processed fully. For example, inventory has been reserved, and the payment has been settled. +* `CHANGE_COMPLETED` is like `COMPLETED` but on a changed order. +* `CANCELLED` is used when the order is cancelled. This could be acustomer initiated cancel or based on Fraud recommendation. +* `FAILED` is used when order failed due to any errors on Partner system. This could be followed by another OrderUpdate call with any `order_status` once the order is recovered, abandoned, or cancelled. +* `CHANGE_FAILED` is like `FAILED` but on a changed order. +* +* `CHANGE_COMPLETED` or `CHANGE_FAILED` are applicable if OrderPurchaseScreen Fraud API was called via a change in order which is through `transaction.transaction_details.order_type` = `CHANGE` +* `COMPLETED` or `CANCELLED` order status indicates the completion of lifecycle on an order. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------|------|----------|-------------| +| CANCELLED | Any | True | ... | +| CHANGE_COMPLETED | Any | True | ... | +| CHANGE_FAILED | Any | True | ... | +| COMPLETED | Any | True | ... | +| FAILED | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Status \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Status1.md b/release/fraudPreventionV2/docs/Status1.md new file mode 100644 index 00000000..82ca6c94 --- /dev/null +++ b/release/fraudPreventionV2/docs/Status1.md @@ -0,0 +1,41 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Status1](Status1.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Status1` +``` +Status1( +) +``` + +pydantic model Status1: The status of a user''s response to the Multi-Factor Authentication initiated by the Partner''s system to the user.' +- `SUCCESS` - Applicable if the user successfully passed the challenge. +- `ABANDON` - Applicable if the user did not complete the challenge. +- `FAILED` - Applicable if the user failed the challenge. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| ABANDON | Any | True | ... | +| FAILED | Any | True | ... | +| SUCCESS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Status1 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Status2.md b/release/fraudPreventionV2/docs/Status2.md new file mode 100644 index 00000000..5859ad78 --- /dev/null +++ b/release/fraudPreventionV2/docs/Status2.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Status2](Status2.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Status2` +``` +Status2( +) +``` + +pydantic model Status2: The status of the remediation action. +- `SUCCESS` - Applicable if the Partner''s system was successfully able to perform the remediation action. +- `FAILED` - Applicable if the Partner''s system failed to perform the remediation action. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| FAILED | Any | True | ... | +| SUCCESS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Status2 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Status3.md b/release/fraudPreventionV2/docs/Status3.md new file mode 100644 index 00000000..561442f2 --- /dev/null +++ b/release/fraudPreventionV2/docs/Status3.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Status3](Status3.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Status3` +``` +Status3( +) +``` + +pydantic model Status3: The status of the challenge served by the Partner''s system to a user before calling Expedia''s Fraud Prevention Service. +- `SUCCESS` - Applicable if the user successfully passed the challenge. +- `FAILED` - Applicable if the user failed the challenge. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| FAILED | Any | True | ... | +| SUCCESS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Status3 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Telephone.md b/release/fraudPreventionV2/docs/Telephone.md new file mode 100644 index 00000000..fbee64c1 --- /dev/null +++ b/release/fraudPreventionV2/docs/Telephone.md @@ -0,0 +1,65 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Telephone](Telephone.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Telephone` +``` +Telephone( + type: Optional[TelephoneType], + platform_type: Optional[TelephonePlatformType], + country_access_code: constr(regex=r"^[0-9]{1,3}$", max_length=3), + area_code: constr(regex=r"^[0-9]{1,20}$", max_length=20), + phone_number: constr(regex=r"^[0-9]{1,50}$", max_length=50), + extension_number: Optional[constr(regex=r"^[0-9]{1,20}$", max_length=20)], + preference_rank: Optional[float], + last_verified_date_time: Optional[datetime], + verified_flag: Optional[bool], +) +``` + +pydantic model Telephone: Group of attributes intended to hold information about phone number associated with the transaction. A user can have one to many phone numbers (home, work, mobile, etc.). + + + +## Attributes + + + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-------------------------|-------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| area_code | constr(regex=r"^[0-9]{1,20}$", max_length=20) | True | A number prefixed to an individual telephone number: used in making long-distance calls. Does not include symbols, spaces, or leading zeros. | +| country_access_code | constr(regex=r"^[0-9]{1,3}$", max_length=3) | True | Numeric digit between 1 to 3 characters used to represent the country code for international dialing. Does not include symbols, spaces, or leading zeros. | +| extension_number | Optional[constr(regex=r"^[0-9]{1,20}$", max_length=20)] | False | The number used to reach an individual once a phone connection is established. Does not include symbols, spaces, or leading zeros. | +| last_verified_date_time | Optional[datetime] | False | Local date and time user validated possession of their phone number via a text or voice multi factor authentication challenge, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| phone_number | constr(regex=r"^[0-9]{1,50}$", max_length=50) | True | A number that is dialed on a telephone, without the country or area codes, to reach a particular person, business, etc. Does not include symbols, spaces, or leading zeros. | +| platform_type | Optional[[TelephonePlatformType](TelephonePlatformType.md)] | False | ... | +| preference_rank | Optional[float] | False | Ranking of order of user preference for contact via text (if type is Mobile) or voice. `0` means no preference. `1` is the primary phone, `2` is the secondary phone, etc. | +| type | Optional[[TelephoneType](TelephoneType.md)] | False | ... | +| verified_flag | Optional[bool] | False | Flag indicating whether user passed validation of possession of their phone number via a text or voice multi factor authentication challenge. | + + + + + + + + + + +# Inheritance +object > BaseModel > Telephone \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TelephonePlatformType.md b/release/fraudPreventionV2/docs/TelephonePlatformType.md new file mode 100644 index 00000000..7e4ed615 --- /dev/null +++ b/release/fraudPreventionV2/docs/TelephonePlatformType.md @@ -0,0 +1,38 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TelephonePlatformType](TelephonePlatformType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TelephonePlatformType` +``` +TelephonePlatformType( +) +``` + +pydantic model TelephonePlatformType: Classification of the phone platform. + + + +## Attributes + + + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| LANDLINE | Any | True | ... | +| MOBILE | Any | True | ... | +| VOIP | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > TelephonePlatformType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TelephoneType.md b/release/fraudPreventionV2/docs/TelephoneType.md new file mode 100644 index 00000000..58a0fe40 --- /dev/null +++ b/release/fraudPreventionV2/docs/TelephoneType.md @@ -0,0 +1,44 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TelephoneType](TelephoneType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TelephoneType` +``` +TelephoneType( +) +``` + +pydantic model TelephoneType: Classification of the phone (e.g. `Home`, `Mobile`). + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------|------|----------|-------------| +| BUSINESS | Any | True | ... | +| FAX | Any | True | ... | +| HOME | Any | True | ... | +| MOBILE | Any | True | ... | +| OTHER | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > TelephoneType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TooManyRequestsError.md b/release/fraudPreventionV2/docs/TooManyRequestsError.md new file mode 100644 index 00000000..68a6afdb --- /dev/null +++ b/release/fraudPreventionV2/docs/TooManyRequestsError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TooManyRequestsError](TooManyRequestsError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TooManyRequestsError` +``` +TooManyRequestsError( +) +``` + +pydantic model TooManyRequestsError: Indicates that the API cannot fulfill the request because server resources have been exhausted. Perhaps the client has sent too many requests in a given amount of time or has reached some specific quota. Please check the rate limits for the product and adjust as necessary before retries. If you believe the rate limit was incorrect or if you need a different rate limit, please reach out to the regarding the next steps. + + + + + + + + + + +# Inheritance +object > [AccountTakeoverError](AccountTakeoverError.md) > TooManyRequestsError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TooManyRequestsErrorDeserializationContract.md b/release/fraudPreventionV2/docs/TooManyRequestsErrorDeserializationContract.md new file mode 100644 index 00000000..10ba5ea2 --- /dev/null +++ b/release/fraudPreventionV2/docs/TooManyRequestsErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TooManyRequestsErrorDeserializationContract](TooManyRequestsErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TooManyRequestsErrorDeserializationContract` +``` +TooManyRequestsErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > TooManyRequestsErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TransactionDetails.md b/release/fraudPreventionV2/docs/TransactionDetails.md new file mode 100644 index 00000000..9451cc66 --- /dev/null +++ b/release/fraudPreventionV2/docs/TransactionDetails.md @@ -0,0 +1,53 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TransactionDetails](TransactionDetails.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TransactionDetails` +``` +TransactionDetails( + order_id: constr(max_length=50), + current_order_status: CurrentOrderStatus, + order_type: OrderType, + travel_products: list[TravelProduct], + travelers: list[Traveler], + payments: Optional[list[Payment]], +) +``` + +pydantic model TransactionDetails + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| current_order_status | [CurrentOrderStatus](CurrentOrderStatus.md) | True | Status of the order:
* `IN_PROGRESS` is used when order has not processed fully. For example, inventory has not yet been reserved, or payment has not yet been settled.
* `COMPLETED` is used when an order has been processed fully. For example, inventory has been reserved, and the payment has been settled. | +| order_id | constr(max_length=50) | True | Unique identifier assigned to the order by the partner. `order_id` is specific to the partner namespace. | +| order_type | [OrderType](OrderType.md) | True | Type of order. Possible `order_types`.

`CREATE` - Initial type of a brand new order.

`CHANGE` - If a `OrderPurchaseScreenRequest` has already been submitted for the initial booking with `order_type = CREATE`, but has now been modified and partner wishes to resubmit for Fraud screening then the `order_type = CHANGE`. Examples of changes that are supported are changes made to `check-in/checkout dates` or `price of a TravelProduct`. | +| payments | Optional[list[Union[[CreditCard](CreditCard.md), [PayPal](PayPal.md), [Points](Points.md), [GiftCard](GiftCard.md), [InternetBankPayment](InternetBankPayment.md), [DirectDebit](DirectDebit.md), [PaymentGeneric](PaymentGeneric.md)]]] | False | List of the form(s) of payment being used to purchase the order. One or more forms of payment can be used within an order. Information gathered will be specific to the form of payment. | +| travel_products | list[Union[[Rail](Rail.md), [Air](Air.md), [Cruise](Cruise.md), [Car](Car.md), [Hotel](Hotel.md), [Insurance](Insurance.md), [TravelProductGeneric](TravelProductGeneric.md)]] | True | ... | +| travelers | list[[Traveler](Traveler.md)] | True | Individuals who are part of the travel party for the order. At minimum there must be at least `1` traveler. | + + + + + + + + + + +# Inheritance +object > BaseModel > TransactionDetails \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TransportationMethod.md b/release/fraudPreventionV2/docs/TransportationMethod.md new file mode 100644 index 00000000..e5866f26 --- /dev/null +++ b/release/fraudPreventionV2/docs/TransportationMethod.md @@ -0,0 +1,57 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TransportationMethod](TransportationMethod.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TransportationMethod` +``` +TransportationMethod( +) +``` + +pydantic model TransportationMethod: This attribute represents the specific transportation method by which the passenger is traveling. It captures the mode of transportation used during the Rail product journey, Possible values are: +- `BUS` - The Rail product includes bus transportation for certain segments of the itinerary. +- `FERRY` - The Rail product involves ferry transportation as part of the journey. +- `PUBLIC_TRANSPORT` - The Rail product represents the use of public transportation modes for the journey. +- `TRAM` - The Rail product includes tram transportation as part of the journey. +- `RAIL` - The Rail product specifically utilizes train transportation for the journey. +- `TRANSFER` - The Rail product involves transfers between different modes of transportation. +- `OTHER` - The Rail product utilizes transportation methods not covered by the aforementioned categories. + + + +## Attributes + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------------|------|----------|-------------| +| BUS | Any | True | ... | +| FERRY | Any | True | ... | +| OTHERS | Any | True | ... | +| PUBLIC_TRANSPORT | Any | True | ... | +| RAIL | Any | True | ... | +| TRAM | Any | True | ... | +| TRANSFER | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > TransportationMethod \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TravelProductGeneric.md b/release/fraudPreventionV2/docs/TravelProductGeneric.md new file mode 100644 index 00000000..6f00ecfa --- /dev/null +++ b/release/fraudPreventionV2/docs/TravelProductGeneric.md @@ -0,0 +1,59 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TravelProductGeneric](TravelProductGeneric.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TravelProductGeneric` +``` +TravelProductGeneric( + price: Amount, + type: TravelProductType, + inventory_type: constr(max_length=30), + inventory_source: InventorySource, + travelers_references: Optional[list[constr(max_length=50)]], + pay_later: Optional[bool], +) +``` + +pydantic model TravelProduct: The `type` field value is used as a discriminator, with the following mapping: +* `CRUISE`: `Cruise` +* `AIR`: `Air` +* `CAR`: `Car` +* `INSURANCE`: `Insurance` +* `HOTEL`: `Hotel` +* `RAIL`: `Rail` + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|----------------------|-------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| inventory_source | [InventorySource](InventorySource.md) | True | Identifies the business model through which the supply is being sold. Merchant/Agency.
* `MERCHANT` is used when Partner is the merchant of record for this order.
* `AGENCY` is used when this order is through an agency booking. | +| inventory_type | constr(max_length=30) | True | Type of inventory.
Ensure attributes mentioned in dictionary below are set to corresponding values only.
`inventory_type` has the following mapping with TravelProduct `type` attribute:
* inventory_type : type
* ------------------------------------------------------
* `Cruise` : `CRUISE`
* `Air` : `AIR`
* `Car` : `CAR`
* `Insurance` : `INSURANCE`
* `Hotel` : `HOTEL`
* `Rail` : `RAIL` | +| pay_later | Optional[bool] | False | The attribute serves as a boolean indicator that significantly influences the handling of payment information during the fraud prevention process:
* When 'pay_later' is set to 'true':
- This configuration signals that payment information is optional for the booking. Travelers are given the choice to defer payment until they arrive at the rental counter following the completion of the booking.
- It is imperative for partners to explicitly set this attribute to 'true' when payment information can be optional for a particular booking scenario.
* When 'pay_later' is set to 'false':
- In this mode, the attribute mandates the inclusion of payment information during the order purchase screen request. Travelers are required to provide payment details.
- Partners must exercise caution and ensure they supply the necessary payment information, as failure to do so in cases where 'pay_later' is set to 'false' will result in a 'Bad Request' error. This error helps maintain the consistency and accuracy of the fraud prevention process and payment handling. | +| price | [Amount](Amount.md) | True | ... | +| travelers_references | Optional[list[constr(max_length=50)]] | False | List of travelerGuids who are part of the traveling party on the order for the product.
Information for each product and its required travelers should be provided in the API request.
If the product booking does not require accompanying quest information then that does not need to be provided in the API request.
Example:
* For Air products, all travelers' details are required to complete the booking.
* For Hotel products, typically the details on the person checking-in is required.
* For Car products, typically only the primary driver information is required.
If multiple traveler details are in the itinerary, this structure allows to fill up traveler details once in the `travelers` section, and then associate individual products to the respective travelers.
This association is made using `traveler_id` field. A GUID can be generated for each object in the `travelers` section. The same GUID can be provided in the `traveler_references` below.
The `travelers` array should have at least one `traveler` object, and each `traveler` object should have a `traveler_id` which is not necessarily an account id.
Example:
* Travelers
* ------------
* A - GUID1
* B - GUID2
* C - GUID3
*
* Products
* ------------
* Air
* [GUID1, GUID2, GUID3]
* Hotel
* [GUID1]
* Car
* [GUID3]
* Rail
* [GUID2]
* The example above demonstrates the association of travelers with various products.
* All three travelers (A, B, and C) are associated with the Air product.
* Traveler A is associated with the Hotel.
* Traveler C is associated with the Car product.
* Traveler B is associated with the Rail product. | +| type | [TravelProductType](TravelProductType.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > TravelProductGeneric \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TravelProductType.md b/release/fraudPreventionV2/docs/TravelProductType.md new file mode 100644 index 00000000..ce85dd2b --- /dev/null +++ b/release/fraudPreventionV2/docs/TravelProductType.md @@ -0,0 +1,47 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TravelProductType](TravelProductType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TravelProductType` +``` +TravelProductType( +) +``` + +pydantic model TravelProductType: Type of product. + + + +## Attributes + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| AIR | Any | True | ... | +| CAR | Any | True | ... | +| CRUISE | Any | True | ... | +| HOTEL | Any | True | ... | +| INSURANCE | Any | True | ... | +| RAIL | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > TravelProductType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Traveler.md b/release/fraudPreventionV2/docs/Traveler.md new file mode 100644 index 00000000..125e2e08 --- /dev/null +++ b/release/fraudPreventionV2/docs/Traveler.md @@ -0,0 +1,61 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Traveler](Traveler.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Traveler` +``` +Traveler( + traveler_name: Name, + email_address: Optional[EmailStr], + telephones: Optional[list[Telephone]], + primary: bool, + age: Optional[float], + birth_date: Optional[datetime], + citizenship_country_code: Optional[constr(regex=r"^[A-Z]{3}$", min_length=3, max_length=3)], + traveler_id: Optional[constr(max_length=100)], +) +``` + +pydantic model Traveler + + + +## Attributes + + + + + + + + + + + + + + + + + + + +| Name | Type | Required | Description | +|--------------------------|-------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| age | Optional[float] | False | Age of the traveler. | +| birth_date | Optional[datetime] | False | Date of birth for traveler, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| citizenship_country_code | Optional[constr(regex=r"^[A-Z]{3}$", min_length=3, max_length=3)] | False | The alpha-3 ISO country code of the traveler's nationality. | +| email_address | Optional[EmailStr] | False | Email address associated with the traveler as supplied by the partner system. | +| primary | bool | True | Indicator for one of the travelers who is the primary traveler. One traveler in each itinerary item must be listed as primary. By default, for a single traveler this should be set to `true`. | +| telephones | Optional[list[[Telephone](Telephone.md)]] | False | ... | +| traveler_id | Optional[constr(max_length=100)] | False | A unique identifier for travelers in the transaction. | +| traveler_name | [Name](Name.md) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > Traveler \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/TravelersReference.md b/release/fraudPreventionV2/docs/TravelersReference.md new file mode 100644 index 00000000..ad69bc43 --- /dev/null +++ b/release/fraudPreventionV2/docs/TravelersReference.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [TravelersReference](TravelersReference.md) +# class `expediagroup.sdk.fraudpreventionv2.model.TravelersReference` +``` +TravelersReference( + __root__: constr(max_length=50), +) +``` + +pydantic model TravelersReference + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|----------|-----------------------|----------|-------------| +| __root__ | constr(max_length=50) | True | ... | + + + + + + + + + + +# Inheritance +object > BaseModel > TravelersReference \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Type.md b/release/fraudPreventionV2/docs/Type.md new file mode 100644 index 00000000..316277b4 --- /dev/null +++ b/release/fraudPreventionV2/docs/Type.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Type](Type.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Type` +``` +Type( +) +``` + +pydantic model Type: This attribute provides information about the specific classification assigned to the rail station. It helps differentiate between different types of stations, such as major stations (STATION) or stations located within a city (city). + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|---------|------|----------|-------------| +| CITY | Any | True | ... | +| STATION | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Type \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Type1.md b/release/fraudPreventionV2/docs/Type1.md new file mode 100644 index 00000000..5770a6d5 --- /dev/null +++ b/release/fraudPreventionV2/docs/Type1.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Type1](Type1.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Type1` +``` +Type1( +) +``` + +pydantic model Type1: The categorized type of account update event from the Partner's system. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|------------------------------------|------|----------|-------------| +| MULTI_FACTOR_AUTHENTICATION_UPDATE | Any | True | ... | +| REMEDIATION_UPDATE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Type1 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Type2.md b/release/fraudPreventionV2/docs/Type2.md new file mode 100644 index 00000000..d8bce6bf --- /dev/null +++ b/release/fraudPreventionV2/docs/Type2.md @@ -0,0 +1,49 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Type2](Type2.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Type2` +``` +Type2( +) +``` + +pydantic model Type2: The categorized type of device used by a user. Possible values are: +- `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer. +- `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone. +- `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet. +- `PHONE_APP` - Applicable if the user initiated this event from an app on a phone. +- `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|------------|------|----------|-------------| +| PHONE_APP | Any | True | ... | +| PHONE_WEB | Any | True | ... | +| TABLET_APP | Any | True | ... | +| TABLET_WEB | Any | True | ... | +| WEBSITE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Type2 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Type3.md b/release/fraudPreventionV2/docs/Type3.md new file mode 100644 index 00000000..6dadbe88 --- /dev/null +++ b/release/fraudPreventionV2/docs/Type3.md @@ -0,0 +1,32 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Type3](Type3.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Type3` +``` +Type3( +) +``` + +pydantic model Type3: The categorized type of account event related to a user's action. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|-------|------|----------|-------------| +| LOGIN | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Type3 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Type4.md b/release/fraudPreventionV2/docs/Type4.md new file mode 100644 index 00000000..d48e1e0a --- /dev/null +++ b/release/fraudPreventionV2/docs/Type4.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Type4](Type4.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Type4` +``` +Type4( +) +``` + +pydantic model Type4: The kind of challenge served by the Partner''s system to a user prior to calling Expedia''s Fraud Prevention Service. +- `CAPTCHA` - Applicable if the challenge served by the Partner''s system was a Captcha challenge. +- `TWO_FACTOR` - Applicable if the challenge served by the Partner''s system was a two-factor challenge including (Email verification, One Time Password, Okta, etc). + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|------------|------|----------|-------------| +| CAPTCHA | Any | True | ... | +| TWO_FACTOR | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > Type4 \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/UnauthorizedError.md b/release/fraudPreventionV2/docs/UnauthorizedError.md new file mode 100644 index 00000000..0f77a763 --- /dev/null +++ b/release/fraudPreventionV2/docs/UnauthorizedError.md @@ -0,0 +1,20 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [UnauthorizedError](UnauthorizedError.md) +# class `expediagroup.sdk.fraudpreventionv2.model.UnauthorizedError` +``` +UnauthorizedError( +) +``` + +pydantic model UnauthorizedError: Indicates that the token sent in the 'Authorization' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. + + + + + + + + + + +# Inheritance +object > [Error](Error.md) > UnauthorizedError \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/UnauthorizedErrorDeserializationContract.md b/release/fraudPreventionV2/docs/UnauthorizedErrorDeserializationContract.md new file mode 100644 index 00000000..134ed89f --- /dev/null +++ b/release/fraudPreventionV2/docs/UnauthorizedErrorDeserializationContract.md @@ -0,0 +1,37 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [UnauthorizedErrorDeserializationContract](UnauthorizedErrorDeserializationContract.md) +# class `expediagroup.sdk.fraudpreventionv2.model.UnauthorizedErrorDeserializationContract` +``` +UnauthorizedErrorDeserializationContract( + exception: type, + model: type, +) +``` + + + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| exception | type | True | ... | +| model | type | True | ... | + + + + + + + + + + +# Inheritance +object > UnauthorizedErrorDeserializationContract \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/UpdateType.md b/release/fraudPreventionV2/docs/UpdateType.md new file mode 100644 index 00000000..c541c21f --- /dev/null +++ b/release/fraudPreventionV2/docs/UpdateType.md @@ -0,0 +1,44 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [UpdateType](UpdateType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.UpdateType` +``` +UpdateType( +) +``` + +pydantic model UpdateType: Transaction type associated with the update event. + + + +## Attributes + + + + + + + + + + + + + +| Name | Type | Required | Description | +|---------------------|------|----------|-------------| +| CHARGEBACK_FEEDBACK | Any | True | ... | +| INSULT_FEEDBACK | Any | True | ... | +| ORDER_UPDATE | Any | True | ... | +| PAYMENT_UPDATE | Any | True | ... | +| REFUND_UPDATE | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > UpdateType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/VerificationType.md b/release/fraudPreventionV2/docs/VerificationType.md new file mode 100644 index 00000000..8c4b1515 --- /dev/null +++ b/release/fraudPreventionV2/docs/VerificationType.md @@ -0,0 +1,35 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [VerificationType](VerificationType.md) +# class `expediagroup.sdk.fraudpreventionv2.model.VerificationType` +``` +VerificationType( +) +``` + +pydantic model VerificationType: The type of the verification used to verify the instrument. If the Card Verfication Value was provided to verify the credit card used for the transaction, `type = CVV`. + + + +## Attributes + + + + + + + +| Name | Type | Required | Description | +|-----------|------|----------|-------------| +| CVV | Any | True | ... | +| field_3DS | Any | True | ... | + + + + + + + + + + +# Inheritance +object > Enum > VerificationType \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/Verify.md b/release/fraudPreventionV2/docs/Verify.md new file mode 100644 index 00000000..f0fb952f --- /dev/null +++ b/release/fraudPreventionV2/docs/Verify.md @@ -0,0 +1,33 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) / [Verify](Verify.md) +# class `expediagroup.sdk.fraudpreventionv2.model.Verify` +``` +Verify( + type: Optional[VerificationType], +) +``` + +pydantic model Verify: A verify operation represents the intent to verify the payment associated with this transaction. + + + +## Attributes + + + + + +| Name | Type | Required | Description | +|------|---------------------------------------------------|----------|-------------| +| type | Optional[[VerificationType](VerificationType.md)] | False | ... | + + + + + + + + + + +# Inheritance +object > [PaymentOperation](PaymentOperation.md) > Verify \ No newline at end of file diff --git a/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.client.md b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.client.md new file mode 100644 index 00000000..83b28acd --- /dev/null +++ b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.client.md @@ -0,0 +1,17 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.client](expediagroup.sdk.fraudpreventionv2.client.md) +# Module expediagroup.sdk.fraudpreventionv2.client + + + + +## Classes + + + + + +| Class | Description | +|-------------------------------------------------------|---------------------------------| +| [FraudPreventionV2Client](FraudPreventionV2Client.md) | Fraud Prevention V2 API Client. | + + diff --git a/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.md b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.md new file mode 100644 index 00000000..d40a16f7 --- /dev/null +++ b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.md @@ -0,0 +1,20 @@ +None +# Module expediagroup.sdk.fraudpreventionv2 + + + +## Submodules + + + + + + +| Module | +|-------------------------------------------------------------------------------------------| +| [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) | +| [expediagroup.sdk.fraudpreventionv2.client](expediagroup.sdk.fraudpreventionv2.client.md) | + + + + diff --git a/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.model.md b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.model.md new file mode 100644 index 00000000..bfc388fd --- /dev/null +++ b/release/fraudPreventionV2/docs/expediagroup.sdk.fraudpreventionv2.model.md @@ -0,0 +1,512 @@ +[index](index.md) / [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) +# Module expediagroup.sdk.fraudpreventionv2.model + + + + +## Classes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +| Class | Description | +|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Code](Code.md) | pydantic model Code: Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| [Error](Error.md) | pydantic model Error: The object used to describe an error, containing both human-readable and machine-readable information. | +| [UnauthorizedError](UnauthorizedError.md) | pydantic model UnauthorizedError: Indicates that the token sent in the 'Authorization' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. | +| [OrderPurchaseUpdateNotFoundError](OrderPurchaseUpdateNotFoundError.md) | pydantic model OrderPurchaseUpdateNotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. | +| [RetryableOrderPurchaseScreenFailure](RetryableOrderPurchaseScreenFailure.md) | pydantic model RetryableOrderPurchaseScreenFailure: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success.
There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." | +| [RetryableOrderPurchaseUpdateFailure](RetryableOrderPurchaseUpdateFailure.md) | pydantic model RetryableOrderPurchaseUpdateFailure: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success.
There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." | +| [Code1](Code1.md) | pydantic model Code1 | +| [Cause](Cause.md) | pydantic model Cause | +| [BadRequestError](BadRequestError.md) | pydantic model BadRequestError: Indicates that a bad request occurred. Typically it is an invalid parameter. | +| [UpdateType](UpdateType.md) | pydantic model UpdateType: Transaction type associated with the update event. | +| [CancellationReason](CancellationReason.md) | pydantic model CancellationReason: Reason of order update cancellation. | +| [RefundStatus](RefundStatus.md) | pydantic model RefundStatus: Identifies the refund status. Possible values are:
-`ISSUED` - The refund was issued.
-`SETTLED` - The refund was settled. | +| [ChargebackStatus](ChargebackStatus.md) | pydantic model ChargebackStatus: Identifies the chargeback status. Possible values are:
-`RECEIVED` - The chargeback was received.
-`REVERSAL` - The chargeback reversal was received. | +| [ChargebackReason](ChargebackReason.md) | pydantic model ChargebackReason: Reason for chargeback which can be `Fraud` or `Non Fraud`. | +| [InsultDetail](InsultDetail.md) | pydantic model InsultDetail: Details related to the insult. | +| [Status](Status.md) | pydantic model Status: Defines the current state of the Order.
Generally, OrderPurchaseScreenRequest is followed by an OrderUpdate reflecting the change in current order status. From `IN_PROGRESS` to any of below possible values:
* `COMPLETED` is used when the order has been processed fully. For example, inventory has been reserved, and the payment has been settled.
* `CHANGE_COMPLETED` is like `COMPLETED` but on a changed order.
* `CANCELLED` is used when the order is cancelled. This could be acustomer initiated cancel or based on Fraud recommendation.
* `FAILED` is used when order failed due to any errors on Partner system. This could be followed by another OrderUpdate call with any `order_status` once the order is recovered, abandoned, or cancelled.
* `CHANGE_FAILED` is like `FAILED` but on a changed order.
*
* `CHANGE_COMPLETED` or `CHANGE_FAILED` are applicable if OrderPurchaseScreen Fraud API was called via a change in order which is through `transaction.transaction_details.order_type` = `CHANGE`
* `COMPLETED` or `CANCELLED` order status indicates the completion of lifecycle on an order. | +| [OrderPurchaseUpdateResponse](OrderPurchaseUpdateResponse.md) | pydantic model OrderPurchaseUpdateResponse | +| [FraudDecision](FraudDecision.md) | pydantic model FraudDecision | +| [SiteInfo](SiteInfo.md) | pydantic model SiteInfo | +| [DeviceDetails](DeviceDetails.md) | pydantic model DeviceDetails | +| [CurrentOrderStatus](CurrentOrderStatus.md) | pydantic model CurrentOrderStatus: Status of the order:
* `IN_PROGRESS` is used when order has not processed fully. For example, inventory has not yet been reserved, or payment has not yet been settled.
* `COMPLETED` is used when an order has been processed fully. For example, inventory has been reserved, and the payment has been settled. | +| [OrderType](OrderType.md) | pydantic model OrderType: Type of order. Possible `order_types`.

`CREATE` - Initial type of a brand new order.

`CHANGE` - If a `OrderPurchaseScreenRequest` has already been submitted for the initial booking with `order_type = CREATE`, but has now been modified and partner wishes to resubmit for Fraud screening then the `order_type = CHANGE`. Examples of changes that are supported are changes made to `check-in/checkout dates` or `price of a TravelProduct`. | +| [AccountType](AccountType.md) | pydantic model AccountType: Identifies if the customer account is known to the client. Possible values are:

-`GUEST` - Applicable if the partner maintains record to distinguish whether the transaction was booked via a guest account.

-`STANDARD` - Default account type. | +| [AddressType](AddressType.md) | pydantic model AddressType | +| [Address](Address.md) | pydantic model Address | +| [InventorySource](InventorySource.md) | pydantic model InventorySource: Identifies the business model through which the supply is being sold. Merchant/Agency.
* `MERCHANT` is used when Partner is the merchant of record for this order.
* `AGENCY` is used when this order is through an agency booking. | +| [TravelersReference](TravelersReference.md) | pydantic model TravelersReference | +| [RouteType](RouteType.md) | pydantic model RouteType: The type of route or itinerary for the Rail product, indicating the travel arrangement and pattern. Possible values are:
- `MULTIPLE_DESTINATIONS` - The Rail product includes multiple destinations in its itinerary.
- `ONE_WAY` - The Rail product represents a one-way journey.
- `ROUNDTRIP` - The Rail product represents a roundtrip journey. | +| [TransportationMethod](TransportationMethod.md) | pydantic model TransportationMethod: This attribute represents the specific transportation method by which the passenger is traveling. It captures the mode of transportation used during the Rail product journey, Possible values are:
- `BUS` - The Rail product includes bus transportation for certain segments of the itinerary.
- `FERRY` - The Rail product involves ferry transportation as part of the journey.
- `PUBLIC_TRANSPORT` - The Rail product represents the use of public transportation modes for the journey.
- `TRAM` - The Rail product includes tram transportation as part of the journey.
- `RAIL` - The Rail product specifically utilizes train transportation for the journey.
- `TRANSFER` - The Rail product involves transfers between different modes of transportation.
- `OTHER` - The Rail product utilizes transportation methods not covered by the aforementioned categories. | +| [OperatingCompany](OperatingCompany.md) | pydantic model OperatingCompany: This attribute captures the name or identifier of the company responsible for operating the Rail product. It represents the specific operating entity, such as Amtrak, British Railways, or a bus company. | +| [Type](Type.md) | pydantic model Type: This attribute provides information about the specific classification assigned to the rail station. It helps differentiate between different types of stations, such as major stations (STATION) or stations located within a city (city). | +| [RailwayStationDetails](RailwayStationDetails.md) | pydantic model RailwayStationDetails | +| [FlightType](FlightType.md) | pydantic model FlightType: Identifies the type of air trip based on the air destinations. | +| [AirSegment](AirSegment.md) | pydantic model AirSegment | +| [HotelAddress](HotelAddress.md) | pydantic model HotelAddress: Address of a hotel. | +| [Brand](Brand.md) | pydantic model Brand: The `brand` field value is the payment brand used for payment on this transaction.
For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only.
Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API.
Incorrect `brand` - `card_type` combination will result in data quality issues and result in degraded risk recommendation.
'brand' is an enum value with the following mapping with CreditCard 'card_type' attribute:
* brand : card_type
* -------------------------------------------------------
* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS`
* `DINERS_CLUB_INTERNATIONAL` : `DINERS_CLUB`
* `BC_CARD` : `DINERS_CLUB`
* `DISCOVER` : `DISCOVER`
* `BC_CARD` : `DISCOVER`
* `DINERS_CLUB_INTERNATIONAL` : `DISCOVER`
* `JCB` : `DISCOVER`
* `JCB` : `JCB`
* `MASTER_CARD` : `MASTER_CARD`
* `MAESTRO` : `MASTER_CARD`
* `POSTEPAY_MASTERCARD` : `MASTER_CARD`
* `SOLO` : `SOLO`
* `SWITCH` : `SWITCH`
* `MAESTRO` : `MAESTRO`
* `CHINA_UNION_PAY` : `CHINA_UNION_PAY`
* `VISA` : `VISA`
* `VISA_DELTA` : `VISA`
* `VISA_ELECTRON` : `VISA`
* `CARTA_SI` : `VISA`
* `CARTE_BLEUE` : `VISA`
* `VISA_DANKORT` : `VISA`
* `POSTEPAY_VISA_ELECTRON` : `VISA`
* `PAYPAL` :

'brand' with 'Points' payment_type is an enum value with following:
* `EXPEDIA_REWARDS`
* `AMEX_POINTS`
* `BANK_OF_AMERICA_REWARDS`
* `DISCOVER_POINTS`
* `MASTER_CARD_POINTS`
* `CITI_THANK_YOU_POINTS`
* `MERRILL_LYNCH_REWARDS`
* `WELLS_FARGO_POINTS`
* `DELTA_SKY_MILES`
* `UNITED_POINTS`
* `DISCOVER_MILES`
* `ALASKA_MILES`
* `RBC_REWARDS`
* `BILT_REWARDS`
* `ORBUCKS`
* `CHEAP_CASH`
* `BONUS_PLUS`
* `ULTIMATE_REWARDS`

'brand' with 'GiftCard' payment_type is an enum value with following:
* `GIFT_CARD`

'brand' with 'InternetBankPayment' payment_type is an enum value with following:
* `IBP`
* `LOCAL_DEBIT_CARD`
* `SOFORT`
* `YANDEX`
* `WEB_MONEY`
* `QIWI`
* `BITCOIN`

'brand' with 'DirectDebit' payment_type is an enum value with following:
* `ELV`
* `INTER_COMPANY` | +| [PaymentThreeDSCriteria](PaymentThreeDSCriteria.md) | pydantic model PaymentThreeDSCriteria: Payment ThreeDS criteria attributes. | +| [PaymentReason](PaymentReason.md) | pydantic model PaymentReason: The reason of payment. Possible values:
- `FULL` - If the amount is paid i full for the order
- `DEPOSIT` - The initial payment. Amount to be paid up front.
- `SCHEDULED` - The amount to be payment based on a schedule for the remaining portion of the booking amount.
- `SUBSEQUENT` - An additional amount paid that was not originally scheduled.
- `DEFERRED` | +| [VerificationType](VerificationType.md) | pydantic model VerificationType: The type of the verification used to verify the instrument. If the Card Verfication Value was provided to verify the credit card used for the transaction, `type = CVV`. | +| [PaymentStatus](PaymentStatus.md) | pydantic model PaymentStatus: The status of the payment operation. | +| [PaymentMethod](PaymentMethod.md) | pydantic model PaymentMethod: The payment method used at the time of purchase for the transaction. Supported `method`'s are: `CREDIT_CARD`, `PAYPAL`, `POINTS`, `GIFT_CARD`, `INTERNET_BANK_PAYMENT`, `DIRECT_DEBIT`. | +| [TravelProductType](TravelProductType.md) | pydantic model TravelProductType: Type of product. | +| [CardType](CardType.md) | pydantic model CardType: The 'card_type' field value is an enum value which is associated with the payment method of the specific payment instrument.
For credit card payment method ensure attributes mentioned in dictionary below are set to corresponding values only.
Ensure to comply with the naming standards provided in below dictionary. For example, some Payment processors use “Japan Credit Bureau” but “JCB” should be used when calling Fraud API.
Incorrect `card_type` - `brand` combination will result in data quality issues and result in degraded risk recommendation.
'card_type' is an enum value with the following mapping with Payment `brand` attribute:
* card_type : brand
* --------------------------------------------------------
* `AMERICAN_EXPRESS` : `AMERICAN_EXPRESS`
* `DINERS_CLUB` : `DINERS_CLUB_INTERNATIONAL`
* `DINERS_CLUB` : `BC_CARD`
* `DISCOVER` : `DISCOVER`
* `DISCOVER` : `BC_CARD`
* `DISCOVER` : `DINERS_CLUB_INTERNATIONAL`
* `DISCOVER` : `JCB`
* `JCB` : `JCB`
* `MASTER_CARD` : `MASTER_CARD`
* `MASTER_CARD` : `MAESTRO`
* `MASTER_CARD` : `POSTEPAY_MASTERCARD`
* `SOLO` : `SOLO`
* `SWITCH` : `SWITCH`
* `MAESTRO` : `MAESTRO`
* `CHINA_UNION_PAY` : `CHINA_UNION_PAY`
* `VISA` : `VISA`
* `VISA` : `VISA_DELTA`
* `VISA` : `VISA_ELECTRON`
* `VISA` : `CARTA_SI`
* `VISA` : `CARTE_BLEUE`
* `VISA` : `VISA_DANKORT`
* `VISA` : `POSTEPAY_VISA_ELECTRON` | +| [Name](Name.md) | pydantic model Name: Group of attributes intended to hold information about a customer or traveler's name for the order. | +| [TelephoneType](TelephoneType.md) | pydantic model TelephoneType: Classification of the phone (e.g. `Home`, `Mobile`). | +| [TelephonePlatformType](TelephonePlatformType.md) | pydantic model TelephonePlatformType: Classification of the phone platform. | +| [Email](Email.md) | pydantic model Email: Group of attributes intended to hold information about email address associated with the transaction. | +| [Amount](Amount.md) | pydantic model Amount | +| [Code2](Code2.md) | pydantic model Code2: Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| [AccountTakeoverError](AccountTakeoverError.md) | pydantic model AccountTakeoverError: The object used to describe an error, containing both human-readable and machine-readable information. | +| [AccountTakeoverUnauthorizedError](AccountTakeoverUnauthorizedError.md) | pydantic model AccountTakeoverUnauthorizedError: Indicates that the token sent in the 'Authorization' header is either invalid or missing. Please check the value in the token field along with the token expiration time before retrying. | +| [AccountUpdateNotFoundError](AccountUpdateNotFoundError.md) | pydantic model AccountUpdateNotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. | +| [ServiceUnavailableError](ServiceUnavailableError.md) | pydantic model ServiceUnavailableError: Indicates that the API is either down for maintenance or overloaded and cannot fulfill the request at the current time. This is a temporary error and retrying the same request after a certain delay could eventually result in success.
There will be a Retry-After HTTP header in API response specifying how long to wait to retry the request. If there is no Retry-After HTTP header then retry can happen immediately. If the error persists after retrying with delay, please reach out to ." | +| [Code3](Code3.md) | pydantic model Code3 | +| [Cause1](Cause1.md) | pydantic model Cause1 | +| [AccountTakeoverBadRequestError](AccountTakeoverBadRequestError.md) | pydantic model AccountTakeoverBadRequestError: Indicates that a bad request occurred. Typically it is an invalid parameter. | +| [Type1](Type1.md) | pydantic model Type1: The categorized type of account update event from the Partner's system. | +| [AccountUpdateRequestGeneric](AccountUpdateRequestGeneric.md) | pydantic model AccountUpdateRequest: The `type` field value is used as a discriminator, with the following mapping:
* `MULTI_FACTOR_AUTHENTICATION_UPDATE`: `MultiFactorAuthenticationUpdate`
* `REMEDIATION_UPDATE`: `RemediationUpdate` | +| [DeliveryMethod](DeliveryMethod.md) | pydantic model DeliveryMethod: The delivery method of the Multi-Factor Authentication to a user. | +| [Status1](Status1.md) | pydantic model Status1: The status of a user''s response to the Multi-Factor Authentication initiated by the Partner''s system to the user.'
- `SUCCESS` - Applicable if the user successfully passed the challenge.
- `ABANDON` - Applicable if the user did not complete the challenge.
- `FAILED` - Applicable if the user failed the challenge. | +| [ActionName](ActionName.md) | pydantic model ActionName: The categorized remediation action initiated by the Partner''s system to a user. Possible values are:
- `PASSWORD_RESET` - Applicable if this event is the result of a password reset by the Partner''s system.
- `DISABLE_ACCOUNT` - Applicable if this event is the result of disabling an account by the Partner''s system.
- `TERMINATE_ALL_SESSIONS` - Applicable if this event is the result of terminating all active user sessions of an account by the Partner''s system. | +| [Status2](Status2.md) | pydantic model Status2: The status of the remediation action.
- `SUCCESS` - Applicable if the Partner''s system was successfully able to perform the remediation action.
- `FAILED` - Applicable if the Partner''s system failed to perform the remediation action. | +| [RemediationUpdateAction](RemediationUpdateAction.md) | pydantic model RemediationUpdateAction: Information specific to the remediation action initiated by the Partner's system to a user. | +| [AccountUpdateResponse](AccountUpdateResponse.md) | pydantic model AccountUpdateResponse | +| [AccountTakeoverFraudDecision](AccountTakeoverFraudDecision.md) | pydantic model AccountTakeoverFraudDecision: Fraud recommendation for an account transaction. A recommendation can be ACCEPT, CHALLENGE, or REJECT.
- `ACCEPT` - Represents an account transaction where the user’’s account activity is accepted.
- `CHALLENGE` - Represents an account transaction that requires additional verification or challenges the user’’s identity (example: CAPTCHA, MULTI_FACTOR_AUTHENTICATION, etc).
- `REJECT` - Represents a suspicious account transaction where the user’’s credentials or their behavior requires us to block the account activity. | +| [PlacementName](PlacementName.md) | pydantic model PlacementName: The categorized name of the page where a user initiated event is being evaluated.
- `LOGIN` - Applicable if the user initiated this account event from a login web page.
- `PASSWORD_RESET` - Applicable if the user initiated this account event from a password reset web page. | +| [AccountTakeoverSiteInfo](AccountTakeoverSiteInfo.md) | pydantic model AccountTakeoverSiteInfo: Information specific to the Partner's website through which a transaction was made. | +| [Type2](Type2.md) | pydantic model Type2: The categorized type of device used by a user. Possible values are:
- `WEBSITE` - Applicable if the user initiated this event from a web browser on a desktop computer.
- `PHONE_WEB` - Applicable if the user initiated this event from a web browser on a phone.
- `TABLET_WEB` - Applicable if the user initiated this event from a web browser on a tablet.
- `PHONE_APP` - Applicable if the user initiated this event from an app on a phone.
- `TABLET_APP` - Applicable if the user initiated this event from an app on a tablet. | +| [AccountTakeoverDeviceDetails](AccountTakeoverDeviceDetails.md) | pydantic model AccountTakeoverDeviceDetails: Information specific to the Partner's device through which a transaction was made. | +| [AccountType1](AccountType1.md) | pydantic model AccountType1: Identifies the account type of a user''s account. Possible values are:
- `INDIVIDUAL` - Applicable if this account is for an individual traveler.
- `BUSINESS` - Applicable if this account is for a business or organization account used by suppliers or Partners. | +| [AccountRole](AccountRole.md) | pydantic model AccountRole: Identifies the account role and associated permissions of a user''s account. Possible values are:
- `USER`: Basic account with no special privileges.
- `MANAGER`: Account with additional privileges, such as the ability to make bookings for others.
- `ADMIN`: Account with higher privileges than a manager, including the ability to grant manager access to other users. | +| [AccountTakeoverName](AccountTakeoverName.md) | pydantic model AccountTakeoverName: Group of attributes intended to hold information about a customer or traveler''s name for the account. | +| [Type3](Type3.md) | pydantic model Type3: The categorized type of account event related to a user's action. | +| [AuthenticationType](AuthenticationType.md) | pydantic model AuthenticationType: The type of login authentication method used by a user.
For `authentication_type` ensure attributes mentioned in dictionary below are set to corresponding values only.
`authentication_type` is an enum value with the following mapping with `authentication_sub_type` attribute:
* authentication_type : authentication_sub_type
* -------------------------------------------------------------------------------
* `CREDENTIALS` : `EMAIL`
* `CREDENTIALS` :
* `PASSWORD_RESET` : `EMAIL`
* `SINGLE_SIGN_ON` : `EMAIL`
* `MULTI_FACTOR_AUTHENTICATION` : `EMAIL`
* `MULTI_FACTOR_AUTHENTICATION` : `PHONE`
* `SOCIAL` : `GOOGLE`
* `SOCIAL` : `FACEBOOK`
* `SOCIAL` : `APPLE` | +| [AuthenticationSubType](AuthenticationSubType.md) | pydantic model AuthenticationSubType: The sub type of login authentication method used by a user.
For `authentication_sub_type` ensure attributes mentioned in dictionary below are set to corresponding values only.
`authentication_sub_type` is an enum value with the following mapping with `authentication_type` attribute:
* authentication_sub_type : authentication_type
* -------------------------------------------------------------------------------
* `EMAIL` : `CREDENTIALS`
* `EMAIL` : `PASSWORD_RESET`
* `EMAIL` : `SINGLE_SIGN_ON`
* `EMAIL` : `MULTI_FACTOR_AUTHENTICATION`
* `PHONE` : `MULTI_FACTOR_AUTHENTICATION`
* `GOOGLE` : `SOCIAL`
* `FACEBOOK` : `SOCIAL`
* `APPLE` : `SOCIAL`
* : `CREDENTIALS` | +| [FailedLoginReason](FailedLoginReason.md) | pydantic model FailedLoginReason: The reason for the failed login attempt in the Partner''s system, related to user failure or Partner''s system failure.
- `INVALID_CREDENTIALS` - Applicable if the user provided invalid login credentials for this login attempt.
- `ACCOUNT_NOT_FOUND` - Applicable if the user attempted to login to an account that doesn't exist.
- `VERIFICATION_FAILED` - Applicable if the user failed the verification for this login, or any authentication exception occured in the Partner system for this login attempt.
- `ACCOUNT_LOCKED` - Applicable if the user attempted to login to an account that is locked. | +| [Type4](Type4.md) | pydantic model Type4: The kind of challenge served by the Partner''s system to a user prior to calling Expedia''s Fraud Prevention Service.
- `CAPTCHA` - Applicable if the challenge served by the Partner''s system was a Captcha challenge.
- `TWO_FACTOR` - Applicable if the challenge served by the Partner''s system was a two-factor challenge including (Email verification, One Time Password, Okta, etc). | +| [Status3](Status3.md) | pydantic model Status3: The status of the challenge served by the Partner''s system to a user before calling Expedia''s Fraud Prevention Service.
- `SUCCESS` - Applicable if the user successfully passed the challenge.
- `FAILED` - Applicable if the user failed the challenge. | +| [ChallengeDetail](ChallengeDetail.md) | pydantic model ChallengeDetail: Information related to challenges initiated by the Partner's system to a user before calling Expedia's Fraud Prevention Service. | +| [ForbiddenError](ForbiddenError.md) | pydantic model ForbiddenError: Indicates that the API cannot fulfill the request because while the client is correctly authenticated, the client doesn't have the permission to execute the specified operation. This error type does not imply that the request is valid, or that the resource against which the operation being performed exists or satisfies other pre-conditions. | +| [NotFoundError](NotFoundError.md) | pydantic model NotFoundError: Indicates that the API cannot find the resource that is either being requested or against which the operation is being performed. Please check the request again to make sure that the request is valid. | +| [TooManyRequestsError](TooManyRequestsError.md) | pydantic model TooManyRequestsError: Indicates that the API cannot fulfill the request because server resources have been exhausted. Perhaps the client has sent too many requests in a given amount of time or has reached some specific quota. Please check the rate limits for the product and adjust as necessary before retries. If you believe the rate limit was incorrect or if you need a different rate limit, please reach out to the regarding the next steps. | +| [InternalServerError](InternalServerError.md) | pydantic model InternalServerError: Indicates that the API encountered an unexpected condition that prevented it from fulfilling the request. Sometimes used as a generic catch-allerror type when no other error types can be used. Retrying the same request will usually result in the same error. Please reach out to support team as next step for this error resolution. | +| [BadGatewayError](BadGatewayError.md) | pydantic model BadGatewayError: Indicates that the server received an invalid response from the upstream server. Causes could be incorrectly configured target server at gateway, EOF exception, incorrectly configured keep-alive timeouts. Please reach out to support team as next step for this error resolution. | +| [GatewayTimeoutError](GatewayTimeoutError.md) | pydantic model GatewayTimeoutError: Indicates that the API gateway has issues completing the request on time. Request can be retried if it is idempotent, If the issue persists, please reach out to support. For non-idempotent requests, please reach out to to know the status of your request before attempting retries. | +| [OrderPurchaseUpdateRequestGeneric](OrderPurchaseUpdateRequestGeneric.md) | pydantic model OrderPurchaseUpdateRequest: The `type` field value is used as a discriminator, with the following mapping:
* `ORDER_UPDATE`: `OrderUpdate`
* `CHARGEBACK_FEEDBACK`: `ChargebackFeedback`
* `INSULT_FEEDBACK`: `InsultFeedback`
* `REFUND_UPDATE`: `RefundUpdate`
* `PAYMENT_UPDATE`: `PaymentUpdate` | +| [OrderUpdate](OrderUpdate.md) | pydantic model OrderUpdate: Order related data that should be updated. | +| [InsultFeedback](InsultFeedback.md) | pydantic model InsultFeedback: Feedback from EG external partners regarding a false positive recommendation that from Fraud Prevention system gave for their customer. | +| [RefundUpdateGeneric](RefundUpdateGeneric.md) | pydantic model RefundUpdate: Refund related data. Update should be sent when refund is issued or settled. Amounts should include all fees and taxes. | +| [IssuedRefundUpdateDetails](IssuedRefundUpdateDetails.md) | pydantic model IssuedRefundUpdateDetails: Data that describes issued refund that should be updated. | +| [SettledRefundUpdateDetails](SettledRefundUpdateDetails.md) | pydantic model SettledRefundUpdateDetails: Data that describes settled refund that should be updated. | +| [PaymentUpdate](PaymentUpdate.md) | pydantic model PaymentUpdate: Payment related data that should be updated. | +| [ChargebackDetail](ChargebackDetail.md) | pydantic model ChargebackDetail: Details related to the chargeback. | +| [OrderPurchaseScreenResponse](OrderPurchaseScreenResponse.md) | pydantic model OrderPurchaseScreenResponse | +| [TravelProductGeneric](TravelProductGeneric.md) | pydantic model TravelProduct: The `type` field value is used as a discriminator, with the following mapping:
* `CRUISE`: `Cruise`
* `AIR`: `Air`
* `CAR`: `Car`
* `INSURANCE`: `Insurance`
* `HOTEL`: `Hotel`
* `RAIL`: `Rail` | +| [RailSegments](RailSegments.md) | pydantic model RailSegments | +| [Air](Air.md) | pydantic model Air | +| [Cruise](Cruise.md) | pydantic model Cruise | +| [Car](Car.md) | pydantic model Car | +| [Hotel](Hotel.md) | pydantic model Hotel | +| [PaymentOutcome](PaymentOutcome.md) | pydantic model PaymentOutcome | +| [Insurance](Insurance.md) | pydantic model Insurance | +| [Telephone](Telephone.md) | pydantic model Telephone: Group of attributes intended to hold information about phone number associated with the transaction. A user can have one to many phone numbers (home, work, mobile, etc.). | +| [MultiFactorAuthenticationAttempt](MultiFactorAuthenticationAttempt.md) | pydantic model MultiFactorAuthenticationAttempt: Information specific to the update event by a user. | +| [RemediationUpdate](RemediationUpdate.md) | pydantic model RemediationUpdate: Information specific to remediation actions initiated by the Partner's system to a user as a result of a fraud recommendation. | +| [AccountScreenResponse](AccountScreenResponse.md) | pydantic model AccountScreenResponse: Response for an account transaction provided by Expedia's Fraud Prevention Service. | +| [AccountTakeoverCustomerAccount](AccountTakeoverCustomerAccount.md) | pydantic model AccountTakeoverCustomerAccount: Information about a user's account. | +| [CurrentUserSession](CurrentUserSession.md) | pydantic model CurrentUserSession: The current user session prior to this transaction, which contains details related to any challenge initiated by the Partner''s system to a user before calling Expedia''s Fraud Prevention Service.
An example is if the Partner''s system sent a Captcha challenge to the user before calling Expedia''s Fraud Prevention Service. | +| [ChargebackFeedback](ChargebackFeedback.md) | pydantic model ChargebackFeedback: Feedback from EG external partners if they receive a chargeback for a false negative recommendation from Fraud Prevention system. | +| [IssuedRefundUpdate](IssuedRefundUpdate.md) | pydantic model IssuedRefundUpdate: Data related to the issued refund that should be updated. | +| [SettledRefundUpdate](SettledRefundUpdate.md) | pydantic model SettledRefundUpdate: Data related to the settled refund that should be updated. | +| [CustomerAccount](CustomerAccount.md) | pydantic model CustomerAccount | +| [Traveler](Traveler.md) | pydantic model Traveler | +| [Rail](Rail.md) | pydantic model Rail | +| [PaymentOperation](PaymentOperation.md) | pydantic model PaymentOperation | +| [MultiFactorAuthenticationUpdate](MultiFactorAuthenticationUpdate.md) | pydantic model MultiFactorAuthenticationUpdate: Information specific to a user's response to a Multi-Factor Authentication initiated by the Partner's system as a result of a fraud recommendation. | +| [AccountTakeoverTransactionDetailsGeneric](AccountTakeoverTransactionDetailsGeneric.md) | pydantic model AccountTakeoverTransactionDetails: The `transaction_type` field value is used as a discriminator, with the following mapping:
* `LOGIN`: `LoginTransactionDetails` | +| [LoginTransactionDetails](LoginTransactionDetails.md) | pydantic model LoginTransactionDetails | +| [Verify](Verify.md) | pydantic model Verify: A verify operation represents the intent to verify the payment associated with this transaction. | +| [Authorize](Authorize.md) | pydantic model Authorize: Authorize operation on the payment. An authorize operation represents placing the funds on hold with the specified form of payment. | +| [AuthorizeReversal](AuthorizeReversal.md) | pydantic model AuthorizeReversal: Authorize Reversal operation on the payment. An authorize reversal operation represents a notification received usually from a 3rd party payment processor to indicate that an authorization hold should be released as a result of a sale being partially or completely cancelled. | +| [Capture](Capture.md) | pydantic model Capture: Capture operation on the payment. A capture operation represents a notification received usually from a 3rd party payment processor to indicate that the funds placed on hold will be captured and the funds transfer process will occur from the customer's funds to the merchant's funds. | +| [Refund](Refund.md) | pydantic model Refund: Refund operation on the payment. A refund operation represents the intent to refund a previous charge. | +| [AccountTransaction](AccountTransaction.md) | pydantic model AccountTransaction: Information for an account transaction. | +| [Operations](Operations.md) | pydantic model Operations: All operations related to a payment throughout its lifespan. An operation represents an event external to Fraud Prevention Service that specifies to perform a payment operation. Possible operation types include:

- `Verify`

- `Authorize`

- `AuthorizeReversal`

- `Capture`

- `Refund` | +| [AccountScreenRequest](AccountScreenRequest.md) | pydantic model AccountScreenRequest: Information for account screening by Expedia's Fraud Prevention Service. | +| [PaymentGeneric](PaymentGeneric.md) | pydantic model Payment: The `method` field value is used as a discriminator, with the following mapping:
* `CREDIT_CARD`: `CreditCard`
* `PAYPAL`: `PayPal`
* `POINTS`: `Points`
* `GIFT_CARD`: `GiftCard`
* `INTERNET_BANK_PAYMENT`: `InternetBankPayment`
* `DIRECT_DEBIT`: `DirectDebit` | +| [CreditCard](CreditCard.md) | pydantic model CreditCard | +| [PayPal](PayPal.md) | pydantic model PayPal | +| [Points](Points.md) | pydantic model Points | +| [GiftCard](GiftCard.md) | pydantic model GiftCard | +| [InternetBankPayment](InternetBankPayment.md) | pydantic model InternetBankPayment | +| [DirectDebit](DirectDebit.md) | pydantic model DirectDebit | +| [TransactionDetails](TransactionDetails.md) | pydantic model TransactionDetails | +| [OrderPurchaseTransaction](OrderPurchaseTransaction.md) | pydantic model OrderPurchaseTransaction | +| [OrderPurchaseScreenRequest](OrderPurchaseScreenRequest.md) | pydantic model OrderPurchaseScreenRequest | +| [ExpediaGroupAccountTakeoverBadRequestErrorException](ExpediaGroupAccountTakeoverBadRequestErrorException.md) | Exception wrapping a AccountTakeoverBadRequestError object. | +| [ExpediaGroupAccountUpdateNotFoundErrorException](ExpediaGroupAccountUpdateNotFoundErrorException.md) | Exception wrapping a AccountUpdateNotFoundError object. | +| [ExpediaGroupOrderPurchaseUpdateNotFoundErrorException](ExpediaGroupOrderPurchaseUpdateNotFoundErrorException.md) | Exception wrapping a OrderPurchaseUpdateNotFoundError object. | +| [ExpediaGroupAccountTakeoverUnauthorizedErrorException](ExpediaGroupAccountTakeoverUnauthorizedErrorException.md) | Exception wrapping a AccountTakeoverUnauthorizedError object. | +| [ExpediaGroupUnauthorizedErrorException](ExpediaGroupUnauthorizedErrorException.md) | Exception wrapping a UnauthorizedError object. | +| [ExpediaGroupNotFoundErrorException](ExpediaGroupNotFoundErrorException.md) | Exception wrapping a NotFoundError object. | +| [ExpediaGroupBadGatewayErrorException](ExpediaGroupBadGatewayErrorException.md) | Exception wrapping a BadGatewayError object. | +| [ExpediaGroupRetryableOrderPurchaseUpdateFailureException](ExpediaGroupRetryableOrderPurchaseUpdateFailureException.md) | Exception wrapping a RetryableOrderPurchaseUpdateFailure object. | +| [ExpediaGroupServiceUnavailableErrorException](ExpediaGroupServiceUnavailableErrorException.md) | Exception wrapping a ServiceUnavailableError object. | +| [ExpediaGroupForbiddenErrorException](ExpediaGroupForbiddenErrorException.md) | Exception wrapping a ForbiddenError object. | +| [ExpediaGroupTooManyRequestsErrorException](ExpediaGroupTooManyRequestsErrorException.md) | Exception wrapping a TooManyRequestsError object. | +| [ExpediaGroupGatewayTimeoutErrorException](ExpediaGroupGatewayTimeoutErrorException.md) | Exception wrapping a GatewayTimeoutError object. | +| [ExpediaGroupInternalServerErrorException](ExpediaGroupInternalServerErrorException.md) | Exception wrapping a InternalServerError object. | +| [ExpediaGroupBadRequestErrorException](ExpediaGroupBadRequestErrorException.md) | Exception wrapping a BadRequestError object. | +| [ExpediaGroupRetryableOrderPurchaseScreenFailureException](ExpediaGroupRetryableOrderPurchaseScreenFailureException.md) | Exception wrapping a RetryableOrderPurchaseScreenFailure object. | +| [AccountTakeoverBadRequestErrorDeserializationContract](AccountTakeoverBadRequestErrorDeserializationContract.md) | | +| [AccountUpdateNotFoundErrorDeserializationContract](AccountUpdateNotFoundErrorDeserializationContract.md) | | +| [OrderPurchaseUpdateNotFoundErrorDeserializationContract](OrderPurchaseUpdateNotFoundErrorDeserializationContract.md) | | +| [AccountTakeoverUnauthorizedErrorDeserializationContract](AccountTakeoverUnauthorizedErrorDeserializationContract.md) | | +| [UnauthorizedErrorDeserializationContract](UnauthorizedErrorDeserializationContract.md) | | +| [NotFoundErrorDeserializationContract](NotFoundErrorDeserializationContract.md) | | +| [BadGatewayErrorDeserializationContract](BadGatewayErrorDeserializationContract.md) | | +| [RetryableOrderPurchaseUpdateFailureDeserializationContract](RetryableOrderPurchaseUpdateFailureDeserializationContract.md) | | +| [ServiceUnavailableErrorDeserializationContract](ServiceUnavailableErrorDeserializationContract.md) | | +| [ForbiddenErrorDeserializationContract](ForbiddenErrorDeserializationContract.md) | | +| [TooManyRequestsErrorDeserializationContract](TooManyRequestsErrorDeserializationContract.md) | | +| [GatewayTimeoutErrorDeserializationContract](GatewayTimeoutErrorDeserializationContract.md) | | +| [InternalServerErrorDeserializationContract](InternalServerErrorDeserializationContract.md) | | +| [BadRequestErrorDeserializationContract](BadRequestErrorDeserializationContract.md) | | +| [RetryableOrderPurchaseScreenFailureDeserializationContract](RetryableOrderPurchaseScreenFailureDeserializationContract.md) | | + + diff --git a/release/fraudPreventionV2/docs/index.md b/release/fraudPreventionV2/docs/index.md new file mode 100644 index 00000000..fd35e655 --- /dev/null +++ b/release/fraudPreventionV2/docs/index.md @@ -0,0 +1,17 @@ +[index](index.md) +# fraudpreventionv2 + +## Modules + + + + + + + +| Module | +|-------------------------------------------------------------------------------------------| +| [expediagroup.sdk.fraudpreventionv2.model](expediagroup.sdk.fraudpreventionv2.model.md) | +| [expediagroup.sdk.fraudpreventionv2.client](expediagroup.sdk.fraudpreventionv2.client.md) | + + diff --git a/release/fraudPreventionV2/__init__.py b/release/fraudPreventionV2/src/__init__.py similarity index 100% rename from release/fraudPreventionV2/__init__.py rename to release/fraudPreventionV2/src/__init__.py diff --git a/release/fraudPreventionV2/client.py b/release/fraudPreventionV2/src/client.py similarity index 100% rename from release/fraudPreventionV2/client.py rename to release/fraudPreventionV2/src/client.py diff --git a/release/fraudPreventionV2/model.py b/release/fraudPreventionV2/src/model.py similarity index 100% rename from release/fraudPreventionV2/model.py rename to release/fraudPreventionV2/src/model.py index 1e52637c..a75c4236 100644 --- a/release/fraudPreventionV2/model.py +++ b/release/fraudPreventionV2/src/model.py @@ -2929,13 +2929,13 @@ class OrderPurchaseScreenRequest( OrderPurchaseScreenRequest.update_forward_refs() -class ExpediaGroupRetryableOrderPurchaseScreenFailureException(ExpediaGroupApiException): - r"""Exception wrapping a RetryableOrderPurchaseScreenFailure object.""" +class ExpediaGroupAccountTakeoverBadRequestErrorException(ExpediaGroupApiException): + r"""Exception wrapping a AccountTakeoverBadRequestError object.""" pass -class ExpediaGroupNotFoundErrorException(ExpediaGroupApiException): - r"""Exception wrapping a NotFoundError object.""" +class ExpediaGroupAccountUpdateNotFoundErrorException(ExpediaGroupApiException): + r"""Exception wrapping a AccountUpdateNotFoundError object.""" pass @@ -2944,23 +2944,28 @@ class ExpediaGroupOrderPurchaseUpdateNotFoundErrorException(ExpediaGroupApiExcep pass -class ExpediaGroupInternalServerErrorException(ExpediaGroupApiException): - r"""Exception wrapping a InternalServerError object.""" +class ExpediaGroupAccountTakeoverUnauthorizedErrorException(ExpediaGroupApiException): + r"""Exception wrapping a AccountTakeoverUnauthorizedError object.""" pass -class ExpediaGroupAccountTakeoverBadRequestErrorException(ExpediaGroupApiException): - r"""Exception wrapping a AccountTakeoverBadRequestError object.""" +class ExpediaGroupUnauthorizedErrorException(ExpediaGroupApiException): + r"""Exception wrapping a UnauthorizedError object.""" pass -class ExpediaGroupUnauthorizedErrorException(ExpediaGroupApiException): - r"""Exception wrapping a UnauthorizedError object.""" +class ExpediaGroupNotFoundErrorException(ExpediaGroupApiException): + r"""Exception wrapping a NotFoundError object.""" pass -class ExpediaGroupGatewayTimeoutErrorException(ExpediaGroupApiException): - r"""Exception wrapping a GatewayTimeoutError object.""" +class ExpediaGroupBadGatewayErrorException(ExpediaGroupApiException): + r"""Exception wrapping a BadGatewayError object.""" + pass + + +class ExpediaGroupRetryableOrderPurchaseUpdateFailureException(ExpediaGroupApiException): + r"""Exception wrapping a RetryableOrderPurchaseUpdateFailure object.""" pass @@ -2974,46 +2979,41 @@ class ExpediaGroupForbiddenErrorException(ExpediaGroupApiException): pass -class ExpediaGroupAccountUpdateNotFoundErrorException(ExpediaGroupApiException): - r"""Exception wrapping a AccountUpdateNotFoundError object.""" - pass - - class ExpediaGroupTooManyRequestsErrorException(ExpediaGroupApiException): r"""Exception wrapping a TooManyRequestsError object.""" pass -class ExpediaGroupBadGatewayErrorException(ExpediaGroupApiException): - r"""Exception wrapping a BadGatewayError object.""" +class ExpediaGroupGatewayTimeoutErrorException(ExpediaGroupApiException): + r"""Exception wrapping a GatewayTimeoutError object.""" pass -class ExpediaGroupBadRequestErrorException(ExpediaGroupApiException): - r"""Exception wrapping a BadRequestError object.""" +class ExpediaGroupInternalServerErrorException(ExpediaGroupApiException): + r"""Exception wrapping a InternalServerError object.""" pass -class ExpediaGroupRetryableOrderPurchaseUpdateFailureException(ExpediaGroupApiException): - r"""Exception wrapping a RetryableOrderPurchaseUpdateFailure object.""" +class ExpediaGroupBadRequestErrorException(ExpediaGroupApiException): + r"""Exception wrapping a BadRequestError object.""" pass -class ExpediaGroupAccountTakeoverUnauthorizedErrorException(ExpediaGroupApiException): - r"""Exception wrapping a AccountTakeoverUnauthorizedError object.""" +class ExpediaGroupRetryableOrderPurchaseScreenFailureException(ExpediaGroupApiException): + r"""Exception wrapping a RetryableOrderPurchaseScreenFailure object.""" pass @dataclass -class RetryableOrderPurchaseScreenFailureDeserializationContract: - exception: type = ExpediaGroupRetryableOrderPurchaseScreenFailureException - model: type = RetryableOrderPurchaseScreenFailure +class AccountTakeoverBadRequestErrorDeserializationContract: + exception: type = ExpediaGroupAccountTakeoverBadRequestErrorException + model: type = AccountTakeoverBadRequestError @dataclass -class NotFoundErrorDeserializationContract: - exception: type = ExpediaGroupNotFoundErrorException - model: type = NotFoundError +class AccountUpdateNotFoundErrorDeserializationContract: + exception: type = ExpediaGroupAccountUpdateNotFoundErrorException + model: type = AccountUpdateNotFoundError @dataclass @@ -3023,15 +3023,9 @@ class OrderPurchaseUpdateNotFoundErrorDeserializationContract: @dataclass -class InternalServerErrorDeserializationContract: - exception: type = ExpediaGroupInternalServerErrorException - model: type = InternalServerError - - -@dataclass -class AccountTakeoverBadRequestErrorDeserializationContract: - exception: type = ExpediaGroupAccountTakeoverBadRequestErrorException - model: type = AccountTakeoverBadRequestError +class AccountTakeoverUnauthorizedErrorDeserializationContract: + exception: type = ExpediaGroupAccountTakeoverUnauthorizedErrorException + model: type = AccountTakeoverUnauthorizedError @dataclass @@ -3041,9 +3035,21 @@ class UnauthorizedErrorDeserializationContract: @dataclass -class GatewayTimeoutErrorDeserializationContract: - exception: type = ExpediaGroupGatewayTimeoutErrorException - model: type = GatewayTimeoutError +class NotFoundErrorDeserializationContract: + exception: type = ExpediaGroupNotFoundErrorException + model: type = NotFoundError + + +@dataclass +class BadGatewayErrorDeserializationContract: + exception: type = ExpediaGroupBadGatewayErrorException + model: type = BadGatewayError + + +@dataclass +class RetryableOrderPurchaseUpdateFailureDeserializationContract: + exception: type = ExpediaGroupRetryableOrderPurchaseUpdateFailureException + model: type = RetryableOrderPurchaseUpdateFailure @dataclass @@ -3058,12 +3064,6 @@ class ForbiddenErrorDeserializationContract: model: type = ForbiddenError -@dataclass -class AccountUpdateNotFoundErrorDeserializationContract: - exception: type = ExpediaGroupAccountUpdateNotFoundErrorException - model: type = AccountUpdateNotFoundError - - @dataclass class TooManyRequestsErrorDeserializationContract: exception: type = ExpediaGroupTooManyRequestsErrorException @@ -3071,24 +3071,24 @@ class TooManyRequestsErrorDeserializationContract: @dataclass -class BadGatewayErrorDeserializationContract: - exception: type = ExpediaGroupBadGatewayErrorException - model: type = BadGatewayError +class GatewayTimeoutErrorDeserializationContract: + exception: type = ExpediaGroupGatewayTimeoutErrorException + model: type = GatewayTimeoutError @dataclass -class BadRequestErrorDeserializationContract: - exception: type = ExpediaGroupBadRequestErrorException - model: type = BadRequestError +class InternalServerErrorDeserializationContract: + exception: type = ExpediaGroupInternalServerErrorException + model: type = InternalServerError @dataclass -class RetryableOrderPurchaseUpdateFailureDeserializationContract: - exception: type = ExpediaGroupRetryableOrderPurchaseUpdateFailureException - model: type = RetryableOrderPurchaseUpdateFailure +class BadRequestErrorDeserializationContract: + exception: type = ExpediaGroupBadRequestErrorException + model: type = BadRequestError @dataclass -class AccountTakeoverUnauthorizedErrorDeserializationContract: - exception: type = ExpediaGroupAccountTakeoverUnauthorizedErrorException - model: type = AccountTakeoverUnauthorizedError +class RetryableOrderPurchaseScreenFailureDeserializationContract: + exception: type = ExpediaGroupRetryableOrderPurchaseScreenFailureException + model: type = RetryableOrderPurchaseScreenFailure diff --git a/release/fraudPreventionV2/setup.py b/release/fraudPreventionV2/src/setup.py similarity index 96% rename from release/fraudPreventionV2/setup.py rename to release/fraudPreventionV2/src/setup.py index 7ccc4ab1..238e51b5 100644 --- a/release/fraudPreventionV2/setup.py +++ b/release/fraudPreventionV2/src/setup.py @@ -18,7 +18,7 @@ setup( name="expediagroup-fraudpreventionv2-sdk", version="2.1.0", - packages=["expediagroup-fraudpreventionv2-sdk"], + packages=["expediagroup.sdk.fraudpreventionv2"], package_dir={"expediagroup-fraudpreventionv2-sdk": "."}, license="Apache License, Version 2.0", author="Expedia Group", diff --git a/release/fraudPreventionV2/specs.yaml b/release/fraudPreventionV2/src/specs.yaml similarity index 100% rename from release/fraudPreventionV2/specs.yaml rename to release/fraudPreventionV2/src/specs.yaml