From ae39c0f34591a70b4816a78703854a650e34776b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 6 Feb 2024 16:27:04 +0300 Subject: [PATCH] chore: Publish fraudPreventionV2 [4.4.0] SDK (#212) --- .../client/classes/FraudPreventionV2Client.md | 30 +++++------ .../core/classes/AxiosClientConfigurations.md | 30 +++++++++++ .../docs/client/core/classes/Client.md | 7 +++ .../docs/{models => client}/core/index.md | 2 +- .../core/interfaces/ClientConfigurations.md | 13 +++++ .../fraudPreventionV2/docs/client/index.md | 4 ++ .../models/classes/AccountScreenRequest.md | 8 +-- .../models/classes/AccountScreenResponse.md | 10 ++-- .../classes/AccountTakeoverBadRequestError.md | 12 ++--- ...countTakeoverBadRequestErrorAllOfCauses.md | 12 ++--- .../classes/AccountTakeoverCustomerAccount.md | 28 +++++------ .../classes/AccountTakeoverDeviceDetails.md | 16 +++--- .../models/classes/AccountTakeoverError.md | 10 ++-- .../models/classes/AccountTakeoverName.md | 16 +++--- .../models/classes/AccountTakeoverSiteInfo.md | 14 +++--- .../AccountTakeoverTransactionDetails.md | 14 +++--- .../AccountTakeoverUnauthorizedError.md | 10 ++-- .../docs/models/classes/AccountTransaction.md | 14 +++--- .../classes/AccountUpdateNotFoundError.md | 10 ++-- .../models/classes/AccountUpdateRequest.md | 10 ++-- .../models/classes/AccountUpdateResponse.md | 8 +-- .../docs/models/classes/Address.md | 20 ++++---- .../docs/models/classes/Air.md | 30 +++++------ .../docs/models/classes/AirSegment.md | 16 +++--- .../docs/models/classes/Amount.md | 10 ++-- .../docs/models/classes/Authorize.md | 12 ++--- .../docs/models/classes/AuthorizeReversal.md | 12 ++--- .../docs/models/classes/BadGatewayError.md | 10 ++-- .../docs/models/classes/BadRequestError.md | 12 ++--- .../classes/BadRequestErrorAllOfCauses.md | 12 ++--- .../docs/models/classes/CancellationReason.md | 14 +++--- .../docs/models/classes/Capture.md | 12 ++--- .../docs/models/classes/Car.md | 26 +++++----- .../docs/models/classes/ChallengeDetail.md | 12 ++--- .../docs/models/classes/ChargebackDetail.md | 16 +++--- .../docs/models/classes/ChargebackFeedback.md | 12 ++--- .../docs/models/classes/CreditCard.md | 50 +++++++++---------- .../docs/models/classes/Cruise.md | 28 +++++------ .../docs/models/classes/CurrentUserSession.md | 12 ++--- .../docs/models/classes/CustomerAccount.md | 20 ++++---- .../models/classes/CustomerAccountAddress.md | 20 ++++---- .../docs/models/classes/DeviceDetails.md | 12 ++--- .../docs/models/classes/DirectDebit.md | 36 ++++++------- .../docs/models/classes/Email.md | 8 +-- .../docs/models/classes/ForbiddenError.md | 10 ++-- .../models/classes/GatewayTimeoutError.md | 12 ++--- .../docs/models/classes/GiftCard.md | 34 ++++++------- .../docs/models/classes/Hotel.md | 32 ++++++------ .../docs/models/classes/HotelAddress.md | 20 ++++---- .../docs/models/classes/InsultDetail.md | 8 +-- .../docs/models/classes/InsultFeedback.md | 12 ++--- .../docs/models/classes/Insurance.md | 18 +++---- .../models/classes/InternalServerError.md | 10 ++-- .../models/classes/InternetBankPayment.md | 34 ++++++------- .../docs/models/classes/IssuedRefundUpdate.md | 14 +++--- .../classes/IssuedRefundUpdateDetails.md | 10 ++-- .../models/classes/LoginTransactionDetails.md | 22 ++++---- .../docs/models/classes/ModelError.md | 10 ++-- .../MultiFactorAuthenticationAttempt.md | 24 ++++----- .../MultiFactorAuthenticationUpdate.md | 12 ++--- .../docs/models/classes/Name.md | 16 +++--- .../docs/models/classes/NotFoundError.md | 10 ++-- .../docs/models/classes/Operations.md | 16 +++--- .../classes/OrderPurchaseScreenRequest.md | 8 +-- .../classes/OrderPurchaseScreenResponse.md | 10 ++-- .../classes/OrderPurchaseTransaction.md | 14 +++--- .../OrderPurchaseUpdateNotFoundError.md | 10 ++-- .../classes/OrderPurchaseUpdateRequest.md | 10 ++-- .../classes/OrderPurchaseUpdateResponse.md | 8 +-- .../docs/models/classes/OrderUpdate.md | 16 +++--- .../docs/models/classes/PayPal.md | 34 ++++++------- .../docs/models/classes/Payment.md | 28 +++++------ .../models/classes/PaymentBillingAddress.md | 20 ++++---- .../docs/models/classes/PaymentOperation.md | 12 ++--- .../docs/models/classes/PaymentOutcome.md | 12 ++--- .../models/classes/PaymentThreeDSCriteria.md | 10 ++-- .../docs/models/classes/PaymentUpdate.md | 12 ++--- .../docs/models/classes/Points.md | 30 +++++------ .../docs/models/classes/Rail.md | 22 ++++---- .../docs/models/classes/RailSegments.md | 18 +++---- .../classes/RailSegmentsOperatingCompany.md | 8 +-- .../models/classes/RailwayStationDetails.md | 16 +++--- .../docs/models/classes/Refund.md | 12 ++--- .../docs/models/classes/RefundUpdate.md | 10 ++-- .../docs/models/classes/RemediationUpdate.md | 12 ++--- .../models/classes/RemediationUpdateAction.md | 12 ++--- .../RetryableOrderPurchaseScreenFailure.md | 12 ++--- .../RetryableOrderPurchaseUpdateFailure.md | 12 ++--- .../models/classes/ServiceUnavailableError.md | 12 ++--- .../models/classes/SettledRefundUpdate.md | 14 +++--- .../classes/SettledRefundUpdateDetails.md | 16 +++--- .../docs/models/classes/SiteInfo.md | 10 ++-- .../docs/models/classes/Telephone.md | 24 ++++----- .../models/classes/TooManyRequestsError.md | 12 ++--- .../docs/models/classes/TransactionDetails.md | 18 +++---- .../docs/models/classes/TravelProduct.md | 18 +++---- .../docs/models/classes/Traveler.md | 22 ++++---- .../docs/models/classes/UnauthorizedError.md | 10 ++-- .../docs/models/classes/Verify.md | 14 +++--- .../core/classes/AxiosClientConfigurations.md | 30 ----------- .../docs/models/core/classes/Client.md | 7 --- .../core/interfaces/ClientConfigurations.md | 13 ----- .../fraudPreventionV2/docs/models/index.md | 4 -- .../AccountScreenRequestProperties.md | 6 +-- .../AccountScreenResponseProperties.md | 8 +-- ...verBadRequestErrorAllOfCausesProperties.md | 10 ++-- ...ccountTakeoverBadRequestErrorProperties.md | 10 ++-- ...ccountTakeoverCustomerAccountProperties.md | 26 +++++----- .../AccountTakeoverDeviceDetailsProperties.md | 14 +++--- .../AccountTakeoverErrorProperties.md | 8 +-- .../AccountTakeoverNameProperties.md | 14 +++--- .../AccountTakeoverSiteInfoProperties.md | 12 ++--- ...untTakeoverTransactionDetailsProperties.md | 12 ++--- ...ountTakeoverUnauthorizedErrorProperties.md | 8 +-- .../AccountTransactionProperties.md | 12 ++--- .../AccountUpdateNotFoundErrorProperties.md | 8 +-- .../AccountUpdateRequestProperties.md | 8 +-- .../AccountUpdateResponseProperties.md | 6 +-- .../models/interfaces/AddressProperties.md | 18 +++---- .../docs/models/interfaces/AirProperties.md | 26 +++++----- .../models/interfaces/AirSegmentProperties.md | 14 +++--- .../models/interfaces/AmountProperties.md | 8 +-- .../models/interfaces/AuthorizeProperties.md | 10 ++-- .../interfaces/AuthorizeReversalProperties.md | 10 ++-- .../interfaces/BadGatewayErrorProperties.md | 8 +-- .../BadRequestErrorAllOfCausesProperties.md | 10 ++-- .../interfaces/BadRequestErrorProperties.md | 10 ++-- .../CancellationReasonProperties.md | 12 ++--- .../models/interfaces/CaptureProperties.md | 10 ++-- .../docs/models/interfaces/CarProperties.md | 22 ++++---- .../interfaces/ChallengeDetailProperties.md | 10 ++-- .../interfaces/ChargebackDetailProperties.md | 14 +++--- .../ChargebackFeedbackProperties.md | 8 +-- .../models/interfaces/CreditCardProperties.md | 46 ++++++++--------- .../models/interfaces/CruiseProperties.md | 24 ++++----- .../CurrentUserSessionProperties.md | 10 ++-- .../CustomerAccountAddressProperties.md | 18 +++---- .../interfaces/CustomerAccountProperties.md | 18 +++---- .../interfaces/DeviceDetailsProperties.md | 10 ++-- .../interfaces/DirectDebitProperties.md | 32 ++++++------ .../docs/models/interfaces/EmailProperties.md | 6 +-- .../interfaces/ForbiddenErrorProperties.md | 8 +-- .../GatewayTimeoutErrorProperties.md | 8 +-- .../models/interfaces/GiftCardProperties.md | 30 +++++------ .../interfaces/HotelAddressProperties.md | 18 +++---- .../docs/models/interfaces/HotelProperties.md | 28 +++++------ .../interfaces/InsultDetailProperties.md | 6 +-- .../interfaces/InsultFeedbackProperties.md | 8 +-- .../models/interfaces/InsuranceProperties.md | 14 +++--- .../InternalServerErrorProperties.md | 8 +-- .../InternetBankPaymentProperties.md | 30 +++++------ .../IssuedRefundUpdateDetailsProperties.md | 8 +-- .../IssuedRefundUpdateProperties.md | 8 +-- .../LoginTransactionDetailsProperties.md | 18 +++---- .../models/interfaces/ModelErrorProperties.md | 8 +-- ...tiFactorAuthenticationAttemptProperties.md | 22 ++++---- ...ltiFactorAuthenticationUpdateProperties.md | 8 +-- .../docs/models/interfaces/NameProperties.md | 14 +++--- .../interfaces/NotFoundErrorProperties.md | 8 +-- .../models/interfaces/OperationsProperties.md | 14 +++--- .../OrderPurchaseScreenRequestProperties.md | 6 +-- .../OrderPurchaseScreenResponseProperties.md | 8 +-- .../OrderPurchaseTransactionProperties.md | 12 ++--- ...erPurchaseUpdateNotFoundErrorProperties.md | 8 +-- .../OrderPurchaseUpdateRequestProperties.md | 8 +-- .../OrderPurchaseUpdateResponseProperties.md | 6 +-- .../interfaces/OrderUpdateProperties.md | 12 ++--- .../models/interfaces/PayPalProperties.md | 30 +++++------ .../PaymentBillingAddressProperties.md | 18 +++---- .../interfaces/PaymentOperationProperties.md | 10 ++-- .../interfaces/PaymentOutcomeProperties.md | 10 ++-- .../models/interfaces/PaymentProperties.md | 26 +++++----- .../PaymentThreeDSCriteriaProperties.md | 8 +-- .../interfaces/PaymentUpdateProperties.md | 8 +-- .../models/interfaces/PointsProperties.md | 26 +++++----- .../docs/models/interfaces/RailProperties.md | 18 +++---- .../RailSegmentsOperatingCompanyProperties.md | 6 +-- .../interfaces/RailSegmentsProperties.md | 16 +++--- .../RailwayStationDetailsProperties.md | 14 +++--- .../models/interfaces/RefundProperties.md | 10 ++-- .../interfaces/RefundUpdateProperties.md | 6 +-- .../RemediationUpdateActionProperties.md | 10 ++-- .../interfaces/RemediationUpdateProperties.md | 8 +-- ...bleOrderPurchaseScreenFailureProperties.md | 8 +-- ...bleOrderPurchaseUpdateFailureProperties.md | 8 +-- .../ServiceUnavailableErrorProperties.md | 8 +-- .../SettledRefundUpdateDetailsProperties.md | 14 +++--- .../SettledRefundUpdateProperties.md | 8 +-- .../models/interfaces/SiteInfoProperties.md | 8 +-- .../models/interfaces/TelephoneProperties.md | 22 ++++---- .../TooManyRequestsErrorProperties.md | 8 +-- .../TransactionDetailsProperties.md | 16 +++--- .../interfaces/TravelProductProperties.md | 16 +++--- .../models/interfaces/TravelerProperties.md | 20 ++++---- .../interfaces/UnauthorizedErrorProperties.md | 8 +-- .../models/interfaces/VerifyProperties.md | 12 ++--- .../client/apis/FraudPreventionV2Client.ts | 2 +- release/fraudPreventionV2/src/package.json | 26 +++++----- release/fraudPreventionV2/src/specs.yaml | 3 -- 199 files changed, 1428 insertions(+), 1431 deletions(-) create mode 100644 release/fraudPreventionV2/docs/client/core/classes/AxiosClientConfigurations.md create mode 100644 release/fraudPreventionV2/docs/client/core/classes/Client.md rename release/fraudPreventionV2/docs/{models => client}/core/index.md (78%) create mode 100644 release/fraudPreventionV2/docs/client/core/interfaces/ClientConfigurations.md delete mode 100644 release/fraudPreventionV2/docs/models/core/classes/AxiosClientConfigurations.md delete mode 100644 release/fraudPreventionV2/docs/models/core/classes/Client.md delete mode 100644 release/fraudPreventionV2/docs/models/core/interfaces/ClientConfigurations.md diff --git a/release/fraudPreventionV2/docs/client/classes/FraudPreventionV2Client.md b/release/fraudPreventionV2/docs/client/classes/FraudPreventionV2Client.md index bd98cf7a..2b28c1f3 100644 --- a/release/fraudPreventionV2/docs/client/classes/FraudPreventionV2Client.md +++ b/release/fraudPreventionV2/docs/client/classes/FraudPreventionV2Client.md @@ -4,7 +4,7 @@ ## Extends -- [`Client`](../../models/core/classes/Client.md) +- [`Client`](../core/classes/Client.md) ## Constructors @@ -14,7 +14,7 @@ #### Parameters -▪ **configurations**: [`ClientConfigurations`](../../models/core/interfaces/ClientConfigurations.md) +• **configurations**: [`ClientConfigurations`](../core/interfaces/ClientConfigurations.md) #### Returns @@ -22,7 +22,7 @@ #### Overrides -Client.constructor +`Client.constructor` #### Source @@ -39,13 +39,13 @@ The Account Update API is called when there is an account lifecycle transition s #### Parameters -▪ **accountUpdateRequest**: [`AccountUpdateRequest`](../../models/classes/AccountUpdateRequest.md) +• **accountUpdateRequest**: [`AccountUpdateRequest`](../../models/classes/AccountUpdateRequest.md) An AccountUpdate request may be of one of the following types `MULTI_FACTOR_AUTHENTICATION_UPDATE`, `REMEDIATION_UPDATE`. -▪ **transactionId**: `string`= `undefined` +• **transactionId**: `string`= `undefined` -A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` #### Returns @@ -104,13 +104,13 @@ The Order Purchase Update API is called when the status of the order has changed #### Parameters -▪ **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequest`](../../models/classes/OrderPurchaseUpdateRequest.md) +• **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequest`](../../models/classes/OrderPurchaseUpdateRequest.md) An OrderPurchaseUpdate request may be of one of the following types `ORDER_UPDATE`, `CHARGEBACK_FEEDBACK`, `INSULT_FEEDBACK`, `REFUND_UPDATE`, `PAYMENT_UPDATE`. -▪ **transactionId**: `string`= `undefined` +• **transactionId**: `string`= `undefined` -A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` #### Returns @@ -169,11 +169,11 @@ The Account Screen API gives a Fraud recommendation for an account transaction. #### Parameters -▪ **accountScreenRequest**: [`AccountScreenRequest`](../../models/classes/AccountScreenRequest.md) +• **accountScreenRequest**: [`AccountScreenRequest`](../../models/classes/AccountScreenRequest.md) -▪ **transactionId**: `string`= `undefined` +• **transactionId**: `string`= `undefined` -A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` #### Returns @@ -232,11 +232,11 @@ The Order Purchase API gives a Fraud recommendation for a transaction. A recomme #### Parameters -▪ **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequest`](../../models/classes/OrderPurchaseScreenRequest.md) +• **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequest`](../../models/classes/OrderPurchaseScreenRequest.md) -▪ **transactionId**: `string`= `undefined` +• **transactionId**: `string`= `undefined` -A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` +A unique ID to uniquely identify a request/response cycle (optional, defaults to a random generated UUID)`` #### Returns diff --git a/release/fraudPreventionV2/docs/client/core/classes/AxiosClientConfigurations.md b/release/fraudPreventionV2/docs/client/core/classes/AxiosClientConfigurations.md new file mode 100644 index 00000000..ffac452a --- /dev/null +++ b/release/fraudPreventionV2/docs/client/core/classes/AxiosClientConfigurations.md @@ -0,0 +1,30 @@ +[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / AxiosClientConfigurations + +# Class: AxiosClientConfigurations + +## Constructors + +### new AxiosClientConfigurations(endpoint, requestTimeout) + +> **new AxiosClientConfigurations**(`endpoint`, `requestTimeout`): [`AxiosClientConfigurations`](AxiosClientConfigurations.md) + +#### Parameters + +• **endpoint**: `string`= `Constant.ENDPOINT` + +• **requestTimeout**: `number`= `Constant.TEN_SECONDS_IN_MILLIS` + +#### Returns + +[`AxiosClientConfigurations`](AxiosClientConfigurations.md) + +#### Source + +core/src/client/AxiosClientConfigurations.ts:24 + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `endpoint` | `readonly` | `string` | +| `requestTimeout` | `readonly` | `number` | diff --git a/release/fraudPreventionV2/docs/client/core/classes/Client.md b/release/fraudPreventionV2/docs/client/core/classes/Client.md new file mode 100644 index 00000000..ececc914 --- /dev/null +++ b/release/fraudPreventionV2/docs/client/core/classes/Client.md @@ -0,0 +1,7 @@ +[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / Client + +# Class: `abstract` Client + +## Extended by + +- [`FraudPreventionV2Client`](../../classes/FraudPreventionV2Client.md) diff --git a/release/fraudPreventionV2/docs/models/core/index.md b/release/fraudPreventionV2/docs/client/core/index.md similarity index 78% rename from release/fraudPreventionV2/docs/models/core/index.md rename to release/fraudPreventionV2/docs/client/core/index.md index ccec9c48..2fa4c960 100644 --- a/release/fraudPreventionV2/docs/models/core/index.md +++ b/release/fraudPreventionV2/docs/client/core/index.md @@ -1,4 +1,4 @@ -[@expediagroup/fraudpreventionv2-sdk](../../index.md) / [models](../index.md) / core +[@expediagroup/fraudpreventionv2-sdk](../../index.md) / [client](../index.md) / core # core diff --git a/release/fraudPreventionV2/docs/client/core/interfaces/ClientConfigurations.md b/release/fraudPreventionV2/docs/client/core/interfaces/ClientConfigurations.md new file mode 100644 index 00000000..47ebef8d --- /dev/null +++ b/release/fraudPreventionV2/docs/client/core/interfaces/ClientConfigurations.md @@ -0,0 +1,13 @@ +[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [client](../../index.md) / [core](../index.md) / ClientConfigurations + +# Interface: ClientConfigurations + +## Properties + +| Property | Type | +| :------ | :------ | +| `authEndpoint?` | `string` | +| `endpoint?` | `string` | +| `key` | `string` | +| `requestTimeout?` | `number` | +| `secret` | `string` | diff --git a/release/fraudPreventionV2/docs/client/index.md b/release/fraudPreventionV2/docs/client/index.md index 490b442d..f8fb02c0 100644 --- a/release/fraudPreventionV2/docs/client/index.md +++ b/release/fraudPreventionV2/docs/client/index.md @@ -4,6 +4,10 @@ ## Index +### Modules + +- [core](core/index.md) + ### Classes - [FraudPreventionV2Client](classes/FraudPreventionV2Client.md) diff --git a/release/fraudPreventionV2/docs/models/classes/AccountScreenRequest.md b/release/fraudPreventionV2/docs/models/classes/AccountScreenRequest.md index f1cdcbca..f9420897 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountScreenRequest.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountScreenRequest.md @@ -12,7 +12,7 @@ Information for account screening by Expedia\'s Fraud Prevention Service. #### Parameters -▪ **accountScreenRequest**: [`AccountScreenRequestProperties`](../interfaces/AccountScreenRequestProperties.md) +• **accountScreenRequest**: [`AccountScreenRequestProperties`](../interfaces/AccountScreenRequestProperties.md) #### Returns @@ -24,6 +24,6 @@ models/AccountScreenRequest.ts:36 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `transaction` | [`AccountTransaction`](AccountTransaction.md) | - | models/AccountScreenRequest.ts:34 | +| Property | Type | +| :------ | :------ | +| `transaction` | [`AccountTransaction`](AccountTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountScreenResponse.md b/release/fraudPreventionV2/docs/models/classes/AccountScreenResponse.md index 3d235f1b..e8239fb7 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountScreenResponse.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountScreenResponse.md @@ -12,7 +12,7 @@ Response for an account transaction provided by Expedia\'s Fraud Prevention Serv #### Parameters -▪ **accountScreenResponse**: [`AccountScreenResponseProperties`](../interfaces/AccountScreenResponseProperties.md) +• **accountScreenResponse**: [`AccountScreenResponseProperties`](../interfaces/AccountScreenResponseProperties.md) #### Returns @@ -24,7 +24,7 @@ models/AccountScreenResponse.ts:37 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `decision`? | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - | models/AccountScreenResponse.ts:35 | -| `riskId`? | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | models/AccountScreenResponse.ts:33 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `decision?` | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - | +| `riskId?` | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestError.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestError.md index 3ef51ec4..533f7554 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestError.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestError.md @@ -12,7 +12,7 @@ Indicates that a bad request occurred. Typically it is an invalid parameter. #### Parameters -▪ **accountTakeoverBadRequestError**: [`AccountTakeoverBadRequestErrorProperties`](../interfaces/AccountTakeoverBadRequestErrorProperties.md) +• **accountTakeoverBadRequestError**: [`AccountTakeoverBadRequestErrorProperties`](../interfaces/AccountTakeoverBadRequestErrorProperties.md) #### Returns @@ -24,8 +24,8 @@ models/AccountTakeoverBadRequestError.ts:48 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `causes`? | [`AccountTakeoverBadRequestErrorAllOfCauses`](AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - | models/AccountTakeoverBadRequestError.ts:46 | -| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountTakeoverBadRequestError.ts:35 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountTakeoverBadRequestError.ts:40 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `causes?` | [`AccountTakeoverBadRequestErrorAllOfCauses`](AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - | +| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md index 0bd025b3..5787b77e 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverBadRequestErrorAllOfCauses.md @@ -10,7 +10,7 @@ #### Parameters -▪ **accountTakeoverBadRequestErrorAllOfCauses**: [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md) +• **accountTakeoverBadRequestErrorAllOfCauses**: [`AccountTakeoverBadRequestErrorAllOfCausesProperties`](../interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md) #### Returns @@ -22,8 +22,8 @@ models/AccountTakeoverBadRequestErrorAllOfCauses.ts:35 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:26 | -| `field`? | `string` | A JSON Path expression indicating which field, in the request body, caused the error. | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:31 | -| `message`? | `string` | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:33 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code?` | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | - | +| `field?` | `string` | A JSON Path expression indicating which field, in the request body, caused the error. | +| `message?` | `string` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverCustomerAccount.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverCustomerAccount.md index 747e2fca..66bf45b1 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverCustomerAccount.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverCustomerAccount.md @@ -12,7 +12,7 @@ Information about a user\'s account. #### Parameters -▪ **accountTakeoverCustomerAccount**: [`AccountTakeoverCustomerAccountProperties`](../interfaces/AccountTakeoverCustomerAccountProperties.md) +• **accountTakeoverCustomerAccount**: [`AccountTakeoverCustomerAccountProperties`](../interfaces/AccountTakeoverCustomerAccountProperties.md) #### Returns @@ -24,16 +24,16 @@ models/AccountTakeoverCustomerAccount.ts:93 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `accountRole`? | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | 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. | models/AccountTakeoverCustomerAccount.ts:51 | -| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | 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. | models/AccountTakeoverCustomerAccount.ts:46 | -| `activeFlag` | `boolean` | Indicator for if this account is an active account or not. | models/AccountTakeoverCustomerAccount.ts:86 | -| `address`? | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - | models/AccountTakeoverCustomerAccount.ts:76 | -| `emailAddress` | `string` | Email address for the account owner. | models/AccountTakeoverCustomerAccount.ts:66 | -| `loyaltyMemberId`? | `string` | Unique loyalty identifier for a user. | models/AccountTakeoverCustomerAccount.ts:91 | -| `name`? | [`AccountTakeoverName`](AccountTakeoverName.md) | - | models/AccountTakeoverCustomerAccount.ts:56 | -| `registeredTime` | `Date` | 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`. | models/AccountTakeoverCustomerAccount.ts:81 | -| `telephones`? | [`Telephone`](Telephone.md)[] | - | models/AccountTakeoverCustomerAccount.ts:71 | -| `userId` | `string` | 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. | models/AccountTakeoverCustomerAccount.ts:41 | -| `username` | `string` | Username of the account. | models/AccountTakeoverCustomerAccount.ts:61 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `accountRole?` | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | 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. | +| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | 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. | +| `activeFlag` | `boolean` | Indicator for if this account is an active account or not. | +| `address?` | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - | +| `emailAddress` | `string` | Email address for the account owner. | +| `loyaltyMemberId?` | `string` | Unique loyalty identifier for a user. | +| `name?` | [`AccountTakeoverName`](AccountTakeoverName.md) | - | +| `registeredTime` | `Date` | 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?` | [`Telephone`](Telephone.md)[] | - | +| `userId` | `string` | 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` | `string` | Username of the account. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverDeviceDetails.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverDeviceDetails.md index a4be0b22..3e8e70ae 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverDeviceDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverDeviceDetails.md @@ -12,7 +12,7 @@ Information specific to the Partner\'s device through which a transaction was ma #### Parameters -▪ **accountTakeoverDeviceDetails**: [`AccountTakeoverDeviceDetailsProperties`](../interfaces/AccountTakeoverDeviceDetailsProperties.md) +• **accountTakeoverDeviceDetails**: [`AccountTakeoverDeviceDetailsProperties`](../interfaces/AccountTakeoverDeviceDetailsProperties.md) #### Returns @@ -24,10 +24,10 @@ models/AccountTakeoverDeviceDetails.ts:54 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `deviceBox` | `string` | Device related information retrieved from TrustWidget. | models/AccountTakeoverDeviceDetails.ts:37 | -| `ipAddress` | `string` | IP address of the device used for this event. | models/AccountTakeoverDeviceDetails.ts:42 | -| `source`? | `string` | Source of the device_box. Default value is `TrustWidget`. | models/AccountTakeoverDeviceDetails.ts:32 | -| `type`? | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | 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. | models/AccountTakeoverDeviceDetails.ts:52 | -| `userAgent` | `string` | The application type, operating system, software vendor, or software version of the originating request. | models/AccountTakeoverDeviceDetails.ts:47 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `deviceBox` | `string` | Device related information retrieved from TrustWidget. | +| `ipAddress` | `string` | IP address of the device used for this event. | +| `source?` | `string` | Source of the device_box. Default value is `TrustWidget`. | +| `type?` | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | 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. | +| `userAgent` | `string` | The application type, operating system, software vendor, or software version of the originating request. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverError.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverError.md index 43be76fb..4d48cb4e 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverError.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverError.md @@ -12,7 +12,7 @@ The object used to describe an error, containing both human-readable and machine #### Parameters -▪ **accountTakeoverError**: [`AccountTakeoverErrorProperties`](../interfaces/AccountTakeoverErrorProperties.md) +• **accountTakeoverError**: [`AccountTakeoverErrorProperties`](../interfaces/AccountTakeoverErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/AccountTakeoverError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountTakeoverError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountTakeoverError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverName.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverName.md index 96617f62..ed0262e2 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverName.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverName.md @@ -12,7 +12,7 @@ Group of attributes intended to hold information about a customer or traveler\'\ #### Parameters -▪ **accountTakeoverName**: [`AccountTakeoverNameProperties`](../interfaces/AccountTakeoverNameProperties.md) +• **accountTakeoverName**: [`AccountTakeoverNameProperties`](../interfaces/AccountTakeoverNameProperties.md) #### Returns @@ -24,10 +24,10 @@ models/AccountTakeoverName.ts:54 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `firstName` | `string` | Given, or first name, of the person. | models/AccountTakeoverName.ts:37 | -| `lastName` | `string` | Surname, or last name, of the person. | models/AccountTakeoverName.ts:32 | -| `middleName`? | `string` | Middle name of the person. | models/AccountTakeoverName.ts:42 | -| `suffix`? | `string` | 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). | models/AccountTakeoverName.ts:52 | -| `title`? | `string` | Title of the person for name (e.g. Mr., Ms. etc). | models/AccountTakeoverName.ts:47 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `firstName` | `string` | Given, or first name, of the person. | +| `lastName` | `string` | Surname, or last name, of the person. | +| `middleName?` | `string` | Middle name of the person. | +| `suffix?` | `string` | 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?` | `string` | Title of the person for name (e.g. Mr., Ms. etc). | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverSiteInfo.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverSiteInfo.md index b5a719e0..cd226900 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverSiteInfo.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverSiteInfo.md @@ -12,7 +12,7 @@ Information specific to the Partner\'s website through which a transaction was m #### Parameters -▪ **accountTakeoverSiteInfo**: [`AccountTakeoverSiteInfoProperties`](../interfaces/AccountTakeoverSiteInfoProperties.md) +• **accountTakeoverSiteInfo**: [`AccountTakeoverSiteInfoProperties`](../interfaces/AccountTakeoverSiteInfoProperties.md) #### Returns @@ -24,9 +24,9 @@ models/AccountTakeoverSiteInfo.ts:49 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `brandName` | `string` | The trademark brand name that is displayed to a user on the website. | models/AccountTakeoverSiteInfo.ts:42 | -| `locale`? | `string` | 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. | models/AccountTakeoverSiteInfo.ts:32 | -| `name`? | `string` | Name of the website from which the event is generated. | models/AccountTakeoverSiteInfo.ts:37 | -| `placementName`? | [`AccountTakeoverSiteInfoPlacementNameEnum`](../type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md) | 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. | models/AccountTakeoverSiteInfo.ts:47 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `brandName` | `string` | The trademark brand name that is displayed to a user on the website. | +| `locale?` | `string` | 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?` | `string` | Name of the website from which the event is generated. | +| `placementName?` | [`AccountTakeoverSiteInfoPlacementNameEnum`](../type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md) | 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. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverTransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverTransactionDetails.md index 33bd0ec5..614d6b70 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverTransactionDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverTransactionDetails.md @@ -4,7 +4,7 @@ The `transaction_type` field value is used as a discriminator, with the following mapping: * `LOGIN`: `LoginTransactionDetails` -## Extended By +## Extended by - [`LoginTransactionDetails`](LoginTransactionDetails.md) @@ -16,7 +16,7 @@ The `transaction_type` field value is used as a discriminator, with the followin #### Parameters -▪ **accountTakeoverTransactionDetails**: [`AccountTakeoverTransactionDetailsProperties`](../interfaces/AccountTakeoverTransactionDetailsProperties.md) +• **accountTakeoverTransactionDetails**: [`AccountTakeoverTransactionDetailsProperties`](../interfaces/AccountTakeoverTransactionDetailsProperties.md) #### Returns @@ -28,8 +28,8 @@ models/AccountTakeoverTransactionDetails.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currentUserSession`? | [`CurrentUserSession`](CurrentUserSession.md) | - | models/AccountTakeoverTransactionDetails.ts:45 | -| `transactionDateTime` | `Date` | 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`. | models/AccountTakeoverTransactionDetails.ts:35 | -| `transactionId` | `string` | Unique identifier to identify a transaction attempt in the Partner\'s system. | models/AccountTakeoverTransactionDetails.ts:40 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `currentUserSession?` | [`CurrentUserSession`](CurrentUserSession.md) | - | +| `transactionDateTime` | `Date` | 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`. | +| `transactionId` | `string` | Unique identifier to identify a transaction attempt in the Partner\'s system. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverUnauthorizedError.md b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverUnauthorizedError.md index be75b732..766cabb0 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTakeoverUnauthorizedError.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTakeoverUnauthorizedError.md @@ -12,7 +12,7 @@ Indicates that the token sent in the \'Authorization\' header is either invalid #### Parameters -▪ **accountTakeoverUnauthorizedError**: [`AccountTakeoverUnauthorizedErrorProperties`](../interfaces/AccountTakeoverUnauthorizedErrorProperties.md) +• **accountTakeoverUnauthorizedError**: [`AccountTakeoverUnauthorizedErrorProperties`](../interfaces/AccountTakeoverUnauthorizedErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/AccountTakeoverUnauthorizedError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountTakeoverUnauthorizedError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountTakeoverUnauthorizedError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountTransaction.md b/release/fraudPreventionV2/docs/models/classes/AccountTransaction.md index 7c8cb685..14d8ffa9 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountTransaction.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountTransaction.md @@ -12,7 +12,7 @@ Information for an account transaction. #### Parameters -▪ **accountTransaction**: [`AccountTransactionProperties`](../interfaces/AccountTransactionProperties.md) +• **accountTransaction**: [`AccountTransactionProperties`](../interfaces/AccountTransactionProperties.md) #### Returns @@ -24,9 +24,9 @@ models/AccountTransaction.ts:63 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `customerAccount` | [`AccountTakeoverCustomerAccount`](AccountTakeoverCustomerAccount.md) | - | models/AccountTransaction.ts:55 | -| `deviceDetails` | [`AccountTakeoverDeviceDetails`](AccountTakeoverDeviceDetails.md) | - | models/AccountTransaction.ts:49 | -| `siteInfo` | [`AccountTakeoverSiteInfo`](AccountTakeoverSiteInfo.md) | - | models/AccountTransaction.ts:43 | -| `transactionDetails` | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md) | - | models/AccountTransaction.ts:61 | +| Property | Type | +| :------ | :------ | +| `customerAccount` | [`AccountTakeoverCustomerAccount`](AccountTakeoverCustomerAccount.md) | +| `deviceDetails` | [`AccountTakeoverDeviceDetails`](AccountTakeoverDeviceDetails.md) | +| `siteInfo` | [`AccountTakeoverSiteInfo`](AccountTakeoverSiteInfo.md) | +| `transactionDetails` | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountUpdateNotFoundError.md b/release/fraudPreventionV2/docs/models/classes/AccountUpdateNotFoundError.md index 3cd2dfea..18948e63 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountUpdateNotFoundError.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountUpdateNotFoundError.md @@ -12,7 +12,7 @@ Indicates that the API cannot find the resource that is either being requested o #### Parameters -▪ **accountUpdateNotFoundError**: [`AccountUpdateNotFoundErrorProperties`](../interfaces/AccountUpdateNotFoundErrorProperties.md) +• **accountUpdateNotFoundError**: [`AccountUpdateNotFoundErrorProperties`](../interfaces/AccountUpdateNotFoundErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/AccountUpdateNotFoundError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/AccountUpdateNotFoundError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/AccountUpdateNotFoundError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountUpdateRequest.md b/release/fraudPreventionV2/docs/models/classes/AccountUpdateRequest.md index 323a8dba..bccdffaa 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountUpdateRequest.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountUpdateRequest.md @@ -4,7 +4,7 @@ The `type` field value is used as a discriminator, with the following mapping: * `MULTI_FACTOR_AUTHENTICATION_UPDATE`: `MultiFactorAuthenticationUpdate` * `REMEDIATION_UPDATE`: `RemediationUpdate` -## Extended By +## Extended by - [`MultiFactorAuthenticationUpdate`](MultiFactorAuthenticationUpdate.md) - [`RemediationUpdate`](RemediationUpdate.md) @@ -17,7 +17,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **accountUpdateRequest**: [`AccountUpdateRequestProperties`](../interfaces/AccountUpdateRequestProperties.md) +• **accountUpdateRequest**: [`AccountUpdateRequestProperties`](../interfaces/AccountUpdateRequestProperties.md) #### Returns @@ -29,6 +29,6 @@ models/AccountUpdateRequest.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | models/AccountUpdateRequest.ts:32 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | diff --git a/release/fraudPreventionV2/docs/models/classes/AccountUpdateResponse.md b/release/fraudPreventionV2/docs/models/classes/AccountUpdateResponse.md index 05891677..04c629e2 100644 --- a/release/fraudPreventionV2/docs/models/classes/AccountUpdateResponse.md +++ b/release/fraudPreventionV2/docs/models/classes/AccountUpdateResponse.md @@ -10,7 +10,7 @@ #### Parameters -▪ **accountUpdateResponse**: [`AccountUpdateResponseProperties`](../interfaces/AccountUpdateResponseProperties.md) +• **accountUpdateResponse**: [`AccountUpdateResponseProperties`](../interfaces/AccountUpdateResponseProperties.md) #### Returns @@ -22,6 +22,6 @@ models/AccountUpdateResponse.ts:31 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId`? | `string` | Unique identifier of transaction that was updated. | models/AccountUpdateResponse.ts:29 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `riskId?` | `string` | Unique identifier of transaction that was updated. | diff --git a/release/fraudPreventionV2/docs/models/classes/Address.md b/release/fraudPreventionV2/docs/models/classes/Address.md index f5131751..26aed2ca 100644 --- a/release/fraudPreventionV2/docs/models/classes/Address.md +++ b/release/fraudPreventionV2/docs/models/classes/Address.md @@ -10,7 +10,7 @@ #### Parameters -▪ **address**: [`AddressProperties`](../interfaces/AddressProperties.md) +• **address**: [`AddressProperties`](../interfaces/AddressProperties.md) #### Returns @@ -22,12 +22,12 @@ models/Address.ts:58 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1`? | `string` | Address line 1 of the address provided. | models/Address.ts:31 | -| `addressLine2`? | `string` | Address line 2 of the address provided. | models/Address.ts:36 | -| `addressType`? | [`AddressAddressTypeEnum`](../type-aliases/AddressAddressTypeEnum.md) | - | models/Address.ts:26 | -| `city`? | `string` | City of the address provided. | models/Address.ts:41 | -| `countryCode`? | `string` | ISO alpha-3 country code of the address provided. | models/Address.ts:56 | -| `state`? | `string` | The two-characters ISO code for the state or province of the address. | models/Address.ts:46 | -| `zipCode`? | `string` | Zip code of the address provided. | models/Address.ts:51 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `addressLine1?` | `string` | Address line 1 of the address provided. | +| `addressLine2?` | `string` | Address line 2 of the address provided. | +| `addressType?` | [`AddressAddressTypeEnum`](../type-aliases/AddressAddressTypeEnum.md) | - | +| `city?` | `string` | City of the address provided. | +| `countryCode?` | `string` | ISO alpha-3 country code of the address provided. | +| `state?` | `string` | The two-characters ISO code for the state or province of the address. | +| `zipCode?` | `string` | Zip code of the address provided. | diff --git a/release/fraudPreventionV2/docs/models/classes/Air.md b/release/fraudPreventionV2/docs/models/classes/Air.md index 58d09c61..5373bd86 100644 --- a/release/fraudPreventionV2/docs/models/classes/Air.md +++ b/release/fraudPreventionV2/docs/models/classes/Air.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **air**: [`AirProperties`](../interfaces/AirProperties.md) +• **air**: [`AirProperties`](../interfaces/AirProperties.md) #### Returns @@ -32,17 +32,17 @@ models/Air.ts:67 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `airSegments` | [`AirSegment`](AirSegment.md)[] | Additional airline and flight details for each of the trip segments. | - | models/Air.ts:47 | -| `public` | `arrivalTime` | `Date` | Local date and time of arrival to final destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Air.ts:39 | -| `public` | `departureTime` | `Date` | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Air.ts:34 | -| `public` | `flightType`? | [`AirFlightTypeEnum`](../type-aliases/AirFlightTypeEnum.md) | Identifies the type of air trip based on the air destinations. | - | models/Air.ts:52 | -| `public` | `globalDistributionSystemType`? | `string` | Associated with Passenger Name Record (PNR). | - | models/Air.ts:62 | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `passengerNameRecord`? | `string` | Airline booking confirmation code for the trip. | - | models/Air.ts:57 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"AIR"` | - | - | models/Air.ts:65 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `airSegments` | `public` | [`AirSegment`](AirSegment.md)[] | Additional airline and flight details for each of the trip segments. | - | +| `arrivalTime` | `public` | `Date` | Local date and time of arrival to final destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `departureTime` | `public` | `Date` | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `flightType?` | `public` | [`AirFlightTypeEnum`](../type-aliases/AirFlightTypeEnum.md) | Identifies the type of air trip based on the air destinations. | - | +| `globalDistributionSystemType?` | `public` | `string` | Associated with Passenger Name Record (PNR). | - | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `passengerNameRecord?` | `public` | `string` | Airline booking confirmation code for the trip. | - | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"AIR"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/AirSegment.md b/release/fraudPreventionV2/docs/models/classes/AirSegment.md index dd532d3e..f7f01c67 100644 --- a/release/fraudPreventionV2/docs/models/classes/AirSegment.md +++ b/release/fraudPreventionV2/docs/models/classes/AirSegment.md @@ -10,7 +10,7 @@ #### Parameters -▪ **airSegment**: [`AirSegmentProperties`](../interfaces/AirSegmentProperties.md) +• **airSegment**: [`AirSegmentProperties`](../interfaces/AirSegmentProperties.md) #### Returns @@ -22,10 +22,10 @@ models/AirSegment.ts:51 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `airlineCode` | `string` | Airline code of the trip segment | models/AirSegment.ts:29 | -| `arrivalAirportCode` | `string` | Arrival airport of the trip segment | models/AirSegment.ts:39 | -| `arrivalTime`? | `Date` | Local date and time of arrival to destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/AirSegment.ts:49 | -| `departureAirportCode` | `string` | Departure airport of the trip segment | models/AirSegment.ts:34 | -| `departureTime`? | `Date` | Local date and time of departure from departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/AirSegment.ts:44 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `airlineCode` | `string` | Airline code of the trip segment | +| `arrivalAirportCode` | `string` | Arrival airport of the trip segment | +| `arrivalTime?` | `Date` | Local date and time of arrival to destination location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| `departureAirportCode` | `string` | Departure airport of the trip segment | +| `departureTime?` | `Date` | Local date and time of departure from departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | diff --git a/release/fraudPreventionV2/docs/models/classes/Amount.md b/release/fraudPreventionV2/docs/models/classes/Amount.md index 682bbb4b..4b9677a0 100644 --- a/release/fraudPreventionV2/docs/models/classes/Amount.md +++ b/release/fraudPreventionV2/docs/models/classes/Amount.md @@ -10,7 +10,7 @@ #### Parameters -▪ **amount**: [`AmountProperties`](../interfaces/AmountProperties.md) +• **amount**: [`AmountProperties`](../interfaces/AmountProperties.md) #### Returns @@ -22,7 +22,7 @@ models/Amount.ts:36 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currencyCode` | `string` | The ISO alpha-3 country code for the amount currency. | models/Amount.ts:34 | -| `value` | `number` | The amount required in payment for the product/order in local currency (including any taxes and fees). | models/Amount.ts:29 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `currencyCode` | `string` | The ISO alpha-3 country code for the amount currency. | +| `value` | `number` | The amount required in payment for the product/order in local currency (including any taxes and fees). | diff --git a/release/fraudPreventionV2/docs/models/classes/Authorize.md b/release/fraudPreventionV2/docs/models/classes/Authorize.md index c9e2f0f9..3ebd596f 100644 --- a/release/fraudPreventionV2/docs/models/classes/Authorize.md +++ b/release/fraudPreventionV2/docs/models/classes/Authorize.md @@ -12,7 +12,7 @@ Authorize operation on the payment. An authorize operation represents placing th #### Parameters -▪ **authorize**: [`AuthorizeProperties`](../interfaces/AuthorizeProperties.md) +• **authorize**: [`AuthorizeProperties`](../interfaces/AuthorizeProperties.md) #### Returns @@ -24,8 +24,8 @@ models/Authorize.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/Authorize.ts:40 | -| `id`? | `string` | - | models/Authorize.ts:35 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/Authorize.ts:45 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/AuthorizeReversal.md b/release/fraudPreventionV2/docs/models/classes/AuthorizeReversal.md index 408fdc9b..2c2c38d7 100644 --- a/release/fraudPreventionV2/docs/models/classes/AuthorizeReversal.md +++ b/release/fraudPreventionV2/docs/models/classes/AuthorizeReversal.md @@ -12,7 +12,7 @@ Authorize Reversal operation on the payment. An authorize reversal operation rep #### Parameters -▪ **authorizeReversal**: [`AuthorizeReversalProperties`](../interfaces/AuthorizeReversalProperties.md) +• **authorizeReversal**: [`AuthorizeReversalProperties`](../interfaces/AuthorizeReversalProperties.md) #### Returns @@ -24,8 +24,8 @@ models/AuthorizeReversal.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/AuthorizeReversal.ts:40 | -| `id`? | `string` | - | models/AuthorizeReversal.ts:35 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/AuthorizeReversal.ts:45 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/BadGatewayError.md b/release/fraudPreventionV2/docs/models/classes/BadGatewayError.md index f7095e09..90968fca 100644 --- a/release/fraudPreventionV2/docs/models/classes/BadGatewayError.md +++ b/release/fraudPreventionV2/docs/models/classes/BadGatewayError.md @@ -12,7 +12,7 @@ Indicates that the server received an invalid response from the upstream server. #### Parameters -▪ **badGatewayError**: [`BadGatewayErrorProperties`](../interfaces/BadGatewayErrorProperties.md) +• **badGatewayError**: [`BadGatewayErrorProperties`](../interfaces/BadGatewayErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/BadGatewayError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/BadGatewayErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/BadGatewayError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/BadGatewayError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/BadGatewayErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/BadRequestError.md b/release/fraudPreventionV2/docs/models/classes/BadRequestError.md index bcd76b6e..4ad4f799 100644 --- a/release/fraudPreventionV2/docs/models/classes/BadRequestError.md +++ b/release/fraudPreventionV2/docs/models/classes/BadRequestError.md @@ -12,7 +12,7 @@ Indicates that a bad request occurred. Typically it is an invalid parameter. #### Parameters -▪ **badRequestError**: [`BadRequestErrorProperties`](../interfaces/BadRequestErrorProperties.md) +• **badRequestError**: [`BadRequestErrorProperties`](../interfaces/BadRequestErrorProperties.md) #### Returns @@ -24,8 +24,8 @@ models/BadRequestError.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `causes`? | [`BadRequestErrorAllOfCauses`](BadRequestErrorAllOfCauses.md)[] | - | models/BadRequestError.ts:45 | -| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/BadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/BadRequestError.ts:35 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/BadRequestError.ts:40 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `causes?` | [`BadRequestErrorAllOfCauses`](BadRequestErrorAllOfCauses.md)[] | - | +| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/BadRequestErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/BadRequestErrorAllOfCauses.md b/release/fraudPreventionV2/docs/models/classes/BadRequestErrorAllOfCauses.md index 55a513c6..f53cbd7b 100644 --- a/release/fraudPreventionV2/docs/models/classes/BadRequestErrorAllOfCauses.md +++ b/release/fraudPreventionV2/docs/models/classes/BadRequestErrorAllOfCauses.md @@ -10,7 +10,7 @@ #### Parameters -▪ **badRequestErrorAllOfCauses**: [`BadRequestErrorAllOfCausesProperties`](../interfaces/BadRequestErrorAllOfCausesProperties.md) +• **badRequestErrorAllOfCauses**: [`BadRequestErrorAllOfCausesProperties`](../interfaces/BadRequestErrorAllOfCausesProperties.md) #### Returns @@ -22,8 +22,8 @@ models/BadRequestErrorAllOfCauses.ts:35 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/BadRequestErrorAllOfCausesCodeEnum.md) | - | models/BadRequestErrorAllOfCauses.ts:26 | -| `field`? | `string` | A JSON Path expression indicating which field, in the request body, caused the error. | models/BadRequestErrorAllOfCauses.ts:31 | -| `message`? | `string` | - | models/BadRequestErrorAllOfCauses.ts:33 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code?` | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/BadRequestErrorAllOfCausesCodeEnum.md) | - | +| `field?` | `string` | A JSON Path expression indicating which field, in the request body, caused the error. | +| `message?` | `string` | - | diff --git a/release/fraudPreventionV2/docs/models/classes/CancellationReason.md b/release/fraudPreventionV2/docs/models/classes/CancellationReason.md index e03498ae..3e09f0cf 100644 --- a/release/fraudPreventionV2/docs/models/classes/CancellationReason.md +++ b/release/fraudPreventionV2/docs/models/classes/CancellationReason.md @@ -12,7 +12,7 @@ Reason of order update cancellation. #### Parameters -▪ **cancellationReason**: [`CancellationReasonProperties`](../interfaces/CancellationReasonProperties.md) +• **cancellationReason**: [`CancellationReasonProperties`](../interfaces/CancellationReasonProperties.md) #### Returns @@ -24,9 +24,9 @@ models/CancellationReason.ts:49 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `primaryReasonCode`? | `string` | Primary cancellation reason code. | models/CancellationReason.ts:32 | -| `primaryReasonDescription`? | `string` | Primary cancellation reason code. Required if `order_status = CANCELLED`. | models/CancellationReason.ts:42 | -| `subReasonCode`? | `string` | Substitute cancellation reason code. | models/CancellationReason.ts:37 | -| `subReasonDescription`? | `string` | Substitute cancellation reason description. | models/CancellationReason.ts:47 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `primaryReasonCode?` | `string` | Primary cancellation reason code. | +| `primaryReasonDescription?` | `string` | Primary cancellation reason code. Required if `order_status = CANCELLED`. | +| `subReasonCode?` | `string` | Substitute cancellation reason code. | +| `subReasonDescription?` | `string` | Substitute cancellation reason description. | diff --git a/release/fraudPreventionV2/docs/models/classes/Capture.md b/release/fraudPreventionV2/docs/models/classes/Capture.md index 0e12954b..8f4e1acf 100644 --- a/release/fraudPreventionV2/docs/models/classes/Capture.md +++ b/release/fraudPreventionV2/docs/models/classes/Capture.md @@ -12,7 +12,7 @@ Capture operation on the payment. A capture operation represents a notification #### Parameters -▪ **capture**: [`CaptureProperties`](../interfaces/CaptureProperties.md) +• **capture**: [`CaptureProperties`](../interfaces/CaptureProperties.md) #### Returns @@ -24,8 +24,8 @@ models/Capture.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/Capture.ts:40 | -| `id`? | `string` | - | models/Capture.ts:35 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/Capture.ts:45 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/Car.md b/release/fraudPreventionV2/docs/models/classes/Car.md index 9b188722..756473ca 100644 --- a/release/fraudPreventionV2/docs/models/classes/Car.md +++ b/release/fraudPreventionV2/docs/models/classes/Car.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **car**: [`CarProperties`](../interfaces/CarProperties.md) +• **car**: [`CarProperties`](../interfaces/CarProperties.md) #### Returns @@ -32,15 +32,15 @@ models/Car.ts:51 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `dropOffLocation` | `string` | Location at which the automobile will be returned. | - | models/Car.ts:36 | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `pickUpLocation` | `string` | Location where the automobile will be picked up. | - | models/Car.ts:31 | -| `public` | `pickupTime` | `Date` | Local date and time the automobile will be picked-up, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Car.ts:41 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `returnTime` | `Date` | Local date and time the automobile will be returned, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Car.ts:46 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"CAR"` | - | - | models/Car.ts:49 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `dropOffLocation` | `public` | `string` | Location at which the automobile will be returned. | - | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `pickUpLocation` | `public` | `string` | Location where the automobile will be picked up. | - | +| `pickupTime` | `public` | `Date` | Local date and time the automobile will be picked-up, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `returnTime` | `public` | `Date` | Local date and time the automobile will be returned, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"CAR"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/ChallengeDetail.md b/release/fraudPreventionV2/docs/models/classes/ChallengeDetail.md index 69da5d61..cad3761f 100644 --- a/release/fraudPreventionV2/docs/models/classes/ChallengeDetail.md +++ b/release/fraudPreventionV2/docs/models/classes/ChallengeDetail.md @@ -12,7 +12,7 @@ Information related to challenges initiated by the Partner\'s system to a user b #### Parameters -▪ **challengeDetail**: [`ChallengeDetailProperties`](../interfaces/ChallengeDetailProperties.md) +• **challengeDetail**: [`ChallengeDetailProperties`](../interfaces/ChallengeDetailProperties.md) #### Returns @@ -24,8 +24,8 @@ models/ChallengeDetail.ts:44 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `displayedFlag` | `boolean` | Indicates that there was a challenge initiated by the Partner\'s system to a user before calling Expedia\'s Fraud Prevention Service. | models/ChallengeDetail.ts:32 | -| `status` | [`ChallengeDetailStatusEnum`](../type-aliases/ChallengeDetailStatusEnum.md) | 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. | models/ChallengeDetail.ts:42 | -| `type` | [`ChallengeDetailTypeEnum`](../type-aliases/ChallengeDetailTypeEnum.md) | 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). | models/ChallengeDetail.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `displayedFlag` | `boolean` | Indicates that there was a challenge initiated by the Partner\'s system to a user before calling Expedia\'s Fraud Prevention Service. | +| `status` | [`ChallengeDetailStatusEnum`](../type-aliases/ChallengeDetailStatusEnum.md) | 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` | [`ChallengeDetailTypeEnum`](../type-aliases/ChallengeDetailTypeEnum.md) | 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). | diff --git a/release/fraudPreventionV2/docs/models/classes/ChargebackDetail.md b/release/fraudPreventionV2/docs/models/classes/ChargebackDetail.md index 1dc53716..97224235 100644 --- a/release/fraudPreventionV2/docs/models/classes/ChargebackDetail.md +++ b/release/fraudPreventionV2/docs/models/classes/ChargebackDetail.md @@ -12,7 +12,7 @@ Details related to the chargeback. #### Parameters -▪ **chargebackDetail**: [`ChargebackDetailProperties`](../interfaces/ChargebackDetailProperties.md) +• **chargebackDetail**: [`ChargebackDetailProperties`](../interfaces/ChargebackDetailProperties.md) #### Returns @@ -24,10 +24,10 @@ models/ChargebackDetail.ts:57 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `bankReasonCode`? | `string` | Unique code provided by the acquiring bank for the category of fraud. | models/ChargebackDetail.ts:50 | -| `chargebackAmount` | [`Amount`](Amount.md) | - | models/ChargebackDetail.ts:45 | -| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/ChargebackDetailChargebackReasonEnum.md) | Reason for chargeback which can be `Fraud` or `Non Fraud`. | models/ChargebackDetail.ts:40 | -| `chargebackReportedDateTime`? | `Date` | Date and time when the chargeback was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/ChargebackDetail.ts:55 | -| `chargebackStatus` | [`ChargebackDetailChargebackStatusEnum`](../type-aliases/ChargebackDetailChargebackStatusEnum.md) | Identifies the chargeback status. Possible values are: -`RECEIVED` - The chargeback was received. -`REVERSAL` - The chargeback reversal was received. | models/ChargebackDetail.ts:35 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `bankReasonCode?` | `string` | Unique code provided by the acquiring bank for the category of fraud. | +| `chargebackAmount` | [`Amount`](Amount.md) | - | +| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/ChargebackDetailChargebackReasonEnum.md) | Reason for chargeback which can be `Fraud` or `Non Fraud`. | +| `chargebackReportedDateTime?` | `Date` | Date and time when the chargeback was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| `chargebackStatus` | [`ChargebackDetailChargebackStatusEnum`](../type-aliases/ChargebackDetailChargebackStatusEnum.md) | Identifies the chargeback status. Possible values are: -`RECEIVED` - The chargeback was received. -`REVERSAL` - The chargeback reversal was received. | diff --git a/release/fraudPreventionV2/docs/models/classes/ChargebackFeedback.md b/release/fraudPreventionV2/docs/models/classes/ChargebackFeedback.md index 03b00c02..c00fe590 100644 --- a/release/fraudPreventionV2/docs/models/classes/ChargebackFeedback.md +++ b/release/fraudPreventionV2/docs/models/classes/ChargebackFeedback.md @@ -16,7 +16,7 @@ Feedback from EG external partners if they receive a chargeback for a false nega #### Parameters -▪ **chargebackFeedback**: [`ChargebackFeedbackProperties`](../interfaces/ChargebackFeedbackProperties.md) +• **chargebackFeedback**: [`ChargebackFeedbackProperties`](../interfaces/ChargebackFeedbackProperties.md) #### Returns @@ -32,8 +32,8 @@ models/ChargebackFeedback.ts:41 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `chargebackDetail`? | [`ChargebackDetail`](ChargebackDetail.md) | - | - | models/ChargebackFeedback.ts:36 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"CHARGEBACK_FEEDBACK"` | - | - | models/ChargebackFeedback.ts:39 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `chargebackDetail?` | `public` | [`ChargebackDetail`](ChargebackDetail.md) | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"CHARGEBACK_FEEDBACK"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/CreditCard.md b/release/fraudPreventionV2/docs/models/classes/CreditCard.md index 8fe25a46..e093a371 100644 --- a/release/fraudPreventionV2/docs/models/classes/CreditCard.md +++ b/release/fraudPreventionV2/docs/models/classes/CreditCard.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **creditCard**: [`CreditCardProperties`](../interfaces/CreditCardProperties.md) +• **creditCard**: [`CreditCardProperties`](../interfaces/CreditCardProperties.md) #### Returns @@ -32,27 +32,27 @@ models/CreditCard.ts:92 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `cardAuthenticationFailureCount`? | `number` | Total authentication failure count for given card. | - | models/CreditCard.ts:87 | -| `public` | `cardAvsResponse`? | `string` | 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. | - | models/CreditCard.ts:64 | -| `public` | `cardCvvResponse`? | `string` | A field used to confirm the Card Verification Value on the Credit Card matches the Credit Card used at the time of purchase. | - | models/CreditCard.ts:69 | -| `public` | `cardNumber` | `string` | All the digits (unencrypted) of the credit card number associated with the payment. | - | models/CreditCard.ts:39 | -| `public` | `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/CreditCardCardTypeEnum.md) | 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` * `UATP` : `UATP` * `UATP` : `UATP_SUPPLY` * `UATP` : `AIR_PLUS` * `UATP` : `UA_PASS_PLUS` * `VISA` : `VISA` * `VISA` : `VISA_DELTA` * `VISA` : `VISA_ELECTRON` * `VISA` : `CARTA_SI` * `VISA` : `CARTE_BLEUE` * `VISA` : `VISA_DANKORT` * `VISA` : `POSTEPAY_VISA_ELECTRON` | - | models/CreditCard.ts:34 | -| `public` | `electronicCommerceIndicator`? | `string` | 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. | - | models/CreditCard.ts:49 | -| `public` | `expiryDate` | `Date` | Expiration date of the credit card used for payment, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/CreditCard.ts:44 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `public` | `merchantOrderCode`? | `string` | 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. | - | models/CreditCard.ts:82 | -| `readonly` | `method` | `"CREDIT_CARD"` | - | - | models/CreditCard.ts:90 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `telephones` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with card holder and credit card. | - | models/CreditCard.ts:77 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | -| `public` | `virtualCreditCardFlag`? | `boolean` | A flag to indicate that the bank card being used for the charge is a virtual credit card. | - | models/CreditCard.ts:54 | -| `public` | `walletType`? | `string` | 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`. | - | models/CreditCard.ts:59 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `cardAuthenticationFailureCount?` | `public` | `number` | Total authentication failure count for given card. | - | +| `cardAvsResponse?` | `public` | `string` | 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. | - | +| `cardCvvResponse?` | `public` | `string` | A field used to confirm the Card Verification Value on the Credit Card matches the Credit Card used at the time of purchase. | - | +| `cardNumber` | `public` | `string` | All the digits (unencrypted) of the credit card number associated with the payment. | - | +| `cardType` | `public` | [`CreditCardCardTypeEnum`](../type-aliases/CreditCardCardTypeEnum.md) | 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` * `UATP` : `UATP` * `UATP` : `UATP_SUPPLY` * `UATP` : `AIR_PLUS` * `UATP` : `UA_PASS_PLUS` * `VISA` : `VISA` * `VISA` : `VISA_DELTA` * `VISA` : `VISA_ELECTRON` * `VISA` : `CARTA_SI` * `VISA` : `CARTE_BLEUE` * `VISA` : `VISA_DANKORT` * `VISA` : `POSTEPAY_VISA_ELECTRON` | - | +| `electronicCommerceIndicator?` | `public` | `string` | 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. | - | +| `expiryDate` | `public` | `Date` | Expiration date of the credit card used for payment, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `merchantOrderCode?` | `public` | `string` | 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` | `readonly` | `"CREDIT_CARD"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `telephones` | `public` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with card holder and credit card. | - | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | +| `virtualCreditCardFlag?` | `public` | `boolean` | A flag to indicate that the bank card being used for the charge is a virtual credit card. | - | +| `walletType?` | `public` | `string` | 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`. | - | diff --git a/release/fraudPreventionV2/docs/models/classes/Cruise.md b/release/fraudPreventionV2/docs/models/classes/Cruise.md index 152b547a..ef24727a 100644 --- a/release/fraudPreventionV2/docs/models/classes/Cruise.md +++ b/release/fraudPreventionV2/docs/models/classes/Cruise.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **cruise**: [`CruiseProperties`](../interfaces/CruiseProperties.md) +• **cruise**: [`CruiseProperties`](../interfaces/CruiseProperties.md) #### Returns @@ -32,16 +32,16 @@ models/Cruise.ts:56 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `arrivalTime` | `Date` | Local date and time of arrival from original arrival location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Cruise.ts:36 | -| `public` | `departureTime` | `Date` | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Cruise.ts:31 | -| `public` | `disembarkationPort` | `string` | The cruise\'s final destination. | - | models/Cruise.ts:46 | -| `public` | `embarkationPort` | `string` | Location from where cruise will depart. | - | models/Cruise.ts:41 | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `shipName` | `string` | Name of the cruise ship. | - | models/Cruise.ts:51 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"CRUISE"` | - | - | models/Cruise.ts:54 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `arrivalTime` | `public` | `Date` | Local date and time of arrival from original arrival location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `departureTime` | `public` | `Date` | Local date and time of departure from original departure location, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `disembarkationPort` | `public` | `string` | The cruise\'s final destination. | - | +| `embarkationPort` | `public` | `string` | Location from where cruise will depart. | - | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `shipName` | `public` | `string` | Name of the cruise ship. | - | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"CRUISE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/CurrentUserSession.md b/release/fraudPreventionV2/docs/models/classes/CurrentUserSession.md index 6db3b73f..78067ed3 100644 --- a/release/fraudPreventionV2/docs/models/classes/CurrentUserSession.md +++ b/release/fraudPreventionV2/docs/models/classes/CurrentUserSession.md @@ -12,7 +12,7 @@ The current user session prior to this transaction, which contains details relat #### Parameters -▪ **currentUserSession**: [`CurrentUserSessionProperties`](../interfaces/CurrentUserSessionProperties.md) +• **currentUserSession**: [`CurrentUserSessionProperties`](../interfaces/CurrentUserSessionProperties.md) #### Returns @@ -24,8 +24,8 @@ models/CurrentUserSession.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `challengeDetail`? | [`ChallengeDetail`](ChallengeDetail.md) | - | models/CurrentUserSession.ts:45 | -| `sessionId`? | `string` | Unique identifier for a user\'s session on their device | models/CurrentUserSession.ts:35 | -| `startDateTime`? | `Date` | The local date and time a user\'s session started, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/CurrentUserSession.ts:40 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `challengeDetail?` | [`ChallengeDetail`](ChallengeDetail.md) | - | +| `sessionId?` | `string` | Unique identifier for a user\'s session on their device | +| `startDateTime?` | `Date` | The local date and time a user\'s session started, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | diff --git a/release/fraudPreventionV2/docs/models/classes/CustomerAccount.md b/release/fraudPreventionV2/docs/models/classes/CustomerAccount.md index 3c507c97..519dba06 100644 --- a/release/fraudPreventionV2/docs/models/classes/CustomerAccount.md +++ b/release/fraudPreventionV2/docs/models/classes/CustomerAccount.md @@ -10,7 +10,7 @@ #### Parameters -▪ **customerAccount**: [`CustomerAccountProperties`](../interfaces/CustomerAccountProperties.md) +• **customerAccount**: [`CustomerAccountProperties`](../interfaces/CustomerAccountProperties.md) #### Returns @@ -22,12 +22,12 @@ models/CustomerAccount.ts:70 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/CustomerAccountAccountTypeEnum.md) | 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. | models/CustomerAccount.ts:43 | -| `address`? | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - | models/CustomerAccount.ts:63 | -| `emailAddress` | `string` | Email address for the account owner. | models/CustomerAccount.ts:53 | -| `name` | [`Name`](Name.md) | - | models/CustomerAccount.ts:48 | -| `registeredTime`? | `Date` | 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`. | models/CustomerAccount.ts:68 | -| `telephones`? | [`Telephone`](Telephone.md)[] | - | models/CustomerAccount.ts:58 | -| `userId`? | `string` | 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. | models/CustomerAccount.ts:38 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/CustomerAccountAccountTypeEnum.md) | 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?` | [`CustomerAccountAddress`](CustomerAccountAddress.md) | - | +| `emailAddress` | `string` | Email address for the account owner. | +| `name` | [`Name`](Name.md) | - | +| `registeredTime?` | `Date` | 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?` | [`Telephone`](Telephone.md)[] | - | +| `userId?` | `string` | 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. | diff --git a/release/fraudPreventionV2/docs/models/classes/CustomerAccountAddress.md b/release/fraudPreventionV2/docs/models/classes/CustomerAccountAddress.md index cece11c3..76e9cf7b 100644 --- a/release/fraudPreventionV2/docs/models/classes/CustomerAccountAddress.md +++ b/release/fraudPreventionV2/docs/models/classes/CustomerAccountAddress.md @@ -10,7 +10,7 @@ #### Parameters -▪ **customerAccountAddress**: [`CustomerAccountAddressProperties`](../interfaces/CustomerAccountAddressProperties.md) +• **customerAccountAddress**: [`CustomerAccountAddressProperties`](../interfaces/CustomerAccountAddressProperties.md) #### Returns @@ -22,12 +22,12 @@ models/CustomerAccountAddress.ts:58 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | Address line 1 of the address provided. | models/CustomerAccountAddress.ts:31 | -| `addressLine2`? | `string` | Address line 2 of the address provided. | models/CustomerAccountAddress.ts:36 | -| `addressType`? | [`CustomerAccountAddressAddressTypeEnum`](../type-aliases/CustomerAccountAddressAddressTypeEnum.md) | - | models/CustomerAccountAddress.ts:26 | -| `city` | `string` | City of the address provided. | models/CustomerAccountAddress.ts:41 | -| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | models/CustomerAccountAddress.ts:56 | -| `state` | `string` | The two-characters ISO code for the state or province of the address. | models/CustomerAccountAddress.ts:46 | -| `zipCode` | `string` | Zip code of the address provided. | models/CustomerAccountAddress.ts:51 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `addressLine1` | `string` | Address line 1 of the address provided. | +| `addressLine2?` | `string` | Address line 2 of the address provided. | +| `addressType?` | [`CustomerAccountAddressAddressTypeEnum`](../type-aliases/CustomerAccountAddressAddressTypeEnum.md) | - | +| `city` | `string` | City of the address provided. | +| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | +| `state` | `string` | The two-characters ISO code for the state or province of the address. | +| `zipCode` | `string` | Zip code of the address provided. | diff --git a/release/fraudPreventionV2/docs/models/classes/DeviceDetails.md b/release/fraudPreventionV2/docs/models/classes/DeviceDetails.md index 1641b3ae..f9523842 100644 --- a/release/fraudPreventionV2/docs/models/classes/DeviceDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/DeviceDetails.md @@ -10,7 +10,7 @@ #### Parameters -▪ **deviceDetails**: [`DeviceDetailsProperties`](../interfaces/DeviceDetailsProperties.md) +• **deviceDetails**: [`DeviceDetailsProperties`](../interfaces/DeviceDetailsProperties.md) #### Returns @@ -22,8 +22,8 @@ models/DeviceDetails.ts:41 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `deviceBox`? | `string` | Device related information retrieved from TrustWidget. | models/DeviceDetails.ts:34 | -| `ipAddress` | `string` | IP address of the device used for booking. | models/DeviceDetails.ts:39 | -| `source`? | `string` | Source of the device_box. Default value is `TrustWidget`. | models/DeviceDetails.ts:29 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `deviceBox?` | `string` | Device related information retrieved from TrustWidget. | +| `ipAddress` | `string` | IP address of the device used for booking. | +| `source?` | `string` | Source of the device_box. Default value is `TrustWidget`. | diff --git a/release/fraudPreventionV2/docs/models/classes/DirectDebit.md b/release/fraudPreventionV2/docs/models/classes/DirectDebit.md index 658f1cb9..3bd7fe10 100644 --- a/release/fraudPreventionV2/docs/models/classes/DirectDebit.md +++ b/release/fraudPreventionV2/docs/models/classes/DirectDebit.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **directDebit**: [`DirectDebitProperties`](../interfaces/DirectDebitProperties.md) +• **directDebit**: [`DirectDebitProperties`](../interfaces/DirectDebitProperties.md) #### Returns @@ -32,20 +32,20 @@ models/DirectDebit.ts:57 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `accountNumber` | `string` | Cleartext (unencrypted) DirectDebit bank account number associated with the payment instrument. | - | models/DirectDebit.ts:39 | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `public` | `mandateType`? | [`DirectDebitMandateTypeEnum`](../type-aliases/DirectDebitMandateTypeEnum.md) | The `mandate_type` is required if given `brand` as `SEPA_ELV` under `DirectDebit`. It is used for the wire transfer or direct debit transaction whose `routing_number` could not be provided or not supported. Allows values: - `ONE_OFF` - `RECURRING` | - | models/DirectDebit.ts:44 | -| `readonly` | `method` | `"DIRECT_DEBIT"` | - | - | models/DirectDebit.ts:55 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `routingNumber`? | `string` | A code that identifies the financial institution for a specific bank account. `routing_number` is required if given `INTER_COMPANY` or `ELV` as `brand`. | - | models/DirectDebit.ts:34 | -| `public` | `telephones` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with direct debit payment provider. | - | models/DirectDebit.ts:52 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `accountNumber` | `public` | `string` | Cleartext (unencrypted) DirectDebit bank account number associated with the payment instrument. | - | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `mandateType?` | `public` | [`DirectDebitMandateTypeEnum`](../type-aliases/DirectDebitMandateTypeEnum.md) | The `mandate_type` is required if given `brand` as `SEPA_ELV` under `DirectDebit`. It is used for the wire transfer or direct debit transaction whose `routing_number` could not be provided or not supported. Allows values: - `ONE_OFF` - `RECURRING` | - | +| `method` | `readonly` | `"DIRECT_DEBIT"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `routingNumber?` | `public` | `string` | A code that identifies the financial institution for a specific bank account. `routing_number` is required if given `INTER_COMPANY` or `ELV` as `brand`. | - | +| `telephones` | `public` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with direct debit payment provider. | - | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/classes/Email.md b/release/fraudPreventionV2/docs/models/classes/Email.md index 2925415b..f0e7932b 100644 --- a/release/fraudPreventionV2/docs/models/classes/Email.md +++ b/release/fraudPreventionV2/docs/models/classes/Email.md @@ -12,7 +12,7 @@ Group of attributes intended to hold information about email address associated #### Parameters -▪ **email**: [`EmailProperties`](../interfaces/EmailProperties.md) +• **email**: [`EmailProperties`](../interfaces/EmailProperties.md) #### Returns @@ -24,6 +24,6 @@ models/Email.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `emailAddress`? | `string` | Full email address including the alias, @ symbol, domain, and root domain. | models/Email.ts:32 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `emailAddress?` | `string` | Full email address including the alias, @ symbol, domain, and root domain. | diff --git a/release/fraudPreventionV2/docs/models/classes/ForbiddenError.md b/release/fraudPreventionV2/docs/models/classes/ForbiddenError.md index 288abeeb..8a3a0ac6 100644 --- a/release/fraudPreventionV2/docs/models/classes/ForbiddenError.md +++ b/release/fraudPreventionV2/docs/models/classes/ForbiddenError.md @@ -12,7 +12,7 @@ Indicates that the API cannot fulfill the request because while the client is co #### Parameters -▪ **forbiddenError**: [`ForbiddenErrorProperties`](../interfaces/ForbiddenErrorProperties.md) +• **forbiddenError**: [`ForbiddenErrorProperties`](../interfaces/ForbiddenErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/ForbiddenError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/ForbiddenErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/ForbiddenError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ForbiddenError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/ForbiddenErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/GatewayTimeoutError.md b/release/fraudPreventionV2/docs/models/classes/GatewayTimeoutError.md index b44f043a..0272477e 100644 --- a/release/fraudPreventionV2/docs/models/classes/GatewayTimeoutError.md +++ b/release/fraudPreventionV2/docs/models/classes/GatewayTimeoutError.md @@ -2,7 +2,7 @@ # Class: 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. +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. ## Constructors @@ -12,7 +12,7 @@ Indicates that the API gateway has issues completing the request on time. Reques #### Parameters -▪ **gatewayTimeoutError**: [`GatewayTimeoutErrorProperties`](../interfaces/GatewayTimeoutErrorProperties.md) +• **gatewayTimeoutError**: [`GatewayTimeoutErrorProperties`](../interfaces/GatewayTimeoutErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/GatewayTimeoutError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/GatewayTimeoutErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/GatewayTimeoutError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/GatewayTimeoutError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/GatewayTimeoutErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/GiftCard.md b/release/fraudPreventionV2/docs/models/classes/GiftCard.md index d00a2860..6a35a6b8 100644 --- a/release/fraudPreventionV2/docs/models/classes/GiftCard.md +++ b/release/fraudPreventionV2/docs/models/classes/GiftCard.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **giftCard**: [`GiftCardProperties`](../interfaces/GiftCardProperties.md) +• **giftCard**: [`GiftCardProperties`](../interfaces/GiftCardProperties.md) #### Returns @@ -32,19 +32,19 @@ models/GiftCard.ts:46 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `cardHolderName` | `string` | The name of gift card holder. | - | models/GiftCard.ts:36 | -| `public` | `cardNumber` | `string` | Gift card number. | - | models/GiftCard.ts:31 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `readonly` | `method` | `"GIFT_CARD"` | - | - | models/GiftCard.ts:44 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `pin` | `string` | The PIN of gift card. | - | models/GiftCard.ts:41 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `cardHolderName` | `public` | `string` | The name of gift card holder. | - | +| `cardNumber` | `public` | `string` | Gift card number. | - | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `method` | `readonly` | `"GIFT_CARD"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `pin` | `public` | `string` | The PIN of gift card. | - | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/classes/Hotel.md b/release/fraudPreventionV2/docs/models/classes/Hotel.md index c51e7874..b86bf49b 100644 --- a/release/fraudPreventionV2/docs/models/classes/Hotel.md +++ b/release/fraudPreventionV2/docs/models/classes/Hotel.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **hotel**: [`HotelProperties`](../interfaces/HotelProperties.md) +• **hotel**: [`HotelProperties`](../interfaces/HotelProperties.md) #### Returns @@ -32,18 +32,18 @@ models/Hotel.ts:69 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `address` | [`HotelAddress`](HotelAddress.md) | - | - | models/Hotel.ts:54 | -| `public` | `checkinTime` | `Date` | Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Hotel.ts:59 | -| `public` | `checkoutTime` | `Date` | Local date and time of the hotel check-out, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | models/Hotel.ts:64 | -| `public` | `hotelId` | `string` | Unique hotel identifier assigned by the partner. | - | models/Hotel.ts:34 | -| `public` | `hotelName` | `string` | Name of the hotel. | - | models/Hotel.ts:44 | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `priceWithheld`? | `boolean` | Identifies if the product price was withheld from the customer during the booking process. | - | models/Hotel.ts:39 | -| `public` | `roomCount`? | `number` | Total number of rooms booked within the hotel product collection. | - | models/Hotel.ts:49 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"HOTEL"` | - | - | models/Hotel.ts:67 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `address` | `public` | [`HotelAddress`](HotelAddress.md) | - | - | +| `checkinTime` | `public` | `Date` | Local date and time of the hotel check-in, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `checkoutTime` | `public` | `Date` | Local date and time of the hotel check-out, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | - | +| `hotelId` | `public` | `string` | Unique hotel identifier assigned by the partner. | - | +| `hotelName` | `public` | `string` | Name of the hotel. | - | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `priceWithheld?` | `public` | `boolean` | Identifies if the product price was withheld from the customer during the booking process. | - | +| `roomCount?` | `public` | `number` | Total number of rooms booked within the hotel product collection. | - | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"HOTEL"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/HotelAddress.md b/release/fraudPreventionV2/docs/models/classes/HotelAddress.md index cae274bb..6824f4f0 100644 --- a/release/fraudPreventionV2/docs/models/classes/HotelAddress.md +++ b/release/fraudPreventionV2/docs/models/classes/HotelAddress.md @@ -12,7 +12,7 @@ Address of a hotel. #### Parameters -▪ **hotelAddress**: [`HotelAddressProperties`](../interfaces/HotelAddressProperties.md) +• **hotelAddress**: [`HotelAddressProperties`](../interfaces/HotelAddressProperties.md) #### Returns @@ -24,12 +24,12 @@ models/HotelAddress.ts:61 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | Address line 1 of the address provided. | models/HotelAddress.ts:34 | -| `addressLine2`? | `string` | Address line 2 of the address provided. | models/HotelAddress.ts:39 | -| `addressType`? | [`HotelAddressAddressTypeEnum`](../type-aliases/HotelAddressAddressTypeEnum.md) | - | models/HotelAddress.ts:29 | -| `city` | `string` | City of the address provided. | models/HotelAddress.ts:44 | -| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | models/HotelAddress.ts:59 | -| `state` | `string` | The two-characters ISO code for the state or province of the address. | models/HotelAddress.ts:49 | -| `zipCode` | `string` | Zip code of the address provided. | models/HotelAddress.ts:54 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `addressLine1` | `string` | Address line 1 of the address provided. | +| `addressLine2?` | `string` | Address line 2 of the address provided. | +| `addressType?` | [`HotelAddressAddressTypeEnum`](../type-aliases/HotelAddressAddressTypeEnum.md) | - | +| `city` | `string` | City of the address provided. | +| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | +| `state` | `string` | The two-characters ISO code for the state or province of the address. | +| `zipCode` | `string` | Zip code of the address provided. | diff --git a/release/fraudPreventionV2/docs/models/classes/InsultDetail.md b/release/fraudPreventionV2/docs/models/classes/InsultDetail.md index 45383a5f..eead2451 100644 --- a/release/fraudPreventionV2/docs/models/classes/InsultDetail.md +++ b/release/fraudPreventionV2/docs/models/classes/InsultDetail.md @@ -12,7 +12,7 @@ Details related to the insult. #### Parameters -▪ **insultDetail**: [`InsultDetailProperties`](../interfaces/InsultDetailProperties.md) +• **insultDetail**: [`InsultDetailProperties`](../interfaces/InsultDetailProperties.md) #### Returns @@ -24,6 +24,6 @@ models/InsultDetail.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `insultReportedDateTime`? | `Date` | Date and time when the insult was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/InsultDetail.ts:32 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `insultReportedDateTime?` | `Date` | Date and time when the insult was reported to the partner, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | diff --git a/release/fraudPreventionV2/docs/models/classes/InsultFeedback.md b/release/fraudPreventionV2/docs/models/classes/InsultFeedback.md index 5f855f43..3782db8a 100644 --- a/release/fraudPreventionV2/docs/models/classes/InsultFeedback.md +++ b/release/fraudPreventionV2/docs/models/classes/InsultFeedback.md @@ -16,7 +16,7 @@ Feedback from EG external partners regarding a false positive recommendation tha #### Parameters -▪ **insultFeedback**: [`InsultFeedbackProperties`](../interfaces/InsultFeedbackProperties.md) +• **insultFeedback**: [`InsultFeedbackProperties`](../interfaces/InsultFeedbackProperties.md) #### Returns @@ -32,8 +32,8 @@ models/InsultFeedback.ts:41 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `insultDetail`? | [`InsultDetail`](InsultDetail.md) | - | - | models/InsultFeedback.ts:36 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"INSULT_FEEDBACK"` | - | - | models/InsultFeedback.ts:39 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `insultDetail?` | `public` | [`InsultDetail`](InsultDetail.md) | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"INSULT_FEEDBACK"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/Insurance.md b/release/fraudPreventionV2/docs/models/classes/Insurance.md index 28fcbdbd..a5412dc1 100644 --- a/release/fraudPreventionV2/docs/models/classes/Insurance.md +++ b/release/fraudPreventionV2/docs/models/classes/Insurance.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **insurance**: [`InsuranceProperties`](../interfaces/InsuranceProperties.md) +• **insurance**: [`InsuranceProperties`](../interfaces/InsuranceProperties.md) #### Returns @@ -32,11 +32,11 @@ models/Insurance.ts:30 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"INSURANCE"` | - | - | models/Insurance.ts:28 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"INSURANCE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/InternalServerError.md b/release/fraudPreventionV2/docs/models/classes/InternalServerError.md index 80f29374..5f36178d 100644 --- a/release/fraudPreventionV2/docs/models/classes/InternalServerError.md +++ b/release/fraudPreventionV2/docs/models/classes/InternalServerError.md @@ -12,7 +12,7 @@ Indicates that the API encountered an unexpected condition that prevented it fro #### Parameters -▪ **internalServerError**: [`InternalServerErrorProperties`](../interfaces/InternalServerErrorProperties.md) +• **internalServerError**: [`InternalServerErrorProperties`](../interfaces/InternalServerErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/InternalServerError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/InternalServerErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/InternalServerError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/InternalServerError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/InternalServerErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/InternetBankPayment.md b/release/fraudPreventionV2/docs/models/classes/InternetBankPayment.md index 00564f63..9cae39b8 100644 --- a/release/fraudPreventionV2/docs/models/classes/InternetBankPayment.md +++ b/release/fraudPreventionV2/docs/models/classes/InternetBankPayment.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **internetBankPayment**: [`InternetBankPaymentProperties`](../interfaces/InternetBankPaymentProperties.md) +• **internetBankPayment**: [`InternetBankPaymentProperties`](../interfaces/InternetBankPaymentProperties.md) #### Returns @@ -32,19 +32,19 @@ models/InternetBankPayment.ts:52 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `bankBranchCode` | `string` | A code that identifies the bank branch for internet bank payment(IBP). | - | models/InternetBankPayment.ts:39 | -| `public` | `bankId` | `string` | The bank_id provided by the internet bank payment(IBP) provider (DRWP aka NetGiro) for the bank used for processing the payment. | - | models/InternetBankPayment.ts:34 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `readonly` | `method` | `"INTERNET_BANK_PAYMENT"` | - | - | models/InternetBankPayment.ts:50 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `telephones` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with internet bank payment(IBP) provider. | - | models/InternetBankPayment.ts:47 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `bankBranchCode` | `public` | `string` | A code that identifies the bank branch for internet bank payment(IBP). | - | +| `bankId` | `public` | `string` | The bank_id provided by the internet bank payment(IBP) provider (DRWP aka NetGiro) for the bank used for processing the payment. | - | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `method` | `readonly` | `"INTERNET_BANK_PAYMENT"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `telephones` | `public` | [`Telephone`](Telephone.md)[] | Telephone(s) associated with internet bank payment(IBP) provider. | - | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdate.md index 1d25c769..d7ac5117 100644 --- a/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdate.md @@ -16,7 +16,7 @@ Data related to the issued refund that should be updated. #### Parameters -▪ **issuedRefundUpdate**: [`IssuedRefundUpdateProperties`](../interfaces/IssuedRefundUpdateProperties.md) +• **issuedRefundUpdate**: [`IssuedRefundUpdateProperties`](../interfaces/IssuedRefundUpdateProperties.md) #### Returns @@ -32,9 +32,9 @@ models/IssuedRefundUpdate.ts:41 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `refundDetails`? | [`IssuedRefundUpdateDetails`](IssuedRefundUpdateDetails.md) | - | - | models/IssuedRefundUpdate.ts:36 | -| `readonly` | `refundStatus` | `"ISSUED"` | - | - | models/IssuedRefundUpdate.ts:39 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`RefundUpdate`](RefundUpdate.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"REFUND_UPDATE"` | - | [`RefundUpdate`](RefundUpdate.md).`type` | models/RefundUpdate.ts:31 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `refundDetails?` | `public` | [`IssuedRefundUpdateDetails`](IssuedRefundUpdateDetails.md) | - | - | +| `refundStatus` | `readonly` | `"ISSUED"` | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`RefundUpdate`](RefundUpdate.md).`riskId` | +| `type` | `readonly` | `"REFUND_UPDATE"` | - | [`RefundUpdate`](RefundUpdate.md).`type` | diff --git a/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdateDetails.md b/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdateDetails.md index 57ee4e44..a03f756b 100644 --- a/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdateDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/IssuedRefundUpdateDetails.md @@ -12,7 +12,7 @@ Data that describes issued refund that should be updated. #### Parameters -▪ **issuedRefundUpdateDetails**: [`IssuedRefundUpdateDetailsProperties`](../interfaces/IssuedRefundUpdateDetailsProperties.md) +• **issuedRefundUpdateDetails**: [`IssuedRefundUpdateDetailsProperties`](../interfaces/IssuedRefundUpdateDetailsProperties.md) #### Returns @@ -24,7 +24,7 @@ models/IssuedRefundUpdateDetails.ts:42 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `refundIssuedAmount` | [`Amount`](Amount.md) | - | models/IssuedRefundUpdateDetails.ts:40 | -| `refundIssuedDateTime` | `Date` | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has issued at the participating financial institutions. | models/IssuedRefundUpdateDetails.ts:35 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `refundIssuedAmount` | [`Amount`](Amount.md) | - | +| `refundIssuedDateTime` | `Date` | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has issued at the participating financial institutions. | diff --git a/release/fraudPreventionV2/docs/models/classes/LoginTransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/LoginTransactionDetails.md index 9c82eb6b..fa2866bd 100644 --- a/release/fraudPreventionV2/docs/models/classes/LoginTransactionDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/LoginTransactionDetails.md @@ -16,7 +16,7 @@ The `transaction_type` field value is used as a discriminator, with the followin #### Parameters -▪ **loginTransactionDetails**: [`LoginTransactionDetailsProperties`](../interfaces/LoginTransactionDetailsProperties.md) +• **loginTransactionDetails**: [`LoginTransactionDetailsProperties`](../interfaces/LoginTransactionDetailsProperties.md) #### Returns @@ -32,13 +32,13 @@ models/LoginTransactionDetails.ts:51 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `authenticationSubType`? | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md) | 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` | - | models/LoginTransactionDetails.ts:36 | -| `public` | `authenticationType` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md) | 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` | - | models/LoginTransactionDetails.ts:31 | -| `public` | `currentUserSession`? | [`CurrentUserSession`](CurrentUserSession.md) | - | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`currentUserSession` | models/AccountTakeoverTransactionDetails.ts:45 | -| `public` | `failedLoginReason`? | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md) | 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. | - | models/LoginTransactionDetails.ts:46 | -| `public` | `successfulLoginFlag` | `boolean` | Identifies if a login attempt by a user was successful or not. | - | models/LoginTransactionDetails.ts:41 | -| `public` | `transactionDateTime` | `Date` | 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`. | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`transactionDateTime` | models/AccountTakeoverTransactionDetails.ts:35 | -| `public` | `transactionId` | `string` | Unique identifier to identify a transaction attempt in the Partner\'s system. | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`transactionId` | models/AccountTakeoverTransactionDetails.ts:40 | -| `readonly` | `type` | `"LOGIN"` | - | - | models/LoginTransactionDetails.ts:49 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `authenticationSubType?` | `public` | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md) | 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` | - | +| `authenticationType` | `public` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md) | 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` | - | +| `currentUserSession?` | `public` | [`CurrentUserSession`](CurrentUserSession.md) | - | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`currentUserSession` | +| `failedLoginReason?` | `public` | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md) | 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. | - | +| `successfulLoginFlag` | `public` | `boolean` | Identifies if a login attempt by a user was successful or not. | - | +| `transactionDateTime` | `public` | `Date` | 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`. | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`transactionDateTime` | +| `transactionId` | `public` | `string` | Unique identifier to identify a transaction attempt in the Partner\'s system. | [`AccountTakeoverTransactionDetails`](AccountTakeoverTransactionDetails.md).`transactionId` | +| `type` | `readonly` | `"LOGIN"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/ModelError.md b/release/fraudPreventionV2/docs/models/classes/ModelError.md index 579c3dac..8d025673 100644 --- a/release/fraudPreventionV2/docs/models/classes/ModelError.md +++ b/release/fraudPreventionV2/docs/models/classes/ModelError.md @@ -12,7 +12,7 @@ The object used to describe an error, containing both human-readable and machine #### Parameters -▪ **error**: [`ModelErrorProperties`](../interfaces/ModelErrorProperties.md) +• **error**: [`ModelErrorProperties`](../interfaces/ModelErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/ModelError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ModelErrorCodeEnum`](../type-aliases/ModelErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/ModelError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ModelError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`ModelErrorCodeEnum`](../type-aliases/ModelErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationAttempt.md b/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationAttempt.md index bff53bc9..a21941a0 100644 --- a/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationAttempt.md +++ b/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationAttempt.md @@ -12,7 +12,7 @@ Information specific to the update event by a user. #### Parameters -▪ **multiFactorAuthenticationAttempt**: [`MultiFactorAuthenticationAttemptProperties`](../interfaces/MultiFactorAuthenticationAttemptProperties.md) +• **multiFactorAuthenticationAttempt**: [`MultiFactorAuthenticationAttemptProperties`](../interfaces/MultiFactorAuthenticationAttemptProperties.md) #### Returns @@ -24,14 +24,14 @@ models/MultiFactorAuthenticationAttempt.ts:77 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `attemptCount` | `number` | The number of attempts a user tried for this Multi-Factor Authentication. | models/MultiFactorAuthenticationAttempt.ts:55 | -| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) | The delivery method of the Multi-Factor Authentication to a user. | models/MultiFactorAuthenticationAttempt.ts:35 | -| `emailAddress`? | `string` | Email address used for the Multi-Factor Authentication by a user. | models/MultiFactorAuthenticationAttempt.ts:75 | -| `providerName` | `string` | The vendor providing the Multi-Factor Authentication verification. | models/MultiFactorAuthenticationAttempt.ts:50 | -| `referenceId` | `string` | The identifier related to a Multi-Factor Authentication attempt by the Partner\'s system to the Multi-Factor Authentication provider. | models/MultiFactorAuthenticationAttempt.ts:45 | -| `status` | [`MultiFactorAuthenticationAttemptStatusEnum`](../type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md) | 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. | models/MultiFactorAuthenticationAttempt.ts:40 | -| `telephone`? | [`Telephone`](Telephone.md) | - | models/MultiFactorAuthenticationAttempt.ts:70 | -| `updateEndDateTime`? | `Date` | 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`. | models/MultiFactorAuthenticationAttempt.ts:65 | -| `updateStartDateTime`? | `Date` | 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`. | models/MultiFactorAuthenticationAttempt.ts:60 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `attemptCount` | `number` | The number of attempts a user tried for this Multi-Factor Authentication. | +| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) | The delivery method of the Multi-Factor Authentication to a user. | +| `emailAddress?` | `string` | Email address used for the Multi-Factor Authentication by a user. | +| `providerName` | `string` | The vendor providing the Multi-Factor Authentication verification. | +| `referenceId` | `string` | The identifier related to a Multi-Factor Authentication attempt by the Partner\'s system to the Multi-Factor Authentication provider. | +| `status` | [`MultiFactorAuthenticationAttemptStatusEnum`](../type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md) | 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?` | [`Telephone`](Telephone.md) | - | +| `updateEndDateTime?` | `Date` | 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`. | +| `updateStartDateTime?` | `Date` | 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`. | diff --git a/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationUpdate.md b/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationUpdate.md index c0ce0151..32f8a196 100644 --- a/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/MultiFactorAuthenticationUpdate.md @@ -16,7 +16,7 @@ Information specific to a user\'s response to a Multi-Factor Authentication init #### Parameters -▪ **multiFactorAuthenticationUpdate**: [`MultiFactorAuthenticationUpdateProperties`](../interfaces/MultiFactorAuthenticationUpdateProperties.md) +• **multiFactorAuthenticationUpdate**: [`MultiFactorAuthenticationUpdateProperties`](../interfaces/MultiFactorAuthenticationUpdateProperties.md) #### Returns @@ -32,8 +32,8 @@ models/MultiFactorAuthenticationUpdate.ts:43 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `multiFactorAuthenticationAttempts` | [`MultiFactorAuthenticationAttempt`](MultiFactorAuthenticationAttempt.md)[] | - | - | models/MultiFactorAuthenticationUpdate.ts:38 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | [`AccountUpdateRequest`](AccountUpdateRequest.md).`riskId` | models/AccountUpdateRequest.ts:32 | -| `readonly` | `type` | `"MULTI_FACTOR_AUTHENTICATION_UPDATE"` | - | - | models/MultiFactorAuthenticationUpdate.ts:41 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `multiFactorAuthenticationAttempts` | `public` | [`MultiFactorAuthenticationAttempt`](MultiFactorAuthenticationAttempt.md)[] | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | [`AccountUpdateRequest`](AccountUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"MULTI_FACTOR_AUTHENTICATION_UPDATE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/Name.md b/release/fraudPreventionV2/docs/models/classes/Name.md index fd8d0abe..9779cb77 100644 --- a/release/fraudPreventionV2/docs/models/classes/Name.md +++ b/release/fraudPreventionV2/docs/models/classes/Name.md @@ -12,7 +12,7 @@ Group of attributes intended to hold information about a customer or traveler\'s #### Parameters -▪ **name**: [`NameProperties`](../interfaces/NameProperties.md) +• **name**: [`NameProperties`](../interfaces/NameProperties.md) #### Returns @@ -24,10 +24,10 @@ models/Name.ts:54 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `firstName` | `string` | Given, or first name, of the person. | models/Name.ts:37 | -| `lastName` | `string` | Surname, or last name, of the person. | models/Name.ts:32 | -| `middleName`? | `string` | Middle name of the person. | models/Name.ts:42 | -| `suffix`? | `string` | 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). | models/Name.ts:52 | -| `title`? | `string` | Title of the person for name (e.g. Mr., Ms. etc). | models/Name.ts:47 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `firstName` | `string` | Given, or first name, of the person. | +| `lastName` | `string` | Surname, or last name, of the person. | +| `middleName?` | `string` | Middle name of the person. | +| `suffix?` | `string` | 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?` | `string` | Title of the person for name (e.g. Mr., Ms. etc). | diff --git a/release/fraudPreventionV2/docs/models/classes/NotFoundError.md b/release/fraudPreventionV2/docs/models/classes/NotFoundError.md index 30d4082b..e815c789 100644 --- a/release/fraudPreventionV2/docs/models/classes/NotFoundError.md +++ b/release/fraudPreventionV2/docs/models/classes/NotFoundError.md @@ -12,7 +12,7 @@ Indicates that the API cannot find the resource that is either being requested o #### Parameters -▪ **notFoundError**: [`NotFoundErrorProperties`](../interfaces/NotFoundErrorProperties.md) +• **notFoundError**: [`NotFoundErrorProperties`](../interfaces/NotFoundErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/NotFoundError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/NotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/NotFoundError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/NotFoundError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/NotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/Operations.md b/release/fraudPreventionV2/docs/models/classes/Operations.md index 176d6743..9e028257 100644 --- a/release/fraudPreventionV2/docs/models/classes/Operations.md +++ b/release/fraudPreventionV2/docs/models/classes/Operations.md @@ -12,7 +12,7 @@ All operations related to a payment throughout its lifespan. An operation repres #### Parameters -▪ **operations**: [`OperationsProperties`](../interfaces/OperationsProperties.md) +• **operations**: [`OperationsProperties`](../interfaces/OperationsProperties.md) #### Returns @@ -24,10 +24,10 @@ models/Operations.ts:68 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `authorize`? | [`Authorize`](Authorize.md) | - | models/Operations.ts:51 | -| `authorizeReversal`? | [`AuthorizeReversal`](AuthorizeReversal.md) | - | models/Operations.ts:56 | -| `capture`? | [`Capture`](Capture.md) | - | models/Operations.ts:61 | -| `refunds`? | [`Refund`](Refund.md)[] | - | models/Operations.ts:66 | -| `verify`? | [`Verify`](Verify.md) | - | models/Operations.ts:46 | +| Property | Type | +| :------ | :------ | +| `authorize?` | [`Authorize`](Authorize.md) | +| `authorizeReversal?` | [`AuthorizeReversal`](AuthorizeReversal.md) | +| `capture?` | [`Capture`](Capture.md) | +| `refunds?` | [`Refund`](Refund.md)[] | +| `verify?` | [`Verify`](Verify.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenRequest.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenRequest.md index aa551487..c4125f15 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenRequest.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenRequest.md @@ -10,7 +10,7 @@ #### Parameters -▪ **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequestProperties`](../interfaces/OrderPurchaseScreenRequestProperties.md) +• **orderPurchaseScreenRequest**: [`OrderPurchaseScreenRequestProperties`](../interfaces/OrderPurchaseScreenRequestProperties.md) #### Returns @@ -22,6 +22,6 @@ models/OrderPurchaseScreenRequest.ts:33 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `transaction` | [`OrderPurchaseTransaction`](OrderPurchaseTransaction.md) | - | models/OrderPurchaseScreenRequest.ts:31 | +| Property | Type | +| :------ | :------ | +| `transaction` | [`OrderPurchaseTransaction`](OrderPurchaseTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenResponse.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenResponse.md index b52fade9..c831db79 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenResponse.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseScreenResponse.md @@ -10,7 +10,7 @@ #### Parameters -▪ **orderPurchaseScreenResponse**: [`OrderPurchaseScreenResponseProperties`](../interfaces/OrderPurchaseScreenResponseProperties.md) +• **orderPurchaseScreenResponse**: [`OrderPurchaseScreenResponseProperties`](../interfaces/OrderPurchaseScreenResponseProperties.md) #### Returns @@ -22,7 +22,7 @@ models/OrderPurchaseScreenResponse.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `decision`? | [`FraudDecision`](../type-aliases/FraudDecision.md) | - | models/OrderPurchaseScreenResponse.ts:32 | -| `riskId`? | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | models/OrderPurchaseScreenResponse.ts:30 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `decision?` | [`FraudDecision`](../type-aliases/FraudDecision.md) | - | +| `riskId?` | `string` | Unique identifier assigned to the transaction by Expedia\'s Fraud Prevention Service. | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseTransaction.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseTransaction.md index 0dd6f10f..60e8a191 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseTransaction.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseTransaction.md @@ -10,7 +10,7 @@ #### Parameters -▪ **orderPurchaseTransaction**: [`OrderPurchaseTransactionProperties`](../interfaces/OrderPurchaseTransactionProperties.md) +• **orderPurchaseTransaction**: [`OrderPurchaseTransactionProperties`](../interfaces/OrderPurchaseTransactionProperties.md) #### Returns @@ -22,9 +22,9 @@ models/OrderPurchaseTransaction.ts:57 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `customerAccount` | [`CustomerAccount`](CustomerAccount.md) | - | models/OrderPurchaseTransaction.ts:50 | -| `deviceDetails` | [`DeviceDetails`](DeviceDetails.md) | - | models/OrderPurchaseTransaction.ts:45 | -| `siteInfo` | [`SiteInfo`](SiteInfo.md) | - | models/OrderPurchaseTransaction.ts:40 | -| `transactionDetails` | [`TransactionDetails`](TransactionDetails.md) | - | models/OrderPurchaseTransaction.ts:55 | +| Property | Type | +| :------ | :------ | +| `customerAccount` | [`CustomerAccount`](CustomerAccount.md) | +| `deviceDetails` | [`DeviceDetails`](DeviceDetails.md) | +| `siteInfo` | [`SiteInfo`](SiteInfo.md) | +| `transactionDetails` | [`TransactionDetails`](TransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateNotFoundError.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateNotFoundError.md index 3888f3c4..a159922e 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateNotFoundError.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateNotFoundError.md @@ -12,7 +12,7 @@ Indicates that the API cannot find the resource that is either being requested o #### Parameters -▪ **orderPurchaseUpdateNotFoundError**: [`OrderPurchaseUpdateNotFoundErrorProperties`](../interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md) +• **orderPurchaseUpdateNotFoundError**: [`OrderPurchaseUpdateNotFoundErrorProperties`](../interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/OrderPurchaseUpdateNotFoundError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/OrderPurchaseUpdateNotFoundError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/OrderPurchaseUpdateNotFoundError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateRequest.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateRequest.md index bc30ecce..ae3ce072 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateRequest.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateRequest.md @@ -4,7 +4,7 @@ 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` -## Extended By +## Extended by - [`ChargebackFeedback`](ChargebackFeedback.md) - [`InsultFeedback`](InsultFeedback.md) @@ -20,7 +20,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequestProperties`](../interfaces/OrderPurchaseUpdateRequestProperties.md) +• **orderPurchaseUpdateRequest**: [`OrderPurchaseUpdateRequestProperties`](../interfaces/OrderPurchaseUpdateRequestProperties.md) #### Returns @@ -32,6 +32,6 @@ models/OrderPurchaseUpdateRequest.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | models/OrderPurchaseUpdateRequest.ts:32 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateResponse.md b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateResponse.md index c7cd94a6..49ac9a46 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateResponse.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderPurchaseUpdateResponse.md @@ -10,7 +10,7 @@ #### Parameters -▪ **orderPurchaseUpdateResponse**: [`OrderPurchaseUpdateResponseProperties`](../interfaces/OrderPurchaseUpdateResponseProperties.md) +• **orderPurchaseUpdateResponse**: [`OrderPurchaseUpdateResponseProperties`](../interfaces/OrderPurchaseUpdateResponseProperties.md) #### Returns @@ -22,6 +22,6 @@ models/OrderPurchaseUpdateResponse.ts:31 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId`? | `string` | Unique identifier of transaction that was updated. | models/OrderPurchaseUpdateResponse.ts:29 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `riskId?` | `string` | Unique identifier of transaction that was updated. | diff --git a/release/fraudPreventionV2/docs/models/classes/OrderUpdate.md b/release/fraudPreventionV2/docs/models/classes/OrderUpdate.md index 5d430a04..a4d42e5f 100644 --- a/release/fraudPreventionV2/docs/models/classes/OrderUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/OrderUpdate.md @@ -16,7 +16,7 @@ Order related data that should be updated. #### Parameters -▪ **orderUpdate**: [`OrderUpdateProperties`](../interfaces/OrderUpdateProperties.md) +• **orderUpdate**: [`OrderUpdateProperties`](../interfaces/OrderUpdateProperties.md) #### Returns @@ -32,10 +32,10 @@ models/OrderUpdate.ts:50 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `acquirerReferenceNumber`? | `string` | 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. | - | models/OrderUpdate.ts:40 | -| `public` | `cancellationReason`? | [`CancellationReason`](CancellationReason.md) | - | - | models/OrderUpdate.ts:45 | -| `public` | `orderStatus` | [`Status`](../type-aliases/Status.md) | - | - | models/OrderUpdate.ts:35 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"ORDER_UPDATE"` | - | - | models/OrderUpdate.ts:48 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `acquirerReferenceNumber?` | `public` | `string` | 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. | - | +| `cancellationReason?` | `public` | [`CancellationReason`](CancellationReason.md) | - | - | +| `orderStatus` | `public` | [`Status`](../type-aliases/Status.md) | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"ORDER_UPDATE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/PayPal.md b/release/fraudPreventionV2/docs/models/classes/PayPal.md index 5e103202..83adf5e7 100644 --- a/release/fraudPreventionV2/docs/models/classes/PayPal.md +++ b/release/fraudPreventionV2/docs/models/classes/PayPal.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **payPal**: [`PayPalProperties`](../interfaces/PayPalProperties.md) +• **payPal**: [`PayPalProperties`](../interfaces/PayPalProperties.md) #### Returns @@ -32,19 +32,19 @@ models/PayPal.ts:46 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `public` | `merchantOrderCode`? | `string` | 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. | - | models/PayPal.ts:41 | -| `readonly` | `method` | `"PAYPAL"` | - | - | models/PayPal.ts:44 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `payerId` | `string` | Unique PayPal Customer Account identification number. | - | models/PayPal.ts:31 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `transactionId` | `string` | Unique transaction number to identify Auth calls at PayPal. | - | models/PayPal.ts:36 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `merchantOrderCode?` | `public` | `string` | 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` | `readonly` | `"PAYPAL"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `payerId` | `public` | `string` | Unique PayPal Customer Account identification number. | - | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `transactionId` | `public` | `string` | Unique transaction number to identify Auth calls at PayPal. | - | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/classes/Payment.md b/release/fraudPreventionV2/docs/models/classes/Payment.md index c07da228..f8aafddc 100644 --- a/release/fraudPreventionV2/docs/models/classes/Payment.md +++ b/release/fraudPreventionV2/docs/models/classes/Payment.md @@ -4,7 +4,7 @@ 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` -## Extended By +## Extended by - [`CreditCard`](CreditCard.md) - [`DirectDebit`](DirectDebit.md) @@ -21,7 +21,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **payment**: [`PaymentProperties`](../interfaces/PaymentProperties.md) +• **payment**: [`PaymentProperties`](../interfaces/PaymentProperties.md) #### Returns @@ -33,15 +33,15 @@ models/Payment.ts:92 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](Amount.md) | - | models/Payment.ts:70 | -| `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | models/Payment.ts:60 | -| `billingEmailAddress` | `string` | Email address associated with the payment. | models/Payment.ts:65 | -| `billingName` | [`Name`](Name.md) | - | models/Payment.ts:55 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | models/Payment.ts:48 | -| `extensions`? | `object` | A key-value pair map to hold additional attributes. | models/Payment.ts:90 | -| `operations`? | [`Operations`](Operations.md) | - | models/Payment.ts:85 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | models/Payment.ts:50 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | models/Payment.ts:80 | -| `verifiedAmount`? | [`Amount`](Amount.md) | - | models/Payment.ts:75 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](Amount.md) | - | +| `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | +| `billingEmailAddress` | `string` | Email address associated with the payment. | +| `billingName` | [`Name`](Name.md) | - | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | +| `extensions?` | `Object` | A key-value pair map to hold additional attributes. | +| `operations?` | [`Operations`](Operations.md) | - | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | +| `verifiedAmount?` | [`Amount`](Amount.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/PaymentBillingAddress.md b/release/fraudPreventionV2/docs/models/classes/PaymentBillingAddress.md index ed3c2839..620a5a03 100644 --- a/release/fraudPreventionV2/docs/models/classes/PaymentBillingAddress.md +++ b/release/fraudPreventionV2/docs/models/classes/PaymentBillingAddress.md @@ -10,7 +10,7 @@ #### Parameters -▪ **paymentBillingAddress**: [`PaymentBillingAddressProperties`](../interfaces/PaymentBillingAddressProperties.md) +• **paymentBillingAddress**: [`PaymentBillingAddressProperties`](../interfaces/PaymentBillingAddressProperties.md) #### Returns @@ -22,12 +22,12 @@ models/PaymentBillingAddress.ts:58 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | Address line 1 of the address provided. | models/PaymentBillingAddress.ts:31 | -| `addressLine2`? | `string` | Address line 2 of the address provided. | models/PaymentBillingAddress.ts:36 | -| `addressType`? | [`PaymentBillingAddressAddressTypeEnum`](../type-aliases/PaymentBillingAddressAddressTypeEnum.md) | - | models/PaymentBillingAddress.ts:26 | -| `city` | `string` | City of the address provided. | models/PaymentBillingAddress.ts:41 | -| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | models/PaymentBillingAddress.ts:56 | -| `state`? | `string` | The two-characters ISO code for the state or province of the address. | models/PaymentBillingAddress.ts:46 | -| `zipCode` | `string` | Zip code of the address provided. | models/PaymentBillingAddress.ts:51 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `addressLine1` | `string` | Address line 1 of the address provided. | +| `addressLine2?` | `string` | Address line 2 of the address provided. | +| `addressType?` | [`PaymentBillingAddressAddressTypeEnum`](../type-aliases/PaymentBillingAddressAddressTypeEnum.md) | - | +| `city` | `string` | City of the address provided. | +| `countryCode` | `string` | ISO alpha-3 country code of the address provided. | +| `state?` | `string` | The two-characters ISO code for the state or province of the address. | +| `zipCode` | `string` | Zip code of the address provided. | diff --git a/release/fraudPreventionV2/docs/models/classes/PaymentOperation.md b/release/fraudPreventionV2/docs/models/classes/PaymentOperation.md index 5bc302b6..1b9affe1 100644 --- a/release/fraudPreventionV2/docs/models/classes/PaymentOperation.md +++ b/release/fraudPreventionV2/docs/models/classes/PaymentOperation.md @@ -10,7 +10,7 @@ #### Parameters -▪ **paymentOperation**: [`PaymentOperationProperties`](../interfaces/PaymentOperationProperties.md) +• **paymentOperation**: [`PaymentOperationProperties`](../interfaces/PaymentOperationProperties.md) #### Returns @@ -22,8 +22,8 @@ models/PaymentOperation.ts:44 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/PaymentOperation.ts:37 | -| `id`? | `string` | - | models/PaymentOperation.ts:32 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/PaymentOperation.ts:42 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/PaymentOutcome.md b/release/fraudPreventionV2/docs/models/classes/PaymentOutcome.md index 315bc8fe..fd6c29de 100644 --- a/release/fraudPreventionV2/docs/models/classes/PaymentOutcome.md +++ b/release/fraudPreventionV2/docs/models/classes/PaymentOutcome.md @@ -10,7 +10,7 @@ #### Parameters -▪ **paymentOutcome**: [`PaymentOutcomeProperties`](../interfaces/PaymentOutcomeProperties.md) +• **paymentOutcome**: [`PaymentOutcomeProperties`](../interfaces/PaymentOutcomeProperties.md) #### Returns @@ -22,8 +22,8 @@ models/PaymentOutcome.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | `string` | A mnemonic code for the payment processing. | models/PaymentOutcome.ts:32 | -| `description`? | `string` | A short description providing additional explanation regarding the mnemonic code. | models/PaymentOutcome.ts:37 | -| `status`? | [`PaymentStatus`](../type-aliases/PaymentStatus.md) | - | models/PaymentOutcome.ts:27 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code?` | `string` | A mnemonic code for the payment processing. | +| `description?` | `string` | A short description providing additional explanation regarding the mnemonic code. | +| `status?` | [`PaymentStatus`](../type-aliases/PaymentStatus.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/PaymentThreeDSCriteria.md b/release/fraudPreventionV2/docs/models/classes/PaymentThreeDSCriteria.md index 236ddeb6..51a9c09c 100644 --- a/release/fraudPreventionV2/docs/models/classes/PaymentThreeDSCriteria.md +++ b/release/fraudPreventionV2/docs/models/classes/PaymentThreeDSCriteria.md @@ -12,7 +12,7 @@ Payment ThreeDS criteria attributes. #### Parameters -▪ **paymentThreeDSCriteria**: [`PaymentThreeDSCriteriaProperties`](../interfaces/PaymentThreeDSCriteriaProperties.md) +• **paymentThreeDSCriteria**: [`PaymentThreeDSCriteriaProperties`](../interfaces/PaymentThreeDSCriteriaProperties.md) #### Returns @@ -24,7 +24,7 @@ models/PaymentThreeDSCriteria.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `probableFlag`? | `boolean` | This is a flag passed that indicates that this transaction could potentially go through 3DS. | models/PaymentThreeDSCriteria.ts:32 | -| `transactionModel`? | `string` | Model used to process payment transaction. | models/PaymentThreeDSCriteria.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `probableFlag?` | `boolean` | This is a flag passed that indicates that this transaction could potentially go through 3DS. | +| `transactionModel?` | `string` | Model used to process payment transaction. | diff --git a/release/fraudPreventionV2/docs/models/classes/PaymentUpdate.md b/release/fraudPreventionV2/docs/models/classes/PaymentUpdate.md index c52ecf03..ac46e1eb 100644 --- a/release/fraudPreventionV2/docs/models/classes/PaymentUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/PaymentUpdate.md @@ -16,7 +16,7 @@ Payment related data that should be updated. #### Parameters -▪ **paymentUpdate**: [`PaymentUpdateProperties`](../interfaces/PaymentUpdateProperties.md) +• **paymentUpdate**: [`PaymentUpdateProperties`](../interfaces/PaymentUpdateProperties.md) #### Returns @@ -32,8 +32,8 @@ models/PaymentUpdate.ts:39 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `merchantOrderCode` | `string` | 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. | - | models/PaymentUpdate.ts:34 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"PAYMENT_UPDATE"` | - | - | models/PaymentUpdate.ts:37 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `merchantOrderCode` | `public` | `string` | 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. | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"PAYMENT_UPDATE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/Points.md b/release/fraudPreventionV2/docs/models/classes/Points.md index 7eb5af18..6f61cc03 100644 --- a/release/fraudPreventionV2/docs/models/classes/Points.md +++ b/release/fraudPreventionV2/docs/models/classes/Points.md @@ -16,7 +16,7 @@ The `method` field value is used as a discriminator, with the following mapping: #### Parameters -▪ **points**: [`PointsProperties`](../interfaces/PointsProperties.md) +• **points**: [`PointsProperties`](../interfaces/PointsProperties.md) #### Returns @@ -32,17 +32,17 @@ models/Points.ts:36 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `accountId` | `string` | Points account id. | - | models/Points.ts:31 | -| `public` | `authorizedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | models/Payment.ts:70 | -| `public` | `billingAddress` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | models/Payment.ts:60 | -| `public` | `billingEmailAddress` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | models/Payment.ts:65 | -| `public` | `billingName` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | models/Payment.ts:55 | -| `public` | `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | models/Payment.ts:48 | -| `public` | `extensions`? | `object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | models/Payment.ts:90 | -| `readonly` | `method` | `"POINTS"` | - | - | models/Points.ts:34 | -| `public` | `operations`? | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | models/Payment.ts:85 | -| `public` | `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | models/Payment.ts:50 | -| `public` | `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | models/Payment.ts:80 | -| `public` | `verifiedAmount`? | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | models/Payment.ts:75 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `accountId` | `public` | `string` | Points account id. | - | +| `authorizedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`authorizedAmount` | +| `billingAddress` | `public` | [`PaymentBillingAddress`](PaymentBillingAddress.md) | - | [`Payment`](Payment.md).`billingAddress` | +| `billingEmailAddress` | `public` | `string` | Email address associated with the payment. | [`Payment`](Payment.md).`billingEmailAddress` | +| `billingName` | `public` | [`Name`](Name.md) | - | [`Payment`](Payment.md).`billingName` | +| `brand` | `public` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | 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` * `UATP` : `UATP` * `UATP_SUPPLY` : `UATP` * `AIR_PLUS` : `UATP` * `UA_PASS_PLUS` : `UATP` * `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` * `SEPA_ELV` | [`Payment`](Payment.md).`brand` | +| `extensions?` | `public` | `Object` | A key-value pair map to hold additional attributes. | [`Payment`](Payment.md).`extensions` | +| `method` | `readonly` | `"POINTS"` | - | - | +| `operations?` | `public` | [`Operations`](Operations.md) | - | [`Payment`](Payment.md).`operations` | +| `reason?` | `public` | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`Payment`](Payment.md).`reason` | +| `threeDigitsSecureCriteria?` | `public` | [`PaymentThreeDSCriteria`](PaymentThreeDSCriteria.md) | - | [`Payment`](Payment.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | `public` | [`Amount`](Amount.md) | - | [`Payment`](Payment.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/classes/Rail.md b/release/fraudPreventionV2/docs/models/classes/Rail.md index 71fa7efc..4710f27f 100644 --- a/release/fraudPreventionV2/docs/models/classes/Rail.md +++ b/release/fraudPreventionV2/docs/models/classes/Rail.md @@ -16,7 +16,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **rail**: [`RailProperties`](../interfaces/RailProperties.md) +• **rail**: [`RailProperties`](../interfaces/RailProperties.md) #### Returns @@ -32,13 +32,13 @@ models/Rail.ts:44 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | models/TravelProduct.ts:44 | -| `public` | `inventoryType` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | models/TravelProduct.ts:39 | -| `public` | `payLater`? | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | models/TravelProduct.ts:54 | -| `public` | `price` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | models/TravelProduct.ts:34 | -| `public` | `railSegments` | [`RailSegments`](RailSegments.md)[] | - | - | models/Rail.ts:39 | -| `public` | `routeType` | [`RailRouteTypeEnum`](../type-aliases/RailRouteTypeEnum.md) | 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. | - | models/Rail.ts:34 | -| `public` | `travelersReferences`? | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | models/TravelProduct.ts:49 | -| `readonly` | `type` | `"RAIL"` | - | - | models/Rail.ts:42 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `inventorySource` | `public` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | [`TravelProduct`](TravelProduct.md).`inventorySource` | +| `inventoryType` | `public` | `string` | 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` | [`TravelProduct`](TravelProduct.md).`inventoryType` | +| `payLater?` | `public` | `boolean` | 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. | [`TravelProduct`](TravelProduct.md).`payLater` | +| `price` | `public` | [`Amount`](Amount.md) | - | [`TravelProduct`](TravelProduct.md).`price` | +| `railSegments` | `public` | [`RailSegments`](RailSegments.md)[] | - | - | +| `routeType` | `public` | [`RailRouteTypeEnum`](../type-aliases/RailRouteTypeEnum.md) | 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. | - | +| `travelersReferences?` | `public` | `string`[] | 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. | [`TravelProduct`](TravelProduct.md).`travelersReferences` | +| `type` | `readonly` | `"RAIL"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/RailSegments.md b/release/fraudPreventionV2/docs/models/classes/RailSegments.md index ae086b30..fdeda876 100644 --- a/release/fraudPreventionV2/docs/models/classes/RailSegments.md +++ b/release/fraudPreventionV2/docs/models/classes/RailSegments.md @@ -10,7 +10,7 @@ #### Parameters -▪ **railSegments**: [`RailSegmentsProperties`](../interfaces/RailSegmentsProperties.md) +• **railSegments**: [`RailSegmentsProperties`](../interfaces/RailSegmentsProperties.md) #### Returns @@ -22,11 +22,11 @@ models/RailSegments.ts:63 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `arrivalStation` | [`RailwayStationDetails`](RailwayStationDetails.md) | - | models/RailSegments.ts:50 | -| `arrivalTime` | `Date` | 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`. | models/RailSegments.ts:40 | -| `departureStation` | [`RailwayStationDetails`](RailwayStationDetails.md) | - | models/RailSegments.ts:45 | -| `departureTime` | `Date` | 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`. | models/RailSegments.ts:35 | -| `operatingCompany`? | [`RailSegmentsOperatingCompany`](RailSegmentsOperatingCompany.md) | - | models/RailSegments.ts:61 | -| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/RailSegmentsTransportationMethodEnum.md) | 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. | models/RailSegments.ts:55 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `arrivalStation` | [`RailwayStationDetails`](RailwayStationDetails.md) | - | +| `arrivalTime` | `Date` | 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`. | +| `departureStation` | [`RailwayStationDetails`](RailwayStationDetails.md) | - | +| `departureTime` | `Date` | 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`. | +| `operatingCompany?` | [`RailSegmentsOperatingCompany`](RailSegmentsOperatingCompany.md) | - | +| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/RailSegmentsTransportationMethodEnum.md) | 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. | diff --git a/release/fraudPreventionV2/docs/models/classes/RailSegmentsOperatingCompany.md b/release/fraudPreventionV2/docs/models/classes/RailSegmentsOperatingCompany.md index 7a63f280..b437c689 100644 --- a/release/fraudPreventionV2/docs/models/classes/RailSegmentsOperatingCompany.md +++ b/release/fraudPreventionV2/docs/models/classes/RailSegmentsOperatingCompany.md @@ -12,7 +12,7 @@ This attribute captures the name or identifier of the company responsible for op #### Parameters -▪ **railSegmentsOperatingCompany**: [`RailSegmentsOperatingCompanyProperties`](../interfaces/RailSegmentsOperatingCompanyProperties.md) +• **railSegmentsOperatingCompany**: [`RailSegmentsOperatingCompanyProperties`](../interfaces/RailSegmentsOperatingCompanyProperties.md) #### Returns @@ -24,6 +24,6 @@ models/RailSegmentsOperatingCompany.ts:34 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `marketingName`? | `string` | The name used by the transportation carrier for marketing purposes in the travel segment. Example: ARX, AMTRAC, ARRIVA | models/RailSegmentsOperatingCompany.ts:32 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `marketingName?` | `string` | The name used by the transportation carrier for marketing purposes in the travel segment. Example: ARX, AMTRAC, ARRIVA | diff --git a/release/fraudPreventionV2/docs/models/classes/RailwayStationDetails.md b/release/fraudPreventionV2/docs/models/classes/RailwayStationDetails.md index 76ef1c91..96f0b23a 100644 --- a/release/fraudPreventionV2/docs/models/classes/RailwayStationDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/RailwayStationDetails.md @@ -10,7 +10,7 @@ #### Parameters -▪ **railwayStationDetails**: [`RailwayStationDetailsProperties`](../interfaces/RailwayStationDetailsProperties.md) +• **railwayStationDetails**: [`RailwayStationDetailsProperties`](../interfaces/RailwayStationDetailsProperties.md) #### Returns @@ -22,10 +22,10 @@ models/RailwayStationDetails.ts:54 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `address` | [`Address`](Address.md) | - | models/RailwayStationDetails.ts:47 | -| `name` | `string` | The popularly known name or title by which the railway station is identified. | models/RailwayStationDetails.ts:32 | -| `stationCode` | `string` | 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. | models/RailwayStationDetails.ts:42 | -| `timezone`? | `string` | The timezone associated with the location of the station, specifying the local time offset from Coordinated Universal Time (UTC). | models/RailwayStationDetails.ts:52 | -| `type`? | [`RailwayStationDetailsTypeEnum`](../type-aliases/RailwayStationDetailsTypeEnum.md) | 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). | models/RailwayStationDetails.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `address` | [`Address`](Address.md) | - | +| `name` | `string` | The popularly known name or title by which the railway station is identified. | +| `stationCode` | `string` | 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?` | `string` | The timezone associated with the location of the station, specifying the local time offset from Coordinated Universal Time (UTC). | +| `type?` | [`RailwayStationDetailsTypeEnum`](../type-aliases/RailwayStationDetailsTypeEnum.md) | 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). | diff --git a/release/fraudPreventionV2/docs/models/classes/Refund.md b/release/fraudPreventionV2/docs/models/classes/Refund.md index 147d056e..bd8ef35f 100644 --- a/release/fraudPreventionV2/docs/models/classes/Refund.md +++ b/release/fraudPreventionV2/docs/models/classes/Refund.md @@ -12,7 +12,7 @@ Refund operation on the payment. A refund operation represents the intent to ref #### Parameters -▪ **refund**: [`RefundProperties`](../interfaces/RefundProperties.md) +• **refund**: [`RefundProperties`](../interfaces/RefundProperties.md) #### Returns @@ -24,8 +24,8 @@ models/Refund.ts:47 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/Refund.ts:40 | -| `id`? | `string` | - | models/Refund.ts:35 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/Refund.ts:45 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/classes/RefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/RefundUpdate.md index b4dba139..f8101988 100644 --- a/release/fraudPreventionV2/docs/models/classes/RefundUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/RefundUpdate.md @@ -16,7 +16,7 @@ Refund related data. Update should be sent when refund is issued or settled. Amo #### Parameters -▪ **refundUpdate**: [`RefundUpdateProperties`](../interfaces/RefundUpdateProperties.md) +• **refundUpdate**: [`RefundUpdateProperties`](../interfaces/RefundUpdateProperties.md) #### Returns @@ -32,7 +32,7 @@ models/RefundUpdate.ts:33 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"REFUND_UPDATE"` | - | - | models/RefundUpdate.ts:31 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`OrderPurchaseUpdateRequest`](OrderPurchaseUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"REFUND_UPDATE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/RemediationUpdate.md b/release/fraudPreventionV2/docs/models/classes/RemediationUpdate.md index 53fa7737..685d4066 100644 --- a/release/fraudPreventionV2/docs/models/classes/RemediationUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/RemediationUpdate.md @@ -16,7 +16,7 @@ Information specific to remediation actions initiated by the Partner\'s system t #### Parameters -▪ **remediationUpdate**: [`RemediationUpdateProperties`](../interfaces/RemediationUpdateProperties.md) +• **remediationUpdate**: [`RemediationUpdateProperties`](../interfaces/RemediationUpdateProperties.md) #### Returns @@ -32,8 +32,8 @@ models/RemediationUpdate.ts:42 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `remediationUpdateActions` | [`RemediationUpdateAction`](RemediationUpdateAction.md)[] | - | - | models/RemediationUpdate.ts:37 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | [`AccountUpdateRequest`](AccountUpdateRequest.md).`riskId` | models/AccountUpdateRequest.ts:32 | -| `readonly` | `type` | `"REMEDIATION_UPDATE"` | - | - | models/RemediationUpdate.ts:40 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `remediationUpdateActions` | `public` | [`RemediationUpdateAction`](RemediationUpdateAction.md)[] | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `AccountScreenResponse`. | [`AccountUpdateRequest`](AccountUpdateRequest.md).`riskId` | +| `type` | `readonly` | `"REMEDIATION_UPDATE"` | - | - | diff --git a/release/fraudPreventionV2/docs/models/classes/RemediationUpdateAction.md b/release/fraudPreventionV2/docs/models/classes/RemediationUpdateAction.md index 97429621..71368093 100644 --- a/release/fraudPreventionV2/docs/models/classes/RemediationUpdateAction.md +++ b/release/fraudPreventionV2/docs/models/classes/RemediationUpdateAction.md @@ -12,7 +12,7 @@ Information specific to the remediation action initiated by the Partner\'s syste #### Parameters -▪ **remediationUpdateAction**: [`RemediationUpdateActionProperties`](../interfaces/RemediationUpdateActionProperties.md) +• **remediationUpdateAction**: [`RemediationUpdateActionProperties`](../interfaces/RemediationUpdateActionProperties.md) #### Returns @@ -24,8 +24,8 @@ models/RemediationUpdateAction.ts:44 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/RemediationUpdateActionActionNameEnum.md) | 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. | models/RemediationUpdateAction.ts:32 | -| `status` | [`RemediationUpdateActionStatusEnum`](../type-aliases/RemediationUpdateActionStatusEnum.md) | 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. | models/RemediationUpdateAction.ts:37 | -| `updateEndDateTime`? | `Date` | 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`. | models/RemediationUpdateAction.ts:42 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/RemediationUpdateActionActionNameEnum.md) | 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` | [`RemediationUpdateActionStatusEnum`](../type-aliases/RemediationUpdateActionStatusEnum.md) | 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. | +| `updateEndDateTime?` | `Date` | 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`. | diff --git a/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseScreenFailure.md b/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseScreenFailure.md index 2da1316e..c455a769 100644 --- a/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseScreenFailure.md +++ b/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseScreenFailure.md @@ -2,7 +2,7 @@ # Class: 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 `` .\" +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 ``.\" ## Constructors @@ -12,7 +12,7 @@ Indicates that the API is either down for maintenance or overloaded and cannot f #### Parameters -▪ **retryableOrderPurchaseScreenFailure**: [`RetryableOrderPurchaseScreenFailureProperties`](../interfaces/RetryableOrderPurchaseScreenFailureProperties.md) +• **retryableOrderPurchaseScreenFailure**: [`RetryableOrderPurchaseScreenFailureProperties`](../interfaces/RetryableOrderPurchaseScreenFailureProperties.md) #### Returns @@ -24,7 +24,7 @@ models/RetryableOrderPurchaseScreenFailure.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/RetryableOrderPurchaseScreenFailure.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/RetryableOrderPurchaseScreenFailure.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md b/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md index 4dd0bf32..ecbae467 100644 --- a/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md +++ b/release/fraudPreventionV2/docs/models/classes/RetryableOrderPurchaseUpdateFailure.md @@ -2,7 +2,7 @@ # Class: 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 `` .\" +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 ``.\" ## Constructors @@ -12,7 +12,7 @@ Indicates that the API is either down for maintenance or overloaded and cannot f #### Parameters -▪ **retryableOrderPurchaseUpdateFailure**: [`RetryableOrderPurchaseUpdateFailureProperties`](../interfaces/RetryableOrderPurchaseUpdateFailureProperties.md) +• **retryableOrderPurchaseUpdateFailure**: [`RetryableOrderPurchaseUpdateFailureProperties`](../interfaces/RetryableOrderPurchaseUpdateFailureProperties.md) #### Returns @@ -24,7 +24,7 @@ models/RetryableOrderPurchaseUpdateFailure.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/RetryableOrderPurchaseUpdateFailure.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/RetryableOrderPurchaseUpdateFailure.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/ServiceUnavailableError.md b/release/fraudPreventionV2/docs/models/classes/ServiceUnavailableError.md index 6cbae94e..a0bf216b 100644 --- a/release/fraudPreventionV2/docs/models/classes/ServiceUnavailableError.md +++ b/release/fraudPreventionV2/docs/models/classes/ServiceUnavailableError.md @@ -2,7 +2,7 @@ # Class: 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 `` .\" +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 ``.\" ## Constructors @@ -12,7 +12,7 @@ Indicates that the API is either down for maintenance or overloaded and cannot f #### Parameters -▪ **serviceUnavailableError**: [`ServiceUnavailableErrorProperties`](../interfaces/ServiceUnavailableErrorProperties.md) +• **serviceUnavailableError**: [`ServiceUnavailableErrorProperties`](../interfaces/ServiceUnavailableErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/ServiceUnavailableError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/ServiceUnavailableErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/ServiceUnavailableError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/ServiceUnavailableError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/ServiceUnavailableErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdate.md b/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdate.md index 08aa5de2..99ec7a8a 100644 --- a/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdate.md +++ b/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdate.md @@ -16,7 +16,7 @@ Data related to the settled refund that should be updated. #### Parameters -▪ **settledRefundUpdate**: [`SettledRefundUpdateProperties`](../interfaces/SettledRefundUpdateProperties.md) +• **settledRefundUpdate**: [`SettledRefundUpdateProperties`](../interfaces/SettledRefundUpdateProperties.md) #### Returns @@ -32,9 +32,9 @@ models/SettledRefundUpdate.ts:41 ## Properties -| Modifier | Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | :------ | -| `public` | `refundDetails`? | [`SettledRefundUpdateDetails`](SettledRefundUpdateDetails.md) | - | - | models/SettledRefundUpdate.ts:36 | -| `readonly` | `refundStatus` | `"SETTLED"` | - | - | models/SettledRefundUpdate.ts:39 | -| `public` | `riskId` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`RefundUpdate`](RefundUpdate.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:32 | -| `readonly` | `type` | `"REFUND_UPDATE"` | - | [`RefundUpdate`](RefundUpdate.md).`type` | models/RefundUpdate.ts:31 | +| Property | Modifier | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `refundDetails?` | `public` | [`SettledRefundUpdateDetails`](SettledRefundUpdateDetails.md) | - | - | +| `refundStatus` | `readonly` | `"SETTLED"` | - | - | +| `riskId` | `public` | `string` | The `risk_id` provided by Expedia\'s Fraud Prevention Service in the `OrderPurchaseScreenResponse`. | [`RefundUpdate`](RefundUpdate.md).`riskId` | +| `type` | `readonly` | `"REFUND_UPDATE"` | - | [`RefundUpdate`](RefundUpdate.md).`type` | diff --git a/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdateDetails.md b/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdateDetails.md index 3cad0de9..457d495b 100644 --- a/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdateDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/SettledRefundUpdateDetails.md @@ -12,7 +12,7 @@ Data that describes settled refund that should be updated. #### Parameters -▪ **settledRefundUpdateDetails**: [`SettledRefundUpdateDetailsProperties`](../interfaces/SettledRefundUpdateDetailsProperties.md) +• **settledRefundUpdateDetails**: [`SettledRefundUpdateDetailsProperties`](../interfaces/SettledRefundUpdateDetailsProperties.md) #### Returns @@ -24,10 +24,10 @@ models/SettledRefundUpdateDetails.ts:57 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `acquirerReferenceNumber` | `string` | 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. | models/SettledRefundUpdateDetails.ts:45 | -| `refundDepositDateTime` | `Date` | Date and time when the refund was deposited to the original form of payment. | models/SettledRefundUpdateDetails.ts:40 | -| `refundSettledAmount` | [`Amount`](Amount.md) | - | models/SettledRefundUpdateDetails.ts:55 | -| `refundSettlementDateTime` | `Date` | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has settled at the participating financial institutions. | models/SettledRefundUpdateDetails.ts:35 | -| `settlementId` | `string` | Unique settlement identifier specific to the payment processor for the settlement transaction generated for a previously submitted payment refund. | models/SettledRefundUpdateDetails.ts:50 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `acquirerReferenceNumber` | `string` | 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. | +| `refundDepositDateTime` | `Date` | Date and time when the refund was deposited to the original form of payment. | +| `refundSettledAmount` | [`Amount`](Amount.md) | - | +| `refundSettlementDateTime` | `Date` | Date and time when the 3rd party payment processor confirmed that a previously submitted payment refund has settled at the participating financial institutions. | +| `settlementId` | `string` | Unique settlement identifier specific to the payment processor for the settlement transaction generated for a previously submitted payment refund. | diff --git a/release/fraudPreventionV2/docs/models/classes/SiteInfo.md b/release/fraudPreventionV2/docs/models/classes/SiteInfo.md index a6140cfe..abe5847b 100644 --- a/release/fraudPreventionV2/docs/models/classes/SiteInfo.md +++ b/release/fraudPreventionV2/docs/models/classes/SiteInfo.md @@ -10,7 +10,7 @@ #### Parameters -▪ **siteInfo**: [`SiteInfoProperties`](../interfaces/SiteInfoProperties.md) +• **siteInfo**: [`SiteInfoProperties`](../interfaces/SiteInfoProperties.md) #### Returns @@ -22,7 +22,7 @@ models/SiteInfo.ts:36 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `agentAssisted` | `boolean` | Identifies if an agent assisted in booking travel for the customer. `False` if the order was directly booked by customer. | models/SiteInfo.ts:34 | -| `countryCode` | `string` | The alpha-3 ISO code that represents a country name. | models/SiteInfo.ts:29 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `agentAssisted` | `boolean` | Identifies if an agent assisted in booking travel for the customer. `False` if the order was directly booked by customer. | +| `countryCode` | `string` | The alpha-3 ISO code that represents a country name. | diff --git a/release/fraudPreventionV2/docs/models/classes/Telephone.md b/release/fraudPreventionV2/docs/models/classes/Telephone.md index e3b2615f..b7ada857 100644 --- a/release/fraudPreventionV2/docs/models/classes/Telephone.md +++ b/release/fraudPreventionV2/docs/models/classes/Telephone.md @@ -12,7 +12,7 @@ Group of attributes intended to hold information about phone number associated w #### Parameters -▪ **telephone**: [`TelephoneProperties`](../interfaces/TelephoneProperties.md) +• **telephone**: [`TelephoneProperties`](../interfaces/TelephoneProperties.md) #### Returns @@ -24,14 +24,14 @@ models/Telephone.ts:70 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `areaCode` | `string` | A number prefixed to an individual telephone number: used in making long-distance calls. Does not include symbols, spaces, or leading zeros. | models/Telephone.ts:43 | -| `countryAccessCode` | `string` | Numeric digit between 1 to 3 characters used to represent the country code for international dialing. Does not include symbols, spaces, or leading zeros. | models/Telephone.ts:38 | -| `extensionNumber`? | `string` | The number used to reach an individual once a phone connection is established. Does not include symbols, spaces, or leading zeros. | models/Telephone.ts:53 | -| `lastVerifiedDateTime`? | `Date` | 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`. | models/Telephone.ts:63 | -| `phoneNumber` | `string` | 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. | models/Telephone.ts:48 | -| `platformType`? | [`TelephonePlatformType`](../type-aliases/TelephonePlatformType.md) | - | models/Telephone.ts:33 | -| `preferenceRank`? | `number` | 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. | models/Telephone.ts:58 | -| `type`? | [`TelephoneType`](../type-aliases/TelephoneType.md) | - | models/Telephone.ts:31 | -| `verifiedFlag`? | `boolean` | Flag indicating whether user passed validation of possession of their phone number via a text or voice multi factor authentication challenge. | models/Telephone.ts:68 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `areaCode` | `string` | A number prefixed to an individual telephone number: used in making long-distance calls. Does not include symbols, spaces, or leading zeros. | +| `countryAccessCode` | `string` | Numeric digit between 1 to 3 characters used to represent the country code for international dialing. Does not include symbols, spaces, or leading zeros. | +| `extensionNumber?` | `string` | The number used to reach an individual once a phone connection is established. Does not include symbols, spaces, or leading zeros. | +| `lastVerifiedDateTime?` | `Date` | 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`. | +| `phoneNumber` | `string` | 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. | +| `platformType?` | [`TelephonePlatformType`](../type-aliases/TelephonePlatformType.md) | - | +| `preferenceRank?` | `number` | 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?` | [`TelephoneType`](../type-aliases/TelephoneType.md) | - | +| `verifiedFlag?` | `boolean` | Flag indicating whether user passed validation of possession of their phone number via a text or voice multi factor authentication challenge. | diff --git a/release/fraudPreventionV2/docs/models/classes/TooManyRequestsError.md b/release/fraudPreventionV2/docs/models/classes/TooManyRequestsError.md index c67f985b..52fb1e59 100644 --- a/release/fraudPreventionV2/docs/models/classes/TooManyRequestsError.md +++ b/release/fraudPreventionV2/docs/models/classes/TooManyRequestsError.md @@ -2,7 +2,7 @@ # Class: 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. +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. ## Constructors @@ -12,7 +12,7 @@ Indicates that the API cannot fulfill the request because server resources have #### Parameters -▪ **tooManyRequestsError**: [`TooManyRequestsErrorProperties`](../interfaces/TooManyRequestsErrorProperties.md) +• **tooManyRequestsError**: [`TooManyRequestsErrorProperties`](../interfaces/TooManyRequestsErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/TooManyRequestsError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/TooManyRequestsErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/TooManyRequestsError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/TooManyRequestsError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/TooManyRequestsErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/TransactionDetails.md b/release/fraudPreventionV2/docs/models/classes/TransactionDetails.md index df4f780e..5dce2f59 100644 --- a/release/fraudPreventionV2/docs/models/classes/TransactionDetails.md +++ b/release/fraudPreventionV2/docs/models/classes/TransactionDetails.md @@ -10,7 +10,7 @@ #### Parameters -▪ **transactionDetails**: [`TransactionDetailsProperties`](../interfaces/TransactionDetailsProperties.md) +• **transactionDetails**: [`TransactionDetailsProperties`](../interfaces/TransactionDetailsProperties.md) #### Returns @@ -22,11 +22,11 @@ models/TransactionDetails.ts:71 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/TransactionDetailsCurrentOrderStatusEnum.md) | 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. | models/TransactionDetails.ts:43 | -| `orderId` | `string` | Unique identifier assigned to the order by the partner. `order_id` is specific to the partner namespace. | models/TransactionDetails.ts:38 | -| `orderType` | [`TransactionDetailsOrderTypeEnum`](../type-aliases/TransactionDetailsOrderTypeEnum.md) | 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`. | models/TransactionDetails.ts:48 | -| `payments`? | [`Payment`](Payment.md)[] | 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. | models/TransactionDetails.ts:69 | -| `travelProducts` | [`TravelProduct`](TravelProduct.md)[] | - | models/TransactionDetails.ts:53 | -| `travelers` | [`Traveler`](Traveler.md)[] | Individuals who are part of the travel party for the order. At minimum there must be at least `1` traveler. | models/TransactionDetails.ts:61 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/TransactionDetailsCurrentOrderStatusEnum.md) | 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. | +| `orderId` | `string` | Unique identifier assigned to the order by the partner. `order_id` is specific to the partner namespace. | +| `orderType` | [`TransactionDetailsOrderTypeEnum`](../type-aliases/TransactionDetailsOrderTypeEnum.md) | 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?` | [`Payment`](Payment.md)[] | 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. | +| `travelProducts` | [`TravelProduct`](TravelProduct.md)[] | - | +| `travelers` | [`Traveler`](Traveler.md)[] | Individuals who are part of the travel party for the order. At minimum there must be at least `1` traveler. | diff --git a/release/fraudPreventionV2/docs/models/classes/TravelProduct.md b/release/fraudPreventionV2/docs/models/classes/TravelProduct.md index afadff06..6be0e1cb 100644 --- a/release/fraudPreventionV2/docs/models/classes/TravelProduct.md +++ b/release/fraudPreventionV2/docs/models/classes/TravelProduct.md @@ -4,7 +4,7 @@ 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` -## Extended By +## Extended by - [`Air`](Air.md) - [`Car`](Car.md) @@ -21,7 +21,7 @@ The `type` field value is used as a discriminator, with the following mapping: * #### Parameters -▪ **travelProduct**: [`TravelProductProperties`](../interfaces/TravelProductProperties.md) +• **travelProduct**: [`TravelProductProperties`](../interfaces/TravelProductProperties.md) #### Returns @@ -33,10 +33,10 @@ models/TravelProduct.ts:56 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | models/TravelProduct.ts:44 | -| `inventoryType` | `string` | 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` | models/TravelProduct.ts:39 | -| `payLater`? | `boolean` | 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. | models/TravelProduct.ts:54 | -| `price` | [`Amount`](Amount.md) | - | models/TravelProduct.ts:34 | -| `travelersReferences`? | `string`[] | 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. | models/TravelProduct.ts:49 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | 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. | +| `inventoryType` | `string` | 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` | +| `payLater?` | `boolean` | 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) | - | +| `travelersReferences?` | `string`[] | 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. | diff --git a/release/fraudPreventionV2/docs/models/classes/Traveler.md b/release/fraudPreventionV2/docs/models/classes/Traveler.md index 214a82fa..ae3ab253 100644 --- a/release/fraudPreventionV2/docs/models/classes/Traveler.md +++ b/release/fraudPreventionV2/docs/models/classes/Traveler.md @@ -10,7 +10,7 @@ #### Parameters -▪ **traveler**: [`TravelerProperties`](../interfaces/TravelerProperties.md) +• **traveler**: [`TravelerProperties`](../interfaces/TravelerProperties.md) #### Returns @@ -22,13 +22,13 @@ models/Traveler.ts:71 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `age`? | `number` | Age of the traveler. | models/Traveler.ts:54 | -| `birthDate`? | `Date` | Date of birth for traveler, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | models/Traveler.ts:59 | -| `citizenshipCountryCode`? | `string` | The alpha-3 ISO country code of the traveler\'s nationality. | models/Traveler.ts:64 | -| `emailAddress`? | `string` | Email address associated with the traveler as supplied by the partner system. | models/Traveler.ts:39 | -| `primary` | `boolean` | 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`. | models/Traveler.ts:49 | -| `telephones`? | [`Telephone`](Telephone.md)[] | - | models/Traveler.ts:44 | -| `travelerId`? | `string` | A unique identifier for travelers in the transaction. | models/Traveler.ts:69 | -| `travelerName` | [`Name`](Name.md) | - | models/Traveler.ts:34 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `age?` | `number` | Age of the traveler. | +| `birthDate?` | `Date` | Date of birth for traveler, in ISO-8601 date and time format `yyyy-MM-ddTHH:mm:ss.SSSZ`. | +| `citizenshipCountryCode?` | `string` | The alpha-3 ISO country code of the traveler\'s nationality. | +| `emailAddress?` | `string` | Email address associated with the traveler as supplied by the partner system. | +| `primary` | `boolean` | 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?` | [`Telephone`](Telephone.md)[] | - | +| `travelerId?` | `string` | A unique identifier for travelers in the transaction. | +| `travelerName` | [`Name`](Name.md) | - | diff --git a/release/fraudPreventionV2/docs/models/classes/UnauthorizedError.md b/release/fraudPreventionV2/docs/models/classes/UnauthorizedError.md index d73defbe..e180041b 100644 --- a/release/fraudPreventionV2/docs/models/classes/UnauthorizedError.md +++ b/release/fraudPreventionV2/docs/models/classes/UnauthorizedError.md @@ -12,7 +12,7 @@ Indicates that the token sent in the \'Authorization\' header is either invalid #### Parameters -▪ **unauthorizedError**: [`UnauthorizedErrorProperties`](../interfaces/UnauthorizedErrorProperties.md) +• **unauthorizedError**: [`UnauthorizedErrorProperties`](../interfaces/UnauthorizedErrorProperties.md) #### Returns @@ -24,7 +24,7 @@ models/UnauthorizedError.ts:39 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/UnauthorizedErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | models/UnauthorizedError.ts:32 | -| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | models/UnauthorizedError.ts:37 | +| Property | Type | Description | +| :------ | :------ | :------ | +| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/UnauthorizedErrorCodeEnum.md) | Snake cased all caps error code interpreted from the HTTP status code that can programmatically be acted upon. | +| `message` | `string` | A human-readable explanation of the error, specific to this error occurrence. | diff --git a/release/fraudPreventionV2/docs/models/classes/Verify.md b/release/fraudPreventionV2/docs/models/classes/Verify.md index 58cddf5b..28f0d67c 100644 --- a/release/fraudPreventionV2/docs/models/classes/Verify.md +++ b/release/fraudPreventionV2/docs/models/classes/Verify.md @@ -12,7 +12,7 @@ A verify operation represents the intent to verify the payment associated with t #### Parameters -▪ **verify**: [`VerifyProperties`](../interfaces/VerifyProperties.md) +• **verify**: [`VerifyProperties`](../interfaces/VerifyProperties.md) #### Returns @@ -24,9 +24,9 @@ models/Verify.ts:50 ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](Amount.md) | - | models/Verify.ts:41 | -| `id`? | `string` | - | models/Verify.ts:36 | -| `outcome`? | [`PaymentOutcome`](PaymentOutcome.md) | - | models/Verify.ts:46 | -| `type`? | [`VerificationType`](../type-aliases/VerificationType.md) | - | models/Verify.ts:48 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](PaymentOutcome.md) | +| `type?` | [`VerificationType`](../type-aliases/VerificationType.md) | diff --git a/release/fraudPreventionV2/docs/models/core/classes/AxiosClientConfigurations.md b/release/fraudPreventionV2/docs/models/core/classes/AxiosClientConfigurations.md deleted file mode 100644 index fd6c907d..00000000 --- a/release/fraudPreventionV2/docs/models/core/classes/AxiosClientConfigurations.md +++ /dev/null @@ -1,30 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [models](../../index.md) / [core](../index.md) / AxiosClientConfigurations - -# Class: AxiosClientConfigurations - -## Constructors - -### new AxiosClientConfigurations(endpoint, requestTimeout) - -> **new AxiosClientConfigurations**(`endpoint`, `requestTimeout`): [`AxiosClientConfigurations`](AxiosClientConfigurations.md) - -#### Parameters - -▪ **endpoint**: `string`= `Constant.ENDPOINT` - -▪ **requestTimeout**: `number`= `Constant.TEN_SECONDS_IN_MILLIS` - -#### Returns - -[`AxiosClientConfigurations`](AxiosClientConfigurations.md) - -#### Source - -core/src/client/AxiosClientConfigurations.ts:24 - -## Properties - -| Modifier | Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | :------ | -| `readonly` | `endpoint` | `string` | - | core/src/client/AxiosClientConfigurations.ts:25 | -| `readonly` | `requestTimeout` | `number` | - | core/src/client/AxiosClientConfigurations.ts:26 | diff --git a/release/fraudPreventionV2/docs/models/core/classes/Client.md b/release/fraudPreventionV2/docs/models/core/classes/Client.md deleted file mode 100644 index f173794d..00000000 --- a/release/fraudPreventionV2/docs/models/core/classes/Client.md +++ /dev/null @@ -1,7 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [models](../../index.md) / [core](../index.md) / Client - -# Class: `abstract` Client - -## Extended By - -- [`FraudPreventionV2Client`](../../../client/classes/FraudPreventionV2Client.md) diff --git a/release/fraudPreventionV2/docs/models/core/interfaces/ClientConfigurations.md b/release/fraudPreventionV2/docs/models/core/interfaces/ClientConfigurations.md deleted file mode 100644 index 1772244f..00000000 --- a/release/fraudPreventionV2/docs/models/core/interfaces/ClientConfigurations.md +++ /dev/null @@ -1,13 +0,0 @@ -[@expediagroup/fraudpreventionv2-sdk](../../../index.md) / [models](../../index.md) / [core](../index.md) / ClientConfigurations - -# Interface: ClientConfigurations - -## Properties - -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `authEndpoint`? | `string` | - | core/src/client/Client.ts:66 | -| `endpoint`? | `string` | - | core/src/client/Client.ts:65 | -| `key` | `string` | - | core/src/client/Client.ts:67 | -| `requestTimeout`? | `number` | - | core/src/client/Client.ts:69 | -| `secret` | `string` | - | core/src/client/Client.ts:68 | diff --git a/release/fraudPreventionV2/docs/models/index.md b/release/fraudPreventionV2/docs/models/index.md index 125cc7af..3959cb4d 100644 --- a/release/fraudPreventionV2/docs/models/index.md +++ b/release/fraudPreventionV2/docs/models/index.md @@ -4,10 +4,6 @@ ## Index -### Modules - -- [core](core/index.md) - ### Classes - [AccountScreenRequest](classes/AccountScreenRequest.md) diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountScreenRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountScreenRequestProperties.md index 057c94d2..68f9c11c 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountScreenRequestProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountScreenRequestProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `transaction` | [`AccountTransaction`](../classes/AccountTransaction.md) | - | models/AccountScreenRequest.ts:42 | +| Property | Type | +| :------ | :------ | +| `transaction` | [`AccountTransaction`](../classes/AccountTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountScreenResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountScreenResponseProperties.md index 180ac5c6..23b5c6c6 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountScreenResponseProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountScreenResponseProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `decision`? | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | - | models/AccountScreenResponse.ts:45 | -| `riskId`? | `string` | - | models/AccountScreenResponse.ts:44 | +| Property | Type | +| :------ | :------ | +| `decision?` | [`AccountTakeoverFraudDecision`](../type-aliases/AccountTakeoverFraudDecision.md) | +| `riskId?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md index e84634d7..d16e1670 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorAllOfCausesProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:50 | -| `field`? | `string` | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:51 | -| `message`? | `string` | - | models/AccountTakeoverBadRequestErrorAllOfCauses.ts:52 | +| Property | Type | +| :------ | :------ | +| `code?` | [`AccountTakeoverBadRequestErrorAllOfCausesCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorAllOfCausesCodeEnum.md) | +| `field?` | `string` | +| `message?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md index 30256ce3..d2fadd05 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverBadRequestErrorProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `causes`? | [`AccountTakeoverBadRequestErrorAllOfCauses`](../classes/AccountTakeoverBadRequestErrorAllOfCauses.md)[] | - | models/AccountTakeoverBadRequestError.ts:73 | -| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | - | models/AccountTakeoverBadRequestError.ts:71 | -| `message` | `string` | - | models/AccountTakeoverBadRequestError.ts:72 | +| Property | Type | +| :------ | :------ | +| `causes?` | [`AccountTakeoverBadRequestErrorAllOfCauses`](../classes/AccountTakeoverBadRequestErrorAllOfCauses.md)[] | +| `code` | [`AccountTakeoverBadRequestErrorCodeEnum`](../type-aliases/AccountTakeoverBadRequestErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md index 9b7f1e5d..7191f54a 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverCustomerAccountProperties.md @@ -4,16 +4,16 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `accountRole`? | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | - | models/AccountTakeoverCustomerAccount.ts:121 | -| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | - | models/AccountTakeoverCustomerAccount.ts:120 | -| `activeFlag` | `boolean` | - | models/AccountTakeoverCustomerAccount.ts:128 | -| `address`? | [`CustomerAccountAddress`](../classes/CustomerAccountAddress.md) | - | models/AccountTakeoverCustomerAccount.ts:126 | -| `emailAddress` | `string` | - | models/AccountTakeoverCustomerAccount.ts:124 | -| `loyaltyMemberId`? | `string` | - | models/AccountTakeoverCustomerAccount.ts:129 | -| `name`? | [`AccountTakeoverName`](../classes/AccountTakeoverName.md) | - | models/AccountTakeoverCustomerAccount.ts:122 | -| `registeredTime` | `Date` | - | models/AccountTakeoverCustomerAccount.ts:127 | -| `telephones`? | [`Telephone`](../classes/Telephone.md)[] | - | models/AccountTakeoverCustomerAccount.ts:125 | -| `userId` | `string` | - | models/AccountTakeoverCustomerAccount.ts:119 | -| `username` | `string` | - | models/AccountTakeoverCustomerAccount.ts:123 | +| Property | Type | +| :------ | :------ | +| `accountRole?` | [`AccountTakeoverCustomerAccountAccountRoleEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountRoleEnum.md) | +| `accountType` | [`AccountTakeoverCustomerAccountAccountTypeEnum`](../type-aliases/AccountTakeoverCustomerAccountAccountTypeEnum.md) | +| `activeFlag` | `boolean` | +| `address?` | [`CustomerAccountAddress`](../classes/CustomerAccountAddress.md) | +| `emailAddress` | `string` | +| `loyaltyMemberId?` | `string` | +| `name?` | [`AccountTakeoverName`](../classes/AccountTakeoverName.md) | +| `registeredTime` | `Date` | +| `telephones?` | [`Telephone`](../classes/Telephone.md)[] | +| `userId` | `string` | +| `username` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md index edd06ba3..817391d9 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverDeviceDetailsProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `deviceBox` | `string` | - | models/AccountTakeoverDeviceDetails.ts:74 | -| `ipAddress` | `string` | - | models/AccountTakeoverDeviceDetails.ts:75 | -| `source`? | `string` | - | models/AccountTakeoverDeviceDetails.ts:73 | -| `type`? | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | - | models/AccountTakeoverDeviceDetails.ts:77 | -| `userAgent` | `string` | - | models/AccountTakeoverDeviceDetails.ts:76 | +| Property | Type | +| :------ | :------ | +| `deviceBox` | `string` | +| `ipAddress` | `string` | +| `source?` | `string` | +| `type?` | [`AccountTakeoverDeviceDetailsTypeEnum`](../type-aliases/AccountTakeoverDeviceDetailsTypeEnum.md) | +| `userAgent` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverErrorProperties.md index 1f14c94b..df7d6962 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | - | models/AccountTakeoverError.ts:59 | -| `message` | `string` | - | models/AccountTakeoverError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`AccountTakeoverErrorCodeEnum`](../type-aliases/AccountTakeoverErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverNameProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverNameProperties.md index dfa8f846..bff6719c 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverNameProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverNameProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `firstName` | `string` | - | models/AccountTakeoverName.ts:65 | -| `lastName` | `string` | - | models/AccountTakeoverName.ts:64 | -| `middleName`? | `string` | - | models/AccountTakeoverName.ts:66 | -| `suffix`? | `string` | - | models/AccountTakeoverName.ts:68 | -| `title`? | `string` | - | models/AccountTakeoverName.ts:67 | +| Property | Type | +| :------ | :------ | +| `firstName` | `string` | +| `lastName` | `string` | +| `middleName?` | `string` | +| `suffix?` | `string` | +| `title?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md index 714d5f2e..ed55c9be 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverSiteInfoProperties.md @@ -4,9 +4,9 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `brandName` | `string` | - | models/AccountTakeoverSiteInfo.ts:66 | -| `locale`? | `string` | - | models/AccountTakeoverSiteInfo.ts:64 | -| `name`? | `string` | - | models/AccountTakeoverSiteInfo.ts:65 | -| `placementName`? | [`AccountTakeoverSiteInfoPlacementNameEnum`](../type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md) | - | models/AccountTakeoverSiteInfo.ts:67 | +| Property | Type | +| :------ | :------ | +| `brandName` | `string` | +| `locale?` | `string` | +| `name?` | `string` | +| `placementName?` | [`AccountTakeoverSiteInfoPlacementNameEnum`](../type-aliases/AccountTakeoverSiteInfoPlacementNameEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md index 060e0fc8..4e38ab08 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverTransactionDetailsProperties.md @@ -2,14 +2,14 @@ # Interface: AccountTakeoverTransactionDetailsProperties -## Extended By +## Extended by - [`LoginTransactionDetailsProperties`](LoginTransactionDetailsProperties.md) ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currentUserSession`? | [`CurrentUserSession`](../classes/CurrentUserSession.md) | - | models/AccountTakeoverTransactionDetails.ts:63 | -| `transactionDateTime` | `Date` | - | models/AccountTakeoverTransactionDetails.ts:61 | -| `transactionId` | `string` | - | models/AccountTakeoverTransactionDetails.ts:62 | +| Property | Type | +| :------ | :------ | +| `currentUserSession?` | [`CurrentUserSession`](../classes/CurrentUserSession.md) | +| `transactionDateTime` | `Date` | +| `transactionId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md index 7a834be5..2fb0e1e5 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTakeoverUnauthorizedErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) | - | models/AccountTakeoverUnauthorizedError.ts:61 | -| `message` | `string` | - | models/AccountTakeoverUnauthorizedError.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`AccountTakeoverUnauthorizedErrorCodeEnum`](../type-aliases/AccountTakeoverUnauthorizedErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountTransactionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountTransactionProperties.md index 2a76e0eb..82393ac0 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountTransactionProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountTransactionProperties.md @@ -4,9 +4,9 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `customerAccount` | [`AccountTakeoverCustomerAccount`](../classes/AccountTakeoverCustomerAccount.md) | - | models/AccountTransaction.ts:74 | -| `deviceDetails` | [`AccountTakeoverDeviceDetails`](../classes/AccountTakeoverDeviceDetails.md) | - | models/AccountTransaction.ts:73 | -| `siteInfo` | [`AccountTakeoverSiteInfo`](../classes/AccountTakeoverSiteInfo.md) | - | models/AccountTransaction.ts:72 | -| `transactionDetails` | [`AccountTakeoverTransactionDetails`](../classes/AccountTakeoverTransactionDetails.md) | - | models/AccountTransaction.ts:75 | +| Property | Type | +| :------ | :------ | +| `customerAccount` | [`AccountTakeoverCustomerAccount`](../classes/AccountTakeoverCustomerAccount.md) | +| `deviceDetails` | [`AccountTakeoverDeviceDetails`](../classes/AccountTakeoverDeviceDetails.md) | +| `siteInfo` | [`AccountTakeoverSiteInfo`](../classes/AccountTakeoverSiteInfo.md) | +| `transactionDetails` | [`AccountTakeoverTransactionDetails`](../classes/AccountTakeoverTransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md index 0032163c..2fffe845 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateNotFoundErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) | - | models/AccountUpdateNotFoundError.ts:61 | -| `message` | `string` | - | models/AccountUpdateNotFoundError.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`AccountUpdateNotFoundErrorCodeEnum`](../type-aliases/AccountUpdateNotFoundErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateRequestProperties.md index c75ee699..47d3c397 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateRequestProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateRequestProperties.md @@ -2,13 +2,13 @@ # Interface: AccountUpdateRequestProperties -## Extended By +## Extended by - [`MultiFactorAuthenticationUpdateProperties`](MultiFactorAuthenticationUpdateProperties.md) - [`RemediationUpdateProperties`](RemediationUpdateProperties.md) ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId` | `string` | - | models/AccountUpdateRequest.ts:44 | +| Property | Type | +| :------ | :------ | +| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateResponseProperties.md index afacc185..a0b65a77 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateResponseProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AccountUpdateResponseProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId`? | `string` | - | models/AccountUpdateResponse.ts:37 | +| Property | Type | +| :------ | :------ | +| `riskId?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AddressProperties.md index 8ebd293d..2704a597 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AddressProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AddressProperties.md @@ -4,12 +4,12 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1`? | `string` | - | models/Address.ts:73 | -| `addressLine2`? | `string` | - | models/Address.ts:74 | -| `addressType`? | [`AddressAddressTypeEnum`](../type-aliases/AddressAddressTypeEnum.md) | - | models/Address.ts:72 | -| `city`? | `string` | - | models/Address.ts:75 | -| `countryCode`? | `string` | - | models/Address.ts:78 | -| `state`? | `string` | - | models/Address.ts:76 | -| `zipCode`? | `string` | - | models/Address.ts:77 | +| Property | Type | +| :------ | :------ | +| `addressLine1?` | `string` | +| `addressLine2?` | `string` | +| `addressType?` | [`AddressAddressTypeEnum`](../type-aliases/AddressAddressTypeEnum.md) | +| `city?` | `string` | +| `countryCode?` | `string` | +| `state?` | `string` | +| `zipCode?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AirProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AirProperties.md index 5a6abe0e..e4aed624 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AirProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AirProperties.md @@ -8,16 +8,16 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `airSegments` | [`AirSegment`](../classes/AirSegment.md)[] | - | - | models/Air.ts:89 | -| `arrivalTime` | `Date` | - | - | models/Air.ts:88 | -| `departureTime` | `Date` | - | - | models/Air.ts:87 | -| `flightType`? | [`AirFlightTypeEnum`](../type-aliases/AirFlightTypeEnum.md) | - | - | models/Air.ts:90 | -| `globalDistributionSystemType`? | `string` | - | - | models/Air.ts:92 | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `passengerNameRecord`? | `string` | - | - | models/Air.ts:91 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `airSegments` | [`AirSegment`](../classes/AirSegment.md)[] | - | +| `arrivalTime` | `Date` | - | +| `departureTime` | `Date` | - | +| `flightType?` | [`AirFlightTypeEnum`](../type-aliases/AirFlightTypeEnum.md) | - | +| `globalDistributionSystemType?` | `string` | - | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `passengerNameRecord?` | `string` | - | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AirSegmentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AirSegmentProperties.md index 0368acfd..02142f3d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AirSegmentProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AirSegmentProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `airlineCode` | `string` | - | models/AirSegment.ts:61 | -| `arrivalAirportCode` | `string` | - | models/AirSegment.ts:63 | -| `arrivalTime`? | `Date` | - | models/AirSegment.ts:65 | -| `departureAirportCode` | `string` | - | models/AirSegment.ts:62 | -| `departureTime`? | `Date` | - | models/AirSegment.ts:64 | +| Property | Type | +| :------ | :------ | +| `airlineCode` | `string` | +| `arrivalAirportCode` | `string` | +| `arrivalTime?` | `Date` | +| `departureAirportCode` | `string` | +| `departureTime?` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AmountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AmountProperties.md index 3853b138..f3c423d0 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AmountProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AmountProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currencyCode` | `string` | - | models/Amount.ts:44 | -| `value` | `number` | - | models/Amount.ts:43 | +| Property | Type | +| :------ | :------ | +| `currencyCode` | `string` | +| `value` | `number` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AuthorizeProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AuthorizeProperties.md index 180b85a5..446262fa 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AuthorizeProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AuthorizeProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/Authorize.ts:56 | -| `id`? | `string` | - | models/Authorize.ts:55 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/Authorize.ts:57 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/AuthorizeReversalProperties.md b/release/fraudPreventionV2/docs/models/interfaces/AuthorizeReversalProperties.md index 7225ee3f..0622cabd 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/AuthorizeReversalProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/AuthorizeReversalProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/AuthorizeReversal.ts:56 | -| `id`? | `string` | - | models/AuthorizeReversal.ts:55 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/AuthorizeReversal.ts:57 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/BadGatewayErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/BadGatewayErrorProperties.md index 3e352f24..faaf7e48 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/BadGatewayErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/BadGatewayErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/BadGatewayErrorCodeEnum.md) | - | models/BadGatewayError.ts:59 | -| `message` | `string` | - | models/BadGatewayError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`BadGatewayErrorCodeEnum`](../type-aliases/BadGatewayErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md b/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md index c1797629..57f0732f 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorAllOfCausesProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/BadRequestErrorAllOfCausesCodeEnum.md) | - | models/BadRequestErrorAllOfCauses.ts:50 | -| `field`? | `string` | - | models/BadRequestErrorAllOfCauses.ts:51 | -| `message`? | `string` | - | models/BadRequestErrorAllOfCauses.ts:52 | +| Property | Type | +| :------ | :------ | +| `code?` | [`BadRequestErrorAllOfCausesCodeEnum`](../type-aliases/BadRequestErrorAllOfCausesCodeEnum.md) | +| `field?` | `string` | +| `message?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorProperties.md index 4f9011f2..2bdbad27 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/BadRequestErrorProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `causes`? | [`BadRequestErrorAllOfCauses`](../classes/BadRequestErrorAllOfCauses.md)[] | - | models/BadRequestError.ts:70 | -| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/BadRequestErrorCodeEnum.md) | - | models/BadRequestError.ts:68 | -| `message` | `string` | - | models/BadRequestError.ts:69 | +| Property | Type | +| :------ | :------ | +| `causes?` | [`BadRequestErrorAllOfCauses`](../classes/BadRequestErrorAllOfCauses.md)[] | +| `code` | [`BadRequestErrorCodeEnum`](../type-aliases/BadRequestErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CancellationReasonProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CancellationReasonProperties.md index d3001959..54516bb4 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CancellationReasonProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CancellationReasonProperties.md @@ -4,9 +4,9 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `primaryReasonCode`? | `string` | - | models/CancellationReason.ts:59 | -| `primaryReasonDescription`? | `string` | - | models/CancellationReason.ts:61 | -| `subReasonCode`? | `string` | - | models/CancellationReason.ts:60 | -| `subReasonDescription`? | `string` | - | models/CancellationReason.ts:62 | +| Property | Type | +| :------ | :------ | +| `primaryReasonCode?` | `string` | +| `primaryReasonDescription?` | `string` | +| `subReasonCode?` | `string` | +| `subReasonDescription?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CaptureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CaptureProperties.md index e87966c1..37f9dfdc 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CaptureProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CaptureProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/Capture.ts:56 | -| `id`? | `string` | - | models/Capture.ts:55 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/Capture.ts:57 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CarProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CarProperties.md index a6a09895..53c0242e 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CarProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CarProperties.md @@ -8,14 +8,14 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `dropOffLocation` | `string` | - | - | models/Car.ts:68 | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `pickUpLocation` | `string` | - | - | models/Car.ts:67 | -| `pickupTime` | `Date` | - | - | models/Car.ts:69 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `returnTime` | `Date` | - | - | models/Car.ts:70 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `dropOffLocation` | `string` | - | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `pickUpLocation` | `string` | - | +| `pickupTime` | `Date` | - | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `returnTime` | `Date` | - | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ChallengeDetailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ChallengeDetailProperties.md index 5223414e..2fb82258 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ChallengeDetailProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ChallengeDetailProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `displayedFlag` | `boolean` | - | models/ChallengeDetail.ts:55 | -| `status` | [`ChallengeDetailStatusEnum`](../type-aliases/ChallengeDetailStatusEnum.md) | - | models/ChallengeDetail.ts:57 | -| `type` | [`ChallengeDetailTypeEnum`](../type-aliases/ChallengeDetailTypeEnum.md) | - | models/ChallengeDetail.ts:56 | +| Property | Type | +| :------ | :------ | +| `displayedFlag` | `boolean` | +| `status` | [`ChallengeDetailStatusEnum`](../type-aliases/ChallengeDetailStatusEnum.md) | +| `type` | [`ChallengeDetailTypeEnum`](../type-aliases/ChallengeDetailTypeEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ChargebackDetailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ChargebackDetailProperties.md index 9d0ef4e0..c4b405bb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ChargebackDetailProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ChargebackDetailProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `bankReasonCode`? | `string` | - | models/ChargebackDetail.ts:74 | -| `chargebackAmount` | [`Amount`](../classes/Amount.md) | - | models/ChargebackDetail.ts:73 | -| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/ChargebackDetailChargebackReasonEnum.md) | - | models/ChargebackDetail.ts:72 | -| `chargebackReportedDateTime`? | `Date` | - | models/ChargebackDetail.ts:75 | -| `chargebackStatus` | [`ChargebackDetailChargebackStatusEnum`](../type-aliases/ChargebackDetailChargebackStatusEnum.md) | - | models/ChargebackDetail.ts:71 | +| Property | Type | +| :------ | :------ | +| `bankReasonCode?` | `string` | +| `chargebackAmount` | [`Amount`](../classes/Amount.md) | +| `chargebackReason` | [`ChargebackDetailChargebackReasonEnum`](../type-aliases/ChargebackDetailChargebackReasonEnum.md) | +| `chargebackReportedDateTime?` | `Date` | +| `chargebackStatus` | [`ChargebackDetailChargebackStatusEnum`](../type-aliases/ChargebackDetailChargebackStatusEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ChargebackFeedbackProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ChargebackFeedbackProperties.md index 6c289d49..b29fa1a8 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ChargebackFeedbackProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ChargebackFeedbackProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `chargebackDetail`? | [`ChargebackDetail`](../classes/ChargebackDetail.md) | - | - | models/ChargebackFeedback.ts:51 | -| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `chargebackDetail?` | [`ChargebackDetail`](../classes/ChargebackDetail.md) | - | +| `riskId` | `string` | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CreditCardProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CreditCardProperties.md index 0395f829..ab0b1e97 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CreditCardProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CreditCardProperties.md @@ -8,26 +8,26 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `cardAuthenticationFailureCount`? | `number` | - | - | models/CreditCard.ts:145 | -| `cardAvsResponse`? | `string` | - | - | models/CreditCard.ts:141 | -| `cardCvvResponse`? | `string` | - | - | models/CreditCard.ts:142 | -| `cardNumber` | `string` | - | - | models/CreditCard.ts:136 | -| `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/CreditCardCardTypeEnum.md) | - | - | models/CreditCard.ts:135 | -| `electronicCommerceIndicator`? | `string` | - | - | models/CreditCard.ts:138 | -| `expiryDate` | `Date` | - | - | models/CreditCard.ts:137 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `merchantOrderCode`? | `string` | - | - | models/CreditCard.ts:144 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/CreditCard.ts:143 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | -| `virtualCreditCardFlag`? | `boolean` | - | - | models/CreditCard.ts:139 | -| `walletType`? | `string` | - | - | models/CreditCard.ts:140 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `cardAuthenticationFailureCount?` | `number` | - | +| `cardAvsResponse?` | `string` | - | +| `cardCvvResponse?` | `string` | - | +| `cardNumber` | `string` | - | +| `cardType` | [`CreditCardCardTypeEnum`](../type-aliases/CreditCardCardTypeEnum.md) | - | +| `electronicCommerceIndicator?` | `string` | - | +| `expiryDate` | `Date` | - | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `merchantOrderCode?` | `string` | - | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | +| `virtualCreditCardFlag?` | `boolean` | - | +| `walletType?` | `string` | - | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CruiseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CruiseProperties.md index bd4b5d6f..e8cacec3 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CruiseProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CruiseProperties.md @@ -8,15 +8,15 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `arrivalTime` | `Date` | - | - | models/Cruise.ts:74 | -| `departureTime` | `Date` | - | - | models/Cruise.ts:73 | -| `disembarkationPort` | `string` | - | - | models/Cruise.ts:76 | -| `embarkationPort` | `string` | - | - | models/Cruise.ts:75 | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `shipName` | `string` | - | - | models/Cruise.ts:77 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `arrivalTime` | `Date` | - | +| `departureTime` | `Date` | - | +| `disembarkationPort` | `string` | - | +| `embarkationPort` | `string` | - | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `shipName` | `string` | - | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CurrentUserSessionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CurrentUserSessionProperties.md index 69011418..33289975 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CurrentUserSessionProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CurrentUserSessionProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `challengeDetail`? | [`ChallengeDetail`](../classes/ChallengeDetail.md) | - | models/CurrentUserSession.ts:57 | -| `sessionId`? | `string` | - | models/CurrentUserSession.ts:55 | -| `startDateTime`? | `Date` | - | models/CurrentUserSession.ts:56 | +| Property | Type | +| :------ | :------ | +| `challengeDetail?` | [`ChallengeDetail`](../classes/ChallengeDetail.md) | +| `sessionId?` | `string` | +| `startDateTime?` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountAddressProperties.md index 2ca92e23..1421b915 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountAddressProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountAddressProperties.md @@ -4,12 +4,12 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | - | models/CustomerAccountAddress.ts:75 | -| `addressLine2`? | `string` | - | models/CustomerAccountAddress.ts:76 | -| `addressType`? | [`CustomerAccountAddressAddressTypeEnum`](../type-aliases/CustomerAccountAddressAddressTypeEnum.md) | - | models/CustomerAccountAddress.ts:74 | -| `city` | `string` | - | models/CustomerAccountAddress.ts:77 | -| `countryCode` | `string` | - | models/CustomerAccountAddress.ts:80 | -| `state` | `string` | - | models/CustomerAccountAddress.ts:78 | -| `zipCode` | `string` | - | models/CustomerAccountAddress.ts:79 | +| Property | Type | +| :------ | :------ | +| `addressLine1` | `string` | +| `addressLine2?` | `string` | +| `addressType?` | [`CustomerAccountAddressAddressTypeEnum`](../type-aliases/CustomerAccountAddressAddressTypeEnum.md) | +| `city` | `string` | +| `countryCode` | `string` | +| `state` | `string` | +| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountProperties.md b/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountProperties.md index 9f1d8b02..ecf98e9e 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/CustomerAccountProperties.md @@ -4,12 +4,12 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/CustomerAccountAccountTypeEnum.md) | - | models/CustomerAccount.ts:85 | -| `address`? | [`CustomerAccountAddress`](../classes/CustomerAccountAddress.md) | - | models/CustomerAccount.ts:89 | -| `emailAddress` | `string` | - | models/CustomerAccount.ts:87 | -| `name` | [`Name`](../classes/Name.md) | - | models/CustomerAccount.ts:86 | -| `registeredTime`? | `Date` | - | models/CustomerAccount.ts:90 | -| `telephones`? | [`Telephone`](../classes/Telephone.md)[] | - | models/CustomerAccount.ts:88 | -| `userId`? | `string` | - | models/CustomerAccount.ts:84 | +| Property | Type | +| :------ | :------ | +| `accountType` | [`CustomerAccountAccountTypeEnum`](../type-aliases/CustomerAccountAccountTypeEnum.md) | +| `address?` | [`CustomerAccountAddress`](../classes/CustomerAccountAddress.md) | +| `emailAddress` | `string` | +| `name` | [`Name`](../classes/Name.md) | +| `registeredTime?` | `Date` | +| `telephones?` | [`Telephone`](../classes/Telephone.md)[] | +| `userId?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/DeviceDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/DeviceDetailsProperties.md index 0e30b6f3..b1276322 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/DeviceDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/DeviceDetailsProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `deviceBox`? | `string` | - | models/DeviceDetails.ts:50 | -| `ipAddress` | `string` | - | models/DeviceDetails.ts:51 | -| `source`? | `string` | - | models/DeviceDetails.ts:49 | +| Property | Type | +| :------ | :------ | +| `deviceBox?` | `string` | +| `ipAddress` | `string` | +| `source?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/DirectDebitProperties.md b/release/fraudPreventionV2/docs/models/interfaces/DirectDebitProperties.md index 0ceaf4e2..50261928 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/DirectDebitProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/DirectDebitProperties.md @@ -8,19 +8,19 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `accountNumber` | `string` | - | - | models/DirectDebit.ts:81 | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `mandateType`? | [`DirectDebitMandateTypeEnum`](../type-aliases/DirectDebitMandateTypeEnum.md) | - | - | models/DirectDebit.ts:82 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `routingNumber`? | `string` | - | - | models/DirectDebit.ts:80 | -| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/DirectDebit.ts:83 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `accountNumber` | `string` | - | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `mandateType?` | [`DirectDebitMandateTypeEnum`](../type-aliases/DirectDebitMandateTypeEnum.md) | - | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `routingNumber?` | `string` | - | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/EmailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/EmailProperties.md index ce915027..3182baa0 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/EmailProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/EmailProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `emailAddress`? | `string` | - | models/Email.ts:40 | +| Property | Type | +| :------ | :------ | +| `emailAddress?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ForbiddenErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ForbiddenErrorProperties.md index 011f745b..107cfe1c 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ForbiddenErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ForbiddenErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/ForbiddenErrorCodeEnum.md) | - | models/ForbiddenError.ts:59 | -| `message` | `string` | - | models/ForbiddenError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`ForbiddenErrorCodeEnum`](../type-aliases/ForbiddenErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/GatewayTimeoutErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/GatewayTimeoutErrorProperties.md index 6b078799..fb9f00ce 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/GatewayTimeoutErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/GatewayTimeoutErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/GatewayTimeoutErrorCodeEnum.md) | - | models/GatewayTimeoutError.ts:59 | -| `message` | `string` | - | models/GatewayTimeoutError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`GatewayTimeoutErrorCodeEnum`](../type-aliases/GatewayTimeoutErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/GiftCardProperties.md b/release/fraudPreventionV2/docs/models/interfaces/GiftCardProperties.md index 37b99c76..da3403fd 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/GiftCardProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/GiftCardProperties.md @@ -8,18 +8,18 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `cardHolderName` | `string` | - | - | models/GiftCard.ts:67 | -| `cardNumber` | `string` | - | - | models/GiftCard.ts:66 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `pin` | `string` | - | - | models/GiftCard.ts:68 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `cardHolderName` | `string` | - | +| `cardNumber` | `string` | - | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `pin` | `string` | - | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/HotelAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/HotelAddressProperties.md index 1c62f210..af51aca3 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/HotelAddressProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/HotelAddressProperties.md @@ -4,12 +4,12 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | - | models/HotelAddress.ts:76 | -| `addressLine2`? | `string` | - | models/HotelAddress.ts:77 | -| `addressType`? | [`HotelAddressAddressTypeEnum`](../type-aliases/HotelAddressAddressTypeEnum.md) | - | models/HotelAddress.ts:75 | -| `city` | `string` | - | models/HotelAddress.ts:78 | -| `countryCode` | `string` | - | models/HotelAddress.ts:81 | -| `state` | `string` | - | models/HotelAddress.ts:79 | -| `zipCode` | `string` | - | models/HotelAddress.ts:80 | +| Property | Type | +| :------ | :------ | +| `addressLine1` | `string` | +| `addressLine2?` | `string` | +| `addressType?` | [`HotelAddressAddressTypeEnum`](../type-aliases/HotelAddressAddressTypeEnum.md) | +| `city` | `string` | +| `countryCode` | `string` | +| `state` | `string` | +| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/HotelProperties.md b/release/fraudPreventionV2/docs/models/interfaces/HotelProperties.md index d48fcb73..a42b057c 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/HotelProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/HotelProperties.md @@ -8,17 +8,17 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `address` | [`HotelAddress`](../classes/HotelAddress.md) | - | - | models/Hotel.ts:92 | -| `checkinTime` | `Date` | - | - | models/Hotel.ts:93 | -| `checkoutTime` | `Date` | - | - | models/Hotel.ts:94 | -| `hotelId` | `string` | - | - | models/Hotel.ts:88 | -| `hotelName` | `string` | - | - | models/Hotel.ts:90 | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `priceWithheld`? | `boolean` | - | - | models/Hotel.ts:89 | -| `roomCount`? | `number` | - | - | models/Hotel.ts:91 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `address` | [`HotelAddress`](../classes/HotelAddress.md) | - | +| `checkinTime` | `Date` | - | +| `checkoutTime` | `Date` | - | +| `hotelId` | `string` | - | +| `hotelName` | `string` | - | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `priceWithheld?` | `boolean` | - | +| `roomCount?` | `number` | - | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/InsultDetailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/InsultDetailProperties.md index 1b8eaf1b..5e93f47d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/InsultDetailProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/InsultDetailProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `insultReportedDateTime`? | `Date` | - | models/InsultDetail.ts:40 | +| Property | Type | +| :------ | :------ | +| `insultReportedDateTime?` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/InsultFeedbackProperties.md b/release/fraudPreventionV2/docs/models/interfaces/InsultFeedbackProperties.md index 42b6b2e8..5ff8447d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/InsultFeedbackProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/InsultFeedbackProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `insultDetail`? | [`InsultDetail`](../classes/InsultDetail.md) | - | - | models/InsultFeedback.ts:51 | -| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `insultDetail?` | [`InsultDetail`](../classes/InsultDetail.md) | - | +| `riskId` | `string` | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/InsuranceProperties.md b/release/fraudPreventionV2/docs/models/interfaces/InsuranceProperties.md index 8ed6a864..9eb58e74 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/InsuranceProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/InsuranceProperties.md @@ -8,10 +8,10 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/InternalServerErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/InternalServerErrorProperties.md index ba3670a1..dc6fb307 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/InternalServerErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/InternalServerErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/InternalServerErrorCodeEnum.md) | - | models/InternalServerError.ts:59 | -| `message` | `string` | - | models/InternalServerError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`InternalServerErrorCodeEnum`](../type-aliases/InternalServerErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/InternetBankPaymentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/InternetBankPaymentProperties.md index 0cbf74a9..b52b170a 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/InternetBankPaymentProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/InternetBankPaymentProperties.md @@ -8,18 +8,18 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `bankBranchCode` | `string` | - | - | models/InternetBankPayment.ts:74 | -| `bankId` | `string` | - | - | models/InternetBankPayment.ts:73 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | - | models/InternetBankPayment.ts:75 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `bankBranchCode` | `string` | - | +| `bankId` | `string` | - | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `telephones` | [`Telephone`](../classes/Telephone.md)[] | - | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md index 6f55408e..bcf08767 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateDetailsProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `refundIssuedAmount` | [`Amount`](../classes/Amount.md) | - | models/IssuedRefundUpdateDetails.ts:53 | -| `refundIssuedDateTime` | `Date` | - | models/IssuedRefundUpdateDetails.ts:52 | +| Property | Type | +| :------ | :------ | +| `refundIssuedAmount` | [`Amount`](../classes/Amount.md) | +| `refundIssuedDateTime` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateProperties.md index f1688d96..705b1cc3 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/IssuedRefundUpdateProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `refundDetails`? | [`IssuedRefundUpdateDetails`](../classes/IssuedRefundUpdateDetails.md) | - | - | models/IssuedRefundUpdate.ts:50 | -| `riskId` | `string` | - | [`RefundUpdateProperties`](RefundUpdateProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `refundDetails?` | [`IssuedRefundUpdateDetails`](../classes/IssuedRefundUpdateDetails.md) | - | +| `riskId` | `string` | [`RefundUpdateProperties`](RefundUpdateProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/LoginTransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/LoginTransactionDetailsProperties.md index c91cd925..047532a1 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/LoginTransactionDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/LoginTransactionDetailsProperties.md @@ -8,12 +8,12 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `authenticationSubType`? | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md) | - | - | models/LoginTransactionDetails.ts:88 | -| `authenticationType` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md) | - | - | models/LoginTransactionDetails.ts:87 | -| `currentUserSession`? | [`CurrentUserSession`](../classes/CurrentUserSession.md) | - | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`currentUserSession` | models/AccountTakeoverTransactionDetails.ts:63 | -| `failedLoginReason`? | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md) | - | - | models/LoginTransactionDetails.ts:90 | -| `successfulLoginFlag` | `boolean` | - | - | models/LoginTransactionDetails.ts:89 | -| `transactionDateTime` | `Date` | - | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`transactionDateTime` | models/AccountTakeoverTransactionDetails.ts:61 | -| `transactionId` | `string` | - | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`transactionId` | models/AccountTakeoverTransactionDetails.ts:62 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `authenticationSubType?` | [`LoginTransactionDetailsAuthenticationSubTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationSubTypeEnum.md) | - | +| `authenticationType` | [`LoginTransactionDetailsAuthenticationTypeEnum`](../type-aliases/LoginTransactionDetailsAuthenticationTypeEnum.md) | - | +| `currentUserSession?` | [`CurrentUserSession`](../classes/CurrentUserSession.md) | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`currentUserSession` | +| `failedLoginReason?` | [`LoginTransactionDetailsFailedLoginReasonEnum`](../type-aliases/LoginTransactionDetailsFailedLoginReasonEnum.md) | - | +| `successfulLoginFlag` | `boolean` | - | +| `transactionDateTime` | `Date` | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`transactionDateTime` | +| `transactionId` | `string` | [`AccountTakeoverTransactionDetailsProperties`](AccountTakeoverTransactionDetailsProperties.md).`transactionId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ModelErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ModelErrorProperties.md index 7cf97aeb..26158aca 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ModelErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ModelErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ModelErrorCodeEnum`](../type-aliases/ModelErrorCodeEnum.md) | - | models/ModelError.ts:59 | -| `message` | `string` | - | models/ModelError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`ModelErrorCodeEnum`](../type-aliases/ModelErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md b/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md index d609ebe7..82fdecb8 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationAttemptProperties.md @@ -4,14 +4,14 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `attemptCount` | `number` | - | models/MultiFactorAuthenticationAttempt.ts:109 | -| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) | - | models/MultiFactorAuthenticationAttempt.ts:105 | -| `emailAddress`? | `string` | - | models/MultiFactorAuthenticationAttempt.ts:113 | -| `providerName` | `string` | - | models/MultiFactorAuthenticationAttempt.ts:108 | -| `referenceId` | `string` | - | models/MultiFactorAuthenticationAttempt.ts:107 | -| `status` | [`MultiFactorAuthenticationAttemptStatusEnum`](../type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md) | - | models/MultiFactorAuthenticationAttempt.ts:106 | -| `telephone`? | [`Telephone`](../classes/Telephone.md) | - | models/MultiFactorAuthenticationAttempt.ts:112 | -| `updateEndDateTime`? | `Date` | - | models/MultiFactorAuthenticationAttempt.ts:111 | -| `updateStartDateTime`? | `Date` | - | models/MultiFactorAuthenticationAttempt.ts:110 | +| Property | Type | +| :------ | :------ | +| `attemptCount` | `number` | +| `deliveryMethod` | [`MultiFactorAuthenticationAttemptDeliveryMethodEnum`](../type-aliases/MultiFactorAuthenticationAttemptDeliveryMethodEnum.md) | +| `emailAddress?` | `string` | +| `providerName` | `string` | +| `referenceId` | `string` | +| `status` | [`MultiFactorAuthenticationAttemptStatusEnum`](../type-aliases/MultiFactorAuthenticationAttemptStatusEnum.md) | +| `telephone?` | [`Telephone`](../classes/Telephone.md) | +| `updateEndDateTime?` | `Date` | +| `updateStartDateTime?` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md index 178d034b..6ed7deeb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/MultiFactorAuthenticationUpdateProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `multiFactorAuthenticationAttempts` | [`MultiFactorAuthenticationAttempt`](../classes/MultiFactorAuthenticationAttempt.md)[] | - | - | models/MultiFactorAuthenticationUpdate.ts:56 | -| `riskId` | `string` | - | [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md).`riskId` | models/AccountUpdateRequest.ts:44 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `multiFactorAuthenticationAttempts` | [`MultiFactorAuthenticationAttempt`](../classes/MultiFactorAuthenticationAttempt.md)[] | - | +| `riskId` | `string` | [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/NameProperties.md b/release/fraudPreventionV2/docs/models/interfaces/NameProperties.md index 8cb41e4f..dbc12d70 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/NameProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/NameProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `firstName` | `string` | - | models/Name.ts:65 | -| `lastName` | `string` | - | models/Name.ts:64 | -| `middleName`? | `string` | - | models/Name.ts:66 | -| `suffix`? | `string` | - | models/Name.ts:68 | -| `title`? | `string` | - | models/Name.ts:67 | +| Property | Type | +| :------ | :------ | +| `firstName` | `string` | +| `lastName` | `string` | +| `middleName?` | `string` | +| `suffix?` | `string` | +| `title?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/NotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/NotFoundErrorProperties.md index 46c5434a..40184e97 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/NotFoundErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/NotFoundErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/NotFoundErrorCodeEnum.md) | - | models/NotFoundError.ts:59 | -| `message` | `string` | - | models/NotFoundError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`NotFoundErrorCodeEnum`](../type-aliases/NotFoundErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OperationsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OperationsProperties.md index 946282c6..dbc00b10 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OperationsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OperationsProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `authorize`? | [`Authorize`](../classes/Authorize.md) | - | models/Operations.ts:79 | -| `authorizeReversal`? | [`AuthorizeReversal`](../classes/AuthorizeReversal.md) | - | models/Operations.ts:80 | -| `capture`? | [`Capture`](../classes/Capture.md) | - | models/Operations.ts:81 | -| `refunds`? | [`Refund`](../classes/Refund.md)[] | - | models/Operations.ts:82 | -| `verify`? | [`Verify`](../classes/Verify.md) | - | models/Operations.ts:78 | +| Property | Type | +| :------ | :------ | +| `authorize?` | [`Authorize`](../classes/Authorize.md) | +| `authorizeReversal?` | [`AuthorizeReversal`](../classes/AuthorizeReversal.md) | +| `capture?` | [`Capture`](../classes/Capture.md) | +| `refunds?` | [`Refund`](../classes/Refund.md)[] | +| `verify?` | [`Verify`](../classes/Verify.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md index 318bb65f..7e72c91b 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenRequestProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `transaction` | [`OrderPurchaseTransaction`](../classes/OrderPurchaseTransaction.md) | - | models/OrderPurchaseScreenRequest.ts:41 | +| Property | Type | +| :------ | :------ | +| `transaction` | [`OrderPurchaseTransaction`](../classes/OrderPurchaseTransaction.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md index d90d573a..df8537ea 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseScreenResponseProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `decision`? | [`FraudDecision`](../type-aliases/FraudDecision.md) | - | models/OrderPurchaseScreenResponse.ts:44 | -| `riskId`? | `string` | - | models/OrderPurchaseScreenResponse.ts:43 | +| Property | Type | +| :------ | :------ | +| `decision?` | [`FraudDecision`](../type-aliases/FraudDecision.md) | +| `riskId?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseTransactionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseTransactionProperties.md index 435b849e..98ce29c3 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseTransactionProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseTransactionProperties.md @@ -4,9 +4,9 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `customerAccount` | [`CustomerAccount`](../classes/CustomerAccount.md) | - | models/OrderPurchaseTransaction.ts:70 | -| `deviceDetails` | [`DeviceDetails`](../classes/DeviceDetails.md) | - | models/OrderPurchaseTransaction.ts:69 | -| `siteInfo` | [`SiteInfo`](../classes/SiteInfo.md) | - | models/OrderPurchaseTransaction.ts:68 | -| `transactionDetails` | [`TransactionDetails`](../classes/TransactionDetails.md) | - | models/OrderPurchaseTransaction.ts:71 | +| Property | Type | +| :------ | :------ | +| `customerAccount` | [`CustomerAccount`](../classes/CustomerAccount.md) | +| `deviceDetails` | [`DeviceDetails`](../classes/DeviceDetails.md) | +| `siteInfo` | [`SiteInfo`](../classes/SiteInfo.md) | +| `transactionDetails` | [`TransactionDetails`](../classes/TransactionDetails.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md index 2d9fb607..8fbe9096 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateNotFoundErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | - | models/OrderPurchaseUpdateNotFoundError.ts:61 | -| `message` | `string` | - | models/OrderPurchaseUpdateNotFoundError.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`OrderPurchaseUpdateNotFoundErrorCodeEnum`](../type-aliases/OrderPurchaseUpdateNotFoundErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md index b1187bb6..7afc19b3 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateRequestProperties.md @@ -2,7 +2,7 @@ # Interface: OrderPurchaseUpdateRequestProperties -## Extended By +## Extended by - [`ChargebackFeedbackProperties`](ChargebackFeedbackProperties.md) - [`InsultFeedbackProperties`](InsultFeedbackProperties.md) @@ -12,6 +12,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId` | `string` | - | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | +| :------ | :------ | +| `riskId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md index 88db6117..c46088b7 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderPurchaseUpdateResponseProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `riskId`? | `string` | - | models/OrderPurchaseUpdateResponse.ts:39 | +| Property | Type | +| :------ | :------ | +| `riskId?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/OrderUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/OrderUpdateProperties.md index d6d4f95b..c13a6080 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/OrderUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/OrderUpdateProperties.md @@ -8,9 +8,9 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `acquirerReferenceNumber`? | `string` | - | - | models/OrderUpdate.ts:63 | -| `cancellationReason`? | [`CancellationReason`](../classes/CancellationReason.md) | - | - | models/OrderUpdate.ts:64 | -| `orderStatus` | [`Status`](../type-aliases/Status.md) | - | - | models/OrderUpdate.ts:62 | -| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `acquirerReferenceNumber?` | `string` | - | +| `cancellationReason?` | [`CancellationReason`](../classes/CancellationReason.md) | - | +| `orderStatus` | [`Status`](../type-aliases/Status.md) | - | +| `riskId` | `string` | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PayPalProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PayPalProperties.md index 33f5222b..bbccaf3b 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PayPalProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PayPalProperties.md @@ -8,18 +8,18 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `merchantOrderCode`? | `string` | - | - | models/PayPal.ts:68 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `payerId` | `string` | - | - | models/PayPal.ts:66 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `transactionId` | `string` | - | - | models/PayPal.ts:67 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `merchantOrderCode?` | `string` | - | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `payerId` | `string` | - | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `transactionId` | `string` | - | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentBillingAddressProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentBillingAddressProperties.md index 77bce258..b29958eb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentBillingAddressProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentBillingAddressProperties.md @@ -4,12 +4,12 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `addressLine1` | `string` | - | models/PaymentBillingAddress.ts:73 | -| `addressLine2`? | `string` | - | models/PaymentBillingAddress.ts:74 | -| `addressType`? | [`PaymentBillingAddressAddressTypeEnum`](../type-aliases/PaymentBillingAddressAddressTypeEnum.md) | - | models/PaymentBillingAddress.ts:72 | -| `city` | `string` | - | models/PaymentBillingAddress.ts:75 | -| `countryCode` | `string` | - | models/PaymentBillingAddress.ts:78 | -| `state`? | `string` | - | models/PaymentBillingAddress.ts:76 | -| `zipCode` | `string` | - | models/PaymentBillingAddress.ts:77 | +| Property | Type | +| :------ | :------ | +| `addressLine1` | `string` | +| `addressLine2?` | `string` | +| `addressType?` | [`PaymentBillingAddressAddressTypeEnum`](../type-aliases/PaymentBillingAddressAddressTypeEnum.md) | +| `city` | `string` | +| `countryCode` | `string` | +| `state?` | `string` | +| `zipCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentOperationProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentOperationProperties.md index 6d76eba8..9e98c2e5 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentOperationProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentOperationProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/PaymentOperation.ts:53 | -| `id`? | `string` | - | models/PaymentOperation.ts:52 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/PaymentOperation.ts:54 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentOutcomeProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentOutcomeProperties.md index 4eba54be..1b45f126 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentOutcomeProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentOutcomeProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code`? | `string` | - | models/PaymentOutcome.ts:48 | -| `description`? | `string` | - | models/PaymentOutcome.ts:49 | -| `status`? | [`PaymentStatus`](../type-aliases/PaymentStatus.md) | - | models/PaymentOutcome.ts:47 | +| Property | Type | +| :------ | :------ | +| `code?` | `string` | +| `description?` | `string` | +| `status?` | [`PaymentStatus`](../type-aliases/PaymentStatus.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentProperties.md index 240d815b..f1ab28eb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentProperties.md @@ -2,7 +2,7 @@ # Interface: PaymentProperties -## Extended By +## Extended by - [`CreditCardProperties`](CreditCardProperties.md) - [`DirectDebitProperties`](DirectDebitProperties.md) @@ -13,15 +13,15 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | models/Payment.ts:161 | -| `extensions`? | `object` | - | models/Payment.ts:170 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | models/Payment.ts:169 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | models/Payment.ts:162 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | models/Payment.ts:167 | +| Property | Type | +| :------ | :------ | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | +| `billingEmailAddress` | `string` | +| `billingName` | [`Name`](../classes/Name.md) | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | +| `extensions?` | `Object` | +| `operations?` | [`Operations`](../classes/Operations.md) | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md index 5a415359..2528186c 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentThreeDSCriteriaProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `probableFlag`? | `boolean` | - | models/PaymentThreeDSCriteria.ts:48 | -| `transactionModel`? | `string` | - | models/PaymentThreeDSCriteria.ts:49 | +| Property | Type | +| :------ | :------ | +| `probableFlag?` | `boolean` | +| `transactionModel?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PaymentUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PaymentUpdateProperties.md index f33897eb..69a0859e 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PaymentUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PaymentUpdateProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `merchantOrderCode` | `string` | - | - | models/PaymentUpdate.ts:49 | -| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `merchantOrderCode` | `string` | - | +| `riskId` | `string` | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/PointsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/PointsProperties.md index 87a57a9a..902eba77 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/PointsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/PointsProperties.md @@ -8,16 +8,16 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `accountId` | `string` | - | - | models/Points.ts:54 | -| `authorizedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | models/Payment.ts:166 | -| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | models/Payment.ts:164 | -| `billingEmailAddress` | `string` | - | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | models/Payment.ts:165 | -| `billingName` | [`Name`](../classes/Name.md) | - | [`PaymentProperties`](PaymentProperties.md).`billingName` | models/Payment.ts:163 | -| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | - | [`PaymentProperties`](PaymentProperties.md).`brand` | models/Payment.ts:161 | -| `extensions`? | `object` | - | [`PaymentProperties`](PaymentProperties.md).`extensions` | models/Payment.ts:170 | -| `operations`? | [`Operations`](../classes/Operations.md) | - | [`PaymentProperties`](PaymentProperties.md).`operations` | models/Payment.ts:169 | -| `reason`? | [`PaymentReason`](../type-aliases/PaymentReason.md) | - | [`PaymentProperties`](PaymentProperties.md).`reason` | models/Payment.ts:162 | -| `threeDigitsSecureCriteria`? | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | - | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | models/Payment.ts:168 | -| `verifiedAmount`? | [`Amount`](../classes/Amount.md) | - | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | models/Payment.ts:167 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `accountId` | `string` | - | +| `authorizedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`authorizedAmount` | +| `billingAddress` | [`PaymentBillingAddress`](../classes/PaymentBillingAddress.md) | [`PaymentProperties`](PaymentProperties.md).`billingAddress` | +| `billingEmailAddress` | `string` | [`PaymentProperties`](PaymentProperties.md).`billingEmailAddress` | +| `billingName` | [`Name`](../classes/Name.md) | [`PaymentProperties`](PaymentProperties.md).`billingName` | +| `brand` | [`PaymentBrandEnum`](../type-aliases/PaymentBrandEnum.md) | [`PaymentProperties`](PaymentProperties.md).`brand` | +| `extensions?` | `Object` | [`PaymentProperties`](PaymentProperties.md).`extensions` | +| `operations?` | [`Operations`](../classes/Operations.md) | [`PaymentProperties`](PaymentProperties.md).`operations` | +| `reason?` | [`PaymentReason`](../type-aliases/PaymentReason.md) | [`PaymentProperties`](PaymentProperties.md).`reason` | +| `threeDigitsSecureCriteria?` | [`PaymentThreeDSCriteria`](../classes/PaymentThreeDSCriteria.md) | [`PaymentProperties`](PaymentProperties.md).`threeDigitsSecureCriteria` | +| `verifiedAmount?` | [`Amount`](../classes/Amount.md) | [`PaymentProperties`](PaymentProperties.md).`verifiedAmount` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RailProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RailProperties.md index f0262184..3aac976f 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RailProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RailProperties.md @@ -8,12 +8,12 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | [`TravelProductProperties`](TravelProductProperties.md).`price` | models/TravelProduct.ts:68 | -| `railSegments` | [`RailSegments`](../classes/RailSegments.md)[] | - | - | models/Rail.ts:64 | -| `routeType` | [`RailRouteTypeEnum`](../type-aliases/RailRouteTypeEnum.md) | - | - | models/Rail.ts:63 | -| `travelersReferences`? | `string`[] | - | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | models/TravelProduct.ts:71 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | [`TravelProductProperties`](TravelProductProperties.md).`inventorySource` | +| `inventoryType` | `string` | [`TravelProductProperties`](TravelProductProperties.md).`inventoryType` | +| `payLater?` | `boolean` | [`TravelProductProperties`](TravelProductProperties.md).`payLater` | +| `price` | [`Amount`](../classes/Amount.md) | [`TravelProductProperties`](TravelProductProperties.md).`price` | +| `railSegments` | [`RailSegments`](../classes/RailSegments.md)[] | - | +| `routeType` | [`RailRouteTypeEnum`](../type-aliases/RailRouteTypeEnum.md) | - | +| `travelersReferences?` | `string`[] | [`TravelProductProperties`](TravelProductProperties.md).`travelersReferences` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md index 8d5e7345..6ff6ccda 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsOperatingCompanyProperties.md @@ -4,6 +4,6 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `marketingName`? | `string` | - | models/RailSegmentsOperatingCompany.ts:42 | +| Property | Type | +| :------ | :------ | +| `marketingName?` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsProperties.md index c645082e..3d9d6afb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RailSegmentsProperties.md @@ -4,11 +4,11 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `arrivalStation` | [`RailwayStationDetails`](../classes/RailwayStationDetails.md) | - | models/RailSegments.ts:86 | -| `arrivalTime` | `Date` | - | models/RailSegments.ts:84 | -| `departureStation` | [`RailwayStationDetails`](../classes/RailwayStationDetails.md) | - | models/RailSegments.ts:85 | -| `departureTime` | `Date` | - | models/RailSegments.ts:83 | -| `operatingCompany`? | [`RailSegmentsOperatingCompany`](../classes/RailSegmentsOperatingCompany.md) | - | models/RailSegments.ts:88 | -| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/RailSegmentsTransportationMethodEnum.md) | - | models/RailSegments.ts:87 | +| Property | Type | +| :------ | :------ | +| `arrivalStation` | [`RailwayStationDetails`](../classes/RailwayStationDetails.md) | +| `arrivalTime` | `Date` | +| `departureStation` | [`RailwayStationDetails`](../classes/RailwayStationDetails.md) | +| `departureTime` | `Date` | +| `operatingCompany?` | [`RailSegmentsOperatingCompany`](../classes/RailSegmentsOperatingCompany.md) | +| `transportationMethod` | [`RailSegmentsTransportationMethodEnum`](../type-aliases/RailSegmentsTransportationMethodEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RailwayStationDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RailwayStationDetailsProperties.md index 7bf9223f..c4731b7d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RailwayStationDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RailwayStationDetailsProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `address` | [`Address`](../classes/Address.md) | - | models/RailwayStationDetails.ts:69 | -| `name` | `string` | - | models/RailwayStationDetails.ts:66 | -| `stationCode` | `string` | - | models/RailwayStationDetails.ts:68 | -| `timezone`? | `string` | - | models/RailwayStationDetails.ts:70 | -| `type`? | [`RailwayStationDetailsTypeEnum`](../type-aliases/RailwayStationDetailsTypeEnum.md) | - | models/RailwayStationDetails.ts:67 | +| Property | Type | +| :------ | :------ | +| `address` | [`Address`](../classes/Address.md) | +| `name` | `string` | +| `stationCode` | `string` | +| `timezone?` | `string` | +| `type?` | [`RailwayStationDetailsTypeEnum`](../type-aliases/RailwayStationDetailsTypeEnum.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RefundProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RefundProperties.md index aad0dc42..171beed1 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RefundProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RefundProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/Refund.ts:56 | -| `id`? | `string` | - | models/Refund.ts:55 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/Refund.ts:57 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RefundUpdateProperties.md index 9ab72bbc..35b613eb 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RefundUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RefundUpdateProperties.md @@ -8,6 +8,6 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `riskId` | `string` | - | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `riskId` | `string` | [`OrderPurchaseUpdateRequestProperties`](OrderPurchaseUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateActionProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateActionProperties.md index 58a14dcd..1d0bb1b6 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateActionProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateActionProperties.md @@ -4,8 +4,8 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/RemediationUpdateActionActionNameEnum.md) | - | models/RemediationUpdateAction.ts:60 | -| `status` | [`RemediationUpdateActionStatusEnum`](../type-aliases/RemediationUpdateActionStatusEnum.md) | - | models/RemediationUpdateAction.ts:61 | -| `updateEndDateTime`? | `Date` | - | models/RemediationUpdateAction.ts:62 | +| Property | Type | +| :------ | :------ | +| `actionName` | [`RemediationUpdateActionActionNameEnum`](../type-aliases/RemediationUpdateActionActionNameEnum.md) | +| `status` | [`RemediationUpdateActionStatusEnum`](../type-aliases/RemediationUpdateActionStatusEnum.md) | +| `updateEndDateTime?` | `Date` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateProperties.md index 5378465e..c6e8a508 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RemediationUpdateProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `remediationUpdateActions` | [`RemediationUpdateAction`](../classes/RemediationUpdateAction.md)[] | - | - | models/RemediationUpdate.ts:53 | -| `riskId` | `string` | - | [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md).`riskId` | models/AccountUpdateRequest.ts:44 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `remediationUpdateActions` | [`RemediationUpdateAction`](../classes/RemediationUpdateAction.md)[] | - | +| `riskId` | `string` | [`AccountUpdateRequestProperties`](AccountUpdateRequestProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md index d068556b..5084f6c9 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseScreenFailureProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) | - | models/RetryableOrderPurchaseScreenFailure.ts:61 | -| `message` | `string` | - | models/RetryableOrderPurchaseScreenFailure.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`RetryableOrderPurchaseScreenFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseScreenFailureCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md b/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md index 54ff4ba9..e85bcb2b 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/RetryableOrderPurchaseUpdateFailureProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) | - | models/RetryableOrderPurchaseUpdateFailure.ts:61 | -| `message` | `string` | - | models/RetryableOrderPurchaseUpdateFailure.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`RetryableOrderPurchaseUpdateFailureCodeEnum`](../type-aliases/RetryableOrderPurchaseUpdateFailureCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/ServiceUnavailableErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/ServiceUnavailableErrorProperties.md index 61291926..c2a8eef8 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/ServiceUnavailableErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/ServiceUnavailableErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/ServiceUnavailableErrorCodeEnum.md) | - | models/ServiceUnavailableError.ts:61 | -| `message` | `string` | - | models/ServiceUnavailableError.ts:62 | +| Property | Type | +| :------ | :------ | +| `code` | [`ServiceUnavailableErrorCodeEnum`](../type-aliases/ServiceUnavailableErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md index d59d8d3d..aded938f 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateDetailsProperties.md @@ -4,10 +4,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `acquirerReferenceNumber` | `string` | - | models/SettledRefundUpdateDetails.ts:75 | -| `refundDepositDateTime` | `Date` | - | models/SettledRefundUpdateDetails.ts:74 | -| `refundSettledAmount` | [`Amount`](../classes/Amount.md) | - | models/SettledRefundUpdateDetails.ts:77 | -| `refundSettlementDateTime` | `Date` | - | models/SettledRefundUpdateDetails.ts:73 | -| `settlementId` | `string` | - | models/SettledRefundUpdateDetails.ts:76 | +| Property | Type | +| :------ | :------ | +| `acquirerReferenceNumber` | `string` | +| `refundDepositDateTime` | `Date` | +| `refundSettledAmount` | [`Amount`](../classes/Amount.md) | +| `refundSettlementDateTime` | `Date` | +| `settlementId` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateProperties.md b/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateProperties.md index 3016e735..e117b590 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/SettledRefundUpdateProperties.md @@ -8,7 +8,7 @@ ## Properties -| Property | Type | Description | Inheritance | Source | -| :------ | :------ | :------ | :------ | :------ | -| `refundDetails`? | [`SettledRefundUpdateDetails`](../classes/SettledRefundUpdateDetails.md) | - | - | models/SettledRefundUpdate.ts:50 | -| `riskId` | `string` | - | [`RefundUpdateProperties`](RefundUpdateProperties.md).`riskId` | models/OrderPurchaseUpdateRequest.ts:42 | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `refundDetails?` | [`SettledRefundUpdateDetails`](../classes/SettledRefundUpdateDetails.md) | - | +| `riskId` | `string` | [`RefundUpdateProperties`](RefundUpdateProperties.md).`riskId` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/SiteInfoProperties.md b/release/fraudPreventionV2/docs/models/interfaces/SiteInfoProperties.md index 2cd2f447..cef18204 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/SiteInfoProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/SiteInfoProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `agentAssisted` | `boolean` | - | models/SiteInfo.ts:44 | -| `countryCode` | `string` | - | models/SiteInfo.ts:43 | +| Property | Type | +| :------ | :------ | +| `agentAssisted` | `boolean` | +| `countryCode` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/TelephoneProperties.md b/release/fraudPreventionV2/docs/models/interfaces/TelephoneProperties.md index 71f5c6da..1d54df7d 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/TelephoneProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/TelephoneProperties.md @@ -4,14 +4,14 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `areaCode` | `string` | - | models/Telephone.ts:87 | -| `countryAccessCode` | `string` | - | models/Telephone.ts:86 | -| `extensionNumber`? | `string` | - | models/Telephone.ts:89 | -| `lastVerifiedDateTime`? | `Date` | - | models/Telephone.ts:91 | -| `phoneNumber` | `string` | - | models/Telephone.ts:88 | -| `platformType`? | [`TelephonePlatformType`](../type-aliases/TelephonePlatformType.md) | - | models/Telephone.ts:85 | -| `preferenceRank`? | `number` | - | models/Telephone.ts:90 | -| `type`? | [`TelephoneType`](../type-aliases/TelephoneType.md) | - | models/Telephone.ts:84 | -| `verifiedFlag`? | `boolean` | - | models/Telephone.ts:92 | +| Property | Type | +| :------ | :------ | +| `areaCode` | `string` | +| `countryAccessCode` | `string` | +| `extensionNumber?` | `string` | +| `lastVerifiedDateTime?` | `Date` | +| `phoneNumber` | `string` | +| `platformType?` | [`TelephonePlatformType`](../type-aliases/TelephonePlatformType.md) | +| `preferenceRank?` | `number` | +| `type?` | [`TelephoneType`](../type-aliases/TelephoneType.md) | +| `verifiedFlag?` | `boolean` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/TooManyRequestsErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/TooManyRequestsErrorProperties.md index 3ffe5cdc..b5d5a6ee 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/TooManyRequestsErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/TooManyRequestsErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/TooManyRequestsErrorCodeEnum.md) | - | models/TooManyRequestsError.ts:59 | -| `message` | `string` | - | models/TooManyRequestsError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`TooManyRequestsErrorCodeEnum`](../type-aliases/TooManyRequestsErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/TransactionDetailsProperties.md b/release/fraudPreventionV2/docs/models/interfaces/TransactionDetailsProperties.md index 55d1f518..c47d3f81 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/TransactionDetailsProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/TransactionDetailsProperties.md @@ -4,11 +4,11 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/TransactionDetailsCurrentOrderStatusEnum.md) | - | models/TransactionDetails.ts:88 | -| `orderId` | `string` | - | models/TransactionDetails.ts:87 | -| `orderType` | [`TransactionDetailsOrderTypeEnum`](../type-aliases/TransactionDetailsOrderTypeEnum.md) | - | models/TransactionDetails.ts:89 | -| `payments`? | [`Payment`](../classes/Payment.md)[] | - | models/TransactionDetails.ts:92 | -| `travelProducts` | [`TravelProduct`](../classes/TravelProduct.md)[] | - | models/TransactionDetails.ts:90 | -| `travelers` | [`Traveler`](../classes/Traveler.md)[] | - | models/TransactionDetails.ts:91 | +| Property | Type | +| :------ | :------ | +| `currentOrderStatus` | [`TransactionDetailsCurrentOrderStatusEnum`](../type-aliases/TransactionDetailsCurrentOrderStatusEnum.md) | +| `orderId` | `string` | +| `orderType` | [`TransactionDetailsOrderTypeEnum`](../type-aliases/TransactionDetailsOrderTypeEnum.md) | +| `payments?` | [`Payment`](../classes/Payment.md)[] | +| `travelProducts` | [`TravelProduct`](../classes/TravelProduct.md)[] | +| `travelers` | [`Traveler`](../classes/Traveler.md)[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/TravelProductProperties.md b/release/fraudPreventionV2/docs/models/interfaces/TravelProductProperties.md index 6e1a6f38..e6f8cacc 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/TravelProductProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/TravelProductProperties.md @@ -2,7 +2,7 @@ # Interface: TravelProductProperties -## Extended By +## Extended by - [`AirProperties`](AirProperties.md) - [`CarProperties`](CarProperties.md) @@ -13,10 +13,10 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | - | models/TravelProduct.ts:70 | -| `inventoryType` | `string` | - | models/TravelProduct.ts:69 | -| `payLater`? | `boolean` | - | models/TravelProduct.ts:72 | -| `price` | [`Amount`](../classes/Amount.md) | - | models/TravelProduct.ts:68 | -| `travelersReferences`? | `string`[] | - | models/TravelProduct.ts:71 | +| Property | Type | +| :------ | :------ | +| `inventorySource` | [`TravelProductInventorySourceEnum`](../type-aliases/TravelProductInventorySourceEnum.md) | +| `inventoryType` | `string` | +| `payLater?` | `boolean` | +| `price` | [`Amount`](../classes/Amount.md) | +| `travelersReferences?` | `string`[] | diff --git a/release/fraudPreventionV2/docs/models/interfaces/TravelerProperties.md b/release/fraudPreventionV2/docs/models/interfaces/TravelerProperties.md index 57c799aa..16d76dd6 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/TravelerProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/TravelerProperties.md @@ -4,13 +4,13 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `age`? | `number` | - | models/Traveler.ts:88 | -| `birthDate`? | `Date` | - | models/Traveler.ts:89 | -| `citizenshipCountryCode`? | `string` | - | models/Traveler.ts:90 | -| `emailAddress`? | `string` | - | models/Traveler.ts:85 | -| `primary` | `boolean` | - | models/Traveler.ts:87 | -| `telephones`? | [`Telephone`](../classes/Telephone.md)[] | - | models/Traveler.ts:86 | -| `travelerId`? | `string` | - | models/Traveler.ts:91 | -| `travelerName` | [`Name`](../classes/Name.md) | - | models/Traveler.ts:84 | +| Property | Type | +| :------ | :------ | +| `age?` | `number` | +| `birthDate?` | `Date` | +| `citizenshipCountryCode?` | `string` | +| `emailAddress?` | `string` | +| `primary` | `boolean` | +| `telephones?` | [`Telephone`](../classes/Telephone.md)[] | +| `travelerId?` | `string` | +| `travelerName` | [`Name`](../classes/Name.md) | diff --git a/release/fraudPreventionV2/docs/models/interfaces/UnauthorizedErrorProperties.md b/release/fraudPreventionV2/docs/models/interfaces/UnauthorizedErrorProperties.md index 4f534056..698bad65 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/UnauthorizedErrorProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/UnauthorizedErrorProperties.md @@ -4,7 +4,7 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/UnauthorizedErrorCodeEnum.md) | - | models/UnauthorizedError.ts:59 | -| `message` | `string` | - | models/UnauthorizedError.ts:60 | +| Property | Type | +| :------ | :------ | +| `code` | [`UnauthorizedErrorCodeEnum`](../type-aliases/UnauthorizedErrorCodeEnum.md) | +| `message` | `string` | diff --git a/release/fraudPreventionV2/docs/models/interfaces/VerifyProperties.md b/release/fraudPreventionV2/docs/models/interfaces/VerifyProperties.md index a56d6b66..eba190c4 100644 --- a/release/fraudPreventionV2/docs/models/interfaces/VerifyProperties.md +++ b/release/fraudPreventionV2/docs/models/interfaces/VerifyProperties.md @@ -4,9 +4,9 @@ ## Properties -| Property | Type | Description | Source | -| :------ | :------ | :------ | :------ | -| `amount`? | [`Amount`](../classes/Amount.md) | - | models/Verify.ts:60 | -| `id`? | `string` | - | models/Verify.ts:59 | -| `outcome`? | [`PaymentOutcome`](../classes/PaymentOutcome.md) | - | models/Verify.ts:61 | -| `type`? | [`VerificationType`](../type-aliases/VerificationType.md) | - | models/Verify.ts:62 | +| Property | Type | +| :------ | :------ | +| `amount?` | [`Amount`](../classes/Amount.md) | +| `id?` | `string` | +| `outcome?` | [`PaymentOutcome`](../classes/PaymentOutcome.md) | +| `type?` | [`VerificationType`](../type-aliases/VerificationType.md) | diff --git a/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts b/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts index 46dab382..c361cea3 100644 --- a/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts +++ b/release/fraudPreventionV2/src/client/apis/FraudPreventionV2Client.ts @@ -49,7 +49,7 @@ export class FraudPreventionV2Client extends Client { private static readonly nodeVersion: string = process.version private static readonly operatingSystemName: string = platform() private static readonly operatingSystemVersion: string = release() - private static readonly userAgent: string = `${this.sdkTitle}/4.3.0 (Node.js ${this.nodeVersion} ${this.operatingSystemName} ${this.operatingSystemVersion})` + private static readonly userAgent: string = `${this.sdkTitle}/4.4.0 (Node.js ${this.nodeVersion} ${this.operatingSystemName} ${this.operatingSystemVersion})` constructor(configurations: ClientConfigurations) { super({ diff --git a/release/fraudPreventionV2/src/package.json b/release/fraudPreventionV2/src/package.json index 6fb26392..b39554cc 100644 --- a/release/fraudPreventionV2/src/package.json +++ b/release/fraudPreventionV2/src/package.json @@ -1,7 +1,7 @@ { "name": "@expediagroup/fraudpreventionv2-sdk", - "version": "4.3.0", - "description": "ExpediaGroup FraudPreventionV2 SDK v4.3.0 Core Modules of EG Travel SDK", + "version": "4.4.0", + "description": "ExpediaGroup FraudPreventionV2 SDK v4.4.0 Core Modules of EG Travel SDK", "main": "lib/index.js", "types": "index.ts", "scripts": { @@ -15,28 +15,28 @@ }, "dependencies": { "@types/lodash": "4.14.202", - "@types/node": "20.10.0", - "@types/uuid": "9.0.7", - "axios": "1.6.2", + "@types/node": "20.11.16", + "@types/uuid": "9.0.8", + "axios": "1.6.7", "lodash": "4.17.21", "typescript-json-serializer": "6.0.1", "uuid": "9.0.1", "winston": "3.11.0" }, "devDependencies": { - "@babel/preset-env": "7.23.3", + "@babel/preset-env": "7.23.9", "@babel/preset-typescript": "7.23.3", - "@types/jest": "29.5.10", + "@types/jest": "29.5.12", "axios-mock-adapter": "1.22.0", "jest": "29.7.0", - "prettier": "3.1.0", + "prettier": "3.2.5", "prettier-plugin-organize-imports": "3.2.4", - "ts-jest": "29.1.1", + "ts-jest": "29.1.2", "ts-standard": "12.0.2", - "typedoc": "0.25.4", - "typedoc-plugin-markdown": "4.0.0-next.27", - "typedoc-plugin-missing-exports": "2.1.0", - "typescript": "5.3.2" + "typedoc": "0.25.7", + "typedoc-plugin-markdown": "4.0.0-next.50", + "typedoc-plugin-missing-exports": "2.2.0", + "typescript": "5.3.3" }, "publishConfig": { "access": "public" diff --git a/release/fraudPreventionV2/src/specs.yaml b/release/fraudPreventionV2/src/specs.yaml index 3cdc49b7..557d686d 100644 --- a/release/fraudPreventionV2/src/specs.yaml +++ b/release/fraudPreventionV2/src/specs.yaml @@ -991,7 +991,6 @@ components: description: Source of the device_box. Default value is `TrustWidget`. device_box: type: string - maxLength: 16000 description: Device related information retrieved from TrustWidget. ip_address: type: string @@ -2952,7 +2951,6 @@ components: description: Source of the device_box. Default value is `TrustWidget`. device_box: type: string - maxLength: 16000 description: Device related information retrieved from TrustWidget. ip_address: type: string @@ -2963,7 +2961,6 @@ components: type: string description: The application type, operating system, software vendor, or software version of the originating request. - maxLength: 200 example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 type: